Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	bin/pax/cache.c	Lines:	60	80	75.0 %
Date:	2017-11-13	Branches:	36	64	56.3 %


/*	$OpenBSD: cache.c,v 1.23 2016/08/26 04:08:18 guenther Exp $	*/
/*	$NetBSD: cache.c,v 1.4 1995/03/21 09:07:10 cgd Exp $	*/

/*-
 * Copyright (c) 1992 Keith Muller.
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Keith Muller of the University of California, San Diego.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/types.h>
#include <sys/stat.h>
#include <grp.h>
#include <pwd.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "pax.h"
#include "extern.h"

/*
 * Constants and data structures used to implement group and password file
 * caches. Traditional passwd/group cache routines perform quite poorly with
 * archives. The chances of hitting a valid lookup with an archive is quite a
 * bit worse than with files already resident on the file system. These misses
 * create a MAJOR performance cost. To address this problem, these routines
 * cache both hits and misses.
 *
 * NOTE:  name lengths must be as large as those stored in ANY PROTOCOL and
 * as stored in the passwd and group files. CACHE SIZES MUST BE PRIME
 */
#define UNMLEN		32	/* >= user name found in any protocol */
#define GNMLEN		32	/* >= group name found in any protocol */
#define UNM_SZ		317	/* size of uid_name() cache */
#define GNM_SZ		317	/* size of gid_name() cache */
#define VALID		1	/* entry and name are valid */
#define INVALID		2	/* entry valid, name NOT valid */

/*
 * Node structures used in the user, group, uid, and gid caches.
 */

typedef struct uidc {
	int valid;		/* is this a valid or a miss entry */
	char name[UNMLEN];	/* uid name */
	uid_t uid;		/* cached uid */
} UIDC;

typedef struct gidc {
	int valid;		/* is this a valid or a miss entry */
	char name[GNMLEN];	/* gid name */
	gid_t gid;		/* cached gid */
} GIDC;


/*
 * routines that control user, group, uid and gid caches (for the archive
 * member print routine).
 * IMPORTANT:
 * these routines cache BOTH hits and misses, a major performance improvement
 */

static	int pwopn = 0;		/* is password file open */
static	int gropn = 0;		/* is group file open */
static UIDC **usrtb = NULL;	/* user name to uid cache */
static GIDC **grptb = NULL;	/* group name to gid cache */

/*
 * usrtb_start
 *	creates an empty usrtb
 * Return:
 *	0 if ok, -1 otherwise
 */

int
usrtb_start(void)
{
	static int fail = 0;

	if (usrtb != NULL)
		return(0);
	if (fail)
		return(-1);
	if ((usrtb = calloc(UNM_SZ, sizeof(UIDC *))) == NULL) {
		++fail;
		paxwarn(1, "Unable to allocate memory for user name cache table");
		return(-1);
	}
	return(0);
}

/*
 * grptb_start
 *	creates an empty grptb
 * Return:
 *	0 if ok, -1 otherwise
 */

int
grptb_start(void)
{
	static int fail = 0;

	if (grptb != NULL)
		return(0);
	if (fail)
		return(-1);
	if ((grptb = calloc(GNM_SZ, sizeof(GIDC *))) == NULL) {
		++fail;
		paxwarn(1,"Unable to allocate memory for group name cache table");
		return(-1);
	}
	return(0);
}

/*
 * uid_name()
 *	caches the uid for a given user name. We use a simple hash table.
 * Return
 *	the uid (if any) for a user name, or a -1 if no match can be found
 */

