isamc/merge.c

   1 /*
   2  * Copyright (c) 1996-1998, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: merge.c,v $
   7  * Revision 1.9  1998-03-19 10:04:38  adam
   8  * Minor changes.
   9  *
  10  * Revision 1.8  1998/03/18 09:23:55  adam
  11  * Blocks are stored in chunks on free list - up to factor 2 in speed.
  12  * Fixed bug that could occur in block category rearrangemen.
  13  *
  14  * Revision 1.7  1998/03/11 11:18:18  adam
  15  * Changed the isc_merge to take into account the mfill (minimum-fill).
  16  *
  17  * Revision 1.6  1998/03/06 13:54:03  adam
  18  * Fixed two nasty bugs in isc_merge.
  19  *
  20  * Revision 1.5  1997/02/12 20:42:43  adam
  21  * Bug fix: during isc_merge operations, some pages weren't marked dirty
  22  * even though they should be. At this point the merge operation marks
  23  * a page dirty if the previous page changed at all. A better approach is
  24  * to mark it dirty if the last key written changed in previous page.
  25  *
  26  * Revision 1.4  1996/11/08 11:15:31  adam
  27  * Number of keys in chain are stored in first block and the function
  28  * to retrieve this information, isc_pp_num is implemented.
  29  *
  30  * Revision 1.3  1996/11/04 14:08:59  adam
  31  * Optimized free block usage.
  32  *
  33  * Revision 1.2  1996/11/01 13:36:46  adam
  34  * New element, max_blocks_mem, that control how many blocks of max size
  35  * to store in memory during isc_merge.
  36  * Function isc_merge now ignores delete/update of identical keys and
  37  * the proper blocks are then non-dirty and not written in flush_blocks.
  38  *
  39  * Revision 1.1  1996/11/01  08:59:15  adam
  40  * First version of isc_merge that supports update/delete.
  41  *
  42  */
  43
  44 #include <stdlib.h>
  45 #include <assert.h>
  46 #include <string.h>
  47 #include <stdio.h>
  48
  49 #include <log.h>
  50 #include "isamc-p.h"
  51
  52 struct isc_merge_block {
  53     int offset;       /* offset in r_buf */
  54     int block;        /* block number of file (0 if none) */
  55     int dirty;        /* block is different from that on file */
  56 };
  57
  58 static void opt_blocks (ISAMC is, struct isc_merge_block *mb, int ptr, int last)
  59 {
  60     int i, no_dirty = 0;
  61     for (i = 0; i<ptr; i++)
  62         if (mb[i].dirty)
  63             no_dirty++;
  64     if (no_dirty*4 < ptr*3)
  65         return;
  66     /* bubble-sort it */
  67     for (i = 0; i<ptr; i++)
  68     {
  69         int tmp, j, j_min = -1;
  70         for (j = i; j<ptr; j++)
  71         {
  72             if (j_min < 0 || mb[j_min].block > mb[j].block)
  73                 j_min = j;
  74         }
  75         assert (j_min >= 0);
  76         tmp = mb[j_min].block;
  77         mb[j_min].block = mb[i].block;
  78         mb[i].block = tmp;
  79         mb[i].dirty = 1;
  80     }
  81     if (!last)
  82         mb[i].dirty = 1;
  83 }
  84
  85 static void flush_blocks (ISAMC is, struct isc_merge_block *mb, int ptr,
  86                           char *r_buf, int *firstpos, int cat, int last,
  87                           int *numkeys)
  88 {
  89     int i;
  90
  91     for (i = 0; i<ptr; i++)
  92     {
  93         /* consider this block number */
  94         if (!mb[i].block)
  95         {
  96             mb[i].block = isc_alloc_block (is, cat);
  97             mb[i].dirty = 1;
  98         }
  99
 100         /* consider next block pointer */
 101         if (last && i == ptr-1)
 102             mb[i+1].block = 0;
 103         else if (!mb[i+1].block)
 104         {
 105             mb[i+1].block = isc_alloc_block (is, cat);
 106             mb[i+1].dirty = 1;
 107             mb[i].dirty = 1;
 108         }
 109     }
 110     opt_blocks (is, mb, ptr, last);
 111     for (i = 0; i<ptr; i++)
 112     {
 113         char *src;
 114         ISAMC_BLOCK_SIZE ssize = mb[i+1].offset - mb[i].offset;
 115
 116         assert (ssize);
 117
 118         /* skip rest if not dirty */
 119         if (!mb[i].dirty)
 120         {
 121             assert (mb[i].block);
 122             if (!*firstpos)
 123                 *firstpos = mb[i].block;
 124             if (is->method->debug > 2)
 125                 logf (LOG_LOG, "isc: skip ptr=%d size=%d %d %d",
 126                      i, ssize, cat, mb[i].block);
 127             ++(is->files[cat].no_skip_writes);
 128             continue;
 129         }
 130         /* write block */
 131
 132         if (!*firstpos)
 133         {
 134             *firstpos = mb[i].block;
 135             src = r_buf + mb[i].offset - ISAMC_BLOCK_OFFSET_1;
 136             ssize += ISAMC_BLOCK_OFFSET_1;
 137
 138             memcpy (src+sizeof(int)+sizeof(ssize), numkeys,
 139                     sizeof(*numkeys));
 140             if (is->method->debug > 2)
 141                 logf (LOG_LOG, "isc: flush ptr=%d numk=%d size=%d nextpos=%d",
 142                      i, *numkeys, (int) ssize, mb[i+1].block);
 143         }
 144         else
 145         {
 146             src = r_buf + mb[i].offset - ISAMC_BLOCK_OFFSET_N;
 147             ssize += ISAMC_BLOCK_OFFSET_N;
 148             if (is->method->debug > 2)
 149                 logf (LOG_LOG, "isc: flush ptr=%d size=%d nextpos=%d",
 150                      i, (int) ssize, mb[i+1].block);
 151         }
 152         memcpy (src, &mb[i+1].block, sizeof(int));
 153         memcpy (src+sizeof(int), &ssize, sizeof(ssize));
 154         isc_write_block (is, cat, mb[i].block, src);
 155     }
 156 }
 157
 158 static int get_border (ISAMC is, struct isc_merge_block *mb, int ptr,
 159                        int cat, int firstpos)
 160 {
 161    /* Border set to initial fill or block size depending on
 162       whether we are creating a new one or updating and old one.
 163     */
 164
 165     int fill = mb[ptr].block ? is->method->filecat[cat].bsize :
 166                                is->method->filecat[cat].ifill;
 167     int off = (ptr||firstpos) ? ISAMC_BLOCK_OFFSET_N : ISAMC_BLOCK_OFFSET_1;
 168
 169     assert (ptr < 199);
 170
 171     return mb[ptr].offset + fill - off;
 172 }
 173
 174 ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
 175 {
 176
 177     char i_item[128], *i_item_ptr;
 178     int i_more, i_mode, i;
 179
 180     ISAMC_PP pp;
 181     char f_item[128], *f_item_ptr;
 182     int f_more;
 183     int last_dirty = 0;
 184     int debug = is->method->debug;
 185
 186     struct isc_merge_block mb[200];
 187
 188     int firstpos = 0;
 189     int cat = 0;
 190     char r_item_buf[128]; /* temporary result output */
 191     char *r_buf;          /* block with resulting data */
 192     int r_offset = 0;     /* current offset in r_buf */
 193     int ptr = 0;          /* pointer */
 194     void *r_clientData;   /* encode client data */
 195     int border;
 196     int numKeys = 0;
 197
 198     r_clientData = (*is->method->code_start)(ISAMC_ENCODE);
 199     r_buf = is->merge_buf + 128;
 200
 201     pp = isc_pp_open (is, ipos);
 202     /* read first item from file. make sure f_more indicates no boundary */
 203     f_item_ptr = f_item;
 204     f_more = isc_read_item (pp, &f_item_ptr);
 205     if (f_more > 0)
 206         f_more = 1;
 207     cat = pp->cat;
 208
 209     if (debug > 1)
 210         logf (LOG_LOG, "isc: isc_merge begin %d %d", cat, pp->pos);
 211
 212     /* read first item from i */
 213     i_item_ptr = i_item;
 214     i_more = (*data->read_item)(data->clientData, &i_item_ptr, &i_mode);
 215
 216     mb[ptr].block = pp->pos;     /* is zero if no block on disk */
 217     mb[ptr].dirty = 0;
 218     mb[ptr].offset = 0;
 219
 220     border = get_border (is, mb, ptr, cat, firstpos);
 221     while (i_more || f_more)
 222     {
 223         char *r_item = r_item_buf;
 224         int cmp;
 225
 226         if (f_more > 1)
 227         {
 228             /* block to block boundary in the original file. */
 229             f_more = 1;
 230             if (cat == pp->cat)
 231             {
 232                 /* the resulting output is of the same category as the
 233                    the original
 234                 */
 235                 if (r_offset <= mb[ptr].offset +is->method->filecat[cat].mfill)
 236                 {
 237                     /* the resulting output block is too small/empty. Delete
 238                        the original (if any)
 239                     */
 240                     if (debug > 3)
 241                         logf (LOG_LOG, "isc: release A");
 242                     if (mb[ptr].block)
 243                         isc_release_block (is, pp->cat, mb[ptr].block);
 244                     mb[ptr].block = pp->pos;
 245                     if (!mb[ptr].dirty)
 246                         mb[ptr].dirty = 1;
 247                     if (ptr > 0)
 248                         mb[ptr-1].dirty = 1;
 249                 }
 250                 else
 251                 {
 252                     /* indicate new boundary based on the original file */
 253                     mb[++ptr].block = pp->pos;
 254                     mb[ptr].dirty = last_dirty;
 255                     mb[ptr].offset = r_offset;
 256                     if (debug > 3)
 257                         logf (LOG_LOG, "isc: bound ptr=%d,offset=%d",
 258                             ptr, r_offset);
 259                     if (cat==is->max_cat && ptr >= is->method->max_blocks_mem)
 260                     {
 261                         /* We are dealing with block(s) of max size. Block(s)
 262                            except 1 will be flushed.
 263                          */
 264                         if (debug > 2)
 265                             logf (LOG_LOG, "isc: flush A %d sections", ptr);
 266                         flush_blocks (is, mb, ptr-1, r_buf, &firstpos, cat,
 267                                       0, &pp->numKeys);
 268                         mb[0].block = mb[ptr-1].block;
 269                         mb[0].dirty = mb[ptr-1].dirty;
 270                         memcpy (r_buf, r_buf + mb[ptr-1].offset,
 271                                 mb[ptr].offset - mb[ptr-1].offset);
 272                         mb[0].offset = 0;
 273
 274                         mb[1].block = mb[ptr].block;
 275                         mb[1].dirty = mb[ptr].dirty;
 276                         mb[1].offset = mb[ptr].offset - mb[ptr-1].offset;
 277                         ptr = 1;
 278                         r_offset = mb[ptr].offset;
 279                     }
 280                 }
 281             }
 282             border = get_border (is, mb, ptr, cat, firstpos);
 283         }
 284         last_dirty = 0;
 285         if (!f_more)
 286             cmp = -1;
 287         else if (!i_more)
 288             cmp = 1;
 289         else
 290             cmp = (*is->method->compare_item)(i_item, f_item);
 291         if (cmp == 0)                   /* insert i=f */
 292         {
 293             if (!i_mode)   /* delete item? */
 294             {
 295                 /* move i */
 296                 i_item_ptr = i_item;
 297                 i_more = (*data->read_item)(data->clientData, &i_item_ptr,
 298                                            &i_mode);
 299                 /* is next input item the same as current except
 300                    for the delete flag? */
 301                 cmp = (*is->method->compare_item)(i_item, f_item);
 302                 if (!cmp && i_mode)   /* delete/insert nop? */
 303                 {
 304                     /* yes! insert as if it was an insert only */
 305                     memcpy (r_item, i_item, i_item_ptr - i_item);
 306                     i_item_ptr = i_item;
 307                     i_more = (*data->read_item)(data->clientData, &i_item_ptr,
 308                                                 &i_mode);
 309                 }
 310                 else
 311                 {
 312                     /* no! delete the item */
 313                     r_item = NULL;
 314                     last_dirty = 1;
 315                     mb[ptr].dirty = 2;
 316                 }
 317             }
 318             else
 319             {
 320                 memcpy (r_item, f_item, f_item_ptr - f_item);
 321
 322                 /* move i */
 323                 i_item_ptr = i_item;
 324                 i_more = (*data->read_item)(data->clientData, &i_item_ptr,
 325                                            &i_mode);
 326             }
 327             /* move f */
 328             f_item_ptr = f_item;
 329             f_more = isc_read_item (pp, &f_item_ptr);
 330         }
 331         else if (cmp > 0)               /* insert f */
 332         {
 333             memcpy (r_item, f_item, f_item_ptr - f_item);
 334             /* move f */
 335             f_item_ptr = f_item;
 336             f_more = isc_read_item (pp, &f_item_ptr);
 337         }
 338         else                            /* insert i */
 339         {
 340             if (!i_mode)                /* delete item which isn't there? */
 341             {
 342                 logf (LOG_FATAL, "Inconsistent register at offset %d",
 343                                  r_offset);
 344                 abort ();
 345             }
 346             memcpy (r_item, i_item, i_item_ptr - i_item);
 347             mb[ptr].dirty = 2;
 348             last_dirty = 1;
 349             /* move i */
 350             i_item_ptr = i_item;
 351             i_more = (*data->read_item)(data->clientData, &i_item_ptr,
 352                                         &i_mode);
 353         }
 354         if (r_item)  /* insert resulting item? */
 355         {
 356             char *r_out_ptr = r_buf + r_offset;
 357             int new_offset;
 358
 359             (*is->method->code_item)(ISAMC_ENCODE, r_clientData,
 360                                      &r_out_ptr, &r_item);
 361             new_offset = r_out_ptr - r_buf;
 362
 363             numKeys++;
 364
 365             if (border < new_offset && border >= r_offset)
 366             {
 367                 if (debug > 2)
 368                     logf (LOG_LOG, "isc: border %d %d", ptr, border);
 369                 /* Max size of current block category reached ...
 370                    make new virtual block entry */
 371                 mb[++ptr].block = 0;
 372                 mb[ptr].dirty = 1;
 373                 mb[ptr].offset = r_offset;
 374                 if (cat == is->max_cat && ptr >= is->method->max_blocks_mem)
 375                 {
 376                     /* We are dealing with block(s) of max size. Block(s)
 377                        except one will be flushed. Note: the block(s) are
 378                        surely not the last one(s).
 379                      */
 380                     if (debug > 2)
 381                         logf (LOG_LOG, "isc: flush B %d sections", ptr-1);
 382                     flush_blocks (is, mb, ptr-1, r_buf, &firstpos, cat,
 383                                   0, &pp->numKeys);
 384                     mb[0].block = mb[ptr-1].block;
 385                     mb[0].dirty = mb[ptr-1].dirty;
 386                     memcpy (r_buf, r_buf + mb[ptr-1].offset,
 387                             mb[ptr].offset - mb[ptr-1].offset);
 388                     mb[0].offset = 0;
 389
 390                     mb[1].block = mb[ptr].block;
 391                     mb[1].dirty = mb[0].dirty;
 392                     mb[1].offset = mb[ptr].offset - mb[ptr-1].offset;
 393                     memcpy (r_buf + mb[1].offset, r_buf + r_offset,
 394                             new_offset - r_offset);
 395                     new_offset = (new_offset - r_offset) + mb[1].offset;
 396                     ptr = 1;
 397                 }
 398                 border = get_border (is, mb, ptr, cat, firstpos);
 399             }
 400             r_offset = new_offset;
 401         }
 402         if (cat < is->max_cat && ptr >= is->method->filecat[cat].mblocks)
 403         {
 404             /* Max number blocks in current category reached ->
 405                must switch to next category (with larger block size)
 406             */
 407             int j = 0;
 408
 409             (is->files[cat].no_remap)++;
 410             /* delete all original block(s) read so far */
 411             for (i = 0; i < ptr; i++)
 412                 if (mb[i].block)
 413                     isc_release_block (is, pp->cat, mb[i].block);
 414             /* also delete all block to be read in the future */
 415             pp->deleteFlag = 1;
 416
 417             /* remap block offsets */
 418             assert (mb[j].offset == 0);
 419             cat++;
 420             mb[j].dirty = 1;
 421             mb[j].block = 0;
 422             mb[ptr].offset = r_offset;
 423             for (i = 1; i < ptr; i++)
 424             {
 425                 int border = is->method->filecat[cat].ifill -
 426                          ISAMC_BLOCK_OFFSET_1 + mb[j].offset;
 427                 if (debug > 3)
 428                     logf (LOG_LOG, "isc: remap %d border=%d", i, border);
 429                 if (mb[i+1].offset > border && mb[i].offset <= border)
 430                 {
 431                     if (debug > 3)
 432                         logf (LOG_LOG, "isc:  to %d %d", j, mb[i].offset);
 433                     mb[++j].dirty = 1;
 434                     mb[j].block = 0;
 435                     mb[j].offset = mb[i].offset;
 436                 }
 437             }
 438             if (debug > 2)
 439                 logf (LOG_LOG, "isc: remap from %d to %d sections to cat %d",
 440                       ptr, j, cat);
 441             ptr = j;
 442             border = get_border (is, mb, ptr, cat, firstpos);
 443             if (debug > 3)
 444                 logf (LOG_LOG, "isc: border=%d r_offset=%d", border, r_offset);
 445         }
 446     }
 447     if (mb[ptr].offset < r_offset)
 448     {   /* make the final boundary offset */
 449         mb[++ptr].dirty = 1;
 450         mb[ptr].block = 0;
 451         mb[ptr].offset = r_offset;
 452     }
 453     else
 454     {   /* empty output. Release last block if any */
 455         if (cat == pp->cat && mb[ptr].block)
 456         {
 457             if (debug > 3)
 458                 logf (LOG_LOG, "isc: release C");
 459             isc_release_block (is, pp->cat, mb[ptr].block);
 460             mb[ptr].block = 0;
 461             if (ptr > 0)
 462                 mb[ptr-1].dirty = 1;
 463         }
 464     }
 465
 466     if (debug > 2)
 467         logf (LOG_LOG, "isc: flush C, %d sections", ptr);
 468
 469     if (firstpos)
 470     {
 471         /* we have to patch initial block with num keys if that
 472            has changed */
 473         if (numKeys != isc_pp_num (pp))
 474         {
 475             if (debug > 2)
 476                 logf (LOG_LOG, "isc: patch num keys firstpos=%d num=%d",
 477                                 firstpos, numKeys);
 478             bf_write (is->files[cat].bf, firstpos, ISAMC_BLOCK_OFFSET_N,
 479                       sizeof(numKeys), &numKeys);
 480         }
 481     }
 482     else if (ptr > 0)
 483     {   /* we haven't flushed initial block yet and there surely are some
 484            blocks to flush. Make first block dirty if numKeys differ */
 485         if (numKeys != isc_pp_num (pp))
 486             mb[0].dirty = 1;
 487     }
 488     /* flush rest of block(s) in r_buf */
 489     flush_blocks (is, mb, ptr, r_buf, &firstpos, cat, 1, &numKeys);
 490
 491     (*is->method->code_stop)(ISAMC_ENCODE, r_clientData);
 492     if (!firstpos)
 493         cat = 0;
 494     if (debug > 1)
 495         logf (LOG_LOG, "isc: isc_merge return %d %d", cat, firstpos);
 496     isc_pp_close (pp);
 497     return cat + firstpos * 8;
 498 }
 499