xref: /freebsd/usr.sbin/ngctl/list.c (revision 641a6cfb86023499caafe26a4d821a0b885cf00b)
1 
2 /*
3  * list.c
4  *
5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
6  * All rights reserved.
7  *
8  * Subject to the following obligations and disclaimer of warranty, use and
9  * redistribution of this software, in source or object code forms, with or
10  * without modifications are expressly permitted by Whistle Communications;
11  * provided, however, that:
12  * 1. Any and all reproductions of the source or object code must include the
13  *    copyright notice above and the following disclaimer of warranties; and
14  * 2. No rights are granted, in any manner or form, to use Whistle
15  *    Communications, Inc. trademarks, including the mark "WHISTLE
16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17  *    such appears in the above copyright notice or in the software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
35  * OF SUCH DAMAGE.
36  *
37  * $FreeBSD$
38  */
39 
40 #include <err.h>
41 #include <netgraph.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <unistd.h>
45 
46 #include "ngctl.h"
47 
48 #define UNNAMED		"<unnamed>"
49 
50 static int ListCmd(int ac, char **av);
51 
52 const struct ngcmd list_cmd = {
53 	ListCmd,
54 	"list [-ln]",
55 	"Show information about all nodes",
56 	"The list command shows information about every node that currently"
57 	" exists in the netgraph system. The optional -n argument limits"
58 	" this list to only those nodes with a global name assignment."
59 	" The optional -l argument provides verbose output that includes"
60 	" hook information as well.",
61 	{ "ls" }
62 };
63 
64 static int
65 ListCmd(int ac, char **av)
66 {
67 	struct ng_mesg *resp;
68 	struct namelist *nlist;
69 	struct nodeinfo *ninfo;
70 	int list_hooks = 0;
71 	int named_only = 0;
72 	int ch, rtn = CMDRTN_OK;
73 
74 	/* Get options */
75 	optind = 1;
76 	while ((ch = getopt(ac, av, "ln")) != -1) {
77 		switch (ch) {
78 		case 'l':
79 			list_hooks = 1;
80 			break;
81 		case 'n':
82 			named_only = 1;
83 			break;
84 		case '?':
85 		default:
86 			return (CMDRTN_USAGE);
87 			break;
88 		}
89 	}
90 	ac -= optind;
91 	av += optind;
92 
93 	/* Get arguments */
94 	switch (ac) {
95 	case 0:
96 		break;
97 	default:
98 		return (CMDRTN_USAGE);
99 	}
100 
101 	/* Get list of nodes */
102 	if (NgSendMsg(csock, ".", NGM_GENERIC_COOKIE,
103 	    named_only ? NGM_LISTNAMES : NGM_LISTNODES, NULL, 0) < 0) {
104 		warn("send msg");
105 		return (CMDRTN_ERROR);
106 	}
107 	if (NgAllocRecvMsg(csock, &resp, NULL) < 0) {
108 		warn("recv msg");
109 		return (CMDRTN_ERROR);
110 	}
111 
112 	/* Show each node */
113 	nlist = (struct namelist *) resp->data;
114 	printf("There are %d total %snodes:\n",
115 	    nlist->numnames, named_only ? "named " : "");
116 	ninfo = nlist->nodeinfo;
117 	if (list_hooks) {
118 		char	path[NG_PATHSIZ];
119 		char	*argv[2] = { "show", path };
120 
121 		while (nlist->numnames > 0) {
122 			snprintf(path, sizeof(path),
123 			    "[%lx]:", (u_long)ninfo->id);
124 			if ((rtn = (*show_cmd.func)(2, argv)) != CMDRTN_OK)
125 				break;
126 			ninfo++;
127 			nlist->numnames--;
128 		}
129 	} else {
130 		while (nlist->numnames > 0) {
131 			if (!*ninfo->name)
132 				snprintf(ninfo->name, sizeof(ninfo->name),
133 				    "%s", UNNAMED);
134 			printf("  Name: %-15s Type: %-15s ID: %08x   "
135 			    "Num hooks: %d\n",
136 			    ninfo->name, ninfo->type, ninfo->id, ninfo->hooks);
137 			ninfo++;
138 			nlist->numnames--;
139 		}
140 	}
141 
142 	/* Done */
143 	free(resp);
144 	return (rtn);
145 }
146 
147