xref: /dflybsd-src/contrib/mdocml/dba.c (revision 54ba96075f5891e4574304da6ba88f1a1afe520b)
1*54ba9607SSascha Wildner /*	$Id: dba.c,v 1.10 2017/02/17 14:43:54 schwarze Exp $ */
2*54ba9607SSascha Wildner /*
3*54ba9607SSascha Wildner  * Copyright (c) 2016, 2017 Ingo Schwarze <schwarze@openbsd.org>
4*54ba9607SSascha Wildner  *
5*54ba9607SSascha Wildner  * Permission to use, copy, modify, and distribute this software for any
6*54ba9607SSascha Wildner  * purpose with or without fee is hereby granted, provided that the above
7*54ba9607SSascha Wildner  * copyright notice and this permission notice appear in all copies.
8*54ba9607SSascha Wildner  *
9*54ba9607SSascha Wildner  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10*54ba9607SSascha Wildner  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*54ba9607SSascha Wildner  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12*54ba9607SSascha Wildner  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*54ba9607SSascha Wildner  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*54ba9607SSascha Wildner  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*54ba9607SSascha Wildner  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*54ba9607SSascha Wildner  *
17*54ba9607SSascha Wildner  * Allocation-based version of the mandoc database, for read-write access.
18*54ba9607SSascha Wildner  * The interface is defined in "dba.h".
19*54ba9607SSascha Wildner  */
20*54ba9607SSascha Wildner #include "config.h"
21*54ba9607SSascha Wildner 
22*54ba9607SSascha Wildner #include <sys/types.h>
23*54ba9607SSascha Wildner #if HAVE_ENDIAN
24*54ba9607SSascha Wildner #include <endian.h>
25*54ba9607SSascha Wildner #elif HAVE_SYS_ENDIAN
26*54ba9607SSascha Wildner #include <sys/endian.h>
27*54ba9607SSascha Wildner #elif HAVE_NTOHL
28*54ba9607SSascha Wildner #include <arpa/inet.h>
29*54ba9607SSascha Wildner #endif
30*54ba9607SSascha Wildner #include <errno.h>
31*54ba9607SSascha Wildner #include <stddef.h>
32*54ba9607SSascha Wildner #include <stdint.h>
33*54ba9607SSascha Wildner #include <stdlib.h>
34*54ba9607SSascha Wildner #include <string.h>
35*54ba9607SSascha Wildner #include <unistd.h>
36*54ba9607SSascha Wildner 
37*54ba9607SSascha Wildner #include "mandoc_aux.h"
38*54ba9607SSascha Wildner #include "mandoc_ohash.h"
39*54ba9607SSascha Wildner #include "mansearch.h"
40*54ba9607SSascha Wildner #include "dba_write.h"
41*54ba9607SSascha Wildner #include "dba_array.h"
42*54ba9607SSascha Wildner #include "dba.h"
43*54ba9607SSascha Wildner 
44*54ba9607SSascha Wildner struct macro_entry {
45*54ba9607SSascha Wildner 	struct dba_array	*pages;
46*54ba9607SSascha Wildner 	char			 value[];
47*54ba9607SSascha Wildner };
48*54ba9607SSascha Wildner 
49*54ba9607SSascha Wildner static void	*prepend(const char *, char);
50*54ba9607SSascha Wildner static void	 dba_pages_write(struct dba_array *);
51*54ba9607SSascha Wildner static int	 compare_names(const void *, const void *);
52*54ba9607SSascha Wildner static int	 compare_strings(const void *, const void *);
53*54ba9607SSascha Wildner 
54*54ba9607SSascha Wildner static struct macro_entry
55*54ba9607SSascha Wildner 		*get_macro_entry(struct ohash *, const char *, int32_t);
56*54ba9607SSascha Wildner static void	 dba_macros_write(struct dba_array *);
57*54ba9607SSascha Wildner static void	 dba_macro_write(struct ohash *);
58*54ba9607SSascha Wildner static int	 compare_entries(const void *, const void *);
59*54ba9607SSascha Wildner 
60*54ba9607SSascha Wildner 
61*54ba9607SSascha Wildner /*** top-level functions **********************************************/
62*54ba9607SSascha Wildner 
63*54ba9607SSascha Wildner struct dba *
dba_new(int32_t npages)64*54ba9607SSascha Wildner dba_new(int32_t npages)
65*54ba9607SSascha Wildner {
66*54ba9607SSascha Wildner 	struct dba	*dba;
67*54ba9607SSascha Wildner 	struct ohash	*macro;
68*54ba9607SSascha Wildner 	int32_t		 im;
69*54ba9607SSascha Wildner 
70*54ba9607SSascha Wildner 	dba = mandoc_malloc(sizeof(*dba));
71*54ba9607SSascha Wildner 	dba->pages = dba_array_new(npages, DBA_GROW);
72*54ba9607SSascha Wildner 	dba->macros = dba_array_new(MACRO_MAX, 0);
73*54ba9607SSascha Wildner 	for (im = 0; im < MACRO_MAX; im++) {
74*54ba9607SSascha Wildner 		macro = mandoc_malloc(sizeof(*macro));
75*54ba9607SSascha Wildner 		mandoc_ohash_init(macro, 4,
76*54ba9607SSascha Wildner 		    offsetof(struct macro_entry, value));
77*54ba9607SSascha Wildner 		dba_array_set(dba->macros, im, macro);
78*54ba9607SSascha Wildner 	}
79*54ba9607SSascha Wildner 	return dba;
80*54ba9607SSascha Wildner }
81*54ba9607SSascha Wildner 
82*54ba9607SSascha Wildner void
dba_free(struct dba * dba)83*54ba9607SSascha Wildner dba_free(struct dba *dba)
84*54ba9607SSascha Wildner {
85*54ba9607SSascha Wildner 	struct dba_array	*page;
86*54ba9607SSascha Wildner 	struct ohash		*macro;
87*54ba9607SSascha Wildner 	struct macro_entry	*entry;
88*54ba9607SSascha Wildner 	unsigned int		 slot;
89*54ba9607SSascha Wildner 
90*54ba9607SSascha Wildner 	dba_array_FOREACH(dba->macros, macro) {
91*54ba9607SSascha Wildner 		for (entry = ohash_first(macro, &slot); entry != NULL;
92*54ba9607SSascha Wildner 		     entry = ohash_next(macro, &slot)) {
93*54ba9607SSascha Wildner 			dba_array_free(entry->pages);
94*54ba9607SSascha Wildner 			free(entry);
95*54ba9607SSascha Wildner 		}
96*54ba9607SSascha Wildner 		ohash_delete(macro);
97*54ba9607SSascha Wildner 		free(macro);
98*54ba9607SSascha Wildner 	}
99*54ba9607SSascha Wildner 	dba_array_free(dba->macros);
100*54ba9607SSascha Wildner 
101*54ba9607SSascha Wildner 	dba_array_undel(dba->pages);
102*54ba9607SSascha Wildner 	dba_array_FOREACH(dba->pages, page) {
103*54ba9607SSascha Wildner 		dba_array_free(dba_array_get(page, DBP_NAME));
104*54ba9607SSascha Wildner 		dba_array_free(dba_array_get(page, DBP_SECT));
105*54ba9607SSascha Wildner 		dba_array_free(dba_array_get(page, DBP_ARCH));
106*54ba9607SSascha Wildner 		free(dba_array_get(page, DBP_DESC));
107*54ba9607SSascha Wildner 		dba_array_free(dba_array_get(page, DBP_FILE));
108*54ba9607SSascha Wildner 		dba_array_free(page);
109*54ba9607SSascha Wildner 	}
110*54ba9607SSascha Wildner 	dba_array_free(dba->pages);
111*54ba9607SSascha Wildner 
112*54ba9607SSascha Wildner 	free(dba);
113*54ba9607SSascha Wildner }
114*54ba9607SSascha Wildner 
115*54ba9607SSascha Wildner /*
116*54ba9607SSascha Wildner  * Write the complete mandoc database to disk; the format is:
117*54ba9607SSascha Wildner  * - One integer each for magic and version.
118*54ba9607SSascha Wildner  * - One pointer each to the macros table and to the final magic.
119*54ba9607SSascha Wildner  * - The pages table.
120*54ba9607SSascha Wildner  * - The macros table.
121*54ba9607SSascha Wildner  * - And at the very end, the magic integer again.
122*54ba9607SSascha Wildner  */
123*54ba9607SSascha Wildner int
dba_write(const char * fname,struct dba * dba)124*54ba9607SSascha Wildner dba_write(const char *fname, struct dba *dba)
125*54ba9607SSascha Wildner {
126*54ba9607SSascha Wildner 	int	 save_errno;
127*54ba9607SSascha Wildner 	int32_t	 pos_end, pos_macros, pos_macros_ptr;
128*54ba9607SSascha Wildner 
129*54ba9607SSascha Wildner 	if (dba_open(fname) == -1)
130*54ba9607SSascha Wildner 		return -1;
131*54ba9607SSascha Wildner 	dba_int_write(MANDOCDB_MAGIC);
132*54ba9607SSascha Wildner 	dba_int_write(MANDOCDB_VERSION);
133*54ba9607SSascha Wildner 	pos_macros_ptr = dba_skip(1, 2);
134*54ba9607SSascha Wildner 	dba_pages_write(dba->pages);
135*54ba9607SSascha Wildner 	pos_macros = dba_tell();
136*54ba9607SSascha Wildner 	dba_macros_write(dba->macros);
137*54ba9607SSascha Wildner 	pos_end = dba_tell();
138*54ba9607SSascha Wildner 	dba_int_write(MANDOCDB_MAGIC);
139*54ba9607SSascha Wildner 	dba_seek(pos_macros_ptr);
140*54ba9607SSascha Wildner 	dba_int_write(pos_macros);
141*54ba9607SSascha Wildner 	dba_int_write(pos_end);
142*54ba9607SSascha Wildner 	if (dba_close() == -1) {
143*54ba9607SSascha Wildner 		save_errno = errno;
144*54ba9607SSascha Wildner 		unlink(fname);
145*54ba9607SSascha Wildner 		errno = save_errno;
146*54ba9607SSascha Wildner 		return -1;
147*54ba9607SSascha Wildner 	}
148*54ba9607SSascha Wildner 	return 0;
149*54ba9607SSascha Wildner }
150*54ba9607SSascha Wildner 
151*54ba9607SSascha Wildner 
152*54ba9607SSascha Wildner /*** functions for handling pages *************************************/
153*54ba9607SSascha Wildner 
154*54ba9607SSascha Wildner /*
155*54ba9607SSascha Wildner  * Create a new page and append it to the pages table.
156*54ba9607SSascha Wildner  */
157*54ba9607SSascha Wildner struct dba_array *
dba_page_new(struct dba_array * pages,const char * arch,const char * desc,const char * file,enum form form)158*54ba9607SSascha Wildner dba_page_new(struct dba_array *pages, const char *arch,
159*54ba9607SSascha Wildner     const char *desc, const char *file, enum form form)
160*54ba9607SSascha Wildner {
161*54ba9607SSascha Wildner 	struct dba_array *page, *entry;
162*54ba9607SSascha Wildner 
163*54ba9607SSascha Wildner 	page = dba_array_new(DBP_MAX, 0);
164*54ba9607SSascha Wildner 	entry = dba_array_new(1, DBA_STR | DBA_GROW);
165*54ba9607SSascha Wildner 	dba_array_add(page, entry);
166*54ba9607SSascha Wildner 	entry = dba_array_new(1, DBA_STR | DBA_GROW);
167*54ba9607SSascha Wildner 	dba_array_add(page, entry);
168*54ba9607SSascha Wildner 	if (arch != NULL && *arch != '\0') {
169*54ba9607SSascha Wildner 		entry = dba_array_new(1, DBA_STR | DBA_GROW);
170*54ba9607SSascha Wildner 		dba_array_add(entry, (void *)arch);
171*54ba9607SSascha Wildner 	} else
172*54ba9607SSascha Wildner 		entry = NULL;
173*54ba9607SSascha Wildner 	dba_array_add(page, entry);
174*54ba9607SSascha Wildner 	dba_array_add(page, mandoc_strdup(desc));
175*54ba9607SSascha Wildner 	entry = dba_array_new(1, DBA_STR | DBA_GROW);
176*54ba9607SSascha Wildner 	dba_array_add(entry, prepend(file, form));
177*54ba9607SSascha Wildner 	dba_array_add(page, entry);
178*54ba9607SSascha Wildner 	dba_array_add(pages, page);
179*54ba9607SSascha Wildner 	return page;
180*54ba9607SSascha Wildner }
181*54ba9607SSascha Wildner 
182*54ba9607SSascha Wildner /*
183*54ba9607SSascha Wildner  * Add a section, architecture, or file name to an existing page.
184*54ba9607SSascha Wildner  * Passing the NULL pointer for the architecture makes the page MI.
185*54ba9607SSascha Wildner  * In that case, any earlier or later architectures are ignored.
186*54ba9607SSascha Wildner  */
187*54ba9607SSascha Wildner void
dba_page_add(struct dba_array * page,int32_t ie,const char * str)188*54ba9607SSascha Wildner dba_page_add(struct dba_array *page, int32_t ie, const char *str)
189*54ba9607SSascha Wildner {
190*54ba9607SSascha Wildner 	struct dba_array	*entries;
191*54ba9607SSascha Wildner 	char			*entry;
192*54ba9607SSascha Wildner 
193*54ba9607SSascha Wildner 	entries = dba_array_get(page, ie);
194*54ba9607SSascha Wildner 	if (ie == DBP_ARCH) {
195*54ba9607SSascha Wildner 		if (entries == NULL)
196*54ba9607SSascha Wildner 			return;
197*54ba9607SSascha Wildner 		if (str == NULL || *str == '\0') {
198*54ba9607SSascha Wildner 			dba_array_free(entries);
199*54ba9607SSascha Wildner 			dba_array_set(page, DBP_ARCH, NULL);
200*54ba9607SSascha Wildner 			return;
201*54ba9607SSascha Wildner 		}
202*54ba9607SSascha Wildner 	}
203*54ba9607SSascha Wildner 	if (*str == '\0')
204*54ba9607SSascha Wildner 		return;
205*54ba9607SSascha Wildner 	dba_array_FOREACH(entries, entry) {
206*54ba9607SSascha Wildner 		if (ie == DBP_FILE && *entry < ' ')
207*54ba9607SSascha Wildner 			entry++;
208*54ba9607SSascha Wildner 		if (strcmp(entry, str) == 0)
209*54ba9607SSascha Wildner 			return;
210*54ba9607SSascha Wildner 	}
211*54ba9607SSascha Wildner 	dba_array_add(entries, (void *)str);
212*54ba9607SSascha Wildner }
213*54ba9607SSascha Wildner 
214*54ba9607SSascha Wildner /*
215*54ba9607SSascha Wildner  * Add an additional name to an existing page.
216*54ba9607SSascha Wildner  */
217*54ba9607SSascha Wildner void
dba_page_alias(struct dba_array * page,const char * name,uint64_t mask)218*54ba9607SSascha Wildner dba_page_alias(struct dba_array *page, const char *name, uint64_t mask)
219*54ba9607SSascha Wildner {
220*54ba9607SSascha Wildner 	struct dba_array	*entries;
221*54ba9607SSascha Wildner 	char			*entry;
222*54ba9607SSascha Wildner 	char			 maskbyte;
223*54ba9607SSascha Wildner 
224*54ba9607SSascha Wildner 	if (*name == '\0')
225*54ba9607SSascha Wildner 		return;
226*54ba9607SSascha Wildner 	maskbyte = mask & NAME_MASK;
227*54ba9607SSascha Wildner 	entries = dba_array_get(page, DBP_NAME);
228*54ba9607SSascha Wildner 	dba_array_FOREACH(entries, entry) {
229*54ba9607SSascha Wildner 		if (strcmp(entry + 1, name) == 0) {
230*54ba9607SSascha Wildner 			*entry |= maskbyte;
231*54ba9607SSascha Wildner 			return;
232*54ba9607SSascha Wildner 		}
233*54ba9607SSascha Wildner 	}
234*54ba9607SSascha Wildner 	dba_array_add(entries, prepend(name, maskbyte));
235*54ba9607SSascha Wildner }
236*54ba9607SSascha Wildner 
237*54ba9607SSascha Wildner /*
238*54ba9607SSascha Wildner  * Return a pointer to a temporary copy of instr with inbyte prepended.
239*54ba9607SSascha Wildner  */
240*54ba9607SSascha Wildner static void *
prepend(const char * instr,char inbyte)241*54ba9607SSascha Wildner prepend(const char *instr, char inbyte)
242*54ba9607SSascha Wildner {
243*54ba9607SSascha Wildner 	static char	*outstr = NULL;
244*54ba9607SSascha Wildner 	static size_t	 outlen = 0;
245*54ba9607SSascha Wildner 	size_t		 newlen;
246*54ba9607SSascha Wildner 
247*54ba9607SSascha Wildner 	newlen = strlen(instr) + 1;
248*54ba9607SSascha Wildner 	if (newlen > outlen) {
249*54ba9607SSascha Wildner 		outstr = mandoc_realloc(outstr, newlen + 1);
250*54ba9607SSascha Wildner 		outlen = newlen;
251*54ba9607SSascha Wildner 	}
252*54ba9607SSascha Wildner 	*outstr = inbyte;
253*54ba9607SSascha Wildner 	memcpy(outstr + 1, instr, newlen);
254*54ba9607SSascha Wildner 	return outstr;
255*54ba9607SSascha Wildner }
256*54ba9607SSascha Wildner 
257*54ba9607SSascha Wildner /*
258*54ba9607SSascha Wildner  * Write the pages table to disk; the format is:
259*54ba9607SSascha Wildner  * - One integer containing the number of pages.
260*54ba9607SSascha Wildner  * - For each page, five pointers to the names, sections,
261*54ba9607SSascha Wildner  *   architectures, description, and file names of the page.
262*54ba9607SSascha Wildner  *   MI pages write 0 instead of the architecture pointer.
263*54ba9607SSascha Wildner  * - One list each for names, sections, architectures, descriptions and
264*54ba9607SSascha Wildner  *   file names.  The description for each page ends with a NUL byte.
265*54ba9607SSascha Wildner  *   For all the other lists, each string ends with a NUL byte,
266*54ba9607SSascha Wildner  *   and the last string for a page ends with two NUL bytes.
267*54ba9607SSascha Wildner  * - To assure alignment of following integers,
268*54ba9607SSascha Wildner  *   the end is padded with NUL bytes up to a multiple of four bytes.
269*54ba9607SSascha Wildner  */
270*54ba9607SSascha Wildner static void
dba_pages_write(struct dba_array * pages)271*54ba9607SSascha Wildner dba_pages_write(struct dba_array *pages)
272*54ba9607SSascha Wildner {
273*54ba9607SSascha Wildner 	struct dba_array	*page, *entry;
274*54ba9607SSascha Wildner 	int32_t			 pos_pages, pos_end;
275*54ba9607SSascha Wildner 
276*54ba9607SSascha Wildner 	pos_pages = dba_array_writelen(pages, 5);
277*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page) {
278*54ba9607SSascha Wildner 		dba_array_setpos(page, DBP_NAME, dba_tell());
279*54ba9607SSascha Wildner 		entry = dba_array_get(page, DBP_NAME);
280*54ba9607SSascha Wildner 		dba_array_sort(entry, compare_names);
281*54ba9607SSascha Wildner 		dba_array_writelst(entry);
282*54ba9607SSascha Wildner 	}
283*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page) {
284*54ba9607SSascha Wildner 		dba_array_setpos(page, DBP_SECT, dba_tell());
285*54ba9607SSascha Wildner 		entry = dba_array_get(page, DBP_SECT);
286*54ba9607SSascha Wildner 		dba_array_sort(entry, compare_strings);
287*54ba9607SSascha Wildner 		dba_array_writelst(entry);
288*54ba9607SSascha Wildner 	}
289*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page) {
290*54ba9607SSascha Wildner 		if ((entry = dba_array_get(page, DBP_ARCH)) != NULL) {
291*54ba9607SSascha Wildner 			dba_array_setpos(page, DBP_ARCH, dba_tell());
292*54ba9607SSascha Wildner 			dba_array_sort(entry, compare_strings);
293*54ba9607SSascha Wildner 			dba_array_writelst(entry);
294*54ba9607SSascha Wildner 		} else
295*54ba9607SSascha Wildner 			dba_array_setpos(page, DBP_ARCH, 0);
296*54ba9607SSascha Wildner 	}
297*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page) {
298*54ba9607SSascha Wildner 		dba_array_setpos(page, DBP_DESC, dba_tell());
299*54ba9607SSascha Wildner 		dba_str_write(dba_array_get(page, DBP_DESC));
300*54ba9607SSascha Wildner 	}
301*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page) {
302*54ba9607SSascha Wildner 		dba_array_setpos(page, DBP_FILE, dba_tell());
303*54ba9607SSascha Wildner 		dba_array_writelst(dba_array_get(page, DBP_FILE));
304*54ba9607SSascha Wildner 	}
305*54ba9607SSascha Wildner 	pos_end = dba_align();
306*54ba9607SSascha Wildner 	dba_seek(pos_pages);
307*54ba9607SSascha Wildner 	dba_array_FOREACH(pages, page)
308*54ba9607SSascha Wildner 		dba_array_writepos(page);
309*54ba9607SSascha Wildner 	dba_seek(pos_end);
310*54ba9607SSascha Wildner }
311*54ba9607SSascha Wildner 
312*54ba9607SSascha Wildner static int
compare_names(const void * vp1,const void * vp2)313*54ba9607SSascha Wildner compare_names(const void *vp1, const void *vp2)
314*54ba9607SSascha Wildner {
315*54ba9607SSascha Wildner 	const char	*cp1, *cp2;
316*54ba9607SSascha Wildner 	int		 diff;
317*54ba9607SSascha Wildner 
318*54ba9607SSascha Wildner 	cp1 = *(const char * const *)vp1;
319*54ba9607SSascha Wildner 	cp2 = *(const char * const *)vp2;
320*54ba9607SSascha Wildner 	return (diff = *cp2 - *cp1) ? diff :
321*54ba9607SSascha Wildner 	    strcasecmp(cp1 + 1, cp2 + 1);
322*54ba9607SSascha Wildner }
323*54ba9607SSascha Wildner 
324*54ba9607SSascha Wildner static int
compare_strings(const void * vp1,const void * vp2)325*54ba9607SSascha Wildner compare_strings(const void *vp1, const void *vp2)
326*54ba9607SSascha Wildner {
327*54ba9607SSascha Wildner 	const char	*cp1, *cp2;
328*54ba9607SSascha Wildner 
329*54ba9607SSascha Wildner 	cp1 = *(const char * const *)vp1;
330*54ba9607SSascha Wildner 	cp2 = *(const char * const *)vp2;
331*54ba9607SSascha Wildner 	return strcmp(cp1, cp2);
332*54ba9607SSascha Wildner }
333*54ba9607SSascha Wildner 
334*54ba9607SSascha Wildner /*** functions for handling macros ************************************/
335*54ba9607SSascha Wildner 
336*54ba9607SSascha Wildner /*
337*54ba9607SSascha Wildner  * In the hash table for a single macro, look up an entry by
338*54ba9607SSascha Wildner  * the macro value or add an empty one if it doesn't exist yet.
339*54ba9607SSascha Wildner  */
340*54ba9607SSascha Wildner static struct macro_entry *
get_macro_entry(struct ohash * macro,const char * value,int32_t np)341*54ba9607SSascha Wildner get_macro_entry(struct ohash *macro, const char *value, int32_t np)
342*54ba9607SSascha Wildner {
343*54ba9607SSascha Wildner 	struct macro_entry	*entry;
344*54ba9607SSascha Wildner 	size_t			 len;
345*54ba9607SSascha Wildner 	unsigned int		 slot;
346*54ba9607SSascha Wildner 
347*54ba9607SSascha Wildner 	slot = ohash_qlookup(macro, value);
348*54ba9607SSascha Wildner 	if ((entry = ohash_find(macro, slot)) == NULL) {
349*54ba9607SSascha Wildner 		len = strlen(value) + 1;
350*54ba9607SSascha Wildner 		entry = mandoc_malloc(sizeof(*entry) + len);
351*54ba9607SSascha Wildner 		memcpy(&entry->value, value, len);
352*54ba9607SSascha Wildner 		entry->pages = dba_array_new(np, DBA_GROW);
353*54ba9607SSascha Wildner 		ohash_insert(macro, slot, entry);
354*54ba9607SSascha Wildner 	}
355*54ba9607SSascha Wildner 	return entry;
356*54ba9607SSascha Wildner }
357*54ba9607SSascha Wildner 
358*54ba9607SSascha Wildner /*
359*54ba9607SSascha Wildner  * In addition to get_macro_entry(), add multiple page references,
360*54ba9607SSascha Wildner  * converting them from the on-disk format (byte offsets in the file)
361*54ba9607SSascha Wildner  * to page pointers in memory.
362*54ba9607SSascha Wildner  */
363*54ba9607SSascha Wildner void
dba_macro_new(struct dba * dba,int32_t im,const char * value,const int32_t * pp)364*54ba9607SSascha Wildner dba_macro_new(struct dba *dba, int32_t im, const char *value,
365*54ba9607SSascha Wildner     const int32_t *pp)
366*54ba9607SSascha Wildner {
367*54ba9607SSascha Wildner 	struct macro_entry	*entry;
368*54ba9607SSascha Wildner 	const int32_t		*ip;
369*54ba9607SSascha Wildner 	int32_t			 np;
370*54ba9607SSascha Wildner 
371*54ba9607SSascha Wildner 	np = 0;
372*54ba9607SSascha Wildner 	for (ip = pp; *ip; ip++)
373*54ba9607SSascha Wildner 		np++;
374*54ba9607SSascha Wildner 
375*54ba9607SSascha Wildner 	entry = get_macro_entry(dba_array_get(dba->macros, im), value, np);
376*54ba9607SSascha Wildner 	for (ip = pp; *ip; ip++)
377*54ba9607SSascha Wildner 		dba_array_add(entry->pages, dba_array_get(dba->pages,
378*54ba9607SSascha Wildner 		    be32toh(*ip) / 5 / sizeof(*ip) - 1));
379*54ba9607SSascha Wildner }
380*54ba9607SSascha Wildner 
381*54ba9607SSascha Wildner /*
382*54ba9607SSascha Wildner  * In addition to get_macro_entry(), add one page reference,
383*54ba9607SSascha Wildner  * directly taking the in-memory page pointer as an argument.
384*54ba9607SSascha Wildner  */
385*54ba9607SSascha Wildner void
dba_macro_add(struct dba_array * macros,int32_t im,const char * value,struct dba_array * page)386*54ba9607SSascha Wildner dba_macro_add(struct dba_array *macros, int32_t im, const char *value,
387*54ba9607SSascha Wildner     struct dba_array *page)
388*54ba9607SSascha Wildner {
389*54ba9607SSascha Wildner 	struct macro_entry	*entry;
390*54ba9607SSascha Wildner 
391*54ba9607SSascha Wildner 	if (*value == '\0')
392*54ba9607SSascha Wildner 		return;
393*54ba9607SSascha Wildner 	entry = get_macro_entry(dba_array_get(macros, im), value, 1);
394*54ba9607SSascha Wildner 	dba_array_add(entry->pages, page);
395*54ba9607SSascha Wildner }
396*54ba9607SSascha Wildner 
397*54ba9607SSascha Wildner /*
398*54ba9607SSascha Wildner  * Write the macros table to disk; the format is:
399*54ba9607SSascha Wildner  * - The number of macro tables (actually, MACRO_MAX).
400*54ba9607SSascha Wildner  * - That number of pointers to the individual macro tables.
401*54ba9607SSascha Wildner  * - The individual macro tables.
402*54ba9607SSascha Wildner  */
403*54ba9607SSascha Wildner static void
dba_macros_write(struct dba_array * macros)404*54ba9607SSascha Wildner dba_macros_write(struct dba_array *macros)
405*54ba9607SSascha Wildner {
406*54ba9607SSascha Wildner 	struct ohash		*macro;
407*54ba9607SSascha Wildner 	int32_t			 im, pos_macros, pos_end;
408*54ba9607SSascha Wildner 
409*54ba9607SSascha Wildner 	pos_macros = dba_array_writelen(macros, 1);
410*54ba9607SSascha Wildner 	im = 0;
411*54ba9607SSascha Wildner 	dba_array_FOREACH(macros, macro) {
412*54ba9607SSascha Wildner 		dba_array_setpos(macros, im++, dba_tell());
413*54ba9607SSascha Wildner 		dba_macro_write(macro);
414*54ba9607SSascha Wildner 	}
415*54ba9607SSascha Wildner 	pos_end = dba_tell();
416*54ba9607SSascha Wildner 	dba_seek(pos_macros);
417*54ba9607SSascha Wildner 	dba_array_writepos(macros);
418*54ba9607SSascha Wildner 	dba_seek(pos_end);
419*54ba9607SSascha Wildner }
420*54ba9607SSascha Wildner 
421*54ba9607SSascha Wildner /*
422*54ba9607SSascha Wildner  * Write one individual macro table to disk; the format is:
423*54ba9607SSascha Wildner  * - The number of entries in the table.
424*54ba9607SSascha Wildner  * - For each entry, two pointers, the first one to the value
425*54ba9607SSascha Wildner  *   and the second one to the list of pages.
426*54ba9607SSascha Wildner  * - A list of values, each ending in a NUL byte.
427*54ba9607SSascha Wildner  * - To assure alignment of following integers,
428*54ba9607SSascha Wildner  *   padding with NUL bytes up to a multiple of four bytes.
429*54ba9607SSascha Wildner  * - A list of pointers to pages, each list ending in a 0 integer.
430*54ba9607SSascha Wildner  */
431*54ba9607SSascha Wildner static void
dba_macro_write(struct ohash * macro)432*54ba9607SSascha Wildner dba_macro_write(struct ohash *macro)
433*54ba9607SSascha Wildner {
434*54ba9607SSascha Wildner 	struct macro_entry	**entries, *entry;
435*54ba9607SSascha Wildner 	struct dba_array	 *page;
436*54ba9607SSascha Wildner 	int32_t			 *kpos, *dpos;
437*54ba9607SSascha Wildner 	unsigned int		  ie, ne, slot;
438*54ba9607SSascha Wildner 	int			  use;
439*54ba9607SSascha Wildner 	int32_t			  addr, pos_macro, pos_end;
440*54ba9607SSascha Wildner 
441*54ba9607SSascha Wildner 	/* Temporary storage for filtering and sorting. */
442*54ba9607SSascha Wildner 
443*54ba9607SSascha Wildner 	ne = ohash_entries(macro);
444*54ba9607SSascha Wildner 	entries = mandoc_reallocarray(NULL, ne, sizeof(*entries));
445*54ba9607SSascha Wildner 	kpos = mandoc_reallocarray(NULL, ne, sizeof(*kpos));
446*54ba9607SSascha Wildner 	dpos = mandoc_reallocarray(NULL, ne, sizeof(*dpos));
447*54ba9607SSascha Wildner 
448*54ba9607SSascha Wildner 	/* Build a list of non-empty entries and sort it. */
449*54ba9607SSascha Wildner 
450*54ba9607SSascha Wildner 	ne = 0;
451*54ba9607SSascha Wildner 	for (entry = ohash_first(macro, &slot); entry != NULL;
452*54ba9607SSascha Wildner 	     entry = ohash_next(macro, &slot)) {
453*54ba9607SSascha Wildner 		use = 0;
454*54ba9607SSascha Wildner 		dba_array_FOREACH(entry->pages, page)
455*54ba9607SSascha Wildner 			if (dba_array_getpos(page))
456*54ba9607SSascha Wildner 				use = 1;
457*54ba9607SSascha Wildner 		if (use)
458*54ba9607SSascha Wildner 			entries[ne++] = entry;
459*54ba9607SSascha Wildner 	}
460*54ba9607SSascha Wildner 	qsort(entries, ne, sizeof(*entries), compare_entries);
461*54ba9607SSascha Wildner 
462*54ba9607SSascha Wildner 	/* Number of entries, and space for the pointer pairs. */
463*54ba9607SSascha Wildner 
464*54ba9607SSascha Wildner 	dba_int_write(ne);
465*54ba9607SSascha Wildner 	pos_macro = dba_skip(2, ne);
466*54ba9607SSascha Wildner 
467*54ba9607SSascha Wildner 	/* String table. */
468*54ba9607SSascha Wildner 
469*54ba9607SSascha Wildner 	for (ie = 0; ie < ne; ie++) {
470*54ba9607SSascha Wildner 		kpos[ie] = dba_tell();
471*54ba9607SSascha Wildner 		dba_str_write(entries[ie]->value);
472*54ba9607SSascha Wildner 	}
473*54ba9607SSascha Wildner 	dba_align();
474*54ba9607SSascha Wildner 
475*54ba9607SSascha Wildner 	/* Pages table. */
476*54ba9607SSascha Wildner 
477*54ba9607SSascha Wildner 	for (ie = 0; ie < ne; ie++) {
478*54ba9607SSascha Wildner 		dpos[ie] = dba_tell();
479*54ba9607SSascha Wildner 		dba_array_FOREACH(entries[ie]->pages, page)
480*54ba9607SSascha Wildner 			if ((addr = dba_array_getpos(page)))
481*54ba9607SSascha Wildner 				dba_int_write(addr);
482*54ba9607SSascha Wildner 		dba_int_write(0);
483*54ba9607SSascha Wildner 	}
484*54ba9607SSascha Wildner 	pos_end = dba_tell();
485*54ba9607SSascha Wildner 
486*54ba9607SSascha Wildner 	/* Fill in the pointer pairs. */
487*54ba9607SSascha Wildner 
488*54ba9607SSascha Wildner 	dba_seek(pos_macro);
489*54ba9607SSascha Wildner 	for (ie = 0; ie < ne; ie++) {
490*54ba9607SSascha Wildner 		dba_int_write(kpos[ie]);
491*54ba9607SSascha Wildner 		dba_int_write(dpos[ie]);
492*54ba9607SSascha Wildner 	}
493*54ba9607SSascha Wildner 	dba_seek(pos_end);
494*54ba9607SSascha Wildner 
495*54ba9607SSascha Wildner 	free(entries);
496*54ba9607SSascha Wildner 	free(kpos);
497*54ba9607SSascha Wildner 	free(dpos);
498*54ba9607SSascha Wildner }
499*54ba9607SSascha Wildner 
500*54ba9607SSascha Wildner static int
compare_entries(const void * vp1,const void * vp2)501*54ba9607SSascha Wildner compare_entries(const void *vp1, const void *vp2)
502*54ba9607SSascha Wildner {
503*54ba9607SSascha Wildner 	const struct macro_entry *ep1, *ep2;
504*54ba9607SSascha Wildner 
505*54ba9607SSascha Wildner 	ep1 = *(const struct macro_entry * const *)vp1;
506*54ba9607SSascha Wildner 	ep2 = *(const struct macro_entry * const *)vp2;
507*54ba9607SSascha Wildner 	return strcmp(ep1->value, ep2->value);
508*54ba9607SSascha Wildner }
509