2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010 Maxim Ignatenko <gelraen.ua@gmail.com>
5 * Copyright (c) 2015 Dmitry Vagin <daemon.hammer@ya.ru>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/endian.h>
38 #include <sys/malloc.h>
42 #include <net/ethernet.h>
44 #include <netgraph/ng_message.h>
45 #include <netgraph/ng_parse.h>
46 #include <netgraph/netgraph.h>
48 #include <netgraph/ng_patch.h>
51 struct ng_patch_priv {
54 uint8_t dlt; /* DLT_XXX from bpf.h */
55 struct ng_patch_stats stats;
56 struct ng_patch_config *conf;
59 typedef struct ng_patch_priv *priv_p;
61 /* Netgraph methods */
62 static ng_constructor_t ng_patch_constructor;
63 static ng_rcvmsg_t ng_patch_rcvmsg;
64 static ng_shutdown_t ng_patch_shutdown;
65 static ng_newhook_t ng_patch_newhook;
66 static ng_rcvdata_t ng_patch_rcvdata;
67 static ng_disconnect_t ng_patch_disconnect;
69 #define ERROUT(x) { error = (x); goto done; }
72 ng_patch_config_getlen(const struct ng_parse_type *type,
73 const u_char *start, const u_char *buf)
75 const struct ng_patch_config *conf;
77 conf = (const struct ng_patch_config *)(buf -
78 offsetof(struct ng_patch_config, ops));
83 static const struct ng_parse_struct_field ng_patch_op_type_fields[]
85 static const struct ng_parse_type ng_patch_op_type = {
86 &ng_parse_struct_type,
87 &ng_patch_op_type_fields
90 static const struct ng_parse_array_info ng_patch_ops_array_info = {
92 &ng_patch_config_getlen
94 static const struct ng_parse_type ng_patch_ops_array_type = {
96 &ng_patch_ops_array_info
99 static const struct ng_parse_struct_field ng_patch_config_type_fields[]
100 = NG_PATCH_CONFIG_TYPE;
101 static const struct ng_parse_type ng_patch_config_type = {
102 &ng_parse_struct_type,
103 &ng_patch_config_type_fields
106 static const struct ng_parse_struct_field ng_patch_stats_fields[]
107 = NG_PATCH_STATS_TYPE;
108 static const struct ng_parse_type ng_patch_stats_type = {
109 &ng_parse_struct_type,
110 &ng_patch_stats_fields
113 static const struct ng_cmdlist ng_patch_cmdlist[] = {
125 &ng_parse_uint8_type,
133 &ng_patch_config_type
139 &ng_patch_config_type,
158 NGM_PATCH_GETCLR_STATS,
166 static struct ng_type typestruct = {
167 .version = NG_ABI_VERSION,
168 .name = NG_PATCH_NODE_TYPE,
169 .constructor = ng_patch_constructor,
170 .rcvmsg = ng_patch_rcvmsg,
171 .shutdown = ng_patch_shutdown,
172 .newhook = ng_patch_newhook,
173 .rcvdata = ng_patch_rcvdata,
174 .disconnect = ng_patch_disconnect,
175 .cmdlist = ng_patch_cmdlist,
178 NETGRAPH_INIT(patch, &typestruct);
181 ng_patch_constructor(node_p node)
185 privdata = malloc(sizeof(*privdata), M_NETGRAPH, M_WAITOK | M_ZERO);
186 privdata->dlt = DLT_RAW;
188 NG_NODE_SET_PRIVATE(node, privdata);
194 ng_patch_newhook(node_p node, hook_p hook, const char *name)
196 const priv_p privp = NG_NODE_PRIVATE(node);
198 if (strncmp(name, NG_PATCH_HOOK_IN, strlen(NG_PATCH_HOOK_IN)) == 0) {
200 } else if (strncmp(name, NG_PATCH_HOOK_OUT,
201 strlen(NG_PATCH_HOOK_OUT)) == 0) {
210 ng_patch_rcvmsg(node_p node, item_p item, hook_p lasthook)
212 const priv_p privp = NG_NODE_PRIVATE(node);
213 struct ng_patch_config *conf, *newconf;
215 struct ng_mesg *resp = NULL;
218 NGI_GET_MSG(item, msg);
220 if (msg->header.typecookie != NGM_PATCH_COOKIE)
223 switch (msg->header.cmd)
225 case NGM_PATCH_GETCONFIG:
226 if (privp->conf == NULL)
229 NG_MKRESPONSE(resp, msg,
230 NG_PATCH_CONF_SIZE(privp->conf->count), M_WAITOK);
235 bcopy(privp->conf, resp->data,
236 NG_PATCH_CONF_SIZE(privp->conf->count));
238 conf = (struct ng_patch_config *) resp->data;
240 for (i = 0; i < conf->count; i++) {
241 switch (conf->ops[i].length)
244 conf->ops[i].val.v8 = conf->ops[i].val.v1;
247 conf->ops[i].val.v8 = conf->ops[i].val.v2;
250 conf->ops[i].val.v8 = conf->ops[i].val.v4;
259 case NGM_PATCH_SETCONFIG:
260 conf = (struct ng_patch_config *) msg->data;
262 if (msg->header.arglen < sizeof(struct ng_patch_config) ||
263 msg->header.arglen < NG_PATCH_CONF_SIZE(conf->count))
266 for (i = 0; i < conf->count; i++) {
267 switch (conf->ops[i].length)
270 conf->ops[i].val.v1 = (uint8_t) conf->ops[i].val.v8;
273 conf->ops[i].val.v2 = (uint16_t) conf->ops[i].val.v8;
276 conf->ops[i].val.v4 = (uint32_t) conf->ops[i].val.v8;
285 conf->csum_flags &= NG_PATCH_CSUM_IPV4|NG_PATCH_CSUM_IPV6;
286 conf->relative_offset = !!conf->relative_offset;
288 newconf = malloc(NG_PATCH_CONF_SIZE(conf->count), M_NETGRAPH, M_WAITOK | M_ZERO);
290 bcopy(conf, newconf, NG_PATCH_CONF_SIZE(conf->count));
293 free(privp->conf, M_NETGRAPH);
295 privp->conf = newconf;
299 case NGM_PATCH_GET_STATS:
300 case NGM_PATCH_CLR_STATS:
301 case NGM_PATCH_GETCLR_STATS:
302 if (msg->header.cmd != NGM_PATCH_CLR_STATS) {
303 NG_MKRESPONSE(resp, msg, sizeof(struct ng_patch_stats), M_WAITOK);
308 bcopy(&(privp->stats), resp->data, sizeof(struct ng_patch_stats));
311 if (msg->header.cmd != NGM_PATCH_GET_STATS)
312 bzero(&(privp->stats), sizeof(struct ng_patch_stats));
316 case NGM_PATCH_GETDLT:
317 NG_MKRESPONSE(resp, msg, sizeof(uint8_t), M_WAITOK);
322 *((uint8_t *) resp->data) = privp->dlt;
326 case NGM_PATCH_SETDLT:
327 if (msg->header.arglen != sizeof(uint8_t))
330 switch (*(uint8_t *) msg->data)
334 privp->dlt = *(uint8_t *) msg->data;
348 NG_RESPOND_MSG(error, node, item, resp);
355 do_patch(priv_p privp, struct mbuf *m, int global_offset)
357 int i, offset, patched = 0;
358 union ng_patch_op_val val;
360 for (i = 0; i < privp->conf->count; i++) {
361 offset = global_offset + privp->conf->ops[i].offset;
363 if (offset + privp->conf->ops[i].length > m->m_pkthdr.len)
366 /* for "=" operation we don't need to copy data from mbuf */
367 if (privp->conf->ops[i].mode != NG_PATCH_MODE_SET)
368 m_copydata(m, offset, privp->conf->ops[i].length, (caddr_t) &val);
370 switch (privp->conf->ops[i].length)
373 switch (privp->conf->ops[i].mode)
375 case NG_PATCH_MODE_SET:
376 val.v1 = privp->conf->ops[i].val.v1;
378 case NG_PATCH_MODE_ADD:
379 val.v1 += privp->conf->ops[i].val.v1;
381 case NG_PATCH_MODE_SUB:
382 val.v1 -= privp->conf->ops[i].val.v1;
384 case NG_PATCH_MODE_MUL:
385 val.v1 *= privp->conf->ops[i].val.v1;
387 case NG_PATCH_MODE_DIV:
388 val.v1 /= privp->conf->ops[i].val.v1;
390 case NG_PATCH_MODE_NEG:
391 *((int8_t *) &val) = - *((int8_t *) &val);
393 case NG_PATCH_MODE_AND:
394 val.v1 &= privp->conf->ops[i].val.v1;
396 case NG_PATCH_MODE_OR:
397 val.v1 |= privp->conf->ops[i].val.v1;
399 case NG_PATCH_MODE_XOR:
400 val.v1 ^= privp->conf->ops[i].val.v1;
402 case NG_PATCH_MODE_SHL:
403 val.v1 <<= privp->conf->ops[i].val.v1;
405 case NG_PATCH_MODE_SHR:
406 val.v1 >>= privp->conf->ops[i].val.v1;
412 val.v2 = ntohs(val.v2);
414 switch (privp->conf->ops[i].mode)
416 case NG_PATCH_MODE_SET:
417 val.v2 = privp->conf->ops[i].val.v2;
419 case NG_PATCH_MODE_ADD:
420 val.v2 += privp->conf->ops[i].val.v2;
422 case NG_PATCH_MODE_SUB:
423 val.v2 -= privp->conf->ops[i].val.v2;
425 case NG_PATCH_MODE_MUL:
426 val.v2 *= privp->conf->ops[i].val.v2;
428 case NG_PATCH_MODE_DIV:
429 val.v2 /= privp->conf->ops[i].val.v2;
431 case NG_PATCH_MODE_NEG:
432 *((int16_t *) &val) = - *((int16_t *) &val);
434 case NG_PATCH_MODE_AND:
435 val.v2 &= privp->conf->ops[i].val.v2;
437 case NG_PATCH_MODE_OR:
438 val.v2 |= privp->conf->ops[i].val.v2;
440 case NG_PATCH_MODE_XOR:
441 val.v2 ^= privp->conf->ops[i].val.v2;
443 case NG_PATCH_MODE_SHL:
444 val.v2 <<= privp->conf->ops[i].val.v2;
446 case NG_PATCH_MODE_SHR:
447 val.v2 >>= privp->conf->ops[i].val.v2;
451 val.v2 = htons(val.v2);
456 val.v4 = ntohl(val.v4);
458 switch (privp->conf->ops[i].mode)
460 case NG_PATCH_MODE_SET:
461 val.v4 = privp->conf->ops[i].val.v4;
463 case NG_PATCH_MODE_ADD:
464 val.v4 += privp->conf->ops[i].val.v4;
466 case NG_PATCH_MODE_SUB:
467 val.v4 -= privp->conf->ops[i].val.v4;
469 case NG_PATCH_MODE_MUL:
470 val.v4 *= privp->conf->ops[i].val.v4;
472 case NG_PATCH_MODE_DIV:
473 val.v4 /= privp->conf->ops[i].val.v4;
475 case NG_PATCH_MODE_NEG:
476 *((int32_t *) &val) = - *((int32_t *) &val);
478 case NG_PATCH_MODE_AND:
479 val.v4 &= privp->conf->ops[i].val.v4;
481 case NG_PATCH_MODE_OR:
482 val.v4 |= privp->conf->ops[i].val.v4;
484 case NG_PATCH_MODE_XOR:
485 val.v4 ^= privp->conf->ops[i].val.v4;
487 case NG_PATCH_MODE_SHL:
488 val.v4 <<= privp->conf->ops[i].val.v4;
490 case NG_PATCH_MODE_SHR:
491 val.v4 >>= privp->conf->ops[i].val.v4;
495 val.v4 = htonl(val.v4);
500 val.v8 = be64toh(val.v8);
502 switch (privp->conf->ops[i].mode)
504 case NG_PATCH_MODE_SET:
505 val.v8 = privp->conf->ops[i].val.v8;
507 case NG_PATCH_MODE_ADD:
508 val.v8 += privp->conf->ops[i].val.v8;
510 case NG_PATCH_MODE_SUB:
511 val.v8 -= privp->conf->ops[i].val.v8;
513 case NG_PATCH_MODE_MUL:
514 val.v8 *= privp->conf->ops[i].val.v8;
516 case NG_PATCH_MODE_DIV:
517 val.v8 /= privp->conf->ops[i].val.v8;
519 case NG_PATCH_MODE_NEG:
520 *((int64_t *) &val) = - *((int64_t *) &val);
522 case NG_PATCH_MODE_AND:
523 val.v8 &= privp->conf->ops[i].val.v8;
525 case NG_PATCH_MODE_OR:
526 val.v8 |= privp->conf->ops[i].val.v8;
528 case NG_PATCH_MODE_XOR:
529 val.v8 ^= privp->conf->ops[i].val.v8;
531 case NG_PATCH_MODE_SHL:
532 val.v8 <<= privp->conf->ops[i].val.v8;
534 case NG_PATCH_MODE_SHR:
535 val.v8 >>= privp->conf->ops[i].val.v8;
539 val.v8 = htobe64(val.v8);
544 m_copyback(m, offset, privp->conf->ops[i].length, (caddr_t) &val);
549 privp->stats.patched++;
553 ng_patch_rcvdata(hook_p hook, item_p item)
555 const priv_p priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
561 priv->stats.received++;
565 #define PULLUP_CHECK(mbuf, length) do { \
566 pullup_len += length; \
567 if (((mbuf)->m_pkthdr.len < pullup_len) || \
568 (pullup_len > MHLEN)) { \
572 if ((mbuf)->m_len < pullup_len && \
573 (((mbuf) = m_pullup((mbuf), pullup_len)) == NULL)) { \
579 if (priv->conf && hook == priv->in &&
580 m && (m->m_flags & M_PKTHDR)) {
582 m = m_unshare(m, M_NOWAIT);
587 if (priv->conf->relative_offset) {
588 struct ether_header *eh;
589 struct ng_patch_vlan_header *vh;
595 PULLUP_CHECK(m, sizeof(struct ether_header));
596 eh = mtod(m, struct ether_header *);
597 etype = ntohs(eh->ether_type);
599 for (;;) { /* QinQ support */
605 PULLUP_CHECK(m, sizeof(struct ng_patch_vlan_header));
606 vh = (struct ng_patch_vlan_header *) mtodo(m,
607 pullup_len - sizeof(struct ng_patch_vlan_header));
608 etype = ntohs(vh->etype);
626 do_patch(priv, m, pullup_len);
628 m->m_pkthdr.csum_flags |= priv->conf->csum_flags;
636 if (hook == priv->in) {
637 /* return frames on 'in' hook if 'out' not connected */
638 out = priv->out ? priv->out : priv->in;
639 } else if (hook == priv->out && priv->in) {
640 /* pass frames on 'out' hook if 'in' connected */
647 NG_FWD_NEW_DATA(error, item, out, m);
656 priv->stats.dropped++;
662 ng_patch_shutdown(node_p node)
664 const priv_p privdata = NG_NODE_PRIVATE(node);
666 NG_NODE_SET_PRIVATE(node, NULL);
669 if (privdata->conf != NULL)
670 free(privdata->conf, M_NETGRAPH);
672 free(privdata, M_NETGRAPH);
678 ng_patch_disconnect(hook_p hook)
682 priv = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
684 if (hook == priv->in) {
688 if (hook == priv->out) {
692 if (NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0 &&
693 NG_NODE_IS_VALID(NG_HOOK_NODE(hook))) /* already shutting down? */
694 ng_rmnode_self(NG_HOOK_NODE(hook));