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