tcpreplay_opts.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. /* -*- buffer-read-only: t -*- vi: set ro:
  2. *
  3. * DO NOT EDIT THIS FILE (tcpreplay_opts.h)
  4. *
  5. * It has been AutoGen-ed
  6. * From the definitions tcpreplay_opts.def
  7. * and the template file options
  8. *
  9. * Generated from AutoOpts 41:0:16 templates.
  10. *
  11. * AutoOpts is a copyrighted work. This header file is not encumbered
  12. * by AutoOpts licensing, but is provided under the licensing terms chosen
  13. * by the tcpreplay author or copyright holder. AutoOpts is
  14. * licensed under the terms of the LGPL. The redistributable library
  15. * (``libopts'') is licensed under the terms of either the LGPL or, at the
  16. * users discretion, the BSD license. See the AutoOpts and/or libopts sources
  17. * for details.
  18. *
  19. * The tcpreplay program is copyrighted and licensed
  20. * under the following terms:
  21. *
  22. * Copyright (C) 2000-2017 Aaron Turner and Fred Klassen, all rights reserved.
  23. * This is free software. It is licensed for use, modification and
  24. * redistribution under the terms of the GNU General Public License,
  25. * version 3 or later <http://gnu.org/licenses/gpl.html>
  26. *
  27. * tcpreplay is free software: you can redistribute it and/or modify it
  28. * under the terms of the GNU General Public License as published by the
  29. * Free Software Foundation, either version 3 of the License, or
  30. * (at your option) any later version.
  31. *
  32. * tcpreplay is distributed in the hope that it will be useful, but
  33. * WITHOUT ANY WARRANTY; without even the implied warranty of
  34. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  35. * See the GNU General Public License for more details.
  36. *
  37. * You should have received a copy of the GNU General Public License along
  38. * with this program. If not, see <http://www.gnu.org/licenses/>.
  39. */
  40. /**
  41. * This file contains the programmatic interface to the Automated
  42. * Options generated for the tcpreplay program.
  43. * These macros are documented in the AutoGen info file in the
  44. * "AutoOpts" chapter. Please refer to that doc for usage help.
  45. */
  46. #ifndef AUTOOPTS_TCPREPLAY_OPTS_H_GUARD
  47. #define AUTOOPTS_TCPREPLAY_OPTS_H_GUARD 1
  48. #include "config.h"
  49. #include <autoopts/options.h>
  50. /**
  51. * Ensure that the library used for compiling this generated header is at
  52. * least as new as the version current when the header template was released
  53. * (not counting patch version increments). Also ensure that the oldest
  54. * tolerable version is at least as old as what was current when the header
  55. * template was released.
  56. */
  57. #define AO_TEMPLATE_VERSION 167936
  58. #if (AO_TEMPLATE_VERSION < OPTIONS_MINIMUM_VERSION) \
  59. || (AO_TEMPLATE_VERSION > OPTIONS_STRUCT_VERSION)
  60. # error option template version mismatches autoopts/options.h header
  61. Choke Me.
  62. #endif
  63. /**
  64. * Enumeration of each option type for tcpreplay
  65. */
  66. typedef enum {
  67. INDEX_OPT_DBUG = 0,
  68. INDEX_OPT_QUIET = 1,
  69. INDEX_OPT_TIMER = 2,
  70. INDEX_OPT_MAXSLEEP = 3,
  71. INDEX_OPT_VERBOSE = 4,
  72. INDEX_OPT_DECODE = 5,
  73. INDEX_OPT_PRELOAD_PCAP = 6,
  74. INDEX_OPT_CACHEFILE = 7,
  75. INDEX_OPT_DUALFILE = 8,
  76. INDEX_OPT_INTF1 = 9,
  77. INDEX_OPT_INTF2 = 10,
  78. INDEX_OPT_LISTNICS = 11,
  79. INDEX_OPT_LOOP = 12,
  80. INDEX_OPT_LOOPDELAY_MS = 13,
  81. INDEX_OPT_PKTLEN = 14,
  82. INDEX_OPT_LIMIT = 15,
  83. INDEX_OPT_DURATION = 16,
  84. INDEX_OPT_MULTIPLIER = 17,
  85. INDEX_OPT_PPS = 18,
  86. INDEX_OPT_MBPS = 19,
  87. INDEX_OPT_TOPSPEED = 20,
  88. INDEX_OPT_ONEATATIME = 21,
  89. INDEX_OPT_PPS_MULTI = 22,
  90. INDEX_OPT_UNIQUE_IP = 23,
  91. INDEX_OPT_UNIQUE_IP_LOOPS = 24,
  92. INDEX_OPT_NETMAP = 25,
  93. INDEX_OPT_NM_DELAY = 26,
  94. INDEX_OPT_NO_FLOW_STATS = 27,
  95. INDEX_OPT_FLOW_EXPIRY = 28,
  96. INDEX_OPT_PID = 29,
  97. INDEX_OPT_STATS = 30,
  98. INDEX_OPT_VERSION = 31,
  99. INDEX_OPT_LESS_HELP = 32,
  100. INDEX_OPT_HELP = 33,
  101. INDEX_OPT_MORE_HELP = 34,
  102. INDEX_OPT_SAVE_OPTS = 35,
  103. INDEX_OPT_LOAD_OPTS = 36
  104. } teOptIndex;
  105. /** count of all options for tcpreplay */
  106. #define OPTION_CT 37
  107. /**
  108. * Interface defines for all options. Replace "n" with the UPPER_CASED
  109. * option name (as in the teOptIndex enumeration above).
  110. * e.g. HAVE_OPT(DBUG)
  111. */
  112. #define DESC(n) (tcpreplayOptions.pOptDesc[INDEX_OPT_## n])
  113. /** 'true' if an option has been specified in any way */
  114. #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  115. /** The string argument to an option. The argument type must be \"string\". */
  116. #define OPT_ARG(n) (DESC(n).optArg.argString)
  117. /** Mask the option state revealing how an option was specified.
  118. * It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
  119. * \a OPTST_DEFINED, \a OPTST_RESET or zero.
  120. */
  121. #define STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
  122. /** Count of option's occurrances *on the command line*. */
  123. #define COUNT_OPT(n) (DESC(n).optOccCt)
  124. /** mask of \a OPTST_SET and \a OPTST_DEFINED. */
  125. #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
  126. /** 'true' if \a HAVE_OPT would yield 'false'. */
  127. #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
  128. /** 'true' if OPTST_DISABLED bit not set. */
  129. #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
  130. /** number of stacked option arguments.
  131. * Valid only for stacked option arguments. */
  132. #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
  133. /** stacked argument vector.
  134. * Valid only for stacked option arguments. */
  135. #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
  136. /** Reset an option. */
  137. #define CLEAR_OPT(n) STMTS( \
  138. DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \
  139. if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
  140. DESC(n).fOptState |= OPTST_DISABLED; \
  141. DESC(n).optCookie = NULL )
  142. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  143. /**
  144. * Enumeration of tcpreplay exit codes
  145. */
  146. typedef enum {
  147. TCPREPLAY_EXIT_SUCCESS = 0,
  148. TCPREPLAY_EXIT_FAILURE = 1,
  149. TCPREPLAY_EXIT_USAGE_ERROR = 64,
  150. TCPREPLAY_EXIT_NO_CONFIG_INPUT = 66,
  151. TCPREPLAY_EXIT_LIBOPTS_FAILURE = 70
  152. } tcpreplay_exit_code_t;
  153. /**
  154. * Interface defines for specific options.
  155. * @{
  156. */
  157. #define VALUE_OPT_DBUG 'd'
  158. #ifdef DEBUG
  159. #define OPT_VALUE_DBUG (DESC(DBUG).optArg.argInt)
  160. #endif /* DEBUG */
  161. #define VALUE_OPT_QUIET 'q'
  162. #define VALUE_OPT_TIMER 'T'
  163. #define VALUE_OPT_MAXSLEEP 0x1001
  164. #define OPT_VALUE_MAXSLEEP (DESC(MAXSLEEP).optArg.argInt)
  165. #define VALUE_OPT_VERBOSE 'v'
  166. #ifdef ENABLE_VERBOSE
  167. #define SET_OPT_VERBOSE STMTS( \
  168. DESC(VERBOSE).optActualIndex = 4; \
  169. DESC(VERBOSE).optActualValue = VALUE_OPT_VERBOSE; \
  170. DESC(VERBOSE).fOptState &= OPTST_PERSISTENT_MASK; \
  171. DESC(VERBOSE).fOptState |= OPTST_SET )
  172. #endif /* ENABLE_VERBOSE */
  173. #define VALUE_OPT_DECODE 'A'
  174. #define VALUE_OPT_PRELOAD_PCAP 'K'
  175. #define VALUE_OPT_CACHEFILE 'c'
  176. #define VALUE_OPT_DUALFILE '2'
  177. #define VALUE_OPT_INTF1 'i'
  178. #define VALUE_OPT_INTF2 'I'
  179. #define VALUE_OPT_LISTNICS 0x1002
  180. #define VALUE_OPT_LOOP 'l'
  181. #define OPT_VALUE_LOOP (DESC(LOOP).optArg.argInt)
  182. #define VALUE_OPT_LOOPDELAY_MS 0x1003
  183. #define OPT_VALUE_LOOPDELAY_MS (DESC(LOOPDELAY_MS).optArg.argInt)
  184. #define VALUE_OPT_PKTLEN 0x1004
  185. #define VALUE_OPT_LIMIT 'L'
  186. #define OPT_VALUE_LIMIT (DESC(LIMIT).optArg.argInt)
  187. #define VALUE_OPT_DURATION 0x1005
  188. #define OPT_VALUE_DURATION (DESC(DURATION).optArg.argInt)
  189. #define VALUE_OPT_MULTIPLIER 'x'
  190. #define VALUE_OPT_PPS 'p'
  191. #define VALUE_OPT_MBPS 'M'
  192. #define VALUE_OPT_TOPSPEED 't'
  193. #define VALUE_OPT_ONEATATIME 'o'
  194. #define VALUE_OPT_PPS_MULTI 0x1006
  195. #define OPT_VALUE_PPS_MULTI (DESC(PPS_MULTI).optArg.argInt)
  196. #define VALUE_OPT_UNIQUE_IP 0x1007
  197. #define VALUE_OPT_UNIQUE_IP_LOOPS 0x1008
  198. #define VALUE_OPT_NETMAP 0x1009
  199. #define VALUE_OPT_NM_DELAY 0x100A
  200. #ifdef HAVE_NETMAP
  201. #define OPT_VALUE_NM_DELAY (DESC(NM_DELAY).optArg.argInt)
  202. #endif /* HAVE_NETMAP */
  203. #define VALUE_OPT_NO_FLOW_STATS 0x100B
  204. #define VALUE_OPT_FLOW_EXPIRY 0x100C
  205. #define OPT_VALUE_FLOW_EXPIRY (DESC(FLOW_EXPIRY).optArg.argInt)
  206. #define VALUE_OPT_PID 'P'
  207. #define VALUE_OPT_STATS 0x100D
  208. #define OPT_VALUE_STATS (DESC(STATS).optArg.argInt)
  209. #define VALUE_OPT_VERSION 'V'
  210. #define VALUE_OPT_LESS_HELP 'h'
  211. /** option flag (value) for help-value option */
  212. #define VALUE_OPT_HELP 'H'
  213. /** option flag (value) for more-help-value option */
  214. #define VALUE_OPT_MORE_HELP '!'
  215. /** option flag (value) for save-opts-value option */
  216. #define VALUE_OPT_SAVE_OPTS 0x100E
  217. /** option flag (value) for load-opts-value option */
  218. #define VALUE_OPT_LOAD_OPTS 0x100F
  219. #define SET_OPT_SAVE_OPTS(a) STMTS( \
  220. DESC(SAVE_OPTS).fOptState &= OPTST_PERSISTENT_MASK; \
  221. DESC(SAVE_OPTS).fOptState |= OPTST_SET; \
  222. DESC(SAVE_OPTS).optArg.argString = (char const*)(a))
  223. /*
  224. * Interface defines not associated with particular options
  225. */
  226. #define ERRSKIP_OPTERR STMTS(tcpreplayOptions.fOptSet &= ~OPTPROC_ERRSTOP)
  227. #define ERRSTOP_OPTERR STMTS(tcpreplayOptions.fOptSet |= OPTPROC_ERRSTOP)
  228. #define RESTART_OPT(n) STMTS( \
  229. tcpreplayOptions.curOptIdx = (n); \
  230. tcpreplayOptions.pzCurOpt = NULL )
  231. #define START_OPT RESTART_OPT(1)
  232. #define USAGE(c) (*tcpreplayOptions.pUsageProc)(&tcpreplayOptions, c)
  233. #ifdef __cplusplus
  234. extern "C" {
  235. #endif
  236. /* * * * * *
  237. *
  238. * Declare the tcpreplay option descriptor.
  239. */
  240. extern tOptions tcpreplayOptions;
  241. #if defined(ENABLE_NLS)
  242. # ifndef _
  243. # include <stdio.h>
  244. # ifndef HAVE_GETTEXT
  245. extern char * gettext(char const *);
  246. # else
  247. # include <libintl.h>
  248. # endif
  249. # ifndef ATTRIBUTE_FORMAT_ARG
  250. # define ATTRIBUTE_FORMAT_ARG(_a)
  251. # endif
  252. static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
  253. static inline char* aoGetsText(char const* pz) {
  254. if (pz == NULL) return NULL;
  255. return (char*)gettext(pz);
  256. }
  257. # define _(s) aoGetsText(s)
  258. # endif /* _() */
  259. # define OPT_NO_XLAT_CFG_NAMES STMTS(tcpreplayOptions.fOptSet |= \
  260. OPTPROC_NXLAT_OPT_CFG;)
  261. # define OPT_NO_XLAT_OPT_NAMES STMTS(tcpreplayOptions.fOptSet |= \
  262. OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
  263. # define OPT_XLAT_CFG_NAMES STMTS(tcpreplayOptions.fOptSet &= \
  264. ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
  265. # define OPT_XLAT_OPT_NAMES STMTS(tcpreplayOptions.fOptSet &= \
  266. ~OPTPROC_NXLAT_OPT;)
  267. #else /* ENABLE_NLS */
  268. # define OPT_NO_XLAT_CFG_NAMES
  269. # define OPT_NO_XLAT_OPT_NAMES
  270. # define OPT_XLAT_CFG_NAMES
  271. # define OPT_XLAT_OPT_NAMES
  272. # ifndef _
  273. # define _(_s) _s
  274. # endif
  275. #endif /* ENABLE_NLS */
  276. #ifdef __cplusplus
  277. }
  278. #endif
  279. #endif /* AUTOOPTS_TCPREPLAY_OPTS_H_GUARD */
  280. /* tcpreplay_opts.h ends here */