int
uid_name(char *name, uid_t *uid)
{
	struct passwd *pw;
	UIDC *ptr;
	int namelen;

	/*
	 * return -1 for mangled names
	 */
	if (((namelen = strlen(name)) == 0) || (name[0] == '\0'))
		return(-1);
	if ((usrtb == NULL) && (usrtb_start() < 0))
		return(-1);

	/*
	 * look up in hash table, if found and valid return the uid,
	 * if found and invalid, return a -1
	 */
	ptr = usrtb[st_hash(name, namelen, UNM_SZ)];
	if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
		if (ptr->valid == INVALID)
			return(-1);
		*uid = ptr->uid;
		return(0);
	}

	if (!pwopn) {
		setpassent(1);
		++pwopn;
	}

	if (ptr == NULL)
		ptr = usrtb[st_hash(name, namelen, UNM_SZ)] =
		  malloc(sizeof(UIDC));

	/*
	 * no match, look it up, if no match store it as an invalid entry,
	 * or store the matching uid
	 */
	if (ptr == NULL) {
		if ((pw = getpwnam(name)) == NULL)
			return(-1);
		*uid = pw->pw_uid;
		return(0);
	}
	(void)strlcpy(ptr->name, name, sizeof(ptr->name));
	if ((pw = getpwnam(name)) == NULL) {
		ptr->valid = INVALID;
		return(-1);
	}
	ptr->valid = VALID;
	*uid = ptr->uid = pw->pw_uid;
	return(0);
}

/*
 * gid_name()
 *	caches the gid for a given group name. We use a simple hash table.
 * Return
 *	the gid (if any) for a group name, or a -1 if no match can be found
 */

int
gid_name(char *name, gid_t *gid)
{
	struct group *gr;
	GIDC *ptr;
	int namelen;

	/*
	 * return -1 for mangled names
	 */
	if (((namelen = strlen(name)) == 0) || (name[0] == '\0'))
		return(-1);
	if ((grptb == NULL) && (grptb_start() < 0))
		return(-1);

	/*
	 * look up in hash table, if found and valid return the uid,
	 * if found and invalid, return a -1
	 */
	ptr = grptb[st_hash(name, namelen, GNM_SZ)];
	if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
		if (ptr->valid == INVALID)
			return(-1);
		*gid = ptr->gid;
		return(0);
	}

	if (!gropn) {
		setgroupent(1);
		++gropn;
	}
	if (ptr == NULL)
		ptr = grptb[st_hash(name, namelen, GNM_SZ)] =
		  malloc(sizeof(GIDC));

	/*
	 * no match, look it up, if no match store it as an invalid entry,
	 * or store the matching gid
	 */
	if (ptr == NULL) {
		if ((gr = getgrnam(name)) == NULL)
			return(-1);
		*gid = gr->gr_gid;
		return(0);
	}

	(void)strlcpy(ptr->name, name, sizeof(ptr->name));
	if ((gr = getgrnam(name)) == NULL) {
		ptr->valid = INVALID;
		return(-1);
	}
	ptr->valid = VALID;
	*gid = ptr->gid = gr->gr_gid;
	return(0);
}


Generated by: GCOVR (Version 3.3)

