1 /* $NetBSD: getnetconfig.c,v 1.3 2000/07/06 03:10:34 christos Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (c) 2009, Sun Microsystems, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 * - Neither the name of Sun Microsystems, Inc. nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
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 mutex_t nc_file_lock = MUTEX_INITIALIZER;
135 static struct netconfig_info ni = { 0, 0, NULL, NULL};
136 static mutex_t ni_lock = MUTEX_INITIALIZER;
138 static thread_key_t nc_key;
139 static once_t nc_once = ONCE_INITIALIZER;
140 static int nc_key_error;
146 nc_key_error = thr_keycreate(&nc_key, free);
149 #define MAXNETCONFIGLINE 1000
154 static int nc_error = 0;
158 * Use the static `nc_error' if we are the main thread
159 * (including non-threaded programs), or if an allocation
164 if (thr_once(&nc_once, nc_key_init) != 0 || nc_key_error != 0)
166 if ((nc_addr = (int *)thr_getspecific(nc_key)) == NULL) {
167 nc_addr = (int *)malloc(sizeof (int));
168 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(void *handlep)
246 struct netconfig_vars *ncp = (struct netconfig_vars *)handlep;
247 char *stringp; /* tmp string pointer */
248 struct netconfig_list *list;
249 struct netconfig *np;
250 struct netconfig *result;
253 * Verify that handle is valid
255 mutex_lock(&nc_file_lock);
256 if (ncp == NULL || nc_file == NULL) {
257 nc_error = NC_NOTINIT;
258 mutex_unlock(&nc_file_lock);
261 mutex_unlock(&nc_file_lock);
263 switch (ncp->valid) {
266 * If entry has already been read into the list,
267 * we return the entry in the linked list.
268 * If this is the first time call, check if there are any entries in
269 * linked list. If no entries, we need to read the netconfig db.
270 * If we have been here and the next entry is there, we just return
273 if (ncp->flag == 0) { /* first time */
275 mutex_lock(&ni_lock);
276 ncp->nc_configs = ni.head;
277 mutex_unlock(&ni_lock);
278 if (ncp->nc_configs != NULL) /* entry already exist */
279 return(ncp->nc_configs->ncp);
281 else if (ncp->nc_configs != NULL && ncp->nc_configs->next != NULL) {
282 ncp->nc_configs = ncp->nc_configs->next;
283 return(ncp->nc_configs->ncp);
287 * If we cannot find the entry in the list and is end of file,
290 mutex_lock(&ni_lock);
292 mutex_unlock(&ni_lock);
295 mutex_unlock(&ni_lock);
299 nc_error = NC_NOTINIT;
303 stringp = (char *) malloc(MAXNETCONFIGLINE);
308 if (malloc_verify() == 0) {
309 fprintf(stderr, "memory heap corrupted in getnetconfig\n");
315 * Read a line from netconfig file.
317 mutex_lock(&nc_file_lock);
319 if (fgets(stringp, MAXNETCONFIGLINE, nc_file) == NULL) {
321 mutex_lock(&ni_lock);
323 mutex_unlock(&ni_lock);
324 mutex_unlock(&nc_file_lock);
327 } while (*stringp == '#');
328 mutex_unlock(&nc_file_lock);
330 list = (struct netconfig_list *) malloc(sizeof (struct netconfig_list));
335 np = (struct netconfig *) malloc(sizeof (struct netconfig));
343 list->ncp->nc_lookups = NULL;
344 list->linep = stringp;
345 if (parse_ncp(stringp, list->ncp) == -1) {
353 * If this is the first entry that's been read, it is the head of
354 * the list. If not, put the entry at the end of the list.
355 * Reposition the current pointer of the handle to the last entry
358 mutex_lock(&ni_lock);
359 if (ni.head == NULL) { /* first entry */
360 ni.head = ni.tail = list;
363 ni.tail->next = list;
364 ni.tail = ni.tail->next;
366 ncp->nc_configs = ni.tail;
367 result = ni.tail->ncp;
368 mutex_unlock(&ni_lock);
374 * endnetconfig() may be called to "unbind" or "close" the netconfig database
375 * when processing is complete, releasing resources for reuse. endnetconfig()
376 * may not be called before setnetconfig(). endnetconfig() returns 0 on
377 * success and -1 on failure (for example, if setnetconfig() was not called
381 endnetconfig(void *handlep)
383 struct netconfig_vars *nc_handlep = (struct netconfig_vars *)handlep;
385 struct netconfig_list *q, *p;
388 * Verify that handle is valid
390 if (nc_handlep == NULL || (nc_handlep->valid != NC_VALID &&
391 nc_handlep->valid != NC_STORAGE)) {
392 nc_error = NC_NOTINIT;
397 * Return 0 if anyone still needs it.
399 nc_handlep->valid = NC_INVALID;
400 nc_handlep->flag = 0;
401 nc_handlep->nc_configs = NULL;
402 mutex_lock(&ni_lock);
404 mutex_unlock(&ni_lock);
410 * No one needs these entries anymore, then frees them.
411 * Make sure all info in netconfig_info structure has been reinitialized.
417 mutex_unlock(&ni_lock);
421 free(q->ncp->nc_lookups);
429 mutex_lock(&nc_file_lock);
432 mutex_unlock(&nc_file_lock);
438 * getnetconfigent(netid) returns a pointer to the struct netconfig structure
439 * corresponding to netid. It returns NULL if netid is invalid (that is, does
440 * not name an entry in the netconfig database). It returns NULL and sets
441 * errno in case of failure (for example, if the netconfig database cannot be
446 getnetconfigent(const char *netid)
448 FILE *file; /* NETCONFIG db's file pointer */
449 char *linep; /* holds current netconfig line */
450 char *stringp; /* temporary string pointer */
451 struct netconfig *ncp = NULL; /* returned value */
452 struct netconfig_list *list; /* pointer to cache list */
454 nc_error = NC_NOTFOUND; /* default error. */
455 if (netid == NULL || strlen(netid) == 0) {
460 * Look up table if the entries have already been read and parsed in
461 * getnetconfig(), then copy this entry into a buffer and return it.
462 * If we cannot find the entry in the current list and there are more
463 * entries in the netconfig db that has not been read, we then read the
464 * db and try find the match netid.
465 * If all the netconfig db has been read and placed into the list and
466 * there is no match for the netid, return NULL.
468 mutex_lock(&ni_lock);
469 if (ni.head != NULL) {
470 for (list = ni.head; list; list = list->next) {
471 if (strcmp(list->ncp->nc_netid, netid) == 0) {
472 mutex_unlock(&ni_lock);
473 return(dup_ncp(list->ncp));
476 if (ni.eof == 1) { /* that's all the entries */
477 mutex_unlock(&ni_lock);
481 mutex_unlock(&ni_lock);
484 if ((file = fopen(NETCONFIG, "r")) == NULL) {
485 nc_error = NC_NONETCONFIG;
489 if ((linep = malloc(MAXNETCONFIGLINE)) == NULL) {
496 char *tmpp; /* tmp string pointer */
499 if ((stringp = fgets(linep, MAXNETCONFIGLINE, file)) == NULL) {
502 } while (*stringp == '#');
503 if (stringp == NULL) { /* eof */
506 if ((tmpp = strpbrk(stringp, "\t ")) == NULL) { /* can't parse file */
507 nc_error = NC_BADFILE;
510 if (strlen(netid) == (size_t) (len = tmpp - stringp) && /* a match */
511 strncmp(stringp, netid, (size_t)len) == 0) {
512 if ((ncp = (struct netconfig *)
513 malloc(sizeof (struct netconfig))) == NULL) {
516 ncp->nc_lookups = NULL;
517 if (parse_ncp(linep, ncp) == -1) {
523 } while (stringp != NULL);
532 * freenetconfigent(netconfigp) frees the netconfig structure pointed to by
533 * netconfigp (previously returned by getnetconfigent()).
537 freenetconfigent(struct netconfig *netconfigp)
539 if (netconfigp != NULL) {
540 free(netconfigp->nc_netid); /* holds all netconfigp's strings */
541 free(netconfigp->nc_lookups);
548 * Parse line and stuff it in a struct netconfig
549 * Typical line might look like:
550 * udp tpi_cots vb inet udp /dev/udp /usr/lib/ip.so,/usr/local/ip.so
552 * We return -1 if any of the tokens don't parse, or malloc fails.
554 * Note that we modify stringp (putting NULLs after tokens) and
555 * we set the ncp's string field pointers to point to these tokens within
558 * stringp - string to parse
559 * ncp - where to put results
563 parse_ncp(char *stringp, struct netconfig *ncp)
565 char *tokenp; /* for processing tokens */
569 nc_error = NC_BADFILE; /* nearly anything that breaks is for this reason */
570 stringp[strlen(stringp)-1] = '\0'; /* get rid of newline */
572 if ((ncp->nc_netid = strtok_r(stringp, "\t ", &lasts)) == NULL) {
577 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
580 if (strcmp(tokenp, NC_TPI_COTS_ORD_S) == 0)
581 ncp->nc_semantics = NC_TPI_COTS_ORD;
582 else if (strcmp(tokenp, NC_TPI_COTS_S) == 0)
583 ncp->nc_semantics = NC_TPI_COTS;
584 else if (strcmp(tokenp, NC_TPI_CLTS_S) == 0)
585 ncp->nc_semantics = NC_TPI_CLTS;
586 else if (strcmp(tokenp, NC_TPI_RAW_S) == 0)
587 ncp->nc_semantics = NC_TPI_RAW;
592 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
595 for (ncp->nc_flag = NC_NOFLAG; *tokenp != '\0';
601 ncp->nc_flag |= NC_VISIBLE;
604 ncp->nc_flag |= NC_BROADCAST;
610 /* protocol family */
611 if ((ncp->nc_protofmly = strtok_r(NULL, "\t ", &lasts)) == NULL) {
615 if ((ncp->nc_proto = strtok_r(NULL, "\t ", &lasts)) == NULL) {
619 if ((ncp->nc_device = strtok_r(NULL, "\t ", &lasts)) == NULL) {
622 if ((tokenp = strtok_r(NULL, "\t ", &lasts)) == NULL) {
625 if (strcmp(tokenp, NC_NOLOOKUP) == 0) {
626 ncp->nc_nlookups = 0;
627 ncp->nc_lookups = NULL;
629 char *cp; /* tmp string */
631 free(ncp->nc_lookups); /* from last visit */
632 ncp->nc_lookups = NULL;
633 ncp->nc_nlookups = 0;
634 while ((cp = tokenp) != NULL) {
635 if ((nc_lookups = reallocarray(ncp->nc_lookups,
636 ncp->nc_nlookups + 1, sizeof(*ncp->nc_lookups))) == NULL) {
637 free(ncp->nc_lookups);
638 ncp->nc_lookups = NULL;
641 tokenp = _get_next_token(cp, ',');
642 ncp->nc_lookups = nc_lookups;
643 ncp->nc_lookups[ncp->nc_nlookups++] = cp;
651 * Returns a string describing the reason for failure.
660 message = _nc_errors[0];
663 message = _nc_errors[1];
666 message = _nc_errors[2];
669 message = _nc_errors[3];
672 message = _nc_errors[4];
675 message = "Unknown network selection error";
677 /* LINTED const castaway */
678 return ((char *)message);
682 * Prints a message onto standard error describing the reason for failure.
685 nc_perror(const char *s)
687 fprintf(stderr, "%s: %s\n", s, nc_sperror());
691 * Duplicates the matched netconfig buffer.
693 static struct netconfig *
694 dup_ncp(struct netconfig *ncp)
700 if ((tmp=malloc(MAXNETCONFIGLINE)) == NULL)
702 if ((p=(struct netconfig *)malloc(sizeof(struct netconfig))) == NULL) {
707 * First we dup all the data from matched netconfig buffer. Then we
708 * adjust some of the member pointer to a pre-allocated buffer where
709 * contains part of the data.
710 * To follow the convention used in parse_ncp(), we store all the
711 * necessary information in the pre-allocated buffer and let each
712 * of the netconfig char pointer member point to the right address
716 p->nc_netid = (char *)strcpy(tmp,ncp->nc_netid);
717 tmp = strchr(tmp, '\0') + 1;
718 p->nc_protofmly = (char *)strcpy(tmp,ncp->nc_protofmly);
719 tmp = strchr(tmp, '\0') + 1;
720 p->nc_proto = (char *)strcpy(tmp,ncp->nc_proto);
721 tmp = strchr(tmp, '\0') + 1;
722 p->nc_device = (char *)strcpy(tmp,ncp->nc_device);
723 p->nc_lookups = (char **)malloc((size_t)(p->nc_nlookups+1) * sizeof(char *));
724 if (p->nc_lookups == NULL) {
729 for (i=0; i < p->nc_nlookups; i++) {
730 tmp = strchr(tmp, '\0') + 1;
731 p->nc_lookups[i] = (char *)strcpy(tmp,ncp->nc_lookups[i]);