4 * Copyright (c) 1996-1999 Whistle Communications, Inc.
7 * Subject to the following obligations and disclaimer of warranty, use and
8 * redistribution of this software, in source or object code forms, with or
9 * without modifications are expressly permitted by Whistle Communications;
10 * provided, however, that:
11 * 1. Any and all reproductions of the source or object code must include the
12 * copyright notice above and the following disclaimer of warranties; and
13 * 2. No rights are granted, in any manner or form, to use Whistle
14 * Communications, Inc. trademarks, including the mark "WHISTLE
15 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
16 * such appears in the above copyright notice or in the software.
18 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
19 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
20 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
21 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
23 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
24 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
25 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
26 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
27 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
28 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
29 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36 * Author: Archie Cobbs <archie@whistle.com>
38 * $Whistle: msg.c,v 1.9 1999/01/20 00:57:23 archie Exp $
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/types.h>
45 #include <sys/socket.h>
47 #include <stdatomic.h>
48 #include <netgraph/ng_message.h>
49 #include <netgraph/ng_socket.h>
54 /* Next message token value */
55 static _Atomic(unsigned int) gMsgId;
57 /* For delivering both messages and replies */
58 static int NgDeliverMsg(int cs, const char *path,
59 const struct ng_mesg *hdr, const void *args, size_t arglen);
62 * Send a message to a node using control socket node "cs".
63 * Returns -1 if error and sets errno appropriately.
64 * If successful, returns the message ID (token) used.
67 NgSendMsg(int cs, const char *path,
68 int cookie, int cmd, const void *args, size_t arglen)
72 /* Prepare message header */
73 memset(&msg, 0, sizeof(msg));
74 msg.header.version = NG_VERSION;
75 msg.header.typecookie = cookie;
76 msg.header.token = atomic_fetch_add(&gMsgId, 1) & INT_MAX;
77 msg.header.flags = NGF_ORIG;
79 snprintf((char *)msg.header.cmdstr, NG_CMDSTRSIZ, "cmd%d", cmd);
82 if (NgDeliverMsg(cs, path, &msg, args, arglen) < 0)
84 return (msg.header.token);
88 * Send a message given in ASCII format. We first ask the node to translate
89 * the command into binary, and then we send the binary.
92 NgSendAsciiMsg(int cs, const char *path, const char *fmt, ...)
94 struct ng_mesg *reply, *binary, *ascii;
95 char *buf, *cmd, *args;
99 /* Parse out command and arguments */
100 va_start(fmtargs, fmt);
101 vasprintf(&buf, fmt, fmtargs);
106 /* Parse out command, arguments */
107 for (cmd = buf; isspace(*cmd); cmd++)
109 for (args = cmd; *args != '\0' && !isspace(*args); args++)
112 while (isspace(*args))
116 /* Get a bigger buffer to hold inner message header plus arg string */
117 if ((ascii = malloc(sizeof(struct ng_mesg)
118 + strlen(args) + 1)) == NULL) {
122 memset(ascii, 0, sizeof(*ascii));
124 /* Build inner header (only need cmdstr, arglen, and data fields) */
125 strncpy((char *)ascii->header.cmdstr, cmd,
126 sizeof(ascii->header.cmdstr) - 1);
127 strcpy(ascii->data, args);
128 ascii->header.arglen = strlen(ascii->data) + 1;
131 /* Send node a request to convert ASCII to binary */
132 if (NgSendMsg(cs, path, NGM_GENERIC_COOKIE, NGM_ASCII2BINARY,
133 (u_char *)ascii, sizeof(*ascii) + ascii->header.arglen) < 0) {
140 if (NgAllocRecvMsg(cs, &reply, NULL) < 0)
143 /* Now send binary version */
144 binary = (struct ng_mesg *)reply->data;
145 binary->header.token = atomic_fetch_add(&gMsgId, 1) & INT_MAX;
146 binary->header.version = NG_VERSION;
148 path, binary, binary->data, binary->header.arglen) < 0) {
152 token = binary->header.token;
158 * Send a message that is a reply to a previously received message.
159 * Returns -1 and sets errno on error, otherwise returns zero.
162 NgSendReplyMsg(int cs, const char *path,
163 const struct ng_mesg *msg, const void *args, size_t arglen)
167 /* Prepare message header */
169 rep.header.flags = NGF_RESP;
171 /* Deliver message */
172 return (NgDeliverMsg(cs, path, &rep, args, arglen));
176 * Send a message to a node using control socket node "cs".
177 * Returns -1 if error and sets errno appropriately, otherwise zero.
180 NgDeliverMsg(int cs, const char *path,
181 const struct ng_mesg *hdr, const void *args, size_t arglen)
183 u_char sgbuf[NG_PATHSIZ + NGSA_OVERHEAD];
184 struct sockaddr_ng *const sg = (struct sockaddr_ng *) sgbuf;
195 if ((buf = malloc(sizeof(*msg) + arglen)) == NULL) {
197 if (_gNgDebugLevel >= 1)
202 msg = (struct ng_mesg *) buf;
204 /* Finalize message */
206 msg->header.arglen = arglen;
207 memcpy(msg->data, args, arglen);
209 /* Prepare socket address */
210 sg->sg_family = AF_NETGRAPH;
211 /* XXX handle overflow */
212 strlcpy(sg->sg_data, path, NG_PATHSIZ);
213 sg->sg_len = strlen(sg->sg_data) + 1 + NGSA_OVERHEAD;
216 if (_gNgDebugLevel >= 2) {
217 NGLOGX("SENDING %s:",
218 (msg->header.flags & NGF_RESP) ? "RESPONSE" : "MESSAGE");
219 _NgDebugSockaddr(sg);
220 _NgDebugMsg(msg, sg->sg_data);
224 if (sendto(cs, msg, sizeof(*msg) + arglen,
225 0, (struct sockaddr *) sg, sg->sg_len) < 0) {
227 if (_gNgDebugLevel >= 1)
228 NGLOG("sendto(%s)", sg->sg_data);
233 /* Wait for reply if there should be one. */
234 if (msg->header.cmd & NGM_HASREPLY && !(msg->header.flags & NGF_RESP)) {
239 rfds.events = POLLIN;
241 n = poll(&rfds, 1, INFTIM);
244 if (_gNgDebugLevel >= 1)
252 free(buf); /* OK if buf is NULL */
258 * Receive a control message.
260 * On error, this returns -1 and sets errno.
261 * Otherwise, it returns the length of the received reply.
264 NgRecvMsg(int cs, struct ng_mesg *rep, size_t replen, char *path)
266 u_char sgbuf[NG_PATHSIZ + NGSA_OVERHEAD];
267 struct sockaddr_ng *const sg = (struct sockaddr_ng *) sgbuf;
268 socklen_t sglen = sizeof(sgbuf);
272 len = recvfrom(cs, rep, replen, 0, (struct sockaddr *) sg, &sglen);
275 if (_gNgDebugLevel >= 1)
280 strlcpy(path, sg->sg_data, NG_PATHSIZ);
283 if (_gNgDebugLevel >= 2) {
284 NGLOGX("RECEIVED %s:",
285 (rep->header.flags & NGF_RESP) ? "RESPONSE" : "MESSAGE");
286 _NgDebugSockaddr(sg);
287 _NgDebugMsg(rep, sg->sg_data);
299 * Identical to NgRecvMsg() except buffer is dynamically allocated.
302 NgAllocRecvMsg(int cs, struct ng_mesg **rep, char *path)
307 optlen = sizeof(len);
308 if (getsockopt(cs, SOL_SOCKET, SO_RCVBUF, &len, &optlen) == -1 ||
309 (*rep = malloc(len)) == NULL)
311 if ((len = NgRecvMsg(cs, *rep, len, path)) < 0)
317 * Receive a control message and convert the arguments to ASCII
320 NgRecvAsciiMsg(int cs, struct ng_mesg *reply, size_t replen, char *path)
322 struct ng_mesg *msg, *ascii;
323 int bufSize, errnosv;
326 /* Allocate buffer */
327 bufSize = 2 * sizeof(*reply) + replen;
328 if ((buf = malloc(bufSize)) == NULL)
330 msg = (struct ng_mesg *)buf;
331 ascii = (struct ng_mesg *)msg->data;
333 /* Get binary message */
334 if (NgRecvMsg(cs, msg, bufSize, path) < 0)
336 memcpy(reply, msg, sizeof(*msg));
338 /* Ask originating node to convert the arguments to ASCII */
339 if (NgSendMsg(cs, path, NGM_GENERIC_COOKIE,
340 NGM_BINARY2ASCII, msg, sizeof(*msg) + msg->header.arglen) < 0)
342 if (NgRecvMsg(cs, msg, bufSize, NULL) < 0)
345 /* Copy result to client buffer */
346 if (sizeof(*ascii) + ascii->header.arglen > replen) {
354 strncpy(reply->data, ascii->data, ascii->header.arglen);
362 * Identical to NgRecvAsciiMsg() except buffer is dynamically allocated.
365 NgAllocRecvAsciiMsg(int cs, struct ng_mesg **reply, char *path)
370 optlen = sizeof(len);
371 if (getsockopt(cs, SOL_SOCKET, SO_RCVBUF, &len, &optlen) == -1 ||
372 (*reply = malloc(len)) == NULL)
374 if ((len = NgRecvAsciiMsg(cs, *reply, len, path)) < 0)