/* * ng_source.h */ /*- * Copyright 2002 Sandvine 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 Sandvine Inc.; 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 Sandvine Inc. * trademarks, including the mark "SANDVINE" on advertising, endorsements, * or otherwise except as such appears in the above copyright notice or in * the software. * * THIS SOFTWARE IS BEING PROVIDED BY SANDVINE "AS IS", AND TO THE MAXIMUM * EXTENT PERMITTED BY LAW, SANDVINE 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. SANDVINE 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 SANDVINE 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 SANDVINE IS ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * * Author: Dave Chapeskie * * $FreeBSD$ */ #ifndef _NETGRAPH_NG_SOURCE_H_ #define _NETGRAPH_NG_SOURCE_H_ /* Node type name and magic cookie */ #define NG_SOURCE_NODE_TYPE "source" #define NGM_SOURCE_COOKIE 1034346805 /* Node-specific mbuf tags */ #define NG_SOURCE_TAG 1 /* Only one type of data */ /* Hook names */ #define NG_SOURCE_HOOK_INPUT "input" #define NG_SOURCE_HOOK_OUTPUT "output" /* Statistics structure returned by NGM_SOURCE_GET_STATS */ struct ng_source_stats { u_int64_t outOctets; u_int64_t outFrames; u_int32_t queueOctets; u_int32_t queueFrames; struct timeval startTime; struct timeval endTime; struct timeval elapsedTime; u_int32_t minEnqueuedPackets; u_int32_t maxEnqueuedPackets; u_int64_t interrupts; u_int64_t slowInterrupts; }; extern const struct ng_parse_type ng_source_timeval_type; /* Keep this in sync with the above structure definition */ #define NG_SOURCE_STATS_TYPE_INFO { \ { "outOctets", &ng_parse_uint64_type }, \ { "outFrames", &ng_parse_uint64_type }, \ { "queueOctets", &ng_parse_uint32_type }, \ { "queueFrames", &ng_parse_uint32_type }, \ { "startTime", &ng_source_timeval_type }, \ { "endTime", &ng_source_timeval_type }, \ { "elapsedTime", &ng_source_timeval_type }, \ { "minEnqueuedPackets", &ng_parse_uint32_type }, \ { "maxEnqueuedPackets", &ng_parse_uint32_type }, \ { "interrupts", &ng_parse_uint64_type }, \ { "slowInterrupts", &ng_parse_uint64_type }, \ { NULL } \ } /* Packet embedding info for NGM_SOURCE_SET/GET_CHKSUM/TIMESTAMP */ struct ng_source_embed_info { u_int16_t offset; /* offset from ethernet header */ u_int8_t flags; u_int8_t spare; #define NGM_SOURCE_EMBED_ENABLE 0x01 /* enable embedding */ #define NGM_SOURCE_INCREMENT_CNT_PER_LIST 0x02 /* increment once per list */ #define NGM_SOURCE_ADD_COUNTER_TO_PKT 0x04 /* add counter to packet */ #define NGM_SOURCE_MODIFY_IP_CHKSUM 0x10 /* adjust IP chksum */ #define NGM_SOURCE_MODIFY_UDP_CHKSUM 0x20 /* adjust UDP chksum */ #define NGM_SOURCE_MODIFY_TCP_CHKSUM 0x40 /* adjust TCP chksum */ #define NGM_SOURCE_MODIFY_ALL_CHKSUM (NGM_SOURCE_MODIFY_IP_CHKSUM \ | NGM_SOURCE_MODIFY_UDP_CHKSUM \ | NGM_SOURCE_MODIFY_TCP_CHKSUM) #ifdef _KERNEL #define NGM_SOURCE_FLAGS_PRINT "\20\1Enable\2IncrementPerList\3AddCounter5IP\6UDP\7TCP\n" #endif }; /* Keep this in sync with the above structure definition */ #define NG_SOURCE_EMBED_TYPE_INFO { \ { "offset", &ng_parse_hint16_type }, \ { "flags", &ng_parse_hint8_type }, \ { NULL } \ } /* Packet embedding info for NGM_SOURCE_SET/GET_COUNTER */ #define NG_SOURCE_COUNTERS 4 struct ng_source_embed_cnt_info { u_int16_t offset; /* offset from ethernet header */ u_int8_t flags; /* as above */ u_int8_t width; /* width in bytes (1, 2, 4) */ u_int32_t next_val; u_int32_t min_val; u_int32_t max_val; int32_t increment; u_int8_t index; /* which counter (0..3) */ }; extern const struct ng_parse_type ng_parse_uint32max_type; extern const struct ng_parse_type ng_parse_int32one_type; /* Keep this in sync with the above structure definition */ #define NG_SOURCE_EMBED_CNT_TYPE_INFO { \ { "offset", &ng_parse_hint16_type }, \ { "flags", &ng_parse_hint8_type }, \ { "width", &ng_parse_uint8_type }, \ { "next_val", &ng_parse_uint32_type }, \ { "min_val", &ng_parse_uint32_type }, \ { "max_val", &ng_parse_uint32_type }, \ { "increment", &ng_parse_int32_type }, \ { "index", &ng_parse_uint8_type }, \ { NULL } \ } /* Netgraph commands */ enum { NGM_SOURCE_GET_STATS = 1, /* get stats */ NGM_SOURCE_CLR_STATS, /* clear stats */ NGM_SOURCE_GETCLR_STATS, /* atomically get and clear stats */ NGM_SOURCE_START, /* start sending queued data */ NGM_SOURCE_STOP, /* stop sending queued data */ NGM_SOURCE_CLR_DATA, /* clear the queued data */ NGM_SOURCE_SHUTDOWN_MODE, /* does the node shutdown when the input hooks are all disconnected */ NGM_SOURCE_SET_MAX_OCTET_RATE, /* rate-limiting octets per second, */ NGM_SOURCE_GET_MAX_OCTET_RATE, /* zero for no limiting */ NGM_SOURCE_SET_COUNTER, /* embedded packet counter */ NGM_SOURCE_GET_COUNTER, NGM_SOURCE_SET_CHKSUM, /* embedded packet checksum */ NGM_SOURCE_GET_CHKSUM, NGM_SOURCE_SET_TIMESTAMP, /* embedded xmit timestamp */ NGM_SOURCE_GET_TIMESTAMP, NGM_SOURCE_START_NOW, /* start on non-ether output */ }; #endif /* _NETGRAPH_NG_SOURCE_H_ */