f8307e1233
NGM_BINARY2ASCII, which convert control messages to ASCII and back. This allows control messages to be sent and received in ASCII form using ngctl(8), which makes ngctl a lot more useful. This also allows all the type-specific debugging code in libnetgraph to go away -- instead, we just ask the node itself to do the ASCII translation for us. Currently, all generic control messages are supported, as well as messages associated with the following node types: async, cisco, ksocket, and ppp. See /usr/share/examples/netgraph/ngctl for an example of using this. Also give ngctl(8) the ability to print out incoming data and control messages at any time. Eventually nghook(8) may be subsumed. Several other misc. bug fixes. Reviewed by: julian
312 lines
8.5 KiB
C
312 lines
8.5 KiB
C
|
|
/*
|
|
* msg.c
|
|
*
|
|
* Copyright (c) 1996-1999 Whistle Communications, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* Subject to the following obligations and disclaimer of warranty, use and
|
|
* redistribution of this software, in source or object code forms, with or
|
|
* without modifications are expressly permitted by Whistle Communications;
|
|
* provided, however, that:
|
|
* 1. Any and all reproductions of the source or object code must include the
|
|
* copyright notice above and the following disclaimer of warranties; and
|
|
* 2. No rights are granted, in any manner or form, to use Whistle
|
|
* Communications, Inc. trademarks, including the mark "WHISTLE
|
|
* COMMUNICATIONS" on advertising, endorsements, or otherwise except as
|
|
* such appears in the above copyright notice or in the software.
|
|
*
|
|
* THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
|
|
* TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
|
|
* REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
|
|
* INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
|
|
* WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
|
|
* REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
|
|
* SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
|
|
* IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
|
|
* RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
|
|
* WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
|
* PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER 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 WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
|
|
* OF SUCH DAMAGE.
|
|
*
|
|
* Author: Archie Cobbs <archie@whistle.com>
|
|
*
|
|
* $FreeBSD$
|
|
* $Whistle: msg.c,v 1.9 1999/01/20 00:57:23 archie Exp $
|
|
*/
|
|
|
|
#include <sys/types.h>
|
|
#include <stdarg.h>
|
|
#include <netgraph/ng_message.h>
|
|
#include <netgraph/ng_socket.h>
|
|
|
|
#include "netgraph.h"
|
|
#include "internal.h"
|
|
|
|
/* Next message token value */
|
|
static int gMsgId;
|
|
|
|
/* For delivering both messages and replies */
|
|
static int NgDeliverMsg(int cs, const char *path,
|
|
const struct ng_mesg *hdr, const void *args, size_t arglen);
|
|
|
|
/*
|
|
* Send a message to a node using control socket node "cs".
|
|
* Returns -1 if error and sets errno appropriately.
|
|
* If successful, returns the message ID (token) used.
|
|
*/
|
|
int
|
|
NgSendMsg(int cs, const char *path,
|
|
int cookie, int cmd, const void *args, size_t arglen)
|
|
{
|
|
struct ng_mesg msg;
|
|
|
|
/* Prepare message header */
|
|
memset(&msg, 0, sizeof(msg));
|
|
msg.header.version = NG_VERSION;
|
|
msg.header.typecookie = cookie;
|
|
msg.header.token = ++gMsgId;
|
|
msg.header.flags = NGF_ORIG;
|
|
msg.header.cmd = cmd;
|
|
snprintf(msg.header.cmdstr, NG_CMDSTRLEN + 1, "cmd%d", cmd);
|
|
|
|
/* Deliver message */
|
|
if (NgDeliverMsg(cs, path, &msg, args, arglen) < 0)
|
|
return (-1);
|
|
return(gMsgId);
|
|
}
|
|
|
|
/*
|
|
* Send a message given in ASCII format. We first ask the node to translate
|
|
* the command into binary, and then we send the binary.
|
|
*/
|
|
int
|
|
NgSendAsciiMsg(int cs, const char *path, const char *fmt, ...)
|
|
{
|
|
const int bufSize = 1024;
|
|
char replybuf[2 * sizeof(struct ng_mesg) + bufSize];
|
|
struct ng_mesg *const reply = (struct ng_mesg *)replybuf;
|
|
struct ng_mesg *const binary = (struct ng_mesg *)reply->data;
|
|
struct ng_mesg *ascii;
|
|
char *buf, *cmd, *args;
|
|
va_list fmtargs;
|
|
|
|
/* Parse out command and arguments */
|
|
va_start(fmtargs, fmt);
|
|
vasprintf(&buf, fmt, fmtargs);
|
|
va_end(fmtargs);
|
|
if (buf == NULL)
|
|
return (-1);
|
|
|
|
/* Parse out command, arguments */
|
|
for (cmd = buf; isspace(*cmd); cmd++)
|
|
;
|
|
for (args = cmd; *args != '\0' && !isspace(*args); args++)
|
|
;
|
|
if (*args != '\0') {
|
|
while (isspace(*args))
|
|
*args++ = '\0';
|
|
}
|
|
|
|
/* Get a bigger buffer to hold inner message header plus arg string */
|
|
if ((ascii = malloc(sizeof(struct ng_mesg)
|
|
+ strlen(buf) + 1)) == NULL) {
|
|
free(buf);
|
|
return (-1);
|
|
}
|
|
memset(ascii, 0, sizeof(*ascii));
|
|
|
|
/* Build inner header (only need cmdstr, arglen, and data fields) */
|
|
strncpy(ascii->header.cmdstr, cmd, sizeof(ascii->header.cmdstr) - 1);
|
|
strcpy(ascii->data, args);
|
|
ascii->header.arglen = strlen(ascii->data) + 1;
|
|
free(buf);
|
|
|
|
/* Send node a request to convert ASCII to binary */
|
|
if (NgSendMsg(cs, path, NGM_GENERIC_COOKIE, NGM_ASCII2BINARY,
|
|
(u_char *)ascii, sizeof(*ascii) + ascii->header.arglen) < 0)
|
|
return (-1);
|
|
|
|
/* Get reply */
|
|
if (NgRecvMsg(cs, reply, sizeof(replybuf), NULL) < 0)
|
|
return (-1);
|
|
|
|
/* Now send binary version */
|
|
return NgDeliverMsg(cs,
|
|
path, binary, binary->data, binary->header.arglen);
|
|
}
|
|
|
|
/*
|
|
* Send a message that is a reply to a previously received message.
|
|
* Returns -1 and sets errno on error, otherwise returns zero.
|
|
*/
|
|
int
|
|
NgSendReplyMsg(int cs, const char *path,
|
|
const struct ng_mesg *msg, const void *args, size_t arglen)
|
|
{
|
|
struct ng_mesg rep;
|
|
|
|
/* Prepare message header */
|
|
rep = *msg;
|
|
rep.header.flags = NGF_RESP;
|
|
|
|
/* Deliver message */
|
|
return (NgDeliverMsg(cs, path, &rep, args, arglen));
|
|
}
|
|
|
|
/*
|
|
* Send a message to a node using control socket node "cs".
|
|
* Returns -1 if error and sets errno appropriately, otherwise zero.
|
|
*/
|
|
static int
|
|
NgDeliverMsg(int cs, const char *path,
|
|
const struct ng_mesg *hdr, const void *args, size_t arglen)
|
|
{
|
|
u_char sgbuf[NG_PATHLEN + 3];
|
|
struct sockaddr_ng *const sg = (struct sockaddr_ng *) sgbuf;
|
|
u_char *buf = NULL;
|
|
struct ng_mesg *msg;
|
|
int errnosv = 0;
|
|
int rtn = 0;
|
|
|
|
/* Sanity check */
|
|
if (args == NULL)
|
|
arglen = 0;
|
|
|
|
/* Get buffer */
|
|
if ((buf = malloc(sizeof(*msg) + arglen)) == NULL) {
|
|
errnosv = errno;
|
|
if (_gNgDebugLevel >= 1)
|
|
NGLOG("malloc");
|
|
rtn = -1;
|
|
goto done;
|
|
}
|
|
msg = (struct ng_mesg *) buf;
|
|
|
|
/* Finalize message */
|
|
*msg = *hdr;
|
|
msg->header.arglen = arglen;
|
|
memcpy(msg->data, args, arglen);
|
|
|
|
/* Prepare socket address */
|
|
sg->sg_family = AF_NETGRAPH;
|
|
snprintf(sg->sg_data, NG_PATHLEN + 1, "%s", path);
|
|
sg->sg_len = strlen(sg->sg_data) + 3;
|
|
|
|
/* Debugging */
|
|
if (_gNgDebugLevel >= 2) {
|
|
NGLOGX("SENDING %s:",
|
|
(msg->header.flags & NGF_RESP) ? "RESPONSE" : "MESSAGE");
|
|
_NgDebugSockaddr(sg);
|
|
_NgDebugMsg(msg, sg->sg_data);
|
|
}
|
|
|
|
/* Send it */
|
|
if (sendto(cs, msg, sizeof(*msg) + arglen,
|
|
0, (struct sockaddr *) sg, sg->sg_len) < 0) {
|
|
errnosv = errno;
|
|
if (_gNgDebugLevel >= 1)
|
|
NGLOG("sendto(%s)", sg->sg_data);
|
|
rtn = -1;
|
|
goto done;
|
|
}
|
|
|
|
done:
|
|
/* Done */
|
|
free(buf); /* OK if buf is NULL */
|
|
errno = errnosv;
|
|
return (rtn);
|
|
}
|
|
|
|
/*
|
|
* Receive a control message.
|
|
*
|
|
* On error, this returns -1 and sets errno.
|
|
* Otherwise, it returns the length of the received reply.
|
|
*/
|
|
int
|
|
NgRecvMsg(int cs, struct ng_mesg *rep, size_t replen, char *path)
|
|
{
|
|
u_char sgbuf[NG_PATHLEN + sizeof(struct sockaddr_ng)];
|
|
struct sockaddr_ng *const sg = (struct sockaddr_ng *) sgbuf;
|
|
int len, sglen = sizeof(sgbuf);
|
|
int errnosv;
|
|
|
|
/* Read reply */
|
|
len = recvfrom(cs, rep, replen, 0, (struct sockaddr *) sg, &sglen);
|
|
if (len < 0) {
|
|
errnosv = errno;
|
|
if (_gNgDebugLevel >= 1)
|
|
NGLOG("recvfrom");
|
|
goto errout;
|
|
}
|
|
if (path != NULL)
|
|
snprintf(path, NG_PATHLEN + 1, "%s", sg->sg_data);
|
|
|
|
/* Debugging */
|
|
if (_gNgDebugLevel >= 2) {
|
|
NGLOGX("RECEIVED %s:",
|
|
(rep->header.flags & NGF_RESP) ? "RESPONSE" : "MESSAGE");
|
|
_NgDebugSockaddr(sg);
|
|
_NgDebugMsg(rep, sg->sg_data);
|
|
}
|
|
|
|
/* Done */
|
|
return (len);
|
|
|
|
errout:
|
|
errno = errnosv;
|
|
return (-1);
|
|
}
|
|
|
|
/*
|
|
* Receive a control message and convert the arguments to ASCII
|
|
*/
|
|
int
|
|
NgRecvAsciiMsg(int cs, struct ng_mesg *reply, size_t replen, char *path)
|
|
{
|
|
struct ng_mesg *msg, *ascii;
|
|
int bufSize, errnosv;
|
|
u_char *buf;
|
|
|
|
/* Allocate buffer */
|
|
bufSize = 2 * sizeof(*reply) + replen;
|
|
if ((buf = malloc(bufSize)) == NULL)
|
|
return (-1);
|
|
msg = (struct ng_mesg *)buf;
|
|
ascii = (struct ng_mesg *)msg->data;
|
|
|
|
/* Get binary message */
|
|
if (NgRecvMsg(cs, msg, bufSize, path) < 0)
|
|
goto fail;
|
|
memcpy(reply, msg, sizeof(*msg));
|
|
|
|
/* Ask originating node to convert the arguments to ASCII */
|
|
if (NgSendMsg(cs, path, NGM_GENERIC_COOKIE,
|
|
NGM_BINARY2ASCII, msg, sizeof(*msg) + msg->header.arglen) < 0)
|
|
goto fail;
|
|
if (NgRecvMsg(cs, msg, bufSize, NULL) < 0)
|
|
goto fail;
|
|
|
|
/* Copy result to client buffer */
|
|
if (sizeof(*ascii) + ascii->header.arglen > replen) {
|
|
errno = ERANGE;
|
|
fail:
|
|
errnosv = errno;
|
|
free(buf);
|
|
errno = errnosv;
|
|
return (-1);
|
|
}
|
|
strncpy(reply->data, ascii->data, ascii->header.arglen);
|
|
|
|
/* Done */
|
|
free(buf);
|
|
return (0);
|
|
}
|
|
|