xref: /freebsd/usr.bin/locate/code/locate.code.c (revision b84ed4e7f626de5475cf26bae6d7ff15ec9f9675)
1 /*
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1995-2022 Wolfram Schneider <wosch@FreeBSD.org>
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * James A. Woods.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  * $FreeBSD$
36  */
37 
38 #if 0
39 #ifndef lint
40 static char copyright[] =
41 "@(#) Copyright (c) 1989, 1993\n\
42 	The Regents of the University of California.  All rights reserved.\n";
43 #endif /* not lint */
44 
45 #ifndef lint
46 static char sccsid[] = "@(#)locate.code.c	8.1 (Berkeley) 6/6/93";
47 #endif /* not lint */
48 #endif
49 
50 /*
51  * PURPOSE:	sorted list compressor (works with a modified 'find'
52  *		to encode/decode a filename database)
53  *
54  * USAGE:	bigram < list > bigrams
55  *		process bigrams (see updatedb) > common_bigrams
56  *		code common_bigrams < list > squozen_list
57  *
58  * METHOD:	Uses 'front compression' (see ";login:", Volume 8, Number 1
59  *		February/March 1983, p. 8).  Output format is, per line, an
60  *		offset differential count byte followed by a partially bigram-
61  *		encoded ascii residue.  A bigram is a two-character sequence,
62  *		the first 128 most common of which are encoded in one byte.
63  *
64  * EXAMPLE:	For simple front compression with no bigram encoding,
65  *		if the input is...		then the output is...
66  *
67  *		/usr/src			 0 /usr/src
68  *		/usr/src/cmd/aardvark.c		 8 /cmd/aardvark.c
69  *		/usr/src/cmd/armadillo.c	14 armadillo.c
70  *		/usr/tmp/zoo			 5 tmp/zoo
71  *
72  *	The codes are:
73  *
74  *	0-28	likeliest differential counts + offset to make nonnegative
75  *	30	switch code for out-of-range count to follow in next word
76  *      31      an 8 bit char followed
77  *	128-255 bigram codes (128 most common, as determined by 'updatedb')
78  *	32-127  single character (printable) ascii residue (ie, literal)
79  *
80  * The locate database store any character except newline ('\n')
81  * and NUL ('\0'). The 8-bit character support don't wast extra
82  * space until you have characters in file names less than 32
83  * or greather than 127.
84  *
85  *
86  * SEE ALSO:	updatedb.sh, ../bigram/locate.bigram.c
87  *
88  * AUTHOR:	James A. Woods, Informatics General Corp.,
89  *		NASA Ames Research Center, 10/82
90  *              8-bit file names characters:
91  *              	Wolfram Schneider, Berlin September 1996
92  */
93 
94 #include <sys/param.h>
95 #include <err.h>
96 #include <errno.h>
97 #include <stdlib.h>
98 #include <string.h>
99 #include <stdio.h>
100 #include <unistd.h>
101 #include "locate.h"
102 
103 #define	BGBUFSIZE	(NBG * 2)	/* size of bigram buffer */
104 
105 u_char buf1[LOCATE_PATH_MAX] = " ";
106 u_char buf2[LOCATE_PATH_MAX];
107 u_char bigrams[BGBUFSIZE + 1] = { 0 };
108 
109 #define LOOKUP 1 /* use a lookup array instead a function, 3x faster */
110 
111 #ifdef LOOKUP
112 #define BGINDEX(x) (big[(u_char)*x][(u_char)*(x + 1)])
113 typedef short bg_t;
114 bg_t big[UCHAR_MAX + 1][UCHAR_MAX + 1];
115 #else
116 #define BGINDEX(x) bgindex(x)
117 typedef int bg_t;
118 int	bgindex(char *);
119 #endif /* LOOKUP */
120 
121 
122 void	usage(void);
123 
124 int
125 main(int argc, char *argv[])
126 {
127 	u_char *cp, *oldpath, *path;
128 	int ch, code, count, diffcount, oldcount;
129 	u_int i, j;
130 	FILE *fp;
131 
132 	while ((ch = getopt(argc, argv, "")) != -1)
133 		switch(ch) {
134 		default:
135 			usage();
136 		}
137 	argc -= optind;
138 	argv += optind;
139 
140 	if (argc != 1)
141 		usage();
142 
143 	if ((fp = fopen(argv[0], "r")) == NULL)
144 		err(1, "%s", argv[0]);
145 
146 	/* First copy bigram array to stdout. */
147 	if (fgets(bigrams, BGBUFSIZE + 1, fp) == NULL) {
148 		if (!feof(fp) || ferror(fp))
149 			err(1, "get bigram array");
150 	}
151 
152 	if (fwrite(bigrams, 1, BGBUFSIZE, stdout) != BGBUFSIZE)
153 		err(1, "stdout");
154 	(void)fclose(fp);
155 
156 #ifdef LOOKUP
157 	/* init lookup table */
158 	for (i = 0; i < UCHAR_MAX + 1; i++)
159 	    	for (j = 0; j < UCHAR_MAX + 1; j++)
160 			big[i][j] = (bg_t)-1;
161 
162 	for (cp = bigrams, i = 0; *cp != '\0'; i += 2, cp += 2)
163 	        big[(u_char)*cp][(u_char)*(cp + 1)] = (bg_t)i;
164 
165 #endif /* LOOKUP */
166 
167 	oldpath = buf1;
168 	path = buf2;
169 	oldcount = 0;
170 
171 	while (fgets(path, sizeof(buf2), stdin) != NULL) {
172 
173 		/* skip empty lines */
174 		if (*path == '\n')
175 			continue;
176 
177 		/* remove newline */
178 		for (cp = path; *cp != '\0'; cp++) {
179 #ifndef LOCATE_CHAR30
180 			/* old locate implementations core'd for char 30 */
181 			if (*cp == SWITCH)
182 				*cp = '?';
183 			else
184 #endif /* !LOCATE_CHAR30 */
185 
186 			/* chop newline */
187 			if (*cp == '\n')
188 				*cp = '\0';
189 		}
190 
191 		/* Skip longest common prefix. */
192 		for (cp = path; *cp == *oldpath; cp++, oldpath++)
193 			if (*cp == '\0')
194 				break;
195 
196 		count = cp - path;
197 		diffcount = count - oldcount + OFFSET;
198 		oldcount = count;
199 		if (diffcount < 0 || diffcount > 2 * OFFSET) {
200 			if (putchar(SWITCH) == EOF ||
201 			    putw(diffcount, stdout) == EOF)
202 				err(1, "stdout");
203 		} else
204 			if (putchar(diffcount) == EOF)
205 				err(1, "stdout");
206 
207 		while (*cp != '\0') {
208 			/* print *two* characters */
209 
210 			if ((code = BGINDEX(cp)) != (bg_t)-1) {
211 				/*
212 				 * print *one* as bigram
213 				 * Found, so mark byte with
214 				 *  parity bit.
215 				 */
216 				if (putchar((code / 2) | PARITY) == EOF)
217 					err(1, "stdout");
218 				cp += 2;
219 			}
220 
221 			else {
222 				for (i = 0; i < 2; i++) {
223 					if (*cp == '\0')
224 						break;
225 
226 					/* print umlauts in file names */
227 					if (*cp < ASCII_MIN ||
228 					    *cp > ASCII_MAX) {
229 						if (putchar(UMLAUT) == EOF ||
230 						    putchar(*cp++) == EOF)
231 							err(1, "stdout");
232 					}
233 
234 					else {
235 						/* normal character */
236 						if(putchar(*cp++) == EOF)
237 							err(1, "stdout");
238 					}
239 				}
240 
241 			}
242 		}
243 
244 		if (path == buf1) {		/* swap pointers */
245 			path = buf2;
246 			oldpath = buf1;
247 		} else {
248 			path = buf1;
249 			oldpath = buf2;
250 		}
251 	}
252 
253 	/* Non-zero status if there were errors */
254 	if (fflush(stdout) != 0 || ferror(stdout))
255 		errx(1, "stdout");
256 
257 	exit(0);
258 }
259 
260 #ifndef LOOKUP
261 int
262 bgindex(char *bg)		/* Return location of bg in bigrams or -1. */
263 {
264 	char bg0, bg1, *p;
265 
266 	bg0 = bg[0];
267 	bg1 = bg[1];
268 	for (p = bigrams; *p != NULL; p++)
269 		if (*p++ == bg0 && *p == bg1)
270 			break;
271 	return (*p == NULL ? -1 : (--p - bigrams));
272 }
273 #endif /* !LOOKUP */
274 
275 void
276 usage(void)
277 {
278 	(void)fprintf(stderr,
279 	    "usage: locate.code common_bigrams < list > squozen_list\n");
280 	exit(1);
281 }
282