osl.c

   1 /*
   2  * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file osl.c Object storage layer functions. */
   8 #include "para.h"
   9 #include "error.h"
  10 #include "list.h"
  11 #include "osl_core.h"
  12 #include <dirent.h> /* readdir() */
  13 #include <assert.h>
  14
  15 //#define FMT_OFF_T "%li"
  16
  17
  18 /**
  19  * A wrapper for lseek(2).
  20  *
  21  * \param fd The filedescriptor whose offset is to be to repositioned.
  22  * \param offset A value-result parameter.
  23  * \param whence Usual repositioning directive.
  24  *
  25  * Reposition the offset of the file descriptor \a fd to the argument \a offset
  26  * according to the directive \a whence. Upon successful return, \a offset
  27  * contains the resulting offset location as measured in bytes from the
  28  * beginning of the file.
  29  *
  30  * \return Positive on success. Otherwise, the function returns \p -E_LSEEK.
  31  *
  32  * \sa lseek(2).
  33  */
  34 int para_lseek(int fd, off_t *offset, int whence)
  35 {
  36         *offset = lseek(fd, *offset, whence);
  37         int ret = -E_LSEEK;
  38         if (*offset == -1)
  39                 return ret;
  40         return 1;
  41 }
  42
  43 /**
  44  * Waraper for the write system call.
  45  *
  46  * \param fd The file descriptor to write to.
  47  * \param buf The buffer to write.
  48  * \param size The length of \a buf in bytes.
  49  *
  50  * This function writes out the given bufffer and retries if an interrupt
  51  * occured during the write.
  52  *
  53  * \return On success, the number of bytes written is returned, otherwise, the
  54  * function returns \p -E_WRITE.
  55  *
  56  * \sa write(2).
  57  */
  58 ssize_t para_write(int fd, const void *buf, size_t size)
  59 {
  60         ssize_t ret;
  61
  62         for (;;) {
  63                 ret = write(fd, buf, size);
  64                 if ((ret < 0) && (errno == EAGAIN || errno == EINTR))
  65                         continue;
  66                 return ret >= 0? ret : -E_WRITE;
  67         }
  68 }
  69
  70 /**
  71  * Write the whole buffer to a file descriptor.
  72  *
  73  * \param fd The file descriptor to write to.
  74  * \param buf The buffer to write.
  75  * \param size The length of \a buf in bytes.
  76  *
  77  * This function writes the given buffer and continues on short writes and
  78  * when interrupted by a signal.
  79  *
  80  * \return Positive on success, negative on errors. Possible errors: any
  81  * errors returned by para_write().
  82  *
  83  * \sa para_write().
  84  */
  85 ssize_t para_write_all(int fd, const void *buf, size_t size)
  86 {
  87 //      PARA_DEBUG_LOG("writing %zu bytes\n", size);
  88         const char *b = buf;
  89         while (size) {
  90                 ssize_t ret = para_write(fd, b, size);
  91 //              PARA_DEBUG_LOG("ret: %zd\n", ret);
  92                 if (ret < 0)
  93                         return ret;
  94                 b += ret;
  95                 size -= ret;
  96         }
  97         return 1;
  98 }
  99 /**
 100  * Wrapper for the open(2) system call.
 101  *
 102  * \param path The filename.
 103  * \param flags The usual open(2) flags.
 104  * \param mode Specifies the permissions to use.
 105  *
 106  * The mode parameter must be specified when O_CREAT is in the flags, and is ignored
 107  * otherwise.
 108  *
 109  * \return Positive on success, negative on errors. Possible errors: \p
 110  * E_EXIST, \p E_ISDIR, \p E_NOENT, \p E_OSL_PERM.
 111  *
 112  * \sa open(2).
 113  */
 114 int para_open(const char *path, int flags, mode_t mode)
 115 {
 116         PARA_DEBUG_LOG("opening %s\n", path);
 117         int ret = open(path, flags, mode);
 118
 119         if (ret >= 0)
 120                 return ret;
 121         switch (errno) {
 122         case EEXIST:
 123                 ret = -E_EXIST;
 124                 break;
 125         case EISDIR:
 126                 ret = -E_ISDIR;
 127                 break;
 128         case ENOENT:
 129                 ret = -E_NOENT;
 130                 break;
 131         case EPERM:
 132                 ret = -E_OSL_PERM;
 133                 break;
 134         };
 135         PARA_ERROR_LOG("failed to open %s: %s\n", path, strerror(errno));
 136         return ret;
 137 }
 138
 139 /**
 140  * Open a file, write the given buffer and close the file.
 141  *
 142  * \param filename Full path to the file to open.
 143  * \param buf The buffer to write to the file.
 144  * \param size The size of \a buf.
 145  *
 146  * \return Positive on success, negative on errors. Possible errors include:
 147  * any errors from para_open() or para_write().
 148  *
 149  * \sa para_open(), para_write().
 150  */
 151 int para_write_file(const char *filename, const void *buf, size_t size)
 152 {
 153         int ret, fd;
 154
 155         ret = para_open(filename, O_WRONLY | O_CREAT | O_EXCL, 0644);
 156         if (ret < 0)
 157                 return ret;
 158         fd = ret;
 159         ret = para_write_all(fd, buf, size);
 160         if (ret < 0)
 161                 goto out;
 162         ret = 1;
 163 out:
 164         close(fd);
 165         return ret;
 166 }
 167
 168 static int append_file(const char *filename, char *header, size_t header_size,
 169         char *data, size_t data_size, uint32_t *new_pos)
 170 {
 171         int ret, fd;
 172
 173 //      PARA_DEBUG_LOG("appending %zu  + %zu bytes\n", header_size, data_size);
 174         ret = para_open(filename, O_WRONLY | O_CREAT | O_APPEND, 0644);
 175         if (ret < 0)
 176                 return ret;
 177         fd = ret;
 178         if (header && header_size) {
 179                 ret = para_write_all(fd, header, header_size);
 180                 if (ret < 0)
 181                         goto out;
 182         }
 183         ret = para_write_all(fd, data, data_size);
 184         if (ret < 0)
 185                 goto out;
 186         if (new_pos) {
 187                 off_t offset = 0;
 188                 ret = para_lseek(fd, &offset, SEEK_END);
 189                 if (ret < 0)
 190                         goto out;
 191 //              PARA_DEBUG_LOG("new file size: " FMT_OFF_T "\n", offset);
 192                 *new_pos = offset;
 193         }
 194         ret = 1;
 195 out:
 196         close(fd);
 197         return ret;
 198 }
 199
 200 /**
 201  * Map a file into memory.
 202  *
 203  * \param path Name of the regular file to map.
 204  * \param open_mode Either \p O_RDONLY or \p O_RDWR.
 205  * \param obj On success, the mapping is returned here.
 206  *
 207  * \return Positive on success, negative on errors. Possible errors include: \p
 208  * E_FSTAT, any errors returned by para_open(), \p E_EMPTY, \p E_MMAP.
 209  *
 210  * \sa para_open(), mmap(2).
 211  */
 212 int mmap_full_file(const char *path, int open_mode, struct osl_object *obj)
 213 {
 214         int fd, ret, mmap_prot, mmap_flags;
 215         struct stat file_status;
 216
 217         if (open_mode == O_RDONLY) {
 218                 mmap_prot = PROT_READ;
 219                 mmap_flags = MAP_PRIVATE;
 220         } else {
 221                 mmap_prot = PROT_READ | PROT_WRITE;
 222                 mmap_flags = MAP_SHARED;
 223         }
 224         ret = para_open(path, open_mode, 0);
 225         if (ret < 0)
 226                 return ret;
 227         fd = ret;
 228         ret = -E_FSTAT;
 229         if (fstat(fd, &file_status) < 0)
 230                 goto out;
 231         obj->size = file_status.st_size;
 232         ret = -E_EMPTY;
 233         PARA_DEBUG_LOG("%s: size %zu\n", path, obj->size);
 234         if (!obj->size)
 235                 goto out;
 236         obj->data = mmap(NULL, obj->size, mmap_prot, mmap_flags, fd, 0);
 237         if (obj->data == MAP_FAILED) {
 238                 obj->data = NULL;
 239                 ret = -E_MMAP;
 240                 goto out;
 241         }
 242         ret = 1;
 243 out:
 244         close(fd);
 245         return ret;
 246 }
 247
 248 /**
 249  * Traverse the given directory recursively.
 250  *
 251  * \param dirname The directory to traverse.
 252  * \param func The function to call for each entry.
 253  * \param private_data Pointer to an arbitrary data structure.
 254  *
 255  * For each regular file  in \a dirname, the supplied function \a func is
 256  * called.  The full path of the regular file and the \a private_data pointer
 257  * are passed to \a func.
 258  *
 259  * \return On success, 1 is returned. Otherwise, this function returns a
 260  * negative value which indicates the kind of the error.
 261  */
 262 int for_each_file_in_dir(const char *dirname,
 263                 int (*func)(const char *, const void *), const void *private_data)
 264 {
 265         DIR *dir = NULL;
 266         struct dirent *entry;
 267         /*
 268          * Opening the current directory (".") and calling fchdir() to return
 269          * is usually faster and more reliable than saving cwd in some buffer
 270          * and calling chdir() afterwards (see man 3 getcwd).
 271          */
 272         int cwd_fd = open(".", O_RDONLY);
 273         struct stat s;
 274         int ret = -1;
 275
 276 //      PARA_DEBUG_LOG("dirname: %s\n", dirname);
 277         if (cwd_fd < 0)
 278                 return -E_OSL_GETCWD;
 279         ret = -E_OSL_CHDIR;
 280         if (chdir(dirname) < 0)
 281                 goto out;
 282         ret = -E_OSL_OPENDIR;
 283         dir = opendir(".");
 284         if (!dir)
 285                 goto out;
 286         /* scan cwd recursively */
 287         while ((entry = readdir(dir))) {
 288                 mode_t m;
 289                 char *tmp;
 290
 291                 if (!strcmp(entry->d_name, "."))
 292                         continue;
 293                 if (!strcmp(entry->d_name, ".."))
 294                         continue;
 295                 ret = -E_OSL_LSTAT;
 296                 if (lstat(entry->d_name, &s) == -1)
 297                         continue;
 298                 m = s.st_mode;
 299                 if (!S_ISREG(m) && !S_ISDIR(m))
 300                         continue;
 301                 tmp = make_message("%s/%s", dirname, entry->d_name);
 302                 if (!S_ISDIR(m)) {
 303                         ret = func(tmp, private_data);
 304                         free(tmp);
 305                         if (ret < 0)
 306                                 goto out;
 307                         continue;
 308                 }
 309                 /* directory */
 310                 ret = for_each_file_in_dir(tmp, func, private_data);
 311                 free(tmp);
 312                 if (ret < 0)
 313                         goto out;
 314         }
 315         ret = 1;
 316 out:
 317         if (dir)
 318                 closedir(dir);
 319         if (fchdir(cwd_fd) < 0 && ret >= 0)
 320                 ret = -E_OSL_CHDIR;
 321         close(cwd_fd);
 322         return ret;
 323 }
 324
 325 int para_mkdir(const char *path, mode_t mode)
 326 {
 327         if (!mkdir(path, mode))
 328                 return 1;
 329         if (errno == EEXIST)
 330                 return -E_EXIST;
 331         if (errno == ENOSPC)
 332                 return -E_NOSPC;
 333         if (errno == ENOTDIR)
 334                 return -E_NOTDIR;
 335         if (errno == EPERM)
 336                 return E_OSL_PERM;
 337         return -E_MKDIR;
 338 }
 339
 340 static int verify_basename(const char *name)
 341 {
 342         if (!name)
 343                 return -E_BAD_BASENAME;
 344         if (!*name)
 345                 return -E_BAD_BASENAME;
 346         if (strchr(name, '/'))
 347                 return -E_BAD_BASENAME;
 348         if (!strcmp(name, ".."))
 349                 return -E_BAD_BASENAME;
 350         if (!strcmp(name, "."))
 351                 return -E_BAD_BASENAME;
 352         return 1;
 353 }
 354
 355 /**
 356  * Compare two osl objects pointing to unsigned integers of 32 bit size.
 357  *
 358  * \param obj1 Pointer to the first integer.
 359  * \param obj2 Pointer to the second integer.
 360  *
 361  * \return The values required for an osl compare function.
 362  *
 363  * \sa osl_compare_func, osl_hash_compare().
 364  */
 365 int uint32_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 366 {
 367         uint32_t d1 = read_u32((const char *)obj1->data);
 368         uint32_t d2 = read_u32((const char *)obj2->data);
 369
 370         if (d1 < d2)
 371                 return 1;
 372         if (d1 > d2)
 373                 return -1;
 374         return 0;
 375 }
 376
 377 /**
 378  * Compare two osl objects pointing to hash values.
 379  *
 380  * \param obj1 Pointer to the first hash object.
 381  * \param obj2 Pointer to the second hash object.
 382  *
 383  * \return The values required for an osl compare function.
 384  *
 385  * \sa osl_compare_func, uint32_compare().
 386  */
 387 int osl_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 388 {
 389         return hash_compare((HASH_TYPE *)obj1->data, (HASH_TYPE *)obj2->data);
 390 }
 391
 392 static char *disk_storage_dirname(const struct osl_table *t, unsigned col_num,
 393                 const char *ds_name)
 394 {
 395         char *dirname, *column_name = column_filename(t, col_num);
 396
 397         if (!(t->desc->flags & OSL_LARGE_TABLE))
 398                 return column_name;
 399         dirname = make_message("%s/%.2s", column_name, ds_name);
 400         free(column_name);
 401         return dirname;
 402 }
 403
 404 static char *disk_storage_name_of_object(const struct osl_table *t,
 405         const struct osl_object *obj)
 406 {
 407         HASH_TYPE hash[HASH_SIZE];
 408         hash_object(obj, hash);
 409         return disk_storage_name_of_hash(t, hash);
 410 }
 411
 412 static int disk_storage_name_of_row(const struct osl_table *t,
 413                 const struct osl_row *row, char **name)
 414 {
 415         struct osl_object obj;
 416         int ret = osl_get_object(t, row, t->disk_storage_name_column, &obj);
 417
 418         if (ret < 0)
 419                 return ret;
 420         *name = disk_storage_name_of_object(t, &obj);
 421         return 1;
 422 }
 423
 424 static void column_name_hash(const char *col_name, HASH_TYPE *hash)
 425 {
 426         return hash_function(col_name, strlen(col_name), hash);
 427 }
 428
 429 static int init_column_descriptions(struct osl_table *t)
 430 {
 431         int i, j, ret;
 432         const struct osl_column_description *cd;
 433
 434         ret = -E_BAD_TABLE_DESC;
 435         ret = verify_basename(t->desc->name);
 436         if (ret < 0)
 437                 goto err;
 438         ret = -E_BAD_DB_DIR;
 439         if (!t->desc->dir)
 440                 goto err;
 441         /* the size of the index header without column descriptions */
 442         t->index_header_size = IDX_COLUMN_DESCRIPTIONS;
 443         FOR_EACH_COLUMN(i, t->desc, cd) {
 444                 struct osl_column *col = t->columns + i;
 445                 if (cd->storage_flags & OSL_RBTREE) {
 446                         if (!cd->compare_function)
 447                                 return -E_NO_COMPARE_FUNC;
 448                 }
 449                 if (cd->storage_type == OSL_NO_STORAGE)
 450                         continue;
 451                 ret = -E_NO_COLUMN_NAME;
 452                 if (!cd->name || !cd->name[0])
 453                         goto err;
 454                 ret = verify_basename(cd->name);
 455                 if (ret < 0)
 456                         goto err;
 457                 t->index_header_size += index_column_description_size(cd->name);
 458                 column_name_hash(cd->name, col->name_hash);
 459                 ret = -E_DUPLICATE_COL_NAME;
 460                 for (j = i + 1; j < t->desc->num_columns; j++) {
 461                         const char *name2 = get_column_description(t->desc,
 462                                 j)->name;
 463                         if (cd->name && name2 && !strcmp(cd->name, name2))
 464                                 goto err;
 465                 }
 466         }
 467         return 1;
 468 err:
 469         return ret;
 470 }
 471
 472 /**
 473  * Initialize a struct table from given table description.
 474  *
 475  * \param desc The description of the osl table.
 476  * \param table_ptr Result is returned here.
 477  *
 478  * This function performs several sanity checks on \p desc and returns if any
 479  * of these tests fail. On success, a struct \p osl_table is allocated and
 480  * initialized with data derived from \p desc.
 481  *
 482  * \return Positive on success, negative on errors. Possible errors include: \p
 483  * E_BAD_TABLE_DESC, \p E_NO_COLUMN_DESC, \p E_NO_COLUMNS, \p
 484  * E_BAD_STORAGE_TYPE, \p E_BAD_STORAGE_FLAGS, \p E_BAD_STORAGE_SIZE, \p
 485  * E_NO_UNIQUE_RBTREE_COLUMN, \p E_NO_RBTREE_COL.
 486  *
 487  * \sa struct osl_table.
 488  */
 489 int init_table_structure(const struct osl_table_description *desc,
 490                 struct osl_table **table_ptr)
 491 {
 492         const struct osl_column_description *cd;
 493         struct osl_table *t = para_calloc(sizeof(*t));
 494         int i, ret = -E_BAD_TABLE_DESC, have_disk_storage_name_column = 0;
 495
 496         if (!desc)
 497                 goto err;
 498         PARA_DEBUG_LOG("creating table structure for '%s' from table "
 499                 "description\n", desc->name);
 500         ret = -E_NO_COLUMN_DESC;
 501         if (!desc->column_descriptions)
 502                 goto err;
 503         ret = -E_NO_COLUMNS;
 504         if (!desc->num_columns)
 505                 goto err;
 506         t->columns = para_calloc(desc->num_columns * sizeof(struct osl_column));
 507         t->desc = desc;
 508         FOR_EACH_COLUMN(i, t->desc, cd) {
 509                 enum osl_storage_type st = cd->storage_type;
 510                 enum osl_storage_flags sf = cd->storage_flags;
 511                 struct osl_column *col = &t->columns[i];
 512
 513                 ret = -E_BAD_STORAGE_TYPE;
 514                 if (st != OSL_MAPPED_STORAGE && st != OSL_DISK_STORAGE
 515                                 && st != OSL_NO_STORAGE)
 516                         goto err;
 517                 ret = -E_BAD_STORAGE_FLAGS;
 518                 if (st == OSL_DISK_STORAGE && sf & OSL_RBTREE)
 519                         goto err;
 520                 ret = -E_BAD_STORAGE_SIZE;
 521                 if (sf & OSL_FIXED_SIZE && !cd->data_size)
 522                         goto err;
 523                 switch (st) {
 524                 case OSL_DISK_STORAGE:
 525                         t->num_disk_storage_columns++;
 526                         break;
 527                 case OSL_MAPPED_STORAGE:
 528                         t->num_mapped_columns++;
 529                         col->index_offset = t->index_entry_size;
 530                         t->index_entry_size += 8;
 531                         break;
 532                 case OSL_NO_STORAGE:
 533                         col->volatile_num = t->num_volatile_columns;
 534                         t->num_volatile_columns++;
 535                         break;
 536                 }
 537                 if (sf & OSL_RBTREE) {
 538                         col->rbtree_num = t->num_rbtrees;
 539                         t->num_rbtrees++;
 540                         if ((sf & OSL_UNIQUE) && (st == OSL_MAPPED_STORAGE)) {
 541                                 if (!have_disk_storage_name_column)
 542                                         t->disk_storage_name_column = i;
 543                                 have_disk_storage_name_column = 1;
 544                         }
 545                 }
 546         }
 547         ret = -E_NO_UNIQUE_RBTREE_COLUMN;
 548         if (t->num_disk_storage_columns && !have_disk_storage_name_column)
 549                 goto err;
 550         ret = -E_NO_RBTREE_COL;
 551         if (!t->num_rbtrees)
 552                 goto err;
 553         /* success */
 554         PARA_DEBUG_LOG("OK. Index entry size: %u\n", t->index_entry_size);
 555         ret = init_column_descriptions(t);
 556         if (ret < 0)
 557                 goto err;
 558         *table_ptr = t;
 559         return 1;
 560 err:
 561         free(t->columns);
 562         free(t);
 563         return ret;
 564 }
 565
 566 /**
 567  * Read the table description from index header.
 568  *
 569  * \param map The memory mapping of the index file.
 570  * \param desc The values found in the index header are returned here.
 571  *
 572  * Read the index header, check for the paraslash magic string and the table version number.
 573  * Read all information stored in the index header into \a desc.
 574  *
 575  * \return Positive on success, negative on errors.
 576  *
 577  * \sa struct osl_table_description, osl_create_table.
 578  */
 579 int read_table_desc(struct osl_object *map, struct osl_table_description *desc)
 580 {
 581         char *buf = map->data;
 582         uint8_t version;
 583         uint16_t header_size;
 584         int ret, i;
 585         unsigned offset;
 586         struct osl_column_description *cd;
 587
 588         if (map->size < MIN_INDEX_HEADER_SIZE(1))
 589                 return -E_SHORT_TABLE;
 590         if (strncmp(buf + IDX_PARA_MAGIC, PARA_MAGIC, strlen(PARA_MAGIC)))
 591                 return -E_NO_MAGIC;
 592         version = read_u8(buf + IDX_VERSION);
 593         if (version < MIN_TABLE_VERSION || version > MAX_TABLE_VERSION)
 594                 return -E_VERSION_MISMATCH;
 595         desc->num_columns = read_u8(buf + IDX_TABLE_FLAGS);
 596         desc->flags = read_u8(buf + IDX_TABLE_FLAGS);
 597         desc->num_columns = read_u16(buf + IDX_NUM_COLUMNS);
 598         PARA_DEBUG_LOG("%u columns\n", desc->num_columns);
 599         if (!desc->num_columns)
 600                 return -E_NO_COLUMNS;
 601         header_size = read_u16(buf + IDX_HEADER_SIZE);
 602         if (map->size < header_size)
 603                 return -E_BAD_SIZE;
 604         desc->column_descriptions = para_calloc(desc->num_columns
 605                 * sizeof(struct osl_column_description));
 606         offset = IDX_COLUMN_DESCRIPTIONS;
 607         FOR_EACH_COLUMN(i, desc, cd) {
 608                 char *null_byte;
 609
 610                 ret = -E_SHORT_TABLE;
 611                 if (map->size < offset + MIN_IDX_COLUMN_DESCRIPTION_SIZE) {
 612                         PARA_ERROR_LOG("map size = %zu < %u = offset + min desc size\n",
 613                                 map->size, offset + MIN_IDX_COLUMN_DESCRIPTION_SIZE);
 614                         goto err;
 615                 }
 616                 cd->storage_type = read_u16(buf + offset + IDX_CD_STORAGE_TYPE);
 617                 cd->storage_flags = read_u16(buf + offset +
 618                         IDX_CD_STORAGE_FLAGS);
 619                 cd->data_size = read_u32(buf + offset + IDX_CD_DATA_SIZE);
 620                 null_byte = memchr(buf + offset + IDX_CD_NAME, '\0',
 621                         map->size - offset - IDX_CD_NAME);
 622                 ret = -E_INDEX_CORRUPTION;
 623                 if (!null_byte)
 624                         goto err;
 625                 cd->name = para_strdup(buf + offset + IDX_CD_NAME);
 626                 offset += index_column_description_size(cd->name);
 627         }
 628         if (offset != header_size) {
 629                 ret = -E_INDEX_CORRUPTION;
 630                 PARA_ERROR_LOG("real header size = %u != %u = stored header size\n",
 631                         offset, header_size);
 632                 goto err;
 633         }
 634         return 1;
 635 err:
 636         FOR_EACH_COLUMN(i, desc, cd)
 637                 free(cd->name);
 638         return ret;
 639 }
 640
 641 /*
 642  * check whether the table description given by \p t->desc matches the on-disk
 643  * table structure stored in the index of \a t.
 644  */
 645 static int compare_table_descriptions(struct osl_table *t)
 646 {
 647         int i, ret;
 648         struct osl_table_description desc;
 649         const struct osl_column_description *cd1, *cd2;
 650
 651         /* read the on-disk structure into desc */
 652         ret = read_table_desc(&t->index_map, &desc);
 653         if (ret < 0)
 654                 return ret;
 655         ret = -E_BAD_TABLE_FLAGS;
 656         if (desc.flags != t->desc->flags)
 657                 goto out;
 658         ret = E_BAD_COLUMN_NUM;
 659         if (desc.num_columns != t->desc->num_columns)
 660                 goto out;
 661         FOR_EACH_COLUMN(i, t->desc, cd1) {
 662                 cd2 = get_column_description(&desc, i);
 663                 ret = -E_BAD_STORAGE_TYPE;
 664                 if (cd1->storage_type != cd2->storage_type)
 665                         goto out;
 666                 ret = -E_BAD_STORAGE_FLAGS;
 667                 if (cd1->storage_flags != cd2->storage_flags) {
 668                         PARA_ERROR_LOG("sf1 = %u != %u = sf2\n",
 669                                 cd1->storage_flags, cd2->storage_flags);
 670                         goto out;
 671                 }
 672                 ret = -E_BAD_DATA_SIZE;
 673                 if (cd1->storage_flags & OSL_FIXED_SIZE)
 674                         if (cd1->data_size != cd2->data_size)
 675                                 goto out;
 676                 ret = -E_BAD_COLUMN_NAME;
 677                 if (strcmp(cd1->name, cd2->name))
 678                         goto out;
 679         }
 680         PARA_DEBUG_LOG("table description of '%s' matches on-disk data, good\n",
 681                 t->desc->name);
 682         ret = 1;
 683 out:
 684         FOR_EACH_COLUMN(i, &desc, cd1)
 685                 free(cd1->name);
 686         free(desc.column_descriptions);
 687         return ret;
 688 }
 689
 690 static int create_table_index(struct osl_table *t)
 691 {
 692         char *buf, *filename;
 693         int i, ret;
 694         size_t size = t->index_header_size;
 695         const struct osl_column_description *cd;
 696         unsigned offset;
 697
 698         PARA_INFO_LOG("creating %zu byte index for table %s\n", size,
 699                 t->desc->name);
 700         buf = para_calloc(size);
 701         sprintf(buf + IDX_PARA_MAGIC, "%s", PARA_MAGIC);
 702         write_u8(buf + IDX_TABLE_FLAGS, t->desc->flags);
 703         write_u8(buf + IDX_DIRTY_FLAG, 0);
 704         write_u8(buf + IDX_VERSION, CURRENT_TABLE_VERSION);
 705         write_u16(buf + IDX_NUM_COLUMNS, t->desc->num_columns);
 706         write_u16(buf + IDX_HEADER_SIZE, t->index_header_size);
 707         offset = IDX_COLUMN_DESCRIPTIONS;
 708         FOR_EACH_COLUMN(i, t->desc, cd) {
 709                 write_u16(buf + offset + IDX_CD_STORAGE_TYPE,
 710                         cd->storage_type);
 711                 write_u16(buf + offset + IDX_CD_STORAGE_FLAGS,
 712                         cd->storage_flags);
 713                 if (cd->storage_flags & OSL_FIXED_SIZE)
 714                         write_u32(buf + offset + IDX_CD_DATA_SIZE,
 715                                 cd->data_size);
 716                 strcpy(buf + offset + IDX_CD_NAME, cd->name);
 717                 offset += index_column_description_size(cd->name);
 718         }
 719         assert(offset = size);
 720         filename = index_filename(t->desc);
 721         ret = para_write_file(filename, buf, size);
 722         free(buf);
 723         free(filename);
 724         return ret;
 725 }
 726
 727 /**
 728  * Create a new osl table.
 729  *
 730  * \param desc Pointer to the table description.
 731  *
 732  * \return Positive on success, negative on errors. Possible errors include: \p
 733  * E_BAD_TABLE_DESC, \p E_BAD_DB_DIR, \p E_BAD_BASENAME, \p E_NO_COMPARE_FUNC, \p
 734  * E_NO_COLUMN_NAME, \p E_DUPLICATE_COL_NAME, \p E_MKDIR, any errors returned
 735  * by para_open().
 736  */
 737 int osl_create_table(const struct osl_table_description *desc)
 738 {
 739         const struct osl_column_description *cd;
 740         char *table_dir = NULL, *filename;
 741         struct osl_table *t;
 742         int i, ret = init_table_structure(desc, &t);
 743
 744         if (ret < 0)
 745                 return ret;
 746         PARA_INFO_LOG("creating %s\n", desc->name);
 747         FOR_EACH_COLUMN(i, t->desc, cd) {
 748                 if (cd->storage_type == OSL_NO_STORAGE)
 749                         continue;
 750                 if (!table_dir) {
 751                         ret = para_mkdir(desc->dir, 0777);
 752                         if (ret < 0 && ret != -E_EXIST)
 753                                 goto out;
 754                         table_dir = make_message("%s/%s", desc->dir,
 755                                 desc->name);
 756                         ret = para_mkdir(table_dir, 0777);
 757                         if (ret < 0)
 758                                 goto out;
 759                 }
 760                 filename = column_filename(t, i);
 761                 PARA_INFO_LOG("filename: %s\n", filename);
 762                 if (cd->storage_type == OSL_MAPPED_STORAGE) {
 763                         ret = para_open(filename, O_RDWR | O_CREAT | O_EXCL,
 764                                 0644);
 765                         free(filename);
 766                         if (ret < 0)
 767                                 goto out;
 768                         close(ret);
 769                         continue;
 770                 }
 771                 /* DISK STORAGE */
 772                 ret = para_mkdir(filename, 0777);
 773                 free(filename);
 774                 if (ret < 0)
 775                         goto out;
 776         }
 777         if (t->num_mapped_columns) {
 778                 ret = create_table_index(t);
 779                 if (ret < 0)
 780                         goto out;
 781         }
 782         ret = 1;
 783 out:
 784         free(table_dir);
 785         free(t->columns);
 786         free(t);
 787         return ret;
 788 }
 789
 790 static int table_is_dirty(struct osl_table *t)
 791 {
 792         char *buf = (char *)t->index_map.data + IDX_DIRTY_FLAG;
 793         uint8_t dirty = read_u8(buf) & 0x1;
 794         return !!dirty;
 795 }
 796
 797 static void mark_table_dirty(struct osl_table *t)
 798 {
 799         char *buf = (char *)t->index_map.data + IDX_DIRTY_FLAG;
 800         write_u8(buf, read_u8(buf) | 1);
 801 }
 802
 803 static void mark_table_clean(struct osl_table *t)
 804 {
 805         char *buf = (char *)t->index_map.data + IDX_DIRTY_FLAG;
 806         write_u8(buf, read_u8(buf) & 0xfe);
 807 }
 808
 809 static void unmap_column(struct osl_table *t, unsigned col_num)
 810 {
 811         struct osl_object map = t->columns[col_num].data_map;
 812         int ret;
 813         if (!map.data)
 814                 return;
 815         ret = para_munmap(map.data, map.size);
 816         assert(ret > 0);
 817         map.data = NULL;
 818 }
 819
 820 /**
 821  * Unmap all mapped files of an osl table.
 822  *
 823  * \param t Pointer to a mapped table.
 824  * \param flags Options for unmapping.
 825  *
 826  * \return Positive on success, negative on errors. Possible errors include:
 827  * E_NOT_MAPPED, E_MUNMAP.
 828  *
 829  * \sa map_table(), enum osl_close_flags, para_munmap().
 830  */
 831 int unmap_table(struct osl_table *t, enum osl_close_flags flags)
 832 {
 833         unsigned i;
 834         const struct osl_column_description *cd;
 835         int ret;
 836
 837         if (!t->num_mapped_columns) /* can this ever happen? */
 838                 return 1;
 839         PARA_DEBUG_LOG("unmapping table '%s'\n", t->desc->name);
 840         if (!t->index_map.data)
 841                 return -E_NOT_MAPPED;
 842         if (flags & OSL_MARK_CLEAN)
 843                 mark_table_clean(t);
 844         ret = para_munmap(t->index_map.data, t->index_map.size);
 845         if (ret < 0)
 846                 return ret;
 847         t->index_map.data = NULL;
 848         if (!t->num_rows)
 849                 return 1;
 850         FOR_EACH_MAPPED_COLUMN(i, t, cd)
 851                 unmap_column(t, i);
 852         return 1;
 853 }
 854
 855 static int map_column(struct osl_table *t, unsigned col_num)
 856 {
 857         struct stat statbuf;
 858         char *filename = column_filename(t, col_num);
 859         int ret = -E_STAT;
 860         if (stat(filename, &statbuf) < 0) {
 861                 free(filename);
 862                 return ret;
 863         }
 864         if (!(S_IFREG & statbuf.st_mode)) {
 865                 free(filename);
 866                 return ret;
 867         }
 868         ret = mmap_full_file(filename, O_RDWR,
 869                 &t->columns[col_num].data_map);
 870         free(filename);
 871         return ret;
 872 }
 873
 874 /**
 875  * Map the index file and all columns of type \p OSL_MAPPED_STORAGE into memory.
 876  *
 877  * \param t Pointer to an initialized table structure.
 878  * \param flags Mapping options.
 879  *
 880  * \return Negative return value on errors; on success the number of rows
 881  * (including invalid rows) is returned.
 882  *
 883  * \sa unmap_table(), enum map_table_flags, osl_open_table(), mmap(2).
 884  */
 885 int map_table(struct osl_table *t, enum map_table_flags flags)
 886 {
 887         char *filename;
 888         const struct osl_column_description *cd;
 889         int i = 0, ret, num_rows = 0;
 890
 891         if (!t->num_mapped_columns)
 892                 return 0;
 893         if (t->index_map.data)
 894                 return -E_ALREADY_MAPPED;
 895         filename = index_filename(t->desc);
 896         PARA_DEBUG_LOG("mapping table '%s' (index: %s)\n", t->desc->name, filename);
 897         ret = mmap_full_file(filename, flags & MAP_TBL_FL_MAP_RDONLY?
 898                 O_RDONLY : O_RDWR, &t->index_map);
 899         free(filename);
 900         if (ret < 0)
 901                 return ret;
 902         if (flags & MAP_TBL_FL_VERIFY_INDEX) {
 903                 ret = compare_table_descriptions(t);
 904                 if (ret < 0)
 905                         goto err;
 906         }
 907         ret = -E_BUSY;
 908         if (!(flags & MAP_TBL_FL_IGNORE_DIRTY)) {
 909                 if (table_is_dirty(t)) {
 910                         PARA_ERROR_LOG("%s is dirty\n", t->desc->name);
 911                         goto err;
 912                 }
 913         }
 914         mark_table_dirty(t);
 915         num_rows = table_num_rows(t);
 916         if (!num_rows)
 917                 return num_rows;
 918         /* map data files */
 919         FOR_EACH_MAPPED_COLUMN(i, t, cd) {
 920                 ret = map_column(t, i);
 921                 if (ret < 0)
 922                         goto err;
 923         }
 924         return num_rows;
 925 err:    /* unmap what is already mapped */
 926         for (i--; i >= 0; i--) {
 927                 struct osl_object map = t->columns[i].data_map;
 928                 para_munmap(map.data, map.size);
 929                 map.data = NULL;
 930         }
 931         para_munmap(t->index_map.data, t->index_map.size);
 932         t->index_map.data = NULL;
 933         return ret;
 934 }
 935
 936 /**
 937  * Retrieve a mapped object by row and column number.
 938  *
 939  * \param t Pointer to an open osl table.
 940  * \param col_num Number of the mapped column containing the object to retrieve.
 941  * \param row_num Number of the row containing the object to retrieve.
 942  * \param obj The result is returned here.
 943  *
 944  * It is considered an error if \a col_num does not refer to a column
 945  * of storage type \p OSL_MAPPED_STORAGE.
 946  *
 947  * \return Positive on success, negative on errors. Possible errors include:
 948  * \p E_BAD_ID, \p E_INVALID_OBJECT.
 949  *
 950  * \sa osl_storage_type.
 951  */
 952 int get_mapped_object(const struct osl_table *t, unsigned col_num,
 953         uint32_t row_num, struct osl_object *obj)
 954 {
 955         struct osl_column *col = &t->columns[col_num];
 956         uint32_t offset;
 957         char *header;
 958         char *index_entry;
 959         int ret;
 960
 961         if (t->num_rows <= row_num)
 962                 return -E_BAD_ID;
 963         ret = get_index_entry(t, row_num, col_num, &index_entry);
 964         if (ret < 0)
 965                 return ret;
 966         offset = read_u32(index_entry);
 967         obj->size = read_u32(index_entry + 4) - 1;
 968         header = col->data_map.data + offset;
 969         obj->data = header + 1;
 970         if (read_u8(header) == 0xff) {
 971                 PARA_ERROR_LOG("col %u, size %zu, offset %u\n", col_num,
 972                         obj->size, offset);
 973                 return -E_INVALID_OBJECT;
 974         }
 975         return 1;
 976 }
 977
 978 static int search_rbtree(const struct osl_object *obj,
 979                 const struct osl_table *t, unsigned col_num,
 980                 struct rb_node **result, struct rb_node ***rb_link)
 981 {
 982         struct osl_column *col = &t->columns[col_num];
 983         struct rb_node **new = &col->rbtree.rb_node, *parent = NULL;
 984         const struct osl_column_description *cd =
 985                 get_column_description(t->desc, col_num);
 986         enum osl_storage_type st = cd->storage_type;
 987         while (*new) {
 988                 struct osl_row *this_row = get_row_pointer(*new,
 989                         col->rbtree_num);
 990                 int ret;
 991                 struct osl_object this_obj;
 992                 parent = *new;
 993                 if (st == OSL_MAPPED_STORAGE) {
 994                         ret = get_mapped_object(t, col_num, this_row->id,
 995                                 &this_obj);
 996                         if (ret < 0)
 997                                 return ret;
 998                 } else
 999                         this_obj = this_row->volatile_objects[col->volatile_num];
1000                 ret = cd->compare_function(obj, &this_obj);
1001                 if (!ret) {
1002                         if (result)
1003                                 *result = get_rb_node_pointer(this_row,
1004                                         col->rbtree_num);
1005                         return 1;
1006                 }
1007                 if (ret < 0)
1008                         new = &((*new)->rb_left);
1009                 else
1010                         new = &((*new)->rb_right);
1011         }
1012         if (result)
1013                 *result = parent;
1014         if (rb_link)
1015                 *rb_link = new;
1016         return -E_RB_KEY_NOT_FOUND;
1017 }
1018
1019 static int insert_rbtree(struct osl_table *t, unsigned col_num,
1020         const struct osl_row *row, const struct osl_object *obj)
1021 {
1022         struct rb_node *parent, **rb_link;
1023         unsigned rbtree_num;
1024         struct rb_node *n;
1025         int ret = search_rbtree(obj, t, col_num, &parent, &rb_link);
1026
1027         if (ret > 0)
1028                 return -E_RB_KEY_EXISTS;
1029         rbtree_num = t->columns[col_num].rbtree_num;
1030         n = get_rb_node_pointer(row, rbtree_num);
1031         rb_link_node(n, parent, rb_link);
1032         rb_insert_color(n, &t->columns[col_num].rbtree);
1033         return 1;
1034 }
1035
1036 static void remove_rb_node(struct osl_table *t, unsigned col_num,
1037                 const struct osl_row *row)
1038 {
1039         struct osl_column *col = &t->columns[col_num];
1040         const struct osl_column_description *cd =
1041                 get_column_description(t->desc, col_num);
1042         enum osl_storage_flags sf = cd->storage_flags;
1043         struct rb_node *victim, *splice_out_node, *tmp;
1044         if (!(sf & OSL_RBTREE))
1045                 return;
1046         /*
1047          * Which node is removed/spliced out actually depends on how many
1048          * children the victim node has: If it has no children, it gets
1049          * deleted. If it has one child, it gets spliced out. If it has two
1050          * children, its successor (which has at most a right child) gets
1051          * spliced out.
1052          */
1053         victim = get_rb_node_pointer(row, col->rbtree_num);
1054         if (victim->rb_left && victim->rb_right)
1055                 splice_out_node = rb_next(victim);
1056         else
1057                 splice_out_node = victim;
1058         /* Go up to the root and decrement the size of each node in the path. */
1059         for (tmp = splice_out_node; tmp; tmp = rb_parent(tmp))
1060                 tmp->size--;
1061         rb_erase(victim, &col->rbtree);
1062 }
1063
1064 static int add_row_to_rbtrees(struct osl_table *t, uint32_t id,
1065                 struct osl_object *volatile_objs, struct osl_row **row_ptr)
1066 {
1067         unsigned i;
1068         int ret;
1069         struct osl_row *row = allocate_row(t->num_rbtrees);
1070         const struct osl_column_description *cd;
1071
1072         row->id = id;
1073         row->volatile_objects = volatile_objs;
1074         FOR_EACH_RBTREE_COLUMN(i, t, cd) {
1075                 if (cd->storage_type == OSL_MAPPED_STORAGE) {
1076                         struct osl_object obj;
1077                         ret = get_mapped_object(t, i, id, &obj);
1078                         if (ret < 0)
1079                                 goto err;
1080                         ret = insert_rbtree(t, i, row, &obj);
1081                 } else { /* volatile */
1082                         const struct osl_object *obj
1083                                 = volatile_objs + t->columns[i].volatile_num;
1084                         ret = insert_rbtree(t, i, row, obj);
1085                 }
1086                 if (ret < 0)
1087                         goto err;
1088         }
1089         if (row_ptr)
1090                 *row_ptr = row;
1091         return 1;
1092 err: /* rollback changes, i.e. remove added entries from rbtrees */
1093         while (i)
1094                 remove_rb_node(t, i--, row);
1095         free(row);
1096         return ret;
1097 }
1098
1099 static void free_volatile_objects(const struct osl_table *t,
1100                 enum osl_close_flags flags)
1101 {
1102         int i, j;
1103         struct rb_node *n;
1104         struct osl_column *rb_col;
1105         const struct osl_column_description *cd;
1106
1107         if (!t->num_volatile_columns)
1108                 return;
1109         /* find the first rbtree column (any will do) */
1110         FOR_EACH_RBTREE_COLUMN(i, t, cd)
1111                 break;
1112         rb_col = t->columns + i;
1113         /* walk that rbtree and free all volatile objects */
1114         for (n = rb_first(&rb_col->rbtree); n; n = rb_next(n)) {
1115                 struct osl_row *r = get_row_pointer(n, rb_col->rbtree_num);
1116                 if (flags & OSL_FREE_VOLATILE)
1117                         for (j = 0; j < t->num_volatile_columns; j++)
1118                                 free(r->volatile_objects[j].data);
1119                 free(r->volatile_objects);
1120         }
1121 }
1122
1123 /**
1124  * Erase all rbtree nodes and free resources.
1125  *
1126  * \param t Pointer to an open osl table.
1127  *
1128  * This function is called by osl_close_table().
1129  */
1130 void clear_rbtrees(struct osl_table *t)
1131 {
1132         const struct osl_column_description *cd;
1133         unsigned i, rbtrees_cleared = 0;
1134
1135         FOR_EACH_RBTREE_COLUMN(i, t, cd) {
1136                 struct osl_column *col = &t->columns[i];
1137                 struct rb_node *n;
1138                 rbtrees_cleared++;
1139                 for (n = rb_first(&col->rbtree); n;) {
1140                         struct osl_row *r;
1141                         rb_erase(n, &col->rbtree);
1142                         if (rbtrees_cleared == t->num_rbtrees) {
1143                                 r = get_row_pointer(n, col->rbtree_num);
1144                                 n = rb_next(n);
1145                                 free(r);
1146                         } else
1147                                 n = rb_next(n);
1148                 }
1149         }
1150
1151 }
1152
1153 /**
1154  * Close an osl table.
1155  *
1156  * \param t Pointer to the table to be closed.
1157  * \param flags Options for what should be cleaned up.
1158  *
1159  * If osl_open_table() succeeds, the resulting table pointer must later be
1160  * passed to this function in order to flush all changes to the filesystem and
1161  * to free the resources that were allocated by osl_open_table().
1162  *
1163  * \return Positive on success, negative on errors. Possible errors: \p E_BAD_TABLE,
1164  * errors returned by unmap_table().
1165  *
1166  * \sa osl_open_table(), unmap_table().
1167  */
1168 int osl_close_table(struct osl_table *t, enum osl_close_flags flags)
1169 {
1170         int ret;
1171
1172         if (!t)
1173                 return -E_BAD_TABLE;
1174         free_volatile_objects(t, flags);
1175         clear_rbtrees(t);
1176         ret = unmap_table(t, flags);
1177         if (ret < 0)
1178                 PARA_ERROR_LOG("unmap_table failed: %d\n", ret);
1179         free(t->columns);
1180         free(t);
1181         return ret;
1182 }
1183
1184 /**
1185  * Find out whether the given row number corresponds to an invalid row.
1186  *
1187  * \param t Pointer to the osl table.
1188  * \param row_num The number of the row in question.
1189  *
1190  * By definition, a row is considered invalid if all its index entries
1191  * are invalid.
1192  *
1193  * \return Positive if \a row_num corresponds to an invalid row,
1194  * zero if it corresponds to a valid row, negative on errors.
1195  */
1196 int row_is_invalid(struct osl_table *t, uint32_t row_num)
1197 {
1198         char *index_entry;
1199         int i, ret = get_index_entry_start(t, row_num, &index_entry);
1200
1201         if (ret < 0)
1202                 return ret;
1203         for (i = 0; i < t->index_entry_size; i++) {
1204                 if ((unsigned char)index_entry[i] != 0xff)
1205                         return 0;
1206         }
1207         PARA_INFO_LOG("row %d is invalid\n", row_num);
1208         return 1;
1209 }
1210
1211 /**
1212  * Invalidate a row of an osl table.
1213  *
1214  * \param t Pointer to an open osl table.
1215  * \param row_num Number of the row to mark as invalid.
1216  *
1217  * This function marks each mapped object in the index entry of \a row as
1218  * invalid.
1219  *
1220  * \return Positive on success, negative on errors.
1221  */
1222 int mark_row_invalid(struct osl_table *t, uint32_t row_num)
1223 {
1224         char *index_entry;
1225         int i, ret = get_index_entry_start(t, row_num, &index_entry);
1226
1227         PARA_INFO_LOG("marking row %d as invalid\n", row_num);
1228         if (ret < 0)
1229                 return ret;
1230         for (i = 0; i < t->index_entry_size; i++)
1231                 index_entry[i] = 0xff;
1232         return 1;
1233 }
1234
1235 /**
1236  * Initialize all rbtrees and compute number of invalid rows.
1237  *
1238  * \param t The table containing the rbtrees to be initialized.
1239  *
1240  * \return Positive on success, negative on errors.
1241  */
1242 int init_rbtrees(struct osl_table *t)
1243 {
1244         int i, ret;
1245         const struct osl_column_description *cd;
1246
1247         /* create rbtrees */
1248         FOR_EACH_RBTREE_COLUMN(i, t, cd)
1249                 t->columns[i].rbtree = RB_ROOT;
1250         /* add valid rows to rbtrees */
1251         t->num_invalid_rows = 0;
1252         for (i = 0; i < t->num_rows; i++) {
1253                 ret = row_is_invalid(t, i);
1254                 if (ret < 0)
1255                         return ret;
1256                 if (ret) {
1257                         t->num_invalid_rows++;
1258                         continue;
1259                 }
1260                 ret = add_row_to_rbtrees(t, i, NULL, NULL);
1261                 if (ret < 0)
1262                         return ret;
1263         }
1264         return 1;
1265 }
1266
1267 /**
1268  * Open an osl table.
1269  *
1270  * Each osl table must be opened before its data can be accessed.
1271  *
1272  * \param table_desc Describes the table to be opened.
1273  * \param result Contains a pointer to the open table on success.
1274  *
1275  * The table description given by \a desc should coincide with the
1276  * description used at creation time.
1277  *
1278  * \return Positive on success, negative on errors. Possible errors include:
1279  * errors returned by init_table_structure(), \p E_NOENT, \p E_STAT, \p \p
1280  * E_NOTDIR, \p E_BAD_TABLE_DESC, \p E_BAD_DB_DIR, \p E_NO_COMPARE_FUNC, \p
1281  * E_NO_COLUMN_NAME, errors returned by init_rbtrees().
1282  */
1283 int osl_open_table(const struct osl_table_description *table_desc,
1284                 struct osl_table **result)
1285 {
1286         int i, ret;
1287         struct osl_table *t;
1288         const struct osl_column_description *cd;
1289
1290         PARA_INFO_LOG("opening table %s\n", table_desc->name);
1291         ret = init_table_structure(table_desc, &t);
1292         if (ret < 0)
1293                 return ret;
1294         FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd) {
1295                 /* check if directory exists */
1296                 char *dirname = column_filename(t, i);
1297                 struct stat statbuf;
1298                 ret = stat(dirname, &statbuf);
1299                 free(dirname);
1300                 if (ret < 0) {
1301                         if (errno == ENOENT)
1302                                 ret = -E_NOENT;
1303                         else
1304                                 ret = -E_STAT;
1305                         goto err;
1306                 }
1307                 ret = -E_NOTDIR;
1308                 if (!S_ISDIR(statbuf.st_mode))
1309                         goto err;
1310         }
1311         ret = map_table(t, MAP_TBL_FL_VERIFY_INDEX);
1312         if (ret < 0)
1313                 goto err;
1314         t->num_rows = ret;
1315         PARA_DEBUG_LOG("num rows: %d\n", t->num_rows);
1316         ret = init_rbtrees(t);
1317         if (ret < 0) {
1318                 osl_close_table(t, OSL_MARK_CLEAN); /* ignore further errors */
1319                 return ret;
1320         }
1321         *result = t;
1322         return 1;
1323 err:
1324         free(t->columns);
1325         free(t);
1326         return ret;
1327 }
1328
1329 static int create_disk_storage_object_dir(const struct osl_table *t,
1330                 unsigned col_num, const char *ds_name)
1331 {
1332         char *dirname;
1333         int ret;
1334
1335         if (!(t->desc->flags & OSL_LARGE_TABLE))
1336                 return 1;
1337         dirname = disk_storage_dirname(t, col_num, ds_name);
1338         ret = para_mkdir(dirname, 0777);
1339         free(dirname);
1340         if (ret < 0 && ret != -E_EXIST)
1341                 return ret;
1342         return 1;
1343 }
1344
1345 static int write_disk_storage_file(const struct osl_table *t, unsigned col_num,
1346         const struct osl_object *obj, const char *ds_name)
1347 {
1348         int ret;
1349         char *filename;
1350
1351         ret = create_disk_storage_object_dir(t, col_num, ds_name);
1352         if (ret < 0)
1353                 return ret;
1354         filename = disk_storage_path(t, col_num, ds_name);
1355         ret = para_write_file(filename, obj->data, obj->size);
1356         free(filename);
1357         return ret;
1358 }
1359
1360 static int append_map_file(const struct osl_table *t, unsigned col_num,
1361         const struct osl_object *obj, uint32_t *new_size)
1362 {
1363         char *filename = column_filename(t, col_num);
1364         int ret;
1365         char header = 0; /* zero means valid object */
1366
1367 //      PARA_DEBUG_LOG("appending %zu + 1 byte\n", obj->size);
1368         ret = append_file(filename, &header, 1, obj->data, obj->size,
1369                 new_size);
1370         free(filename);
1371         return ret;
1372 }
1373
1374 static int append_index_entry(const struct osl_table *t, char *new_index_entry)
1375 {
1376         char *filename;
1377         int ret;
1378
1379         if (!t->num_mapped_columns)
1380                 return 1;
1381         filename = index_filename(t->desc);
1382 //      PARA_DEBUG_LOG("appending %u bytes\n", t->index_entry_size);
1383         ret = append_file(filename, NULL, 0, new_index_entry,
1384                 t->index_entry_size, NULL);
1385         free(filename);
1386         return ret;
1387 }
1388
1389 /**
1390  * A wrapper for truncate(2)
1391  *
1392  * \param path Name of the regular file to truncate
1393  * \param size Number of bytes to \b shave \b off
1394  *
1395  * Truncate the regular file named by \a path by \a size bytes.
1396  *
1397  * \return Positive on success, negative on errors. Possible errors include: \p
1398  * E_STAT, \p E_BAD_SIZE, \p E_TRUNC.
1399  *
1400  * \sa truncate(2)
1401  */
1402 int para_truncate(const char *path, off_t size)
1403 {
1404         int ret;
1405         struct stat statbuf;
1406
1407         ret = -E_STAT;
1408         if (stat(path, &statbuf) < 0)
1409                 goto out;
1410         ret = -E_BAD_SIZE;
1411         if (statbuf.st_size < size)
1412                 goto out;
1413         ret = -E_TRUNC;
1414         if (truncate(path, statbuf.st_size - size) < 0)
1415                 goto out;
1416         ret = 1;
1417 out:
1418         return ret;
1419 }
1420
1421 static int truncate_mapped_file(const struct osl_table *t, unsigned col_num,
1422                 off_t size)
1423 {
1424         char *filename = column_filename(t, col_num);
1425         int ret = para_truncate(filename, size);
1426         free(filename);
1427         return ret;
1428 }
1429
1430 static int delete_disk_storage_file(const struct osl_table *t, unsigned col_num,
1431                 const char *ds_name)
1432 {
1433         char *dirname, *filename = disk_storage_path(t, col_num, ds_name);
1434         int ret = unlink(filename);
1435
1436         PARA_DEBUG_LOG("deleted %s\n", filename);
1437         free(filename);
1438         if (ret < 0) {
1439                 if (errno == ENOENT)
1440                         return -E_NOENT;
1441                 return -E_UNLINK;
1442         }
1443         if (!(t->desc->flags & OSL_LARGE_TABLE))
1444                 return 1;
1445         dirname = disk_storage_dirname(t, col_num, ds_name);
1446         rmdir(dirname);
1447         free(dirname);
1448         return 1;
1449 }
1450
1451 /**
1452  * Add a new row to an osl table and retrieve this row.
1453  *
1454  * \param t Pointer to an open osl table.
1455  * \param objects Array of objects to be added.
1456  * \param row Result pointer.
1457  *
1458  * The \a objects parameter must point to an array containing one object per
1459  * column.  The order of the objects in the array is given by the table
1460  * description of \a table. Several sanity checks are performed during object
1461  * insertion and the function returns without modifying the table if any of
1462  * these tests fail.  In fact, it is atomic in the sense that it either
1463  * succeeds or leaves the table unchanged (i.e. either all or none of the
1464  * objects are added to the table).
1465  *
1466  * It is considered an error if an object is added to a column with associated
1467  * rbtree if this object is equal to an object already contained in that column
1468  * (i.e. the compare function for the column's rbtree returns zero).
1469  *
1470  * Possible errors include: \p E_RB_KEY_EXISTS, \p E_BAD_DATA_SIZE.
1471  *
1472  * \return Positive on success, negative on errors.
1473  *
1474  * \sa struct osl_table_description, osl_compare_func, osl_add_row().
1475  */
1476 int osl_add_and_get_row(struct osl_table *t, struct osl_object *objects,
1477                 struct osl_row **row)
1478 {
1479         int i, ret;
1480         char *ds_name = NULL;
1481         struct rb_node **rb_parents = NULL, ***rb_links = NULL;
1482         char *new_index_entry = NULL;
1483         struct osl_object *volatile_objs = NULL;
1484         const struct osl_column_description *cd;
1485
1486         if (!t)
1487                 return -E_BAD_TABLE;
1488         rb_parents = para_malloc(t->num_rbtrees * sizeof(struct rn_node*));
1489         rb_links = para_malloc(t->num_rbtrees * sizeof(struct rn_node**));
1490         if (t->num_mapped_columns)
1491                 new_index_entry = para_malloc(t->index_entry_size);
1492         /* pass 1: sanity checks */
1493 //      PARA_DEBUG_LOG("sanity tests: %p:%p\n", objects[0].data,
1494 //              objects[1].data);
1495         FOR_EACH_COLUMN(i, t->desc, cd) {
1496                 enum osl_storage_type st = cd->storage_type;
1497                 enum osl_storage_flags sf = cd->storage_flags;
1498
1499 //              ret = -E_NULL_OBJECT;
1500 //              if (!objects[i])
1501 //                      goto out;
1502                 if (st == OSL_DISK_STORAGE)
1503                         continue;
1504                 if (sf & OSL_RBTREE) {
1505                         unsigned rbtree_num = t->columns[i].rbtree_num;
1506                         ret = -E_RB_KEY_EXISTS;
1507 //                      PARA_DEBUG_LOG("checking whether %p exists\n",
1508 //                              objects[i].data);
1509                         if (search_rbtree(objects + i, t, i,
1510                                         &rb_parents[rbtree_num],
1511                                         &rb_links[rbtree_num]) > 0)
1512                                 goto out;
1513                 }
1514                 if (sf & OSL_FIXED_SIZE) {
1515 //                      PARA_DEBUG_LOG("fixed size. need: %zu, have: %d\n",
1516 //                              objects[i].size, cd->data_size);
1517                         ret = -E_BAD_DATA_SIZE;
1518                         if (objects[i].size != cd->data_size)
1519                                 goto out;
1520                 }
1521         }
1522         if (t->num_disk_storage_columns)
1523                 ds_name = disk_storage_name_of_object(t,
1524                         &objects[t->disk_storage_name_column]);
1525         ret = unmap_table(t, OSL_MARK_CLEAN);
1526         if (ret < 0)
1527                 goto out;
1528 //      PARA_DEBUG_LOG("sanity tests passed%s\n", "");
1529         /* pass 2: create data files, append map data */
1530         FOR_EACH_COLUMN(i, t->desc, cd) {
1531                 enum osl_storage_type st = cd->storage_type;
1532                 if (st == OSL_NO_STORAGE)
1533                         continue;
1534                 if (st == OSL_MAPPED_STORAGE) {
1535                         uint32_t new_size;
1536                         struct osl_column *col = &t->columns[i];
1537 //                      PARA_DEBUG_LOG("appending object of size %zu\n",
1538 //                              objects[i].size);
1539                         ret = append_map_file(t, i, objects + i, &new_size);
1540                         if (ret < 0)
1541                                 goto rollback;
1542                         update_index_entry(new_index_entry, col, new_size,
1543                                 objects[i].size);
1544                         continue;
1545                 }
1546                 /* DISK_STORAGE */
1547                 ret = write_disk_storage_file(t, i, objects + i, ds_name);
1548                 if (ret < 0)
1549                         goto rollback;
1550         }
1551         ret = append_index_entry(t, new_index_entry);
1552         if (ret < 0)
1553                 goto rollback;
1554         ret = map_table(t, MAP_TBL_FL_VERIFY_INDEX);
1555         if (ret < 0) { /* truncate index and rollback changes */
1556                 char *filename = index_filename(t->desc);
1557                 para_truncate(filename, t->index_entry_size);
1558                 free(filename);
1559                 goto rollback;
1560         }
1561         /* pass 3: add entry to rbtrees */
1562         if (t->num_volatile_columns) {
1563                 volatile_objs = para_calloc(t->num_volatile_columns
1564                         * sizeof(struct osl_object));
1565                 FOR_EACH_VOLATILE_COLUMN(i, t, cd)
1566                         volatile_objs[t->columns[i].volatile_num] = objects[i];
1567         }
1568         t->num_rows++;
1569 //      PARA_DEBUG_LOG("adding new entry as row #%d\n", t->num_rows - 1);
1570         ret = add_row_to_rbtrees(t, t->num_rows - 1, volatile_objs, row);
1571         if (ret < 0)
1572                 goto out;
1573 //      PARA_DEBUG_LOG("added new entry as row #%d\n", t->num_rows - 1);
1574         ret = 1;
1575         goto out;
1576 rollback: /* rollback all changes made, ignore further errors */
1577         for (i--; i >= 0; i--) {
1578                 cd = get_column_description(t->desc, i);
1579                 enum osl_storage_type st = cd->storage_type;
1580                 if (st == OSL_NO_STORAGE)
1581                         continue;
1582
1583                 if (st == OSL_MAPPED_STORAGE)
1584                         truncate_mapped_file(t, i, objects[i].size);
1585                 else /* disk storage */
1586                         delete_disk_storage_file(t, i, ds_name);
1587         }
1588         /* ignore error and return previous error value */
1589         map_table(t, MAP_TBL_FL_VERIFY_INDEX);
1590 out:
1591         free(new_index_entry);
1592         free(ds_name);
1593         free(rb_parents);
1594         free(rb_links);
1595         return ret;
1596 }
1597
1598 /**
1599  * Add a new row to an osl table.
1600  *
1601  * \param t Same meaning as osl_add_and_get_row().
1602  * \param objects Same meaning as osl_add_and_get_row().
1603  *
1604  * \return The return value of the underlying call to osl_add_and_get_row().
1605  *
1606  * This is equivalent to osl_add_and_get_row(t, objects, NULL).
1607  */
1608 int osl_add_row(struct osl_table *t, struct osl_object *objects)
1609 {
1610         return osl_add_and_get_row(t, objects, NULL);
1611 }
1612
1613 /**
1614  * Retrieve an object identified by row and column
1615  *
1616  * \param t Pointer to an open osl table.
1617  * \param r Pointer to the row.
1618  * \param col_num The column number.
1619  * \param object The result pointer.
1620  *
1621  * The column determined by \a col_num must be of type \p OSL_MAPPED_STORAGE
1622  * or \p OSL_NO_STORAGE, i.e. no disk storage objects may be retrieved by this
1623  * function.
1624  *
1625  * \return Positive if object was found, negative on errors. Possible errors
1626  * include: \p E_BAD_TABLE, \p E_BAD_STORAGE_TYPE.
1627  *
1628  * \sa osl_storage_type, osl_open_disk_object().
1629  */
1630 int osl_get_object(const struct osl_table *t, const struct osl_row *r,
1631         unsigned col_num, struct osl_object *object)
1632 {
1633         const struct osl_column_description *cd;
1634
1635         if (!t)
1636                 return -E_BAD_TABLE;
1637         cd = get_column_description(t->desc, col_num);
1638         /* col must not be disk storage */
1639         if (cd->storage_type == OSL_DISK_STORAGE)
1640                 return -E_BAD_STORAGE_TYPE;
1641         if (cd->storage_type == OSL_MAPPED_STORAGE)
1642                 return get_mapped_object(t, col_num, r->id, object);
1643         /* volatile */
1644         *object = r->volatile_objects[t->columns[col_num].volatile_num];
1645         return 1;
1646 }
1647
1648 static int mark_mapped_object_invalid(const struct osl_table *t, uint32_t id,
1649                 unsigned col_num)
1650 {
1651         struct osl_object obj;
1652         char *p;
1653         int ret = get_mapped_object(t, col_num, id, &obj);
1654
1655         if (ret < 0)
1656                 return ret;
1657         p = obj.data;
1658         p--;
1659         *p = 0xff;
1660         return 1;
1661 }
1662
1663 /**
1664  * Delete a row from an osl table.
1665  *
1666  * \param t Pointer to an open osl table.
1667  * \param row Pointer to the row to delete.
1668  *
1669  * This removes all disk storage objects, removes all rbtree nodes,  and frees
1670  * all volatile objects belonging to the given row. For mapped columns, the
1671  * data is merely marked invalid and may be pruned from time to time by
1672  * para_fsck.
1673  *
1674  * \return Positive on success, negative on errors. Possible errors include:
1675  * \p E_BAD_TABLE, errors returned by osl_get_object().
1676  */
1677 int osl_del_row(struct osl_table *t, struct osl_row *row)
1678 {
1679         struct osl_row *r = row;
1680         int i, ret;
1681         const struct osl_column_description *cd;
1682
1683         if (!t)
1684                 return -E_BAD_TABLE;
1685         PARA_INFO_LOG("deleting row %p\n", row);
1686
1687         if (t->num_disk_storage_columns) {
1688                 char *ds_name;
1689                 ret = disk_storage_name_of_row(t, r, &ds_name);
1690                 if (ret < 0)
1691                         goto out;
1692                 FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd)
1693                         delete_disk_storage_file(t, i, ds_name);
1694                 free(ds_name);
1695         }
1696         FOR_EACH_COLUMN(i, t->desc, cd) {
1697                 struct osl_column *col = t->columns + i;
1698                 enum osl_storage_type st = cd->storage_type;
1699                 remove_rb_node(t, i, r);
1700                 if (st == OSL_MAPPED_STORAGE) {
1701                         mark_mapped_object_invalid(t, r->id, i);
1702                         continue;
1703                 }
1704                 if (st == OSL_NO_STORAGE)
1705                         free(r->volatile_objects[col->volatile_num].data);
1706         }
1707         if (t->num_mapped_columns) {
1708                 ret = mark_row_invalid(t, r->id);
1709                 if (ret < 0)
1710                         goto out;
1711                 t->num_invalid_rows++;
1712         } else
1713                 t->num_rows--;
1714         ret = 1;
1715 out:
1716         free(r->volatile_objects);
1717         free(r);
1718         return ret;
1719 }
1720
1721 /* test if column has an rbtree */
1722 static int check_rbtree_col(const struct osl_table *t, unsigned col_num,
1723                 struct osl_column **col)
1724 {
1725         if (!t)
1726                 return -E_BAD_TABLE;
1727         if (!(get_column_description(t->desc, col_num)->storage_flags & OSL_RBTREE))
1728                 return -E_BAD_STORAGE_FLAGS;
1729         *col = t->columns + col_num;
1730         return 1;
1731 }
1732
1733 /**
1734  * Get the row that contains the given object.
1735  *
1736  * \param t Pointer to an open osl table.
1737  * \param col_num The number of the column to be searched.
1738  * \param obj The object to be looked up.
1739  * \param result Points to the row containing \a obj.
1740  *
1741  * Lookup \a obj in \a t and return the row containing \a obj. The column
1742  * specified by \a col_num must have an associated rbtree.
1743  *
1744  * \return Positive on success, negative on errors. If an error occured, \a
1745  * result is set to \p NULL. Possible errors include: \p E_BAD_TABLE, \p
1746  * E_BAD_STORAGE_FLAGS, errors returned by get_mapped_object(), \p
1747  * E_RB_KEY_NOT_FOUND.
1748  *
1749  * \sa osl_storage_flags
1750  */
1751 int osl_get_row(const struct osl_table *t, unsigned col_num,
1752                 const struct osl_object *obj, struct osl_row **result)
1753 {
1754         int ret;
1755         struct rb_node *node;
1756         struct osl_row *row;
1757         struct osl_column *col;
1758
1759         *result = NULL;
1760         ret = check_rbtree_col(t, col_num, &col);
1761         if (ret < 0)
1762                 return ret;
1763         ret = search_rbtree(obj, t, col_num, &node, NULL);
1764         if (ret < 0)
1765                 return ret;
1766         row = get_row_pointer(node, t->columns[col_num].rbtree_num);
1767         *result = row;
1768         return 1;
1769 }
1770
1771 static int rbtree_loop(struct osl_column *col,  void *private_data,
1772                 osl_rbtree_loop_func *func)
1773 {
1774         struct rb_node *n;
1775
1776         for (n = rb_first(&col->rbtree); n; n = rb_next(n)) {
1777                 struct osl_row *r = get_row_pointer(n, col->rbtree_num);
1778                 int ret = func(r, private_data);
1779                 if (ret < 0)
1780                         return ret;
1781         }
1782         return 1;
1783 }
1784
1785 static int rbtree_loop_reverse(struct osl_column *col,  void *private_data,
1786                 osl_rbtree_loop_func *func)
1787 {
1788         struct rb_node *n;
1789
1790         for (n = rb_last(&col->rbtree); n; n = rb_prev(n)) {
1791                 struct osl_row *r = get_row_pointer(n, col->rbtree_num);
1792                 int ret = func(r, private_data);
1793                 if (ret < 0)
1794                         return ret;
1795         }
1796         return 1;
1797 }
1798
1799 /**
1800  * Loop over all nodes in an rbtree.
1801  *
1802  * \param t Pointer to an open osl table.
1803  * \param col_num The column to use for iterating over the elements.
1804  * \param private_data Pointer that gets passed to \a func.
1805  * \param func The function to be called for each node in the rbtree.
1806  *
1807  * This function does an in-order walk of the rbtree associated with \a
1808  * col_num. It is an error if the \p OSL_RBTREE flag is not set for this
1809  * column. For each node in the rbtree, the given function \a func is called
1810  * with two \p void* pointers as arguments: The first argument points to the
1811  * row that contains the object corresponding to the rbtree node currently
1812  * traversed, and the \a private_data pointer is passed to \a func as the
1813  * second argument. The loop terminates either if \a func returns a negative
1814  * value, or if all nodes of the tree have been visited.
1815  *
1816  *
1817  * \return Positive on success, negative on errors. If the termination of the
1818  * loop was caused by \a func returning a negative value, this value is
1819  * returned.
1820  *
1821  * \sa osl_storage_flags, osl_rbtree_loop_reverse(), osl_compare_func.
1822  */
1823 int osl_rbtree_loop(const struct osl_table *t, unsigned col_num,
1824         void *private_data, osl_rbtree_loop_func *func)
1825 {
1826         struct osl_column *col;
1827
1828         int ret = check_rbtree_col(t, col_num, &col);
1829         if (ret < 0)
1830                 return ret;
1831         return rbtree_loop(col, private_data, func);
1832 }
1833
1834 /**
1835  * Loop over all nodes in an rbtree in reverse order.
1836  *
1837  * \param t Identical meaning as in \p osl_rbtree_loop().
1838  * \param col_num Identical meaning as in \p osl_rbtree_loop().
1839  * \param private_data Identical meaning as in \p osl_rbtree_loop().
1840  * \param func Identical meaning as in \p osl_rbtree_loop().
1841  *
1842  * This function is identical to \p osl_rbtree_loop(), the only difference
1843  * is that the tree is walked in reverse order.
1844  *
1845  * \return The same return value as \p osl_rbtree_loop().
1846  *
1847  * \sa osl_rbtree_loop().
1848  */
1849 int osl_rbtree_loop_reverse(const struct osl_table *t, unsigned col_num,
1850         void *private_data, osl_rbtree_loop_func *func)
1851 {
1852         struct osl_column *col;
1853
1854         int ret = check_rbtree_col(t, col_num, &col);
1855         if (ret < 0)
1856                 return ret;
1857         return rbtree_loop_reverse(col, private_data, func);
1858 }
1859
1860 /* TODO: Rollback changes on errors */
1861 static int rename_disk_storage_objects(struct osl_table *t,
1862                 struct osl_object *old_obj, struct osl_object *new_obj)
1863 {
1864         int i, ret;
1865         const struct osl_column_description *cd;
1866         char *old_ds_name, *new_ds_name;
1867
1868         if (!t->num_disk_storage_columns)
1869                 return 1; /* nothing to do */
1870         if (old_obj->size == new_obj->size && !memcmp(new_obj->data,
1871                         old_obj->data, new_obj->size))
1872                 return 1; /* object did not change */
1873         old_ds_name = disk_storage_name_of_object(t, old_obj);
1874         new_ds_name = disk_storage_name_of_object(t, new_obj);
1875         FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd) {
1876                 char *old_filename, *new_filename;
1877                 ret = create_disk_storage_object_dir(t, i, new_ds_name);
1878                 if (ret < 0)
1879                         goto out;
1880                 old_filename = disk_storage_path(t, i, old_ds_name);
1881                 new_filename = disk_storage_path(t, i, new_ds_name);
1882                 ret = para_rename(old_filename, new_filename);
1883                 free(old_filename);
1884                 free(new_filename);
1885                 if (ret < 0)
1886                         goto out;
1887         }
1888         ret = 1;
1889 out:
1890         free(old_ds_name);
1891         free(new_ds_name);
1892         return ret;
1893
1894 }
1895
1896 /**
1897  * Change an object in an osl table.
1898  *
1899  * \param t Pointer to an open osl table.
1900  * \param r Pointer to the row containing the object to be updated.
1901  * \param col_num Number of the column containing the object to be updated.
1902  * \param obj Pointer to the replacement object.
1903  *
1904  * This function  gets rid of all references to the old object. This includes
1905  * removal of the rbtree node in case there is an rbtree associated with \a
1906  * col_num. It then inserts \a obj into the table and the rbtree if neccessary.
1907  *
1908  * If the \p OSL_RBTREE flag is set for \a col_num, you \b MUST call this
1909  * function in order to change the contents of an object, even for volatile or
1910  * mapped columns of constant size (which may be updated directly if \p
1911  * OSL_RBTREE is not set).  Otherwise the rbtree might become corrupted.
1912  *
1913  * \return Positive on success, negative on errors. Possible errors include: \p
1914  * E_BAD_TABLE, \p E_RB_KEY_EXISTS, \p E_BAD_SIZE, \p E_NOENT, \p E_UNLINK,
1915  * errors returned by para_write_file(), \p E_MKDIR.
1916  */
1917 int osl_update_object(struct osl_table *t, const struct osl_row *r,
1918                 unsigned col_num, struct osl_object *obj)
1919 {
1920         struct osl_column *col;
1921         const struct osl_column_description *cd;
1922         int ret;
1923
1924         if (!t)
1925                 return -E_BAD_TABLE;
1926         col = &t->columns[col_num];
1927         cd = get_column_description(t->desc, col_num);
1928         PARA_DEBUG_LOG("updating column %u of %s\n", col_num, t->desc->name);
1929         if (cd->storage_flags & OSL_RBTREE) {
1930                 if (search_rbtree(obj, t, col_num, NULL, NULL) > 0)
1931                         return -E_RB_KEY_EXISTS;
1932         }
1933         if (cd->storage_flags & OSL_FIXED_SIZE) {
1934                 if (obj->size != cd->data_size)
1935                         return -E_BAD_SIZE;
1936         }
1937         remove_rb_node(t, col_num, r);
1938         if (cd->storage_type == OSL_NO_STORAGE) { /* TODO: If fixed size, reuse object? */
1939                 free(r->volatile_objects[col->volatile_num].data);
1940                 r->volatile_objects[col->volatile_num] = *obj;
1941         } else if (cd->storage_type == OSL_DISK_STORAGE) {
1942                 char *ds_name;
1943                 ret = disk_storage_name_of_row(t, r, &ds_name);
1944                 if (ret < 0)
1945                         return ret;
1946                 ret = delete_disk_storage_file(t, col_num, ds_name);
1947                 if (ret < 0 && ret != -E_NOENT) {
1948                         free(ds_name);
1949                         return ret;
1950                 }
1951                 ret = write_disk_storage_file(t, col_num, obj, ds_name);
1952                 free(ds_name);
1953                 if (ret < 0)
1954                         return ret;
1955         } else { /* mapped storage */
1956                 struct osl_object old_obj;
1957                 ret = get_mapped_object(t, col_num, r->id, &old_obj);
1958                 if (ret < 0)
1959                         return ret;
1960                 /*
1961                  * If the updated column is the disk storage name column, the
1962                  * disk storage name changes, so we have to rename all disk
1963                  * storage objects accordingly.
1964                  */
1965                 if (col_num == t->disk_storage_name_column) {
1966                         ret = rename_disk_storage_objects(t, &old_obj, obj);
1967                         if (ret < 0)
1968                                 return ret;
1969                 }
1970                 if (cd->storage_flags & OSL_FIXED_SIZE)
1971                         memcpy(old_obj.data, obj->data, cd->data_size);
1972                 else { /* TODO: if the size doesn't change, use old space */
1973                         uint32_t new_data_map_size;
1974                         char *index_entry;
1975                         ret = get_index_entry_start(t, r->id, &index_entry);
1976                         if (ret < 0)
1977                                 return ret;
1978                         ret = mark_mapped_object_invalid(t, r->id, col_num);
1979                         if (ret < 0)
1980                                 return ret;
1981                         unmap_column(t, col_num);
1982                         ret = append_map_file(t, col_num, obj,
1983                                 &new_data_map_size);
1984                         if (ret < 0)
1985                                 return ret;
1986                         ret = map_column(t, col_num);
1987                         if (ret < 0)
1988                                 return ret;
1989                         update_index_entry(index_entry, col, new_data_map_size,
1990                                 obj->size);
1991                 }
1992         }
1993         if (cd->storage_flags & OSL_RBTREE) {
1994                 ret = insert_rbtree(t, col_num, r, obj);
1995                 if (ret < 0)
1996                         return ret;
1997         }
1998         return 1;
1999 }
2000
2001 /**
2002  * Retrieve an object of type \p OSL_DISK_STORAGE by row and column.
2003  *
2004  * \param t Pointer to an open osl table.
2005  * \param r Pointer to the row containing the object.
2006  * \param col_num The column number.
2007  * \param obj Points to the result upon successful return.
2008  *
2009  * For columns of type \p OSL_DISK_STORAGE, this function must be used to
2010  * retrieve one of its containing objects. Afterwards, osl_close_disk_object()
2011  * must be called in order to deallocate the resources.
2012  *
2013  * \return Positive on success, negative on errors. Possible errors include:
2014  * \p E_BAD_TABLE, \p E_BAD_STORAGE_TYPE, errors returned by osl_get_object().
2015  *
2016  * \sa osl_get_object(), osl_storage_type, osl_close_disk_object().
2017  */
2018 int osl_open_disk_object(const struct osl_table *t, const struct osl_row *r,
2019                 unsigned col_num, struct osl_object *obj)
2020 {
2021         const struct osl_column_description *cd;
2022         char *ds_name, *filename;
2023         int ret;
2024
2025         if (!t)
2026                 return -E_BAD_TABLE;
2027         cd = get_column_description(t->desc, col_num);
2028         if (cd->storage_type != OSL_DISK_STORAGE)
2029                 return -E_BAD_STORAGE_TYPE;
2030
2031         ret = disk_storage_name_of_row(t, r, &ds_name);
2032         if (ret < 0)
2033                 return ret;
2034         filename = disk_storage_path(t, col_num, ds_name);
2035         free(ds_name);
2036         PARA_DEBUG_LOG("filename: %s\n", filename);
2037         ret = mmap_full_file(filename, O_RDONLY, obj);
2038         free(filename);
2039         return ret;
2040 }
2041
2042 /**
2043  * Free resources that were allocated during osl_open_disk_object().
2044  *
2045  * \param obj Pointer to the object previously returned by open_disk_object().
2046  *
2047  * \return The return value of the underlying call to para_munmap().
2048  *
2049  * \sa para_munmap().
2050  */
2051 int osl_close_disk_object(struct osl_object *obj)
2052 {
2053         return para_munmap(obj->data, obj->size);
2054 }
2055
2056 /**
2057  * Get the number of rows of the given table.
2058  *
2059  * \param t Pointer to an open osl table.
2060  * \param num_rows Result is returned here.
2061  *
2062  * The number of rows returned via \a num_rows excluding any invalid rows.
2063  *
2064  * \return Positive on success, \p -E_BAD_TABLE if \a t is \p NULL.
2065  */
2066 int osl_get_num_rows(const struct osl_table *t, unsigned *num_rows)
2067 {
2068         if (!t)
2069                 return -E_BAD_TABLE;
2070         assert(t->num_rows >= t->num_invalid_rows);
2071         *num_rows = t->num_rows - t->num_invalid_rows;
2072         return 1;
2073 }
2074
2075 /**
2076  * Get the rank of a row.
2077  *
2078  * \param t An open osl table.
2079  * \param r The row to get the rank of.
2080  * \param col_num The number of an rbtree column.
2081  * \param rank Result pointer.
2082  *
2083  * The rank is, by definition, the position of the row in the linear order
2084  * determined by an inorder tree walk of the rbtree associated with column
2085  * number \a col_num of \a table.
2086  *
2087  * \return Positive on success, negative on errors.
2088  *
2089  * \sa osl_get_nth_row().
2090  */
2091 int osl_get_rank(const struct osl_table *t, struct osl_row *r,
2092                 unsigned col_num, unsigned *rank)
2093 {
2094         struct osl_object obj;
2095         struct osl_column *col;
2096         struct rb_node *node;
2097         int ret = check_rbtree_col(t, col_num, &col);
2098
2099         if (ret < 0)
2100                 return ret;
2101         ret = osl_get_object(t, r, col_num, &obj);
2102         if (ret < 0)
2103                 return ret;
2104         ret = search_rbtree(&obj, t, col_num, &node, NULL);
2105         if (ret < 0)
2106                 return ret;
2107         ret = rb_rank(node, rank);
2108         if (ret < 0)
2109                 return -E_BAD_ROW;
2110         return 1;
2111 }
2112
2113 /**
2114  * Get the row with n-th greatest value.
2115  *
2116  * \param t Pointer to an open osl table.
2117  * \param col_num The column number.
2118  * \param n The rank of the desired row.
2119  * \param result Row is returned here.
2120  *
2121  * Retrieve the n-th order statistic with respect to the compare function
2122  * of the rbtree column \a col_num. In other words, get that row with
2123  * \a n th greatest value in column \a col_num. It's an error if
2124  * \a col_num is not a rbtree column, or if \a n is larger than the
2125  * number of rows in the table.
2126  *
2127  * \return Positive on success, negative on errors. Possible errors:
2128  * \p E_BAD_TABLE, \p E_BAD_STORAGE_FLAGS, \p E_RB_KEY_NOT_FOUND.
2129  *
2130  * \sa osl_storage_flags, osl_compare_func, osl_get_row(),
2131  * osl_rbtree_last_row(), osl_rbtree_first_row(), osl_get_rank().
2132  */
2133 int osl_get_nth_row(const struct osl_table *t, unsigned col_num,
2134                 unsigned n, struct osl_row **result)
2135 {
2136         struct osl_column *col;
2137         struct rb_node *node;
2138         int ret = check_rbtree_col(t, col_num, &col);
2139
2140         if (ret < 0)
2141                 return ret;
2142         node = rb_nth(col->rbtree.rb_node, n);
2143         if (!node)
2144                 return -E_RB_KEY_NOT_FOUND;
2145         *result = get_row_pointer(node, col->rbtree_num);
2146         return 1;
2147 }
2148
2149 /**
2150  * Get the row corresponding to the smallest rbtree node of a column.
2151  *
2152  * \param t An open rbtree table.
2153  * \param col_num The number of the rbtree column.
2154  * \param result A pointer to the first row is returned here.
2155  *
2156  * The rbtree node of the smallest object (with respect to the corresponding
2157  * compare function) is selected and the row containing this object is
2158  * returned. It is an error if \a col_num refers to a column without an
2159  * associated rbtree.
2160  *
2161  * \return Positive on success, negative on errors.
2162  *
2163  * \sa osl_get_nth_row(), osl_rbtree_last_row().
2164  */
2165 int osl_rbtree_first_row(const struct osl_table *t, unsigned col_num,
2166                 struct osl_row **result)
2167 {
2168         return osl_get_nth_row(t, col_num, 1, result);
2169 }
2170
2171 /**
2172  * Get the row corresponding to the greatest rbtree node of a column.
2173  *
2174  * \param t The same meaning as in \p osl_rbtree_first_row().
2175  * \param col_num The same meaning as in \p osl_rbtree_first_row().
2176  * \param result The same meaning as in \p osl_rbtree_first_row().
2177  *
2178  * This function works just like osl_rbtree_first_row(), the only difference
2179  * is that the row containing the greatest rather than the smallest object is
2180  * returned.
2181  *
2182  * \return Positive on success, negative on errors.
2183  *
2184  * \sa osl_get_nth_row(), osl_rbtree_first_row().
2185  */
2186 int osl_rbtree_last_row(const struct osl_table *t, unsigned col_num,
2187                 struct osl_row **result)
2188 {
2189         unsigned num_rows;
2190         int ret = osl_get_num_rows(t, &num_rows);
2191
2192         if (ret < 0)
2193                 return ret;
2194         return osl_get_nth_row(t, col_num, num_rows, result);
2195 }