xref: /freebsd/lib/libc/db/hash/page.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Margo Seltzer.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 /*
36  * Definitions for hashing page file format.
37  */
38 
39 /*
40  * routines dealing with a data page
41  *
42  * page format:
43  *	+------------------------------+
44  * p	| n | keyoff | datoff | keyoff |
45  * 	+------------+--------+--------+
46  *	| datoff | free  |  ptr  | --> |
47  *	+--------+---------------------+
48  *	|	 F R E E A R E A       |
49  *	+--------------+---------------+
50  *	|  <---- - - - | data	       |
51  *	+--------+-----+----+----------+
52  *	|  key   | data     | key      |
53  *	+--------+----------+----------+
54  *
55  * Pointer to the free space is always:  p[p[0] + 2]
56  * Amount of free space on the page is:  p[p[0] + 1]
57  */
58 
59 /*
60  * How many bytes required for this pair?
61  *	2 shorts in the table at the top of the page + room for the
62  *	key and room for the data
63  *
64  * We prohibit entering a pair on a page unless there is also room to append
65  * an overflow page. The reason for this it that you can get in a situation
66  * where a single key/data pair fits on a page, but you can't append an
67  * overflow page and later you'd have to split the key/data and handle like
68  * a big pair.
69  * You might as well do this up front.
70  */
71 
72 #define	PAIRSIZE(K,D)	(2*sizeof(u_int16_t) + (K)->size + (D)->size)
73 #define BIGOVERHEAD	(4*sizeof(u_int16_t))
74 #define KEYSIZE(K)	(4*sizeof(u_int16_t) + (K)->size);
75 #define OVFLSIZE	(2*sizeof(u_int16_t))
76 #define FREESPACE(P)	((P)[(P)[0]+1])
77 #define	OFFSET(P)	((P)[(P)[0]+2])
78 #define PAIRFITS(P,K,D) \
79 	(((P)[2] >= REAL_KEY) && \
80 	    (PAIRSIZE((K),(D)) + OVFLSIZE) <= FREESPACE((P)))
81 #define PAGE_META(N)	(((N)+3) * sizeof(u_int16_t))
82 
83 typedef struct {
84 	BUFHEAD *newp;
85 	BUFHEAD *oldp;
86 	BUFHEAD *nextp;
87 	u_int16_t next_addr;
88 }       SPLIT_RETURN;
89