7e71037e46a3e1bde824d3104f0c5940a97e78a7
[kopensolaris-gnu/glibc.git] / db2 / btree / bt_delete.c
1 /*-
2  * See the file LICENSE for redistribution information.
3  *
4  * Copyright (c) 1996, 1997, 1998
5  *      Sleepycat Software.  All rights reserved.
6  */
7 /*
8  * Copyright (c) 1990, 1993, 1994, 1995, 1996
9  *      Keith Bostic.  All rights reserved.
10  */
11 /*
12  * Copyright (c) 1990, 1993, 1994, 1995
13  *      The Regents of the University of California.  All rights reserved.
14  *
15  * This code is derived from software contributed to Berkeley by
16  * Mike Olson.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  * 3. All advertising materials mentioning features or use of this software
27  *    must display the following acknowledgement:
28  *      This product includes software developed by the University of
29  *      California, Berkeley and its contributors.
30  * 4. Neither the name of the University nor the names of its contributors
31  *    may be used to endorse or promote products derived from this software
32  *    without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
35  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  */
46
47 #include "config.h"
48
49 #ifndef lint
50 static const char sccsid[] = "@(#)bt_delete.c   10.31 (Sleepycat) 5/6/98";
51 #endif /* not lint */
52
53 #ifndef NO_SYSTEM_INCLUDES
54 #include <sys/types.h>
55
56 #include <string.h>
57 #endif
58
59 #include "db_int.h"
60 #include "db_page.h"
61 #include "btree.h"
62
63 static int __bam_dpages __P((DB *, BTREE *));
64
65 /*
66  * __bam_delete --
67  *      Delete the items referenced by a key.
68  *
69  * PUBLIC: int __bam_delete __P((DB *, DB_TXN *, DBT *, u_int32_t));
70  */
71 int
72 __bam_delete(argdbp, txn, key, flags)
73         DB *argdbp;
74         DB_TXN *txn;
75         DBT *key;
76         u_int32_t flags;
77 {
78         BTREE *t;
79         DB *dbp;
80         PAGE *h;
81         db_indx_t cnt, i, indx;
82         int dpage, exact, ret, stack;
83
84         DEBUG_LWRITE(argdbp, txn, "bam_delete", key, NULL, flags);
85
86         stack = 0;
87
88         /* Check for invalid flags. */
89         if ((ret = __db_delchk(argdbp,
90             key, flags, F_ISSET(argdbp, DB_AM_RDONLY))) != 0)
91                 return (ret);
92
93         GETHANDLE(argdbp, txn, &dbp, ret);
94         t = dbp->internal;
95
96         /* Search the tree for the key; delete only deletes exact matches. */
97         if ((ret = __bam_search(dbp, key, S_DELETE, 1, NULL, &exact)) != 0)
98                 goto err;
99         stack = 1;
100         h = t->bt_csp->page;
101         indx = t->bt_csp->indx;
102
103         /* Delete the key/data pair, including any on-or-off page duplicates. */
104         for (cnt = 1, i = indx;; ++cnt)
105                 if ((i += P_INDX) >= NUM_ENT(h) || h->inp[i] != h->inp[indx])
106                         break;
107         for (; cnt > 0; --cnt, ++t->lstat.bt_deleted)
108                 if (__bam_ca_delete(dbp, h->pgno, indx, NULL, 1) == 0) {
109                         /*
110                          * XXX
111                          * Delete the key item first, otherwise the duplicate
112                          * checks in __bam_ditem() won't work!
113                          */
114                         if ((ret = __bam_ditem(dbp, h, indx)) != 0)
115                                 goto err;
116                         if ((ret = __bam_ditem(dbp, h, indx)) != 0)
117                                 goto err;
118                 } else {
119                         B_DSET(GET_BKEYDATA(h, indx + O_INDX)->type);
120                         indx += P_INDX;
121                 }
122
123         /* If we're using record numbers, update internal page record counts. */
124         if (F_ISSET(dbp, DB_BT_RECNUM) && (ret = __bam_adjust(dbp, t, -1)) != 0)
125                 goto err;
126
127         /* If the page is now empty, delete it. */
128         dpage = NUM_ENT(h) == 0 && h->pgno != PGNO_ROOT;
129
130         __bam_stkrel(dbp);
131         stack = 0;
132
133         ret = dpage ? __bam_dpage(dbp, key) : 0;
134
135 err:    if (stack)
136                 __bam_stkrel(dbp);
137         PUTHANDLE(dbp);
138         return (ret);
139 }
140
141 /*
142  * __ram_delete --
143  *      Delete the items referenced by a key.
144  *
145  * PUBLIC: int __ram_delete __P((DB *, DB_TXN *, DBT *, u_int32_t));
146  */
147 int
148 __ram_delete(argdbp, txn, key, flags)
149         DB *argdbp;
150         DB_TXN *txn;
151         DBT *key;
152         u_int32_t flags;
153 {
154         BKEYDATA bk;
155         BTREE *t;
156         DB *dbp;
157         DBT hdr, data;
158         PAGE *h;
159         db_indx_t indx;
160         db_recno_t recno;
161         int exact, ret, stack;
162
163         stack = 0;
164
165         /* Check for invalid flags. */
166         if ((ret = __db_delchk(argdbp,
167             key, flags, F_ISSET(argdbp, DB_AM_RDONLY))) != 0)
168                 return (ret);
169
170         GETHANDLE(argdbp, txn, &dbp, ret);
171         t = dbp->internal;
172
173         /* Check the user's record number and fill in as necessary. */
174         if ((ret = __ram_getno(argdbp, key, &recno, 0)) != 0)
175                 goto err;
176
177         /* Search the tree for the key; delete only deletes exact matches. */
178         if ((ret = __bam_rsearch(dbp, &recno, S_DELETE, 1, &exact)) != 0)
179                 goto err;
180         if (!exact) {
181                 ret = DB_NOTFOUND;
182                 goto err;
183         }
184
185         h = t->bt_csp->page;
186         indx = t->bt_csp->indx;
187         stack = 1;
188
189         /* If the record has already been deleted, we couldn't have found it. */
190         if (B_DISSET(GET_BKEYDATA(h, indx)->type)) {
191                 ret = DB_KEYEMPTY;
192                 goto done;
193         }
194
195         /*
196          * If we're not renumbering records, replace the record with a marker
197          * and return.
198          */
199         if (!F_ISSET(dbp, DB_RE_RENUMBER)) {
200                 if ((ret = __bam_ditem(dbp, h, indx)) != 0)
201                         goto err;
202
203                 B_TSET(bk.type, B_KEYDATA, 1);
204                 bk.len = 0;
205                 memset(&hdr, 0, sizeof(hdr));
206                 hdr.data = &bk;
207                 hdr.size = SSZA(BKEYDATA, data);
208                 memset(&data, 0, sizeof(data));
209                 data.data = (char *)"";
210                 data.size = 0;
211                 if ((ret = __db_pitem(dbp,
212                     h, indx, BKEYDATA_SIZE(0), &hdr, &data)) != 0)
213                         goto err;
214
215                 ++t->lstat.bt_deleted;
216                 goto done;
217         }
218
219         /* Delete the item. */
220         if ((ret = __bam_ditem(dbp, h, indx)) != 0)
221                 goto err;
222
223         ++t->lstat.bt_deleted;
224         if (t->bt_recno != NULL)
225                 F_SET(t->bt_recno, RECNO_MODIFIED);
226
227         /* Adjust the counts. */
228         __bam_adjust(dbp, t, -1);
229
230         /* Adjust the cursors. */
231         __ram_ca(dbp, recno, CA_DELETE);
232
233         /*
234          * If the page is now empty, delete it -- we have the whole tree
235          * locked, so there are no preparations to make.  Else, release
236          * the pages.
237          */
238         if (NUM_ENT(h) == 0 && h->pgno != PGNO_ROOT) {
239                 stack = 0;
240                 ret = __bam_dpages(dbp, t);
241         }
242
243 done:
244 err:    if (stack)
245                 __bam_stkrel(dbp);
246
247         PUTHANDLE(dbp);
248         return (ret);
249 }
250
251 /*
252  * __bam_ditem --
253  *      Delete one or more entries from a page.
254  *
255  * PUBLIC: int __bam_ditem __P((DB *, PAGE *, u_int32_t));
256  */
257 int
258 __bam_ditem(dbp, h, indx)
259         DB *dbp;
260         PAGE *h;
261         u_int32_t indx;
262 {
263         BINTERNAL *bi;
264         BKEYDATA *bk;
265         BOVERFLOW *bo;
266         u_int32_t nbytes;
267         int ret;
268
269         switch (TYPE(h)) {
270         case P_IBTREE:
271                 bi = GET_BINTERNAL(h, indx);
272                 switch (B_TYPE(bi->type)) {
273                 case B_DUPLICATE:
274                 case B_OVERFLOW:
275                         nbytes = BINTERNAL_SIZE(bi->len);
276                         bo = (BOVERFLOW *)bi->data;
277                         goto offpage;
278                 case B_KEYDATA:
279                         nbytes = BINTERNAL_SIZE(bi->len);
280                         break;
281                 default:
282                         return (__db_pgfmt(dbp, h->pgno));
283                 }
284                 break;
285         case P_IRECNO:
286                 nbytes = RINTERNAL_SIZE;
287                 break;
288         case P_LBTREE:
289                 /*
290                  * If it's a duplicate key, discard the index and don't touch
291                  * the actual page item.
292                  *
293                  * XXX
294                  * This works because no data item can have an index matching
295                  * any other index so even if the data item is in a key "slot",
296                  * it won't match any other index.
297                  */
298                 if ((indx % 2) == 0) {
299                         /*
300                          * Check for a duplicate after us on the page.  NOTE:
301                          * we have to delete the key item before deleting the
302                          * data item, otherwise the "indx + P_INDX" calculation
303                          * won't work!
304                          */
305                         if (indx + P_INDX < (u_int32_t)NUM_ENT(h) &&
306                             h->inp[indx] == h->inp[indx + P_INDX])
307                                 return (__bam_adjindx(dbp,
308                                     h, indx, indx + O_INDX, 0));
309                         /*
310                          * Check for a duplicate before us on the page.  It
311                          * doesn't matter if we delete the key item before or
312                          * after the data item for the purposes of this one.
313                          */
314                         if (indx > 0 && h->inp[indx] == h->inp[indx - P_INDX])
315                                 return (__bam_adjindx(dbp,
316                                     h, indx, indx - P_INDX, 0));
317                 }
318                 /* FALLTHROUGH */
319         case P_LRECNO:
320                 bk = GET_BKEYDATA(h, indx);
321                 switch (B_TYPE(bk->type)) {
322                 case B_DUPLICATE:
323                 case B_OVERFLOW:
324                         nbytes = BOVERFLOW_SIZE;
325                         bo = GET_BOVERFLOW(h, indx);
326
327 offpage:                /* Delete duplicate/offpage chains. */
328                         if (B_TYPE(bo->type) == B_DUPLICATE) {
329                                 if ((ret =
330                                     __db_ddup(dbp, bo->pgno, __bam_free)) != 0)
331                                         return (ret);
332                         } else
333                                 if ((ret =
334                                     __db_doff(dbp, bo->pgno, __bam_free)) != 0)
335                                         return (ret);
336                         break;
337                 case B_KEYDATA:
338                         nbytes = BKEYDATA_SIZE(bk->len);
339                         break;
340                 default:
341                         return (__db_pgfmt(dbp, h->pgno));
342                 }
343                 break;
344         default:
345                 return (__db_pgfmt(dbp, h->pgno));
346         }
347
348         /* Delete the item. */
349         if ((ret = __db_ditem(dbp, h, indx, nbytes)) != 0)
350                 return (ret);
351
352         /* Mark the page dirty. */
353         return (memp_fset(dbp->mpf, h, DB_MPOOL_DIRTY));
354 }
355
356 /*
357  * __bam_adjindx --
358  *      Adjust an index on the page.
359  *
360  * PUBLIC: int __bam_adjindx __P((DB *, PAGE *, u_int32_t, u_int32_t, int));
361  */
362 int
363 __bam_adjindx(dbp, h, indx, indx_copy, is_insert)
364         DB *dbp;
365         PAGE *h;
366         u_int32_t indx, indx_copy;
367         int is_insert;
368 {
369         db_indx_t copy;
370         int ret;
371
372         /* Log the change. */
373         if (DB_LOGGING(dbp) &&
374             (ret = __bam_adj_log(dbp->dbenv->lg_info, dbp->txn, &LSN(h),
375             0, dbp->log_fileid, PGNO(h), &LSN(h), indx, indx_copy,
376             (u_int32_t)is_insert)) != 0)
377                 return (ret);
378
379         if (is_insert) {
380                 copy = h->inp[indx_copy];
381                 if (indx != NUM_ENT(h))
382                         memmove(&h->inp[indx + O_INDX], &h->inp[indx],
383                             sizeof(db_indx_t) * (NUM_ENT(h) - indx));
384                 h->inp[indx] = copy;
385                 ++NUM_ENT(h);
386         } else {
387                 --NUM_ENT(h);
388                 if (indx != NUM_ENT(h))
389                         memmove(&h->inp[indx], &h->inp[indx + O_INDX],
390                             sizeof(db_indx_t) * (NUM_ENT(h) - indx));
391         }
392
393         /* Mark the page dirty. */
394         ret = memp_fset(dbp->mpf, h, DB_MPOOL_DIRTY);
395
396         /* Adjust the cursors. */
397         __bam_ca_di(dbp, h->pgno, indx, is_insert ? 1 : -1);
398         return (0);
399 }
400
401 /*
402  * __bam_dpage --
403  *      Delete a page from the tree.
404  *
405  * PUBLIC: int __bam_dpage __P((DB *, const DBT *));
406  */
407 int
408 __bam_dpage(dbp, key)
409         DB *dbp;
410         const DBT *key;
411 {
412         BTREE *t;
413         DB_LOCK lock;
414         PAGE *h;
415         db_pgno_t pgno;
416         int level;              /* !!!: has to hold number of tree levels. */
417         int exact, ret;
418
419         ret = 0;
420         t = dbp->internal;
421
422         /*
423          * The locking protocol is that we acquire locks by walking down the
424          * tree, to avoid the obvious deadlocks.
425          *
426          * Call __bam_search to reacquire the empty leaf page, but this time
427          * get both the leaf page and it's parent, locked.  Walk back up the
428          * tree, until we have the top pair of pages that we want to delete.
429          * Once we have the top page that we want to delete locked, lock the
430          * underlying pages and check to make sure they're still empty.  If
431          * they are, delete them.
432          */
433         for (level = LEAFLEVEL;; ++level) {
434                 /* Acquire a page and its parent, locked. */
435                 if ((ret =
436                     __bam_search(dbp, key, S_WRPAIR, level, NULL, &exact)) != 0)
437                         return (ret);
438
439                 /*
440                  * If we reach the root or the page isn't going to be empty
441                  * when we delete one record, quit.
442                  */
443                 h = t->bt_csp[-1].page;
444                 if (h->pgno == PGNO_ROOT || NUM_ENT(h) != 1)
445                         break;
446
447                 /* Release the two locked pages. */
448                 (void)memp_fput(dbp->mpf, t->bt_csp[-1].page, 0);
449                 (void)__BT_TLPUT(dbp, t->bt_csp[-1].lock);
450                 (void)memp_fput(dbp->mpf, t->bt_csp[0].page, 0);
451                 (void)__BT_TLPUT(dbp, t->bt_csp[0].lock);
452         }
453
454         /*
455          * Leave the stack pointer one after the last entry, we may be about
456          * to push more items on the stack.
457          */
458         ++t->bt_csp;
459
460         /*
461          * t->bt_csp[-2].page is the top page, which we're not going to delete,
462          * and t->bt_csp[-1].page is the first page we are going to delete.
463          *
464          * Walk down the chain, acquiring the rest of the pages until we've
465          * retrieved the leaf page.  If we find any pages that aren't going
466          * to be emptied by the delete, someone else added something while we
467          * were walking the tree, and we discontinue the delete.
468          */
469         for (h = t->bt_csp[-1].page;;) {
470                 if (ISLEAF(h)) {
471                         if (NUM_ENT(h) != 0)
472                                 goto release;
473                         break;
474                 } else
475                         if (NUM_ENT(h) != 1)
476                                 goto release;
477
478                 /*
479                  * Get the next page, write lock it and push it onto the stack.
480                  * We know it's index 0, because it can only have one element.
481                  */
482                 pgno = TYPE(h) == P_IBTREE ?
483                     GET_BINTERNAL(h, 0)->pgno : GET_RINTERNAL(h, 0)->pgno;
484
485                 if ((ret = __bam_lget(dbp, 0, pgno, DB_LOCK_WRITE, &lock)) != 0)
486                         goto release;
487                 if ((ret = __bam_pget(dbp, &h, &pgno, 0)) != 0)
488                         goto release;
489                 BT_STK_PUSH(t, h, 0, lock, ret);
490                 if (ret != 0)
491                         goto release;
492         }
493
494         BT_STK_POP(t);
495         return (__bam_dpages(dbp, t));
496
497 release:
498         /* Discard any locked pages and return. */
499         BT_STK_POP(t);
500         __bam_stkrel(dbp);
501         return (ret);
502 }
503
504 /*
505  * __bam_dpages --
506  *      Delete a set of locked pages.
507  */
508 static int
509 __bam_dpages(dbp, t)
510         DB *dbp;
511         BTREE *t;
512 {
513         DBT a, b;
514         DB_LOCK lock;
515         EPG *epg;
516         PAGE *h;
517         db_pgno_t pgno;
518         db_recno_t rcnt;
519         int ret;
520
521         COMPQUIET(rcnt, 0);
522
523         epg = t->bt_sp;
524
525         /*
526          * !!!
527          * There is an interesting deadlock situation here.  We have to relink
528          * the leaf page chain around the leaf page being deleted.  Consider
529          * a cursor walking through the leaf pages, that has the previous page
530          * read-locked and is waiting on a lock for the page we're deleting.
531          * It will deadlock here.  This is a problem, because if our process is
532          * selected to resolve the deadlock, we'll leave an empty leaf page
533          * that we can never again access by walking down the tree.  So, before
534          * we unlink the subtree, we relink the leaf page chain.
535          */
536         if ((ret = __db_relink(dbp, t->bt_csp->page, NULL, 1)) != 0)
537                 goto release;
538
539         /*
540          * We have the entire stack of deletable pages locked.  Start from the
541          * top of the tree and move to the bottom, as it's better to release
542          * the inner pages as soon as possible.
543          */
544         if ((ret = __bam_ditem(dbp, epg->page, epg->indx)) != 0)
545                 goto release;
546
547         /*
548          * If we just deleted the last or next-to-last item from the root page,
549          * the tree can collapse a level.  Write lock the last page referenced
550          * by the root page and copy it over the root page.  If we can't get a
551          * write lock, that's okay, the tree just remains a level deeper than
552          * we'd like.
553          */
554         h = epg->page;
555         if (h->pgno == PGNO_ROOT && NUM_ENT(h) <= 1) {
556                 pgno = TYPE(epg->page) == P_IBTREE ?
557                     GET_BINTERNAL(epg->page, 0)->pgno :
558                     GET_RINTERNAL(epg->page, 0)->pgno;
559                 if ((ret = __bam_lget(dbp, 0, pgno, DB_LOCK_WRITE, &lock)) != 0)
560                         goto release;
561                 if ((ret = __bam_pget(dbp, &h, &pgno, 0)) != 0)
562                         goto release;
563
564                 /* Log the change. */
565                 if (DB_LOGGING(dbp)) {
566                         memset(&a, 0, sizeof(a));
567                         a.data = h;
568                         a.size = dbp->pgsize;
569                         memset(&b, 0, sizeof(b));
570                         b.data = P_ENTRY(epg->page, 0);
571                         b.size = BINTERNAL_SIZE(((BINTERNAL *)b.data)->len);
572                         __bam_rsplit_log(dbp->dbenv->lg_info, dbp->txn,
573                            &h->lsn, 0, dbp->log_fileid, h->pgno, &a,
574                            RE_NREC(epg->page), &b, &epg->page->lsn);
575                 }
576
577                 /*
578                  * Make the switch.
579                  *
580                  * One fixup -- if the tree has record numbers and we're not
581                  * converting to a leaf page, we have to preserve the total
582                  * record count.
583                  */
584                 if (TYPE(h) == P_IRECNO ||
585                     (TYPE(h) == P_IBTREE && F_ISSET(dbp, DB_BT_RECNUM)))
586                         rcnt = RE_NREC(epg->page);
587                 memcpy(epg->page, h, dbp->pgsize);
588                 epg->page->pgno = PGNO_ROOT;
589                 if (TYPE(h) == P_IRECNO ||
590                     (TYPE(h) == P_IBTREE && F_ISSET(dbp, DB_BT_RECNUM)))
591                         RE_NREC_SET(epg->page, rcnt);
592                 (void)memp_fset(dbp->mpf, epg->page, DB_MPOOL_DIRTY);
593
594                 /*
595                  * Free the page copied onto the root page and discard its
596                  * lock.  (The call to __bam_free() discards our reference
597                  * to the page.)
598                  *
599                  * It's possible that the reverse split we're doing involves
600                  * pages from the stack of pages we're deleting.  Don't free
601                  * the page twice.
602                  */
603                  if (h->pgno == (epg + 1)->page->pgno)
604                         (void)memp_fput(dbp->mpf, h, 0);
605                 else {
606                         (void)__bam_free(dbp, h);
607                         ++t->lstat.bt_freed;
608                 }
609                 (void)__BT_TLPUT(dbp, lock);
610
611                 /* Adjust the cursors. */
612                 __bam_ca_move(dbp, h->pgno, PGNO_ROOT);
613         }
614
615         /* Release the top page in the subtree. */
616         (void)memp_fput(dbp->mpf, epg->page, 0);
617         (void)__BT_TLPUT(dbp, epg->lock);
618
619         /*
620          * Free the rest of the pages.
621          *
622          * XXX
623          * Don't bother checking for errors.  We've unlinked the subtree from
624          * the tree, and there's no possibility of recovery.
625          */
626         while (++epg <= t->bt_csp) {
627                 /*
628                  * XXX
629                  * Why do we need to do this?  Isn't the page already empty?
630                  */
631                 if (NUM_ENT(epg->page) != 0)
632                         (void)__bam_ditem(dbp, epg->page, epg->indx);
633
634                 (void)__bam_free(dbp, epg->page);
635                 (void)__BT_TLPUT(dbp, epg->lock);
636                 ++t->lstat.bt_freed;
637         }
638         return (0);
639
640 release:
641         /* Discard any remaining pages and return. */
642         for (; epg <= t->bt_csp; ++epg) {
643                 (void)memp_fput(dbp->mpf, epg->page, 0);
644                 (void)__BT_TLPUT(dbp, epg->lock);
645         }
646         return (ret);
647 }