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