Fix documentation of of chr's equivalent directive ZEB-672
[idzebra-moved-to-github.git] / isamc / merge.c
index b0d4315..bcb21f9 100644 (file)
@@ -1,61 +1,41 @@
-/*
- * Copyright (c) 1996-1998, Index Data.
- * See the file LICENSE for details.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: merge.c,v $
- * Revision 1.9  1998-03-19 10:04:38  adam
- * Minor changes.
- *
- * Revision 1.8  1998/03/18 09:23:55  adam
- * Blocks are stored in chunks on free list - up to factor 2 in speed.
- * Fixed bug that could occur in block category rearrangemen.
- *
- * Revision 1.7  1998/03/11 11:18:18  adam
- * Changed the isc_merge to take into account the mfill (minimum-fill).
- *
- * Revision 1.6  1998/03/06 13:54:03  adam
- * Fixed two nasty bugs in isc_merge.
- *
- * Revision 1.5  1997/02/12 20:42:43  adam
- * Bug fix: during isc_merge operations, some pages weren't marked dirty
- * even though they should be. At this point the merge operation marks
- * a page dirty if the previous page changed at all. A better approach is
- * to mark it dirty if the last key written changed in previous page.
- *
- * Revision 1.4  1996/11/08 11:15:31  adam
- * Number of keys in chain are stored in first block and the function
- * to retrieve this information, isc_pp_num is implemented.
- *
- * Revision 1.3  1996/11/04 14:08:59  adam
- * Optimized free block usage.
- *
- * Revision 1.2  1996/11/01 13:36:46  adam
- * New element, max_blocks_mem, that control how many blocks of max size
- * to store in memory during isc_merge.
- * Function isc_merge now ignores delete/update of identical keys and
- * the proper blocks are then non-dirty and not written in flush_blocks.
- *
- * Revision 1.1  1996/11/01  08:59:15  adam
- * First version of isc_merge that supports update/delete.
- *
- */
+/* This file is part of the Zebra server.
+   Copyright (C) Index Data
+
+Zebra is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
 
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
+
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
 #include <stdlib.h>
 #include <assert.h>
 #include <string.h>
 #include <stdio.h>
-
-#include <log.h>
+#include <yaz/log.h>
 #include "isamc-p.h"
 
-struct isc_merge_block {
-    int offset;       /* offset in r_buf */
-    int block;        /* block number of file (0 if none) */
-    int dirty;        /* block is different from that on file */
+struct isamc_merge_block {
+    int offset;   /* offset in r_buf */
+    zint block;   /* block number of file (0 if none) */
+    int dirty;    /* block is different from that on file */
 };
 
-static void opt_blocks (ISAMC is, struct isc_merge_block *mb, int ptr, int last)
+#if 0
+static void opt_blocks (ISAMC is, struct isamc_merge_block *mb, int ptr,
+                       int last)
 {
     int i, no_dirty = 0;
     for (i = 0; i<ptr; i++)
@@ -81,33 +61,34 @@ static void opt_blocks (ISAMC is, struct isc_merge_block *mb, int ptr, int last)
     if (!last)
        mb[i].dirty = 1;
 }
+#endif
 
