1 .\" Copyright 2002-2007 Sandvine Inc.
2 .\" All rights reserved.
4 .\" Subject to the following obligations and disclaimer of warranty, use and
5 .\" redistribution of this software, in source or object code forms, with or
6 .\" without modifications are expressly permitted by Sandvine Inc.; provided,
8 .\" 1. Any and all reproductions of the source or object code must include the
9 .\" copyright notice above and the following disclaimer of warranties; and
10 .\" 2. No rights are granted, in any manner or form, to use Sandvine Inc.
11 .\" trademarks, including the mark "SANDVINE" on advertising, endorsements,
12 .\" or otherwise except as such appears in the above copyright notice or in
15 .\" THIS SOFTWARE IS BEING PROVIDED BY SANDVINE "AS IS", AND TO THE MAXIMUM
16 .\" EXTENT PERMITTED BY LAW, SANDVINE MAKES NO REPRESENTATIONS OR WARRANTIES,
17 .\" EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE, INCLUDING WITHOUT LIMITATION,
18 .\" ANY AND ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
19 .\" PURPOSE, OR NON-INFRINGEMENT. SANDVINE DOES NOT WARRANT, GUARANTEE, OR
20 .\" MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE
21 .\" USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY
22 .\" OR OTHERWISE. IN NO EVENT SHALL SANDVINE BE LIABLE FOR ANY DAMAGES
23 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
24 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
25 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
26 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
27 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 .\" THIS SOFTWARE, EVEN IF SANDVINE IS ADVISED OF THE POSSIBILITY OF SUCH
32 .\" Author: Dave Chapeskie
40 .Nd netgraph node for traffic generation
43 .In netgraph/ng_source.h
47 node acts as a source of packets according to the parameters set up
48 using control messages and input packets.
51 node type is used primarily for testing and benchmarking.
61 hook must remain connected, its disconnection will shutdown the node.
63 The operation of the node is as follows.
64 Packets received on the
66 hook are queued internally.
71 node assumes that its neighbour node is of
74 The neighbour is queried for its interface name.
77 node then uses queue of the interface for its evil purposes.
85 If interface name cannot be obtained automatically, it should
86 be configured explicitly with the
87 .Dv NGM_SOURCE_SETIFACE
90 should be turned off on
94 Once interface is configured, upon receipt of a
96 control message the node starts sending
97 the previously queued packets out the
99 hook on every clock tick as fast
100 as the connected interface will take them.
101 While active, on every clock tick the node checks the available space
102 in the interface queue and sends that many packets out its
105 Once the number of packets indicated in the start message has been
106 sent, or upon receipt of a
108 message, the node stops sending data.
110 This node type supports the generic control messages as well as the following,
111 which must be sent with the
112 .Dv NGM_SOURCE_COOKIE
114 .Bl -tag -width indent
115 .It Dv NGM_SOURCE_GET_STATS Pq Ic getstats
116 Returns a structure containing the following fields:
117 .Bl -tag -width indent
119 The number of octets/bytes sent out the
123 The number of frames/packets sent out the
127 The number of octets queued from the
131 The number of frames queued from the
135 The time the last start message was received.
137 The time the last end message was received or
138 the output packet count was reached.
141 .Va endTime Li \- Va startTime
146 .It Dv NGM_SOURCE_CLR_STATS Pq Ic clrstats
147 Clears and resets the statistics returned by
153 .It Dv NGM_SOURCE_GETCLR_STATS Pq Ic getclrstats
156 but clears the statistics at the same time.
157 .It Dv NGM_SOURCE_START Pq Ic start
158 This message requires a single
160 parameter which is the number of packets to
161 send before stopping.
162 Node starts sending the queued packets out the
167 hook must be connected and node must have
168 interface configured.
169 .It Dv NGM_SOURCE_STOP Pq Ic stop
170 Stops the node if it is active.
171 .It Dv NGM_SOURCE_CLR_DATA Pq Ic clrdata
172 Clears the packets queued from the
175 .It Dv NGM_SOURCE_SETIFACE Pq Ic setiface
176 This message requires the name of the interface
177 to be configured as an argument.
178 .It Dv NGM_SOURCE_SETPPS Pq Ic setpps
179 This message requires a single
181 parameter which puts upper limit on the amount of packets
183 .It Dv NGM_SOURCE_SET_TIMESTAMP Pq Ic settimestamp
184 This message specifies that a timestamp (in the format of a
185 .Vt "struct timeval" Ns )
186 should be inserted in the transmitted packets.
187 This message requires a structure containing the following fields:
188 .Bl -tag -width indent
190 The offset from the beginning of the packet at which the timestamp is to be
193 Set to 1 to enable the timestamp.
195 .It Dv NGM_SOURCE_GET_TIMESTAMP Pq Ic gettimestamp
196 Returns the current timestamp settings in the form of the structure described
198 .It Dv NGM_SOURCE_SET_COUNTER Pq Ic setcounter
199 This message specifies that a counter should be embedded in transmitted
201 Up to four counters may be independently configured.
202 This message requires a structure containing the following fields:
203 .Bl -tag -width indent
205 The offset from the beginning of the packet at which the counter is to be
208 Set to 1 to enable the counter.
210 The byte width of the counter. It may be 1, 2, or 4.
212 The value for the next insertion of the counter.
214 The minimum value to be used by the counter.
216 The maximum value to be used by the counter.
218 The value to be added to the counter after each insertion.
221 The counter to be configured, from 0 to 3.
223 .It Dv NGM_SOURCE_GET_COUNTER Pq Ic getcounter
224 This message requires a single
226 parameter which specifies the counter to query.
227 Returns the current counter settings in the form of the structure described
231 This node shuts down upon receipt of a
233 control message, when all hooks have been disconnected, or when the
235 hook has been disconnected.
237 Attach the node to an
239 node for an interface.
243 not already loaded you will need to do so.
244 For example, these commands
247 module and attach the
257 .Bd -literal -offset indent
259 ngctl mkpeer bge0: source orphans output
262 At this point the new node can be referred to as
263 .Dq Li bge0:orphans .
265 node can be given its own name like this:
267 .Dl "ngctl name bge0:orphans src0"
269 After which it can be referred to as
272 Once created, packets can be sent to the node as raw binary data.
273 Each packet must be delivered in a separate netgraph message.
275 The following example uses a short Perl script to convert the hex
276 representation of an ICMP packet to binary and deliver it to the
282 .Bd -literal -offset indent
283 perl -pe 's/(..)[ \et\en]*/chr(hex($1))/ge' <<EOF | nghook src0: input
284 ff ff ff ff ff ff 00 00 00 00 00 00 08 00 45 00
285 00 54 cb 13 00 00 40 01 b9 87 c0 a8 2b 65 0a 00
286 00 01 08 00 f8 d0 c9 76 00 00 45 37 01 73 00 01
287 04 0a 08 09 0a 0b 0c 0d 0e 0f 10 11 12 13 14 15
288 16 17 18 19 1a 1b 1c 1d 1e 1f 20 21 22 23 24 25
289 26 27 28 29 2a 2b 2c 2d 2e 2f 30 31 32 33 34 35
294 To check that the node has queued these packets you can get the node
296 .Bd -literal -offset indent
297 ngctl msg bge0:orphans getstats
298 Args: { queueOctets=64 queueFrames=1 }
301 Send as many packets as required out the
305 .Dl "ngctl msg bge0:orphans start 16"
307 Either wait for them to be sent (periodically fetching stats if desired)
308 or send the stop message:
310 .Dl "ngctl msg bge0:orphans stop"
312 Check the statistics (here we use
314 to also clear the statistics):
315 .Bd -literal -offset indent
316 ngctl msg bge0:orphans getclrstats
317 Args: { outOctets=1024 outFrames=16 queueOctets=64 queueFrames=1
318 startTime={ tv_sec=1035305880 tv_usec=758036 } endTime={ tv_sec=1035305880
319 tv_usec=759041 } elapsedTime={ tv_usec=1005 } }
323 .Vt "struct timeval" Ns s ,
326 field is seconds since
327 the Epoch and can be converted into a date string via TCL's [clock
331 .Bd -literal -offset indent
333 Tue Oct 22 12:58:00 EDT 2002
345 node type was implemented in