isamc/merge.c

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