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