isamc/merge.c

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