98929540e4f37bd1e9509495fedfd2cb82543136
[kopensolaris-gnu/glibc.git] / db2 / btree / bt_delete.c
1 /*-
2  * See the file LICENSE for redistribution information.
3  *
4  * Copyright (c) 1996, 1997
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.21 (Sleepycat) 9/3/97";
51 #endif /* not lint */
52
53 #ifndef NO_SYSTEM_INCLUDES
54 #include <sys/types.h>
55
56 #include <stdio.h>
57 #include <string.h>
58 #endif
59
60 #include "db_int.h"
61 #include "db_page.h"
62 #include "btree.h"
63
64 static int __bam_dpages __P((DB *, BTREE *));
65
66 /*
67  * __bam_delete --
68  *      Delete the items referenced by a key.
69  *
70  * PUBLIC: int __bam_delete __P((DB *, DB_TXN *, DBT *, int));
71  */
72 int
73 __bam_delete(argdbp, txn, key, flags)
74         DB *argdbp;
75         DB_TXN *txn;
76         DBT *key;
77         int flags;
78 {
79         BTREE *t;
80         DB *dbp;
81         PAGE *h;
82         db_indx_t cnt, i, indx;
83         int dpage, exact, ret, stack;
84
85         DEBUG_LWRITE(argdbp, txn, "bam_delete", key, NULL, flags);
86
87         stack = 0;
88
89         /* Check for invalid flags. */
90         if ((ret =
91             __db_delchk(argdbp, flags, F_ISSET(argdbp, DB_AM_RDONLY))) != 0)
92                 return (ret);
93
94         GETHANDLE(argdbp, txn, &dbp, ret);
95         t = dbp->internal;
96
97         /* Search the tree for the key; delete only deletes exact matches. */
98         if ((ret = __bam_search(dbp, key, S_DELETE, 1, NULL, &exact)) != 0)
99                 goto err;
100         stack = 1;
101         h = t->bt_csp->page;
102         indx = t->bt_csp->indx;
103
104         /* Delete the key/data pair, including any duplicates. */
105         for (cnt = 1, i = indx;; ++cnt)
106                 if ((i += P_INDX) >= NUM_ENT(h) || h->inp[i] != h->inp[indx])
107                         break;
108         for (; cnt > 0; --cnt, ++t->lstat.bt_deleted)
109                 if (__bam_ca_delete(dbp, h->pgno, indx, NULL) != 0) {
110                         B_DSET(GET_BKEYDATA(h, indx + O_INDX)->type);
111                         indx += P_INDX;
112                 } else if ((ret = __bam_ditem(dbp, h, indx)) != 0 ||
113                     (ret = __bam_ditem(dbp, h, indx)) != 0)
114                         goto err;
115
116         /* If we're using record numbers, update internal page record counts. */
117         if (F_ISSET(dbp, DB_BT_RECNUM) && (ret = __bam_adjust(dbp, t, -1)) != 0)
118                 goto err;
119
120         /* If the page is now empty, delete it. */
121         dpage = NUM_ENT(h) == 0 && h->pgno != PGNO_ROOT;
122
123         __bam_stkrel(dbp);
124         stack = 0;
125
126         ret = dpage ? __bam_dpage(dbp, key) : 0;
127
128 err:    if (stack)
129                 __bam_stkrel(dbp);
130         PUTHANDLE(dbp);
131         return (ret);
132 }
133
134 /*
135  * __ram_delete --
136  *      Delete the items referenced by a key.
137  *
138  * PUBLIC: int __ram_delete __P((DB *, DB_TXN *, DBT *, int));
139  */
140 int
141 __ram_delete(argdbp, txn, key, flags)
142         DB *argdbp;
143         DB_TXN *txn;
144         DBT *key;
145         int flags;
146 {
147         BKEYDATA bk;
148         BTREE *t;
149         DB *dbp;
150         DBT hdr, data;
151         PAGE *h;
152         db_indx_t indx;
153         db_recno_t recno;
154         int exact, ret, stack;
155
156         stack = 0;
157
158         /* Check for invalid flags. */
159         if ((ret =
160             __db_delchk(argdbp, flags, F_ISSET(argdbp, DB_AM_RDONLY))) != 0)
161                 return (ret);
162
163         GETHANDLE(argdbp, txn, &dbp, ret);
164         t = dbp->internal;
165
166         /* Check the user's record number and fill in as necessary. */
167         if ((ret = __ram_getno(argdbp, key, &recno, 0)) != 0)
168                 goto err;
169
170         /* Search the tree for the key; delete only deletes exact matches. */
171         if ((ret = __bam_rsearch(dbp, &recno, S_DELETE, 1, &exact)) != 0)
172                 goto err;
173         if (!exact) {
174                 ret = DB_NOTFOUND;
175                 goto err;
176         }
177
178         h = t->bt_csp->page;
179         indx = t->bt_csp->indx;
180         stack = 1;
181
182         /* If the record has already been deleted, we couldn't have found it. */
183         if (B_DISSET(GET_BKEYDATA(h, indx)->type)) {
184                 ret = DB_KEYEMPTY;
185                 goto done;
186         }
187
188         /*
189          * If we're not renumbering records, replace the record with a marker
190          * and return.
191          */
192         if (!F_ISSET(dbp, DB_RE_RENUMBER)) {
193                 if ((ret = __bam_ditem(dbp, h, indx)) != 0)
194                         goto err;
195
196                 B_TSET(bk.type, B_KEYDATA, 1);
197                 bk.len = 0;
198                 memset(&hdr, 0, sizeof(hdr));
199                 hdr.data = &bk;
200                 hdr.size = SSZA(BKEYDATA, data);
201                 memset(&data, 0, sizeof(data));
202                 data.data = (char *)"";
203                 data.size = 0;
204                 if ((ret = __db_pitem(dbp,
205                     h, indx, BKEYDATA_SIZE(0), &hdr, &data)) != 0)
206                         goto err;
207
208                 ++t->lstat.bt_deleted;
209                 goto done;
210         }
211
212         /* Delete the item. */
213         if ((ret = __bam_ditem(dbp, h, indx)) != 0)
214                 goto err;
215
216         ++t->lstat.bt_deleted;
217         if (t->bt_recno != NULL)
218                 F_SET(t->bt_recno, RECNO_MODIFIED);
219
220         /* Adjust the counts. */
221         __bam_adjust(dbp, t, -1);
222
223         /* Adjust the cursors. */
224         __ram_ca(dbp, recno, CA_DELETE);
225
226         /*
227          * If the page is now empty, delete it -- we have the whole tree
228          * locked, so there are no preparations to make.  Else, release
229          * the pages.
230          */
231         if (NUM_ENT(h) == 0 && h->pgno != PGNO_ROOT) {
232                 stack = 0;
233                 ret = __bam_dpages(dbp, t);
234         }
235
236 done:
237 err:    if (stack)
238                 __bam_stkrel(dbp);
239
240         PUTHANDLE(dbp);
241         return (ret);
242 }
243
244 /*
245  * __bam_ditem --
246  *      Delete one or more entries from a page.
247  *
248  * PUBLIC: int __bam_ditem __P((DB *, PAGE *, u_int32_t));
249  */
250 int
251 __bam_ditem(dbp, h, indx)
252         DB *dbp;
253         PAGE *h;
254         u_int32_t indx;
255 {
256         BINTERNAL *bi;
257         BKEYDATA *bk;
258         BOVERFLOW *bo;
259         u_int32_t nbytes;
260         int ret;
261
262         switch (TYPE(h)) {
263         case P_IBTREE:
264                 bi = GET_BINTERNAL(h, indx);
265                 switch (B_TYPE(bi->type)) {
266                 case B_DUPLICATE:
267                 case B_OVERFLOW:
268                         nbytes = BINTERNAL_SIZE(bi->len);
269                         goto offpage;
270                 case B_KEYDATA:
271                         nbytes = BKEYDATA_SIZE(bi->len);
272                         break;
273                 default:
274                         return (__db_pgfmt(dbp, h->pgno));
275                 }
276                 break;
277         case P_IRECNO:
278                 nbytes = RINTERNAL_SIZE;
279                 break;
280         case P_LBTREE:
281                 /*
282                  * If it's a duplicate key, discard the index and don't touch
283                  * the actual page item.  This works because no data item can
284                  * have an index that matches any other index so even if the
285                  * data item is in an index "slot", it won't match any other
286                  * index.
287                  */
288                 if (!(indx % 2)) {
289                         if (indx > 0 && h->inp[indx] == h->inp[indx - P_INDX])
290                                 return (__bam_adjindx(dbp,
291                                     h, indx, indx - P_INDX, 0));
292                         if (indx < (u_int32_t)(NUM_ENT(h) - P_INDX) &&
293                             h->inp[indx] == h->inp[indx + P_INDX])
294                                 return (__bam_adjindx(dbp,
295                                     h, indx, indx + O_INDX, 0));
296                 }
297                 /* FALLTHROUGH */
298         case P_LRECNO:
299                 bk = GET_BKEYDATA(h, indx);
300                 switch (B_TYPE(bk->type)) {
301                 case B_DUPLICATE:
302                 case B_OVERFLOW:
303                         nbytes = BOVERFLOW_SIZE;
304
305 offpage:                /* Delete duplicate/offpage chains. */
306                         bo = GET_BOVERFLOW(h, indx);
307                         if (B_TYPE(bo->type) == B_DUPLICATE) {
308                                 if ((ret =
309                                     __db_ddup(dbp, bo->pgno, __bam_free)) != 0)
310                                         return (ret);
311                         } else
312                                 if ((ret =
313                                     __db_doff(dbp, bo->pgno, __bam_free)) != 0)
314                                         return (ret);
315                         break;
316                 case B_KEYDATA:
317                         nbytes = BKEYDATA_SIZE(bk->len);
318                         break;
319                 default:
320                         return (__db_pgfmt(dbp, h->pgno));
321                 }
322                 break;
323         default:
324                 return (__db_pgfmt(dbp, h->pgno));
325         }
326
327         /* Delete the item. */
328         if ((ret = __db_ditem(dbp, h, indx, nbytes)) != 0)
329                 return (ret);
330
331         /* Mark the page dirty. */
332         return (memp_fset(dbp->mpf, h, DB_MPOOL_DIRTY));
333 }
334
335 /*
336  * __bam_adjindx --
337  *      Adjust an index on the page.
338  *
339  * PUBLIC: int __bam_adjindx __P((DB *, PAGE *, u_int32_t, u_int32_t, int));
340  */
341 int
342 __bam_adjindx(dbp, h, indx, indx_copy, is_insert)
343         DB *dbp;
344         PAGE *h;
345         u_int32_t indx, indx_copy;
346         int is_insert;
347 {
348         db_indx_t copy;
349         int ret;
350
351         /* Log the change. */
352         if (DB_LOGGING(dbp) &&
353             (ret = __bam_adj_log(dbp->dbenv->lg_info, dbp->txn, &LSN(h),
354             0, dbp->log_fileid, PGNO(h), &LSN(h), indx, indx_copy,
355             (u_int32_t)is_insert)) != 0)
356                 return (ret);
357
358         if (is_insert) {
359                 copy = h->inp[indx_copy];
360                 if (indx != NUM_ENT(h))
361                         memmove(&h->inp[indx + O_INDX], &h->inp[indx],
362                             sizeof(db_indx_t) * (NUM_ENT(h) - indx));
363                 h->inp[indx] = copy;
364                 ++NUM_ENT(h);
365         } else {
366                 --NUM_ENT(h);
367                 if (indx != NUM_ENT(h))
368                         memmove(&h->inp[indx], &h->inp[indx + O_INDX],
369                             sizeof(db_indx_t) * (NUM_ENT(h) - indx));
370         }
371
372         /* Mark the page dirty. */
373         ret = memp_fset(dbp->mpf, h, DB_MPOOL_DIRTY);
374
375         /* Adjust the cursors. */
376         __bam_ca_di(dbp, h->pgno, indx, is_insert ? 1 : -1);
377         return (0);
378 }
379
380 /*
381  * __bam_dpage --
382  *      Delete a page from the tree.
383  *
384  * PUBLIC: int __bam_dpage __P((DB *, const DBT *));
385  */
386 int
387 __bam_dpage(dbp, key)
388         DB *dbp;
389         const DBT *key;
390 {
391         BTREE *t;
392         DB_LOCK lock;
393         PAGE *h;
394         db_pgno_t pgno;
395         int exact, level, ret;
396
397         ret = 0;
398         t = dbp->internal;
399
400         /*
401          * The locking protocol is that we acquire locks by walking down the
402          * tree, to avoid the obvious deadlocks.
403          *
404          * Call __bam_search to reacquire the empty leaf page, but this time
405          * get both the leaf page and it's parent, locked.  Walk back up the
406          * tree, until we have the top pair of pages that we want to delete.
407          * Once we have the top page that we want to delete locked, lock the
408          * underlying pages and check to make sure they're still empty.  If
409          * they are, delete them.
410          */
411         for (level = LEAFLEVEL;; ++level) {
412                 /* Acquire a page and its parent, locked. */
413                 if ((ret =
414                     __bam_search(dbp, key, S_WRPAIR, level, NULL, &exact)) != 0)
415                         return (ret);
416
417                 /*
418                  * If we reach the root or the page isn't going to be empty
419                  * when we delete one record, quit.
420                  */
421                 h = t->bt_csp[-1].page;
422                 if (h->pgno == PGNO_ROOT || NUM_ENT(h) != 1)
423                         break;
424
425                 /* Release the two locked pages. */
426                 (void)memp_fput(dbp->mpf, t->bt_csp[-1].page, 0);
427                 (void)__BT_TLPUT(dbp, t->bt_csp[-1].lock);
428                 (void)memp_fput(dbp->mpf, t->bt_csp[0].page, 0);
429                 (void)__BT_TLPUT(dbp, t->bt_csp[0].lock);
430         }
431
432         /*
433          * Leave the stack pointer one after the last entry, we may be about
434          * to push more items on the stack.
435          */
436         ++t->bt_csp;
437
438         /*
439          * t->bt_csp[-2].page is the top page, which we're not going to delete,
440          * and t->bt_csp[-1].page is the first page we are going to delete.
441          *
442          * Walk down the chain, acquiring the rest of the pages until we've
443          * retrieved the leaf page.  If we find any pages that aren't going
444          * to be emptied by the delete, someone else added something while we
445          * were walking the tree, and we discontinue the delete.
446          */
447         for (h = t->bt_csp[-1].page;;) {
448                 if (ISLEAF(h)) {
449                         if (NUM_ENT(h) != 0)
450                                 goto release;
451                         break;
452                 } else
453                         if (NUM_ENT(h) != 1)
454                                 goto release;
455
456                 /*
457                  * Get the next page, write lock it and push it onto the stack.
458                  * We know it's index 0, because it can only have one element.
459                  */
460                 pgno = TYPE(h) == P_IBTREE ?
461                     GET_BINTERNAL(h, 0)->pgno : GET_RINTERNAL(h, 0)->pgno;
462
463                 if ((ret = __bam_lget(dbp, 0, pgno, DB_LOCK_WRITE, &lock)) != 0)
464                         goto release;
465                 if ((ret = __bam_pget(dbp, &h, &pgno, 0)) != 0)
466                         goto release;
467                 BT_STK_PUSH(t, h, 0, lock, ret);
468                 if (ret != 0)
469                         goto release;
470         }
471
472         BT_STK_POP(t);
473         return (__bam_dpages(dbp, t));
474
475 release:
476         /* Discard any locked pages and return. */
477         BT_STK_POP(t);
478         __bam_stkrel(dbp);
479         return (ret);
480 }
481
482 /*
483  * __bam_dpages --
484  *      Delete a set of locked pages.
485  */
486 static int
487 __bam_dpages(dbp, t)
488         DB *dbp;
489         BTREE *t;
490 {
491         DBT a, b;
492         DB_LOCK lock;
493         EPG *epg;
494         PAGE *h;
495         db_pgno_t pgno;
496         db_recno_t rcnt;
497         int ret;
498
499         rcnt = 0;                               /* XXX: Shut the compiler up. */
500         epg = t->bt_sp;
501
502         /*
503          * !!!
504          * There is an interesting deadlock situation here.  We have to relink
505          * the leaf page chain around the leaf page being deleted.  Consider
506          * a cursor walking through the leaf pages, that has the previous page
507          * read-locked and is waiting on a lock for the page we're deleting.
508          * It will deadlock here.  This is a problem, because if our process is
509          * selected to resolve the deadlock, we'll leave an empty leaf page
510          * that we can never again access by walking down the tree.  So, before
511          * we unlink the subtree, we relink the leaf page chain.
512          */
513         if ((ret = __db_relink(dbp, t->bt_csp->page, NULL, 1)) != 0)
514                 goto release;
515
516         /*
517          * We have the entire stack of deletable pages locked.  Start from the
518          * top of the tree and move to the bottom, as it's better to release
519          * the inner pages as soon as possible.
520          */
521         if ((ret = __bam_ditem(dbp, epg->page, epg->indx)) != 0)
522                 goto release;
523
524         /*
525          * If we deleted the next-to-last item from the root page, the tree
526          * has collapsed a level.  Try and write lock the remaining root + 1
527          * page and copy it onto the root page.  If we can't get the lock,
528          * that's okay, the tree just stays a level deeper than we'd like.
529          */
530         h = epg->page;
531         if (h->pgno == PGNO_ROOT && NUM_ENT(h) == 1) {
532                 pgno = TYPE(epg->page) == P_IBTREE ?
533                     GET_BINTERNAL(epg->page, 0)->pgno :
534                     GET_RINTERNAL(epg->page, 0)->pgno;
535                 if ((ret = __bam_lget(dbp, 0, pgno, DB_LOCK_WRITE, &lock)) != 0)
536                         goto release;
537                 if ((ret = __bam_pget(dbp, &h, &pgno, 0)) != 0)
538                         goto release;
539
540                 /* Log the change. */
541                 if (DB_LOGGING(dbp)) {
542                         memset(&a, 0, sizeof(a));
543                         a.data = h;
544                         a.size = dbp->pgsize;
545                         memset(&b, 0, sizeof(b));
546                         b.data = P_ENTRY(epg->page, 0);
547                         b.size = BINTERNAL_SIZE(((BINTERNAL *)b.data)->len);
548                         __bam_rsplit_log(dbp->dbenv->lg_info, dbp->txn,
549                            &h->lsn, 0, dbp->log_fileid, h->pgno, &a, &b,
550                            &epg->page->lsn);
551                 }
552
553                 /*
554                  * Make the switch.
555                  *
556                  * One fixup -- if the tree has record numbers and we're not
557                  * converting to a leaf page, we have to preserve the total
558                  * record count.
559                  */
560                 if (TYPE(h) == P_IRECNO ||
561                     (TYPE(h) == P_IBTREE && F_ISSET(dbp, DB_BT_RECNUM)))
562                         rcnt = RE_NREC(epg->page);
563                 memcpy(epg->page, h, dbp->pgsize);
564                 epg->page->pgno = PGNO_ROOT;
565                 if (TYPE(h) == P_IRECNO ||
566                     (TYPE(h) == P_IBTREE && F_ISSET(dbp, DB_BT_RECNUM)))
567                         RE_NREC_SET(epg->page, rcnt);
568
569                 /* Free the last page in that level of the btree. */
570                 ++t->lstat.bt_freed;
571                 (void)__bam_free(dbp, h);
572
573                 /* Adjust the cursors. */
574                 __bam_ca_move(dbp, t, h->pgno, PGNO_ROOT);
575
576                 (void)__BT_TLPUT(dbp, lock);
577         }
578
579         /* Release the top page in the subtree. */
580         (void)memp_fput(dbp->mpf, epg->page, 0);
581         (void)__BT_TLPUT(dbp, epg->lock);
582
583         /*
584          * Free the rest of the pages.
585          *
586          * XXX
587          * Don't bother checking for errors.  We've unlinked the subtree from
588          * the tree, and there's no possibility of recovery.
589          */
590         for (; ++epg <= t->bt_csp; ++t->lstat.bt_freed) {
591                 if (NUM_ENT(epg->page) != 0)
592                         (void)__bam_ditem(dbp, epg->page, epg->indx);
593
594                 (void)__bam_free(dbp, epg->page);
595                 (void)__BT_TLPUT(dbp, epg->lock);
596         }
597         return (0);
598
599 release:
600         /* Discard any remaining pages and return. */
601         for (; epg <= t->bt_csp; ++epg) {
602                 (void)memp_fput(dbp->mpf, epg->page, 0);
603                 (void)__BT_TLPUT(dbp, epg->lock);
604         }
605         return (ret);
606 }