-static void flush_blocks (ISAMC is, struct isc_merge_block *mb, int ptr,
-                          char *r_buf, int *firstpos, int cat, int last,
-                          int *numkeys)
+static void flush_blocks (ISAMC is, struct isamc_merge_block *mb, int ptr,
+                          char *r_buf, zint *firstpos, int cat, int last,
+                          zint *numkeys)
 {
     int i;
 
     for (i = 0; i<ptr; i++)
     {
         /* consider this block number */
-        if (!mb[i].block) 
+        if (!mb[i].block)
         {
-            mb[i].block = isc_alloc_block (is, cat);
+            mb[i].block = isamc_alloc_block (is, cat);
             mb[i].dirty = 1;
         }
 
         /* consider next block pointer */
         if (last && i == ptr-1)
             mb[i+1].block = 0;
-        else if (!mb[i+1].block)       
+        else if (!mb[i+1].block)
         {
-            mb[i+1].block = isc_alloc_block (is, cat);
+            mb[i+1].block = isamc_alloc_block (is, cat);
             mb[i+1].dirty = 1;
             mb[i].dirty = 1;
         }
     }
-    opt_blocks (is, mb, ptr, last);
+
     for (i = 0; i<ptr; i++)
     {
         char *src;
@@ -122,7 +103,7 @@ static void flush_blocks (ISAMC is, struct isc_merge_block *mb, int ptr,
             if (!*firstpos)
                 *firstpos = mb[i].block;
             if (is->method->debug > 2)
-                logf (LOG_LOG, "isc: skip ptr=%d size=%d %d %d",
+                yaz_log (YLOG_LOG, "isc: skip ptr=%d size=%d %d " ZINT_FORMAT,
                      i, ssize, cat, mb[i].block);
             ++(is->files[cat].no_skip_writes);
             continue;
@@ -135,79 +116,78 @@ static void flush_blocks (ISAMC is, struct isc_merge_block *mb, int ptr,
             src = r_buf + mb[i].offset - ISAMC_BLOCK_OFFSET_1;
             ssize += ISAMC_BLOCK_OFFSET_1;
 
-            memcpy (src+sizeof(int)+sizeof(ssize), numkeys,
-                    sizeof(*numkeys));
+            memcpy (src+sizeof(zint)+sizeof(ssize), numkeys, sizeof(*numkeys));
             if (is->method->debug > 2)
-                logf (LOG_LOG, "isc: flush ptr=%d numk=%d size=%d nextpos=%d",
-                     i, *numkeys, (int) ssize, mb[i+1].block);
+                yaz_log (YLOG_LOG, "isc: flush ptr=%d numk=" ZINT_FORMAT " size=%d nextpos="
+                     ZINT_FORMAT, i, *numkeys, (int) ssize, mb[i+1].block);
         }
         else
         {
             src = r_buf + mb[i].offset - ISAMC_BLOCK_OFFSET_N;
             ssize += ISAMC_BLOCK_OFFSET_N;
             if (is->method->debug > 2)
-                logf (LOG_LOG, "isc: flush ptr=%d size=%d nextpos=%d",
+                yaz_log (YLOG_LOG, "isc: flush ptr=%d size=%d nextpos=" ZINT_FORMAT,
                      i, (int) ssize, mb[i+1].block);
         }
-        memcpy (src, &mb[i+1].block, sizeof(int));
-        memcpy (src+sizeof(int), &ssize, sizeof(ssize));
-        isc_write_block (is, cat, mb[i].block, src);
+        memcpy (src, &mb[i+1].block, sizeof(zint));
+        memcpy (src+sizeof(zint), &ssize, sizeof(ssize));
+        isamc_write_block (is, cat, mb[i].block, src);
     }
 }
 
-static int get_border (ISAMC is, struct isc_merge_block *mb, int ptr,
-                       int cat, int firstpos)
+static int get_border (ISAMC is, struct isamc_merge_block *mb, zint ptr,
+                       int cat, zint firstpos)
 {
    /* Border set to initial fill or block size depending on
       whether we are creating a new one or updating and old one.
     */
-    
+
     int fill = mb[ptr].block ? is->method->filecat[cat].bsize :
                                is->method->filecat[cat].ifill;
     int off = (ptr||firstpos) ? ISAMC_BLOCK_OFFSET_N : ISAMC_BLOCK_OFFSET_1;
-    
+
     assert (ptr < 199);
 
     return mb[ptr].offset + fill - off;
 }
 
-ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
+void isamc_merge (ISAMC is, ISAM_P *ipos, ISAMC_I *data)
 {
 
     char i_item[128], *i_item_ptr;
     int i_more, i_mode, i;
 
-    ISAMC_PP pp; 
+    ISAMC_PP pp;
     char f_item[128], *f_item_ptr;
     int f_more;
     int last_dirty = 0;
     int debug = is->method->debug;
-    struct isc_merge_block mb[200];
 
-    int firstpos = 0;
+    struct isamc_merge_block mb[200];
+
+    zint firstpos = 0;
     int cat = 0;
     char r_item_buf[128]; /* temporary result output */
     char *r_buf;          /* block with resulting data */
     int r_offset = 0;     /* current offset in r_buf */
     int ptr = 0;          /* pointer */
     void *r_clientData;   /* encode client data */
-    int border;
-    int numKeys = 0;
+    zint border;
+    zint numKeys = 0;
 
-    r_clientData = (*is->method->code_start)(ISAMC_ENCODE);
+    r_clientData = (*is->method->codec.start)();
     r_buf = is->merge_buf + 128;
 
-    pp = isc_pp_open (is, ipos);
+    pp = isamc_pp_open (is, *ipos);
     /* read first item from file. make sure f_more indicates no boundary */
     f_item_ptr = f_item;
-    f_more = isc_read_item (pp, &f_item_ptr);
+    f_more = isamc_read_item (pp, &f_item_ptr);
     if (f_more > 0)
         f_more = 1;
     cat = pp->cat;
 
     if (debug > 1)
-        logf (LOG_LOG, "isc: isc_merge begin %d %d", cat, pp->pos);
+        yaz_log (YLOG_LOG, "isc: isamc_merge begin %d " ZINT_FORMAT, cat, pp->pos);
 
     /* read first item from i */
     i_item_ptr = i_item;
@@ -227,10 +207,10 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
         {
             /* block to block boundary in the original file. */
             f_more = 1;
-            if (cat == pp->cat) 
+            if (cat == pp->cat)
             {
                 /* the resulting output is of the same category as the
-                   the original 
+                   the original
                */
                 if (r_offset <= mb[ptr].offset +is->method->filecat[cat].mfill)
                 {
@@ -238,9 +218,9 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
                        the original (if any)
                    */
                     if (debug > 3)
-                        logf (LOG_LOG, "isc: release A");
+                        yaz_log (YLOG_LOG, "isc: release A");
                     if (mb[ptr].block)
-                        isc_release_block (is, pp->cat, mb[ptr].block);
+                        isamc_release_block (is, pp->cat, mb[ptr].block);
                     mb[ptr].block = pp->pos;
                    if (!mb[ptr].dirty)
                        mb[ptr].dirty = 1;
@@ -254,7 +234,7 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
                     mb[ptr].dirty = last_dirty;
                     mb[ptr].offset = r_offset;
                     if (debug > 3)
-                        logf (LOG_LOG, "isc: bound ptr=%d,offset=%d",
+                        yaz_log (YLOG_LOG, "isc: bound ptr=%d,offset=%d",
                             ptr, r_offset);
                     if (cat==is->max_cat && ptr >= is->method->max_blocks_mem)
                     {
@@ -262,7 +242,7 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
                            except 1 will be flushed.
                          */
                         if (debug > 2)
-                            logf (LOG_LOG, "isc: flush A %d sections", ptr);
+                            yaz_log (YLOG_LOG, "isc: flush A %d sections", ptr);
                         flush_blocks (is, mb, ptr-1, r_buf, &firstpos, cat,
                                       0, &pp->numKeys);
                         mb[0].block = mb[ptr-1].block;
@@ -326,20 +306,20 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
             }
             /* move f */
             f_item_ptr = f_item;
-            f_more = isc_read_item (pp, &f_item_ptr);
+            f_more = isamc_read_item (pp, &f_item_ptr);
         }
         else if (cmp > 0)               /* insert f */
         {
             memcpy (r_item, f_item, f_item_ptr - f_item);
             /* move f */
             f_item_ptr = f_item;
-            f_more = isc_read_item (pp, &f_item_ptr);
+            f_more = isamc_read_item (pp, &f_item_ptr);
         }
         else                            /* insert i */
         {
             if (!i_mode)                /* delete item which isn't there? */
             {
-                logf (LOG_FATAL, "Inconsistent register at offset %d",
+                yaz_log (YLOG_FATAL, "Inconsistent register at offset %d",
                                  r_offset);
                 abort ();
             }
@@ -354,18 +334,19 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
         if (r_item)  /* insert resulting item? */
         {
             char *r_out_ptr = r_buf + r_offset;
+           const char *src = r_item;
             int new_offset;
 
-            (*is->method->code_item)(ISAMC_ENCODE, r_clientData,
-                                     &r_out_ptr, &r_item);
-            new_offset = r_out_ptr - r_buf; 
+            (*is->method->codec.encode)(r_clientData, &r_out_ptr, &src);
+            new_offset = r_out_ptr - r_buf;
 
             numKeys++;
 
             if (border < new_offset && border >= r_offset)
             {
                 if (debug > 2)
-                    logf (LOG_LOG, "isc: border %d %d", ptr, border);
+                    yaz_log (YLOG_LOG, "isc: border %d " ZINT_FORMAT,
+                         ptr, border);
                 /* Max size of current block category reached ...
                    make new virtual block entry */
                 mb[++ptr].block = 0;
@@ -378,7 +359,7 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
                        surely not the last one(s).
                      */
                     if (debug > 2)
-                        logf (LOG_LOG, "isc: flush B %d sections", ptr-1);
+                        yaz_log (YLOG_LOG, "isc: flush B %d sections", ptr-1);
                     flush_blocks (is, mb, ptr-1, r_buf, &firstpos, cat,
                                   0, &pp->numKeys);
                     mb[0].block = mb[ptr-1].block;
@@ -402,7 +383,7 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
         if (cat < is->max_cat && ptr >= is->method->filecat[cat].mblocks)
         {
             /* Max number blocks in current category reached ->
-               must switch to next category (with larger block size) 
+               must switch to next category (with larger block size)
             */
             int j = 0;
 
@@ -410,7 +391,7 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
             /* delete all original block(s) read so far */
             for (i = 0; i < ptr; i++)
                 if (mb[i].block)
-                    isc_release_block (is, pp->cat, mb[i].block);
+                    isamc_release_block (is, pp->cat, mb[i].block);
             /* also delete all block to be read in the future */
             pp->deleteFlag = 1;
 
@@ -425,29 +406,30 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
                 int border = is->method->filecat[cat].ifill -
                          ISAMC_BLOCK_OFFSET_1 + mb[j].offset;
                 if (debug > 3)
-                    logf (LOG_LOG, "isc: remap %d border=%d", i, border);
+                    yaz_log (YLOG_LOG, "isc: remap %d border=%d", i, border);
                 if (mb[i+1].offset > border && mb[i].offset <= border)
                 {
                     if (debug > 3)
-                        logf (LOG_LOG, "isc:  to %d %d", j, mb[i].offset);
+                        yaz_log (YLOG_LOG, "isc:  to %d %d", j, mb[i].offset);
                     mb[++j].dirty = 1;
                     mb[j].block = 0;
                     mb[j].offset = mb[i].offset;
                 }
             }
             if (debug > 2)
-                logf (LOG_LOG, "isc: remap from %d to %d sections to cat %d",
+                yaz_log (YLOG_LOG, "isc: remap from %d to %d sections to cat %d",
                       ptr, j, cat);
             ptr = j;
             border = get_border (is, mb, ptr, cat, firstpos);
            if (debug > 3)
-               logf (LOG_LOG, "isc: border=%d r_offset=%d", border, r_offset);
+               yaz_log (YLOG_LOG, "isc: border=" ZINT_FORMAT " r_offset=%d",
+                     border, r_offset);
         }
     }
     if (mb[ptr].offset < r_offset)
     {   /* make the final boundary offset */
-        mb[++ptr].dirty = 1; 
-        mb[ptr].block = 0; 
+        mb[++ptr].dirty = 1;
+        mb[ptr].block = 0;
         mb[ptr].offset = r_offset;
     }
     else
@@ -455,8 +437,8 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
         if (cat == pp->cat && mb[ptr].block)
         {
             if (debug > 3)
-                logf (LOG_LOG, "isc: release C");
-            isc_release_block (is, pp->cat, mb[ptr].block);
+                yaz_log (YLOG_LOG, "isc: release C");
+            isamc_release_block (is, pp->cat, mb[ptr].block);
             mb[ptr].block = 0;
            if (ptr > 0)
                mb[ptr-1].dirty = 1;
@@ -464,16 +446,16 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
     }
 
     if (debug > 2)
-        logf (LOG_LOG, "isc: flush C, %d sections", ptr);
+        yaz_log (YLOG_LOG, "isc: flush C, %d sections", ptr);
 
     if (firstpos)
     {
         /* we have to patch initial block with num keys if that
            has changed */
-        if (numKeys != isc_pp_num (pp))
+        if (numKeys != isamc_pp_num (pp))
         {
             if (debug > 2)
-                logf (LOG_LOG, "isc: patch num keys firstpos=%d num=%d",
+                yaz_log (YLOG_LOG, "isc: patch num keys firstpos=" ZINT_FORMAT " num=" ZINT_FORMAT,
                                 firstpos, numKeys);
             bf_write (is->files[cat].bf, firstpos, ISAMC_BLOCK_OFFSET_N,
                       sizeof(numKeys), &numKeys);
@@ -482,18 +464,27 @@ ISAMC_P isc_merge (ISAMC is, ISAMC_P ipos, ISAMC_I data)
     else if (ptr > 0)
     {   /* we haven't flushed initial block yet and there surely are some
            blocks to flush. Make first block dirty if numKeys differ */
-        if (numKeys != isc_pp_num (pp))
+        if (numKeys != isamc_pp_num (pp))
             mb[0].dirty = 1;
     }
     /* flush rest of block(s) in r_buf */
     flush_blocks (is, mb, ptr, r_buf, &firstpos, cat, 1, &numKeys);
 
-    (*is->method->code_stop)(ISAMC_ENCODE, r_clientData);
+    (*is->method->codec.stop)(r_clientData);
     if (!firstpos)
         cat = 0;
     if (debug > 1)
-        logf (LOG_LOG, "isc: isc_merge return %d %d", cat, firstpos);
-    isc_pp_close (pp);
-    return cat + firstpos * 8;
+        yaz_log (YLOG_LOG, "isc: isamc_merge return %d " ZINT_FORMAT, cat, firstpos);
+    isamc_pp_close (pp);
+    *ipos = cat + firstpos * 8;
 }
 
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+