Line	Branch	Exec	Source
1			/* $OpenBSD: cache.c,v 1.23 2016/08/26 04:08:18 guenther Exp $ */
2			/* $NetBSD: cache.c,v 1.4 1995/03/21 09:07:10 cgd Exp $ */
3
4			/*-
5			* Copyright (c) 1992 Keith Muller.
6			* Copyright (c) 1992, 1993
7			* The Regents of the University of California. All rights reserved.
8			*
9			* This code is derived from software contributed to Berkeley by
10			* Keith Muller of the University of California, San Diego.
11			*
12			* Redistribution and use in source and binary forms, with or without
13			* modification, are permitted provided that the following conditions
14			* are met:
15			* 1. Redistributions of source code must retain the above copyright
16			* notice, this list of conditions and the following disclaimer.
17			* 2. Redistributions in binary form must reproduce the above copyright
18			* notice, this list of conditions and the following disclaimer in the
19			* documentation and/or other materials provided with the distribution.
20			* 3. Neither the name of the University nor the names of its contributors
21			* may be used to endorse or promote products derived from this software
22			* without specific prior written permission.
23			*
24			* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27			* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34			* SUCH DAMAGE.
35			*/
36
37			#include <sys/types.h>
38			#include <sys/stat.h>
39			#include <grp.h>
40			#include <pwd.h>
41			#include <stdio.h>
42			#include <stdlib.h>
43			#include <string.h>
44
45			#include "pax.h"
46			#include "extern.h"
47
48			/*
49			* Constants and data structures used to implement group and password file
50			* caches. Traditional passwd/group cache routines perform quite poorly with
51			* archives. The chances of hitting a valid lookup with an archive is quite a
52			* bit worse than with files already resident on the file system. These misses
53			* create a MAJOR performance cost. To address this problem, these routines
54			* cache both hits and misses.
55			*
56			* NOTE: name lengths must be as large as those stored in ANY PROTOCOL and
57			* as stored in the passwd and group files. CACHE SIZES MUST BE PRIME
58			*/
59			#define UNMLEN 32 /* >= user name found in any protocol */
60			#define GNMLEN 32 /* >= group name found in any protocol */
61			#define UNM_SZ 317 /* size of uid_name() cache */
62			#define GNM_SZ 317 /* size of gid_name() cache */
63			#define VALID 1 /* entry and name are valid */
64			#define INVALID 2 /* entry valid, name NOT valid */
65
66			/*
67			* Node structures used in the user, group, uid, and gid caches.
68			*/
69
70			typedef struct uidc {
71			int valid; /* is this a valid or a miss entry */
72			char name[UNMLEN]; /* uid name */
73			uid_t uid; /* cached uid */
74			} UIDC;
75
76			typedef struct gidc {
77			int valid; /* is this a valid or a miss entry */
78			char name[GNMLEN]; /* gid name */
79			gid_t gid; /* cached gid */
80			} GIDC;
81
82
83			/*
84			* routines that control user, group, uid and gid caches (for the archive
85			* member print routine).
86			* IMPORTANT:
87			* these routines cache BOTH hits and misses, a major performance improvement
88			*/
89
90			static int pwopn = 0; /* is password file open */
91			static int gropn = 0; /* is group file open */
92			static UIDC *usrtb = NULL; / user name to uid cache */
93			static GIDC *grptb = NULL; / group name to gid cache */
94
95			/*
96			* usrtb_start
97			* creates an empty usrtb
98			* Return:
99			* 0 if ok, -1 otherwise
100			*/
101
102			int
103			usrtb_start(void)
104			{
105			static int fail = 0;
106
107	✗✓	132	if (usrtb != NULL)
108			return(0);
109	✗✓	66	if (fail)
110			return(-1);
111	✗✓	66	if ((usrtb = calloc(UNM_SZ, sizeof(UIDC *))) == NULL) {
112			++fail;
113			paxwarn(1, "Unable to allocate memory for user name cache table");
114			return(-1);
115			}
116		66	return(0);
117		66	}
118
119			/*
120			* grptb_start
121			* creates an empty grptb
122			* Return:
123			* 0 if ok, -1 otherwise
124			*/
125
126			int
127			grptb_start(void)
128			{
129			static int fail = 0;
130
131	✗✓	132	if (grptb != NULL)
132			return(0);
133	✗✓	66	if (fail)
134			return(-1);
135	✗✓	66	if ((grptb = calloc(GNM_SZ, sizeof(GIDC *))) == NULL) {
136			++fail;
137			paxwarn(1,"Unable to allocate memory for group name cache table");
138			return(-1);
139			}
140		66	return(0);
141		66	}
142
143			/*
144			* uid_name()
145			* caches the uid for a given user name. We use a simple hash table.
146			* Return
147			* the uid (if any) for a user name, or a -1 if no match can be found
148			*/
149
150			int
151			uid_name(char name, uid_t uid)
152			{
153			struct passwd *pw;
154			UIDC *ptr;
155			int namelen;
156
157			/*
158			* return -1 for mangled names
159			*/
160	✓✓✗✓	816	if (((namelen = strlen(name)) == 0) \|\| (name[0] == '\0'))
161		12	return(-1);
162	✗✓✗✗	264	if ((usrtb == NULL) && (usrtb_start() < 0))
163			return(-1);
164
165			/*
166			* look up in hash table, if found and valid return the uid,
167			* if found and invalid, return a -1
168			*/
169		264	ptr = usrtb[st_hash(name, namelen, UNM_SZ)];
170	✓✓✓✗ ✓✗	672	if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
171	✓✓	204	if (ptr->valid == INVALID)
172		192	return(-1);
173		12	*uid = ptr->uid;
174		12	return(0);
175			}
176
177	✓✗	60	if (!pwopn) {
178		60	setpassent(1);
179		60	++pwopn;
180		60	}
181
182	✓✗	60	if (ptr == NULL)
183		60	ptr = usrtb[st_hash(name, namelen, UNM_SZ)] =
184		60	malloc(sizeof(UIDC));
185
186			/*
187			* no match, look it up, if no match store it as an invalid entry,
188			* or store the matching uid
189			*/
190	✗✓	60	if (ptr == NULL) {
191			if ((pw = getpwnam(name)) == NULL)
192			return(-1);
193			*uid = pw->pw_uid;
194			return(0);
195			}
196		60	(void)strlcpy(ptr->name, name, sizeof(ptr->name));
197	✓✓	60	if ((pw = getpwnam(name)) == NULL) {
198		12	ptr->valid = INVALID;
199		12	return(-1);
200			}
201		48	ptr->valid = VALID;
202		48	*uid = ptr->uid = pw->pw_uid;
203		48	return(0);
204		276	}
205
206			/*
207			* gid_name()
208			* caches the gid for a given group name. We use a simple hash table.
209			* Return
210			* the gid (if any) for a group name, or a -1 if no match can be found
211			*/
212
213			int
214			gid_name(char name, gid_t gid)
215			{
216			struct group *gr;
217			GIDC *ptr;
218			int namelen;
219
220			/*
221			* return -1 for mangled names
222			*/
223	✓✓✗✓	816	if (((namelen = strlen(name)) == 0) \|\| (name[0] == '\0'))
224		12	return(-1);
225	✗✓✗✗	264	if ((grptb == NULL) && (grptb_start() < 0))
226			return(-1);
227
228			/*
229			* look up in hash table, if found and valid return the uid,
230			* if found and invalid, return a -1
231			*/
232		264	ptr = grptb[st_hash(name, namelen, GNM_SZ)];
233	✓✓✓✗ ✓✗	672	if ((ptr != NULL) && (ptr->valid > 0) && !strcmp(name, ptr->name)) {
234	✓✓	204	if (ptr->valid == INVALID)
235		192	return(-1);
236		12	*gid = ptr->gid;
237		12	return(0);
238			}
239
240	✓✗	60	if (!gropn) {
241		60	setgroupent(1);
242		60	++gropn;
243		60	}
244	✓✗	60	if (ptr == NULL)
245		60	ptr = grptb[st_hash(name, namelen, GNM_SZ)] =
246		60	malloc(sizeof(GIDC));
247
248			/*
249			* no match, look it up, if no match store it as an invalid entry,
250			* or store the matching gid
251			*/
252	✗✓	60	if (ptr == NULL) {
253			if ((gr = getgrnam(name)) == NULL)
254			return(-1);
255			*gid = gr->gr_gid;
256			return(0);
257			}
258
259		60	(void)strlcpy(ptr->name, name, sizeof(ptr->name));
260	✓✓	60	if ((gr = getgrnam(name)) == NULL) {
261		12	ptr->valid = INVALID;
262		12	return(-1);
263			}
264		48	ptr->valid = VALID;
265		48	*gid = ptr->gid = gr->gr_gid;
266		48	return(0);
267		276	}