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