1 /* $NetBSD: getnetconfig.c,v 1.3 2000/07/06 03:10:34 christos Exp $ */
4 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5 * unrestricted use provided that this legend is included on all tape
6 * media and as a part of the software program in whole or part. Users
7 * may copy or modify Sun RPC without charge, but are not authorized
8 * to license or distribute it to anyone else except as part of a product or
9 * program developed by the user or with the express written consent of
10 * Sun Microsystems, Inc.
12 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
13 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
14 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
16 * Sun RPC is provided with no support and without any obligation on the
17 * part of Sun Microsystems, Inc. to assist in its use, correction,
18 * modification or enhancement.
20 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
21 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
22 * OR ANY PART THEREOF.
24 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
25 * or profits or other special, indirect and consequential damages, even if
26 * Sun has been advised of the possibility of such damages.
28 * Sun Microsystems, Inc.
30 * Mountain View, California 94043
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid[] = "@(#)getnetconfig.c 1.12 91/12/19 SMI";
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * Copyright (c) 1989 by Sun Microsystems, Inc.
43 #include "namespace.h"
44 #include "reentrant.h"
47 #include <netconfig.h>
53 #include "un-namespace.h"
57 * The five library routines in this file provide application access to the
58 * system network configuration database, /etc/netconfig. In addition to the
59 * netconfig database and the routines for accessing it, the environment
60 * variable NETPATH and its corresponding routines in getnetpath.c may also be
61 * used to specify the network transport to be used.
69 #define NC_NONETCONFIG ENOENT
70 #define NC_NOMEM ENOMEM
71 #define NC_NOTINIT EINVAL /* setnetconfig was not called first */
72 #define NC_BADFILE EBADF /* format for netconfig file is bad */
73 #define NC_NOTFOUND ENOPROTOOPT /* specified netid was not found */
76 * semantics as strings (should be in netconfig.h)
78 #define NC_TPI_CLTS_S "tpi_clts"
79 #define NC_TPI_COTS_S "tpi_cots"
80 #define NC_TPI_COTS_ORD_S "tpi_cots_ord"
81 #define NC_TPI_RAW_S "tpi_raw"
84 * flags as characters (also should be in netconfig.h)
86 #define NC_NOFLAG_C '-'
87 #define NC_VISIBLE_C 'v'
88 #define NC_BROADCAST_C 'b'
91 * Character used to indicate there is no name-to-address lookup library
93 #define NC_NOLOOKUP "-"
95 static const char * const _nc_errors[] = {
96 "Netconfig database not found",
99 "Netconfig database has invalid format",
100 "Netid not found in netconfig database"
103 struct netconfig_info {
104 int eof; /* all entries has been read */
105 int ref; /* # of times setnetconfig() has been called */
106 struct netconfig_list *head; /* head of the list */
107 struct netconfig_list *tail; /* last of the list */
110 struct netconfig_list {
111 char *linep; /* hold line read from netconfig */
112 struct netconfig *ncp;
113 struct netconfig_list *next;
116 struct netconfig_vars {
117 int valid; /* token that indicates a valid netconfig_vars */
118 int flag; /* first time flag */
119 struct netconfig_list *nc_configs; /* pointer to the current netconfig entry */
122 #define NC_VALID 0xfeed
123 #define NC_STORAGE 0xf00d
127 static int *__nc_error(void);
128 static int parse_ncp(char *, struct netconfig *);
129 static struct netconfig *dup_ncp(struct netconfig *);
132 static FILE *nc_file; /* for netconfig db */
133 static pthread_mutex_t nc_file_lock = PTHREAD_MUTEX_INITIALIZER;
135 static struct netconfig_info ni = { 0, 0, NULL, NULL};
136 static pthread_mutex_t ni_lock = PTHREAD_MUTEX_INITIALIZER;
139 #define MAXNETCONFIGLINE 1000
144 static pthread_mutex_t nc_lock = PTHREAD_MUTEX_INITIALIZER;
145 static thread_key_t nc_key = 0;
146 static int nc_error = 0;
150 * Use the static `nc_error' if we are the main thread
151 * (including non-threaded programs), or if an allocation
158 mutex_lock(&nc_lock);
160 error = thr_keycreate(&nc_key, free);
161 mutex_unlock(&nc_lock);
165 if ((nc_addr = (int *)thr_getspecific(nc_key)) == NULL) {
166 nc_addr = (int *)malloc(sizeof (int));
167 if (thr_setspecific(nc_key, (void *) nc_addr) != 0) {
177 #define nc_error (*(__nc_error()))
179 * A call to setnetconfig() establishes a /etc/netconfig "session". A session
180 * "handle" is returned on a successful call. At the start of a session (after
181 * a call to setnetconfig()) searches through the /etc/netconfig database will
182 * proceed from the start of the file. The session handle must be passed to
183 * getnetconfig() to parse the file. Each call to getnetconfig() using the
184 * current handle will process one subsequent entry in /etc/netconfig.
185 * setnetconfig() must be called before the first call to getnetconfig().
186 * (Handles are used to allow for nested calls to setnetpath()).
188 * A new session is established with each call to setnetconfig(), with a new
189 * handle being returned on each call. Previously established sessions remain
190 * active until endnetconfig() is called with that session's handle as an
193 * setnetconfig() need *not* be called before a call to getnetconfigent().
194 * setnetconfig() returns a NULL pointer on failure (for example, if
195 * the netconfig database is not present).
200 struct netconfig_vars *nc_vars;
202 if ((nc_vars = (struct netconfig_vars *)malloc(sizeof
203 (struct netconfig_vars))) == NULL) {
208 * For multiple calls, i.e. nc_file is not NULL, we just return the
209 * handle without reopening the netconfig db.
211 mutex_lock(&ni_lock);
213 mutex_unlock(&ni_lock);
215 mutex_lock(&nc_file_lock);
216 if ((nc_file != NULL) || (nc_file = fopen(NETCONFIG, "r")) != NULL) {
217 nc_vars->valid = NC_VALID;
219 nc_vars->nc_configs = ni.head;
220 mutex_unlock(&nc_file_lock);
221 return ((void *)nc_vars);
223 mutex_unlock(&nc_file_lock);
225 mutex_lock(&ni_lock);
227 mutex_unlock(&ni_lock);
229 nc_error = NC_NONETCONFIG;
236 * When first called, getnetconfig() returns a pointer to the first entry in
237 * the netconfig database, formatted as a struct netconfig. On each subsequent
238 * call, getnetconfig() returns a pointer to the next entry in the database.
239 * getnetconfig() can thus be used to search the entire netconfig file.
240 * getnetconfig() returns NULL at end of file.
244 getnetconfig(handlep)
247 struct netconfig_vars *ncp = (struct netconfig_vars *)handlep;
248 char *stringp; /* tmp string pointer */
249 struct netconfig_list *list;
250 struct netconfig *np;
251 struct netconfig *result;
254 * Verify that handle is valid
256 mutex_lock(&nc_file_lock);
257 if (ncp == NULL || nc_file == NULL) {
258 nc_error = NC_NOTINIT;
259 mutex_unlock(&nc_file_lock);
262 mutex_unlock(&nc_file_lock);
264 switch (ncp->valid) {
267 * If entry has already been read into the list,
268 * we return the entry in the linked list.
269 * If this is the first time call, check if there are any entries in
270 * linked list. If no entries, we need to read the netconfig db.
271 * If we have been here and the next entry is there, we just return
274 if (ncp->flag == 0) { /* first time */
276 mutex_lock(&ni_lock);
277 ncp->nc_configs = ni.head;
278 mutex_unlock(&ni_lock);
279 if (ncp->nc_configs != NULL) /* entry already exist */
280 return(ncp->nc_configs->ncp);
282 else if (ncp->nc_configs != NULL && ncp->nc_configs->next != NULL) {
283 ncp->nc_configs = ncp->nc_configs->next;
284 return(ncp->nc_configs->ncp);
288 * If we cannot find the entry in the list and is end of file,
291 mutex_lock(&ni_lock);
293 mutex_unlock(&ni_lock);
296 mutex_unlock(&ni_lock);
300 nc_error = NC_NOTINIT;
304 stringp = (char *) malloc(MAXNETCONFIGLINE);
309 if (malloc_verify() == 0) {
310 fprintf(stderr, "memory heap corrupted in getnetconfig\n");
316 * Read a line from netconfig file.
318 mutex_lock(&nc_file_lock);
320 if (fgets(stringp, MAXNETCONFIGLINE, nc_file) == NULL) {
322 mutex_lock(&ni_lock);
324 mutex_unlock(&ni_lock);
325 mutex_unlock(&nc_file_lock);
328 } while (*stringp == '#');
329 mutex_unlock(&nc_file_lock);
331 list = (struct netconfig_list *) malloc(sizeof (struct netconfig_list));
336 np = (struct netconfig *) malloc(sizeof (struct netconfig));
344 list->ncp->nc_lookups = NULL;
345 list->linep = stringp;
346 if (parse_ncp(stringp, list->ncp) == -1) {
354 * If this is the first entry that's been read, it is the head of
355 * the list. If not, put the entry at the end of the list.
356 * Reposition the current pointer of the handle to the last entry
359 mutex_lock(&ni_lock);
360 if (ni.head == NULL) { /* first entry */
361 ni.head = ni.tail = list;
364 ni.tail->next = list;
365 ni.tail = ni.tail->next;
367 ncp->nc_configs = ni.tail;
368 result = ni.tail->ncp;
369 mutex_unlock(&ni_lock);
375 * endnetconfig() may be called to "unbind" or "close" the netconfig database
376 * when processing is complete, releasing resources for reuse. endnetconfig()
377 * may not be called before setnetconfig(). endnetconfig() returns 0 on
378 * success and -1 on failure (for example, if setnetconfig() was not called
382 endnetconfig(handlep)
385 struct netconfig_vars *nc_handlep = (struct netconfig_vars *)handlep;
387 struct netconfig_list *q, *p;
390 * Verify that handle is valid
392 if (nc_handlep == NULL || (nc_handlep->valid != NC_VALID &&
393 nc_handlep->valid != NC_STORAGE)) {
394 nc_error = NC_NOTINIT;
399 * Return 0 if anyone still needs it.
401 nc_handlep->valid = NC_INVALID;
402 nc_handlep->flag = 0;
403 nc_handlep->nc_configs = NULL;
404 mutex_lock(&ni_lock);
406 mutex_unlock(&ni_lock);
412 * Noone needs these entries anymore, then frees them.
413 * Make sure all info in netconfig_info structure has been reinitialized.
419 mutex_unlock(&ni_lock);
423 if (q->ncp->nc_lookups != NULL) free(q->ncp->nc_lookups);
431 mutex_lock(&nc_file_lock);
434 mutex_unlock(&nc_file_lock);
440 * getnetconfigent(netid) returns a pointer to the struct netconfig structure
441 * corresponding to netid. It returns NULL if netid is invalid (that is, does
442 * not name an entry in the netconfig database). It returns NULL and sets
443 * errno in case of failure (for example, if the netconfig database cannot be
448 getnetconfigent(netid)
451 FILE *file; /* NETCONFIG db's file pointer */
452 char *linep; /* holds current netconfig line */
453 char *stringp; /* temporary string pointer */
454 struct netconfig *ncp = NULL; /* returned value */
455 struct netconfig_list *list; /* pointer to cache list */
457 nc_error = NC_NOTFOUND; /* default error. */
458 if (netid == NULL || strlen(netid) == 0) {
463 * Look up table if the entries have already been read and parsed in
464 * getnetconfig(), then copy this entry into a buffer and return it.
465 * If we cannot find the entry in the current list and there are more
466 * entries in the netconfig db that has not been read, we then read the
467 * db and try find the match netid.
468 * If all the netconfig db has been read and placed into the list and
469 * there is no match for the netid, return NULL.
471 mutex_lock(&ni_lock);
472 if (ni.head != NULL) {
473 for (list = ni.head; list; list = list->next) {
474 if (strcmp(list->ncp->nc_netid, netid) == 0) {
475 mutex_unlock(&ni_lock);
476 return(dup_ncp(list->ncp));
479 if (ni.eof == 1) { /* that's all the entries */
480 mutex_unlock(&ni_lock);
484 mutex_unlock(&ni_lock);
487 if ((file = fopen(NETCONFIG, "r")) == NULL) {
488 nc_error = NC_NONETCONFIG;
492 if ((linep = malloc(MAXNETCONFIGLINE)) == NULL) {
499 char *tmpp; /* tmp string pointer */
502 if ((stringp = fgets(linep, MAXNETCONFIGLINE, file)) == NULL) {
505 } while (*stringp == '#');
506 if (stringp == NULL) { /* eof */
509 if ((tmpp = strpbrk(stringp, "\t ")) == NULL) { /* can't parse file */
510 nc_error = NC_BADFILE;
513 if (strlen(netid) == (size_t) (len = tmpp - stringp) && /* a match */
514 strncmp(stringp, netid, (size_t)len) == 0) {
515 if ((ncp = (struct netconfig *)
516 malloc(sizeof (struct netconfig))) == NULL) {
519 ncp->nc_lookups = NULL;
520 if (parse_ncp(linep, ncp) == -1) {
526 } while (stringp != NULL);
535 * freenetconfigent(netconfigp) frees the netconfig structure pointed to by
536 * netconfigp (previously returned by getnetconfigent()).
540 freenetconfigent(netconfigp)
541 struct netconfig *netconfigp;
543 if (netconfigp != NULL) {
544 free(netconfigp->nc_netid); /* holds all netconfigp's strings */
545 if (netconfigp->nc_lookups != NULL)
546 free(netconfigp->nc_lookups);
553 * Parse line and stuff it in a struct netconfig
554 * Typical line might look like:
555 * udp tpi_cots vb inet udp /dev/udp /usr/lib/ip.so,/usr/local/ip.so
557 * We return -1 if any of the tokens don't parse, or malloc fails.
559 * Note that we modify stringp (putting NULLs after tokens) and
560 * we set the ncp's string field pointers to point to these tokens within
565 parse_ncp(stringp, ncp)
566 char *stringp; /* string to parse */
567 struct netconfig *ncp; /* where to put results */
569 char *tokenp; /* for processing tokens */
573 nc_error = NC_BADFILE; /* nearly anything that breaks is for this reason */
574 stringp[strlen(stringp)-1] = '\0'; /* get rid of newline */
576 if ((ncp->nc_netid = strtok_r(stringp, "\t ", &lasts)) == NULL) {
581 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
584 if (strcmp(tokenp, NC_TPI_COTS_ORD_S) == 0)
585 ncp->nc_semantics = NC_TPI_COTS_ORD;
586 else if (strcmp(tokenp, NC_TPI_COTS_S) == 0)
587 ncp->nc_semantics = NC_TPI_COTS;
588 else if (strcmp(tokenp, NC_TPI_CLTS_S) == 0)
589 ncp->nc_semantics = NC_TPI_CLTS;
590 else if (strcmp(tokenp, NC_TPI_RAW_S) == 0)
591 ncp->nc_semantics = NC_TPI_RAW;
596 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
599 for (ncp->nc_flag = NC_NOFLAG; *tokenp != '\0';
605 ncp->nc_flag |= NC_VISIBLE;
608 ncp->nc_flag |= NC_BROADCAST;
614 /* protocol family */
615 if ((ncp->nc_protofmly = strtok_r(NULL, "\t ", &lasts)) == NULL) {
619 if ((ncp->nc_proto = strtok_r(NULL, "\t ", &lasts)) == NULL) {
623 if ((ncp->nc_device = strtok_r(NULL, "\t ", &lasts)) == NULL) {
626 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
629 if (strcmp(tokenp, NC_NOLOOKUP) == 0) {
630 ncp->nc_nlookups = 0;
631 ncp->nc_lookups = NULL;
633 char *cp; /* tmp string */
635 if (ncp->nc_lookups != NULL) /* from last visit */
636 free(ncp->nc_lookups);
637 ncp->nc_lookups = NULL;
638 ncp->nc_nlookups = 0;
639 while ((cp = tokenp) != NULL) {
640 if ((nc_lookups = realloc(ncp->nc_lookups,
641 (ncp->nc_nlookups + 1) * sizeof *ncp->nc_lookups)) == NULL) {
642 free(ncp->nc_lookups);
643 ncp->nc_lookups = NULL;
646 tokenp = _get_next_token(cp, ',');
647 ncp->nc_lookups = nc_lookups;
648 ncp->nc_lookups[ncp->nc_nlookups++] = cp;
656 * Returns a string describing the reason for failure.
665 message = _nc_errors[0];
668 message = _nc_errors[1];
671 message = _nc_errors[2];
674 message = _nc_errors[3];
677 message = _nc_errors[4];
680 message = "Unknown network selection error";
682 /* LINTED const castaway */
683 return ((char *)message);
687 * Prints a message onto standard error describing the reason for failure.
693 fprintf(stderr, "%s: %s\n", s, nc_sperror());
697 * Duplicates the matched netconfig buffer.
699 static struct netconfig *
701 struct netconfig *ncp;
707 if ((tmp=malloc(MAXNETCONFIGLINE)) == NULL)
709 if ((p=(struct netconfig *)malloc(sizeof(struct netconfig))) == NULL) {
714 * First we dup all the data from matched netconfig buffer. Then we
715 * adjust some of the member pointer to a pre-allocated buffer where
716 * contains part of the data.
717 * To follow the convention used in parse_ncp(), we store all the
718 * necessary information in the pre-allocated buffer and let each
719 * of the netconfig char pointer member point to the right address
723 p->nc_netid = (char *)strcpy(tmp,ncp->nc_netid);
724 tmp = strchr(tmp, '\0') + 1;
725 p->nc_protofmly = (char *)strcpy(tmp,ncp->nc_protofmly);
726 tmp = strchr(tmp, '\0') + 1;
727 p->nc_proto = (char *)strcpy(tmp,ncp->nc_proto);
728 tmp = strchr(tmp, '\0') + 1;
729 p->nc_device = (char *)strcpy(tmp,ncp->nc_device);
730 p->nc_lookups = (char **)malloc((size_t)(p->nc_nlookups+1) * sizeof(char *));
731 if (p->nc_lookups == NULL) {
736 for (i=0; i < p->nc_nlookups; i++) {
737 tmp = strchr(tmp, '\0') + 1;
738 p->nc_lookups[i] = (char *)strcpy(tmp,ncp->nc_lookups[i]);