tcpbridge_opts.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. /* -*- buffer-read-only: t -*- vi: set ro:
  2. *
  3. * DO NOT EDIT THIS FILE (tcpbridge_opts.h)
  4. *
  5. * It has been AutoGen-ed
  6. * From the definitions tcpbridge_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 tcpbridge 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 tcpbridge 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. * tcpbridge 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. * tcpbridge 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 tcpbridge 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_TCPBRIDGE_OPTS_H_GUARD
  47. #define AUTOOPTS_TCPBRIDGE_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 tcpbridge
  65. */
  66. typedef enum {
  67. INDEX_OPT_PORTMAP = 1,
  68. INDEX_OPT_SEED = 2,
  69. INDEX_OPT_PNAT = 3,
  70. INDEX_OPT_SRCIPMAP = 4,
  71. INDEX_OPT_DSTIPMAP = 5,
  72. INDEX_OPT_ENDPOINTS = 6,
  73. INDEX_OPT_SKIPBROADCAST = 7,
  74. INDEX_OPT_FIXCSUM = 8,
  75. INDEX_OPT_MTU = 9,
  76. INDEX_OPT_MTU_TRUNC = 10,
  77. INDEX_OPT_EFCS = 11,
  78. INDEX_OPT_TTL = 12,
  79. INDEX_OPT_TOS = 13,
  80. INDEX_OPT_TCLASS = 14,
  81. INDEX_OPT_FLOWLABEL = 15,
  82. INDEX_OPT_FIXLEN = 16,
  83. INDEX_OPT_FUZZ_SEED = 17,
  84. INDEX_OPT_SKIPL2BROADCAST = 18,
  85. INDEX_OPT_DLT = 19,
  86. INDEX_OPT_ENET_DMAC = 20,
  87. INDEX_OPT_ENET_SMAC = 21,
  88. INDEX_OPT_ENET_SUBSMAC = 22,
  89. INDEX_OPT_ENET_MAC_SEED = 23,
  90. INDEX_OPT_ENET_MAC_SEED_KEEP_BYTES = 24,
  91. INDEX_OPT_ENET_VLAN = 25,
  92. INDEX_OPT_ENET_VLAN_TAG = 26,
  93. INDEX_OPT_ENET_VLAN_CFI = 27,
  94. INDEX_OPT_ENET_VLAN_PRI = 28,
  95. INDEX_OPT_HDLC_CONTROL = 29,
  96. INDEX_OPT_HDLC_ADDRESS = 30,
  97. INDEX_OPT_USER_DLT = 31,
  98. INDEX_OPT_USER_DLINK = 32,
  99. INDEX_OPT_DBUG = 33,
  100. INDEX_OPT_INTF1 = 34,
  101. INDEX_OPT_INTF2 = 35,
  102. INDEX_OPT_UNIDIR = 36,
  103. INDEX_OPT_LISTNICS = 37,
  104. INDEX_OPT_LIMIT = 38,
  105. INDEX_OPT_MAC = 39,
  106. INDEX_OPT_INCLUDE = 40,
  107. INDEX_OPT_EXCLUDE = 41,
  108. INDEX_OPT_PID = 42,
  109. INDEX_OPT_VERBOSE = 43,
  110. INDEX_OPT_DECODE = 44,
  111. INDEX_OPT_VERSION = 45,
  112. INDEX_OPT_LESS_HELP = 46,
  113. INDEX_OPT_HELP = 47,
  114. INDEX_OPT_MORE_HELP = 48,
  115. INDEX_OPT_SAVE_OPTS = 49,
  116. INDEX_OPT_LOAD_OPTS = 50
  117. } teOptIndex;
  118. /** count of all options for tcpbridge */
  119. #define OPTION_CT 51
  120. /**
  121. * Interface defines for all options. Replace "n" with the UPPER_CASED
  122. * option name (as in the teOptIndex enumeration above).
  123. * e.g. HAVE_OPT(TCPEDIT)
  124. */
  125. #define DESC(n) (tcpbridgeOptions.pOptDesc[INDEX_OPT_## n])
  126. /** 'true' if an option has been specified in any way */
  127. #define HAVE_OPT(n) (! UNUSED_OPT(& DESC(n)))
  128. /** The string argument to an option. The argument type must be \"string\". */
  129. #define OPT_ARG(n) (DESC(n).optArg.argString)
  130. /** Mask the option state revealing how an option was specified.
  131. * It will be one and only one of \a OPTST_SET, \a OPTST_PRESET,
  132. * \a OPTST_DEFINED, \a OPTST_RESET or zero.
  133. */
  134. #define STATE_OPT(n) (DESC(n).fOptState & OPTST_SET_MASK)
  135. /** Count of option's occurrances *on the command line*. */
  136. #define COUNT_OPT(n) (DESC(n).optOccCt)
  137. /** mask of \a OPTST_SET and \a OPTST_DEFINED. */
  138. #define ISSEL_OPT(n) (SELECTED_OPT(&DESC(n)))
  139. /** 'true' if \a HAVE_OPT would yield 'false'. */
  140. #define ISUNUSED_OPT(n) (UNUSED_OPT(& DESC(n)))
  141. /** 'true' if OPTST_DISABLED bit not set. */
  142. #define ENABLED_OPT(n) (! DISABLED_OPT(& DESC(n)))
  143. /** number of stacked option arguments.
  144. * Valid only for stacked option arguments. */
  145. #define STACKCT_OPT(n) (((tArgList*)(DESC(n).optCookie))->useCt)
  146. /** stacked argument vector.
  147. * Valid only for stacked option arguments. */
  148. #define STACKLST_OPT(n) (((tArgList*)(DESC(n).optCookie))->apzArgs)
  149. /** Reset an option. */
  150. #define CLEAR_OPT(n) STMTS( \
  151. DESC(n).fOptState &= OPTST_PERSISTENT_MASK; \
  152. if ((DESC(n).fOptState & OPTST_INITENABLED) == 0) \
  153. DESC(n).fOptState |= OPTST_DISABLED; \
  154. DESC(n).optCookie = NULL )
  155. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
  156. /**
  157. * Enumeration of tcpbridge exit codes
  158. */
  159. typedef enum {
  160. TCPBRIDGE_EXIT_SUCCESS = 0,
  161. TCPBRIDGE_EXIT_FAILURE = 1,
  162. TCPBRIDGE_EXIT_USAGE_ERROR = 64,
  163. TCPBRIDGE_EXIT_NO_CONFIG_INPUT = 66,
  164. TCPBRIDGE_EXIT_LIBOPTS_FAILURE = 70
  165. } tcpbridge_exit_code_t;
  166. /**
  167. * Interface defines for specific options.
  168. * @{
  169. */
  170. #define VALUE_OPT_PORTMAP 'r'
  171. #define VALUE_OPT_SEED 's'
  172. #define OPT_VALUE_SEED (DESC(SEED).optArg.argInt)
  173. #define VALUE_OPT_PNAT 'N'
  174. #define VALUE_OPT_SRCIPMAP 'S'
  175. #define VALUE_OPT_DSTIPMAP 'D'
  176. #define VALUE_OPT_ENDPOINTS 'e'
  177. #define VALUE_OPT_SKIPBROADCAST 'b'
  178. #define VALUE_OPT_FIXCSUM 'C'
  179. #define VALUE_OPT_MTU 'm'
  180. #define OPT_VALUE_MTU (DESC(MTU).optArg.argInt)
  181. #define VALUE_OPT_MTU_TRUNC 0x1001
  182. #define VALUE_OPT_EFCS 'E'
  183. #define VALUE_OPT_TTL 0x1002
  184. #define VALUE_OPT_TOS 0x1003
  185. #define OPT_VALUE_TOS (DESC(TOS).optArg.argInt)
  186. #define VALUE_OPT_TCLASS 0x1004
  187. #define OPT_VALUE_TCLASS (DESC(TCLASS).optArg.argInt)
  188. #define VALUE_OPT_FLOWLABEL 0x1005
  189. #define OPT_VALUE_FLOWLABEL (DESC(FLOWLABEL).optArg.argInt)
  190. #define VALUE_OPT_FIXLEN 'F'
  191. #define VALUE_OPT_FUZZ_SEED 0x1006
  192. #define OPT_VALUE_FUZZ_SEED (DESC(FUZZ_SEED).optArg.argInt)
  193. #define VALUE_OPT_SKIPL2BROADCAST 0x1007
  194. #define VALUE_OPT_DLT 0x1008
  195. #define VALUE_OPT_ENET_DMAC 0x1009
  196. #define VALUE_OPT_ENET_SMAC 0x100A
  197. #define VALUE_OPT_ENET_SUBSMAC 0x100B
  198. #define VALUE_OPT_ENET_MAC_SEED 0x100C
  199. #define OPT_VALUE_ENET_MAC_SEED (DESC(ENET_MAC_SEED).optArg.argInt)
  200. #define VALUE_OPT_ENET_MAC_SEED_KEEP_BYTES 0x100D
  201. #define OPT_VALUE_ENET_MAC_SEED_KEEP_BYTES (DESC(ENET_MAC_SEED_KEEP_BYTES).optArg.argInt)
  202. #define VALUE_OPT_ENET_VLAN 0x100E
  203. #define VALUE_OPT_ENET_VLAN_TAG 0x100F
  204. #define OPT_VALUE_ENET_VLAN_TAG (DESC(ENET_VLAN_TAG).optArg.argInt)
  205. #define VALUE_OPT_ENET_VLAN_CFI 0x1010
  206. #define OPT_VALUE_ENET_VLAN_CFI (DESC(ENET_VLAN_CFI).optArg.argInt)
  207. #define VALUE_OPT_ENET_VLAN_PRI 0x1011
  208. #define OPT_VALUE_ENET_VLAN_PRI (DESC(ENET_VLAN_PRI).optArg.argInt)
  209. #define VALUE_OPT_HDLC_CONTROL 0x1012
  210. #define OPT_VALUE_HDLC_CONTROL (DESC(HDLC_CONTROL).optArg.argInt)
  211. #define VALUE_OPT_HDLC_ADDRESS 0x1013
  212. #define OPT_VALUE_HDLC_ADDRESS (DESC(HDLC_ADDRESS).optArg.argInt)
  213. #define VALUE_OPT_USER_DLT 0x1014
  214. #define OPT_VALUE_USER_DLT (DESC(USER_DLT).optArg.argInt)
  215. #define VALUE_OPT_USER_DLINK 0x1015
  216. #define VALUE_OPT_DBUG 'd'
  217. #ifdef DEBUG
  218. #define OPT_VALUE_DBUG (DESC(DBUG).optArg.argInt)
  219. #endif /* DEBUG */
  220. #define VALUE_OPT_INTF1 'i'
  221. #define VALUE_OPT_INTF2 'I'
  222. #define VALUE_OPT_UNIDIR 'u'
  223. #define VALUE_OPT_LISTNICS 0x1016
  224. #define VALUE_OPT_LIMIT 'L'
  225. #define OPT_VALUE_LIMIT (DESC(LIMIT).optArg.argInt)
  226. #define VALUE_OPT_MAC 'M'
  227. #define VALUE_OPT_INCLUDE 'x'
  228. #define VALUE_OPT_EXCLUDE 'X'
  229. #define VALUE_OPT_PID 'P'
  230. #define VALUE_OPT_VERBOSE 'v'
  231. #ifdef ENABLE_VERBOSE
  232. #define SET_OPT_VERBOSE STMTS( \
  233. DESC(VERBOSE).optActualIndex = 43; \
  234. DESC(VERBOSE).optActualValue = VALUE_OPT_VERBOSE; \
  235. DESC(VERBOSE).fOptState &= OPTST_PERSISTENT_MASK; \
  236. DESC(VERBOSE).fOptState |= OPTST_SET )
  237. #endif /* ENABLE_VERBOSE */
  238. #define VALUE_OPT_DECODE 'A'
  239. #define VALUE_OPT_VERSION 'V'
  240. #define VALUE_OPT_LESS_HELP 'h'
  241. /** option flag (value) for help-value option */
  242. #define VALUE_OPT_HELP 'H'
  243. /** option flag (value) for more-help-value option */
  244. #define VALUE_OPT_MORE_HELP '!'
  245. /** option flag (value) for save-opts-value option */
  246. #define VALUE_OPT_SAVE_OPTS 0x1017
  247. /** option flag (value) for load-opts-value option */
  248. #define VALUE_OPT_LOAD_OPTS 0x1018
  249. #define SET_OPT_SAVE_OPTS(a) STMTS( \
  250. DESC(SAVE_OPTS).fOptState &= OPTST_PERSISTENT_MASK; \
  251. DESC(SAVE_OPTS).fOptState |= OPTST_SET; \
  252. DESC(SAVE_OPTS).optArg.argString = (char const*)(a))
  253. /*
  254. * Interface defines not associated with particular options
  255. */
  256. #define ERRSKIP_OPTERR STMTS(tcpbridgeOptions.fOptSet &= ~OPTPROC_ERRSTOP)
  257. #define ERRSTOP_OPTERR STMTS(tcpbridgeOptions.fOptSet |= OPTPROC_ERRSTOP)
  258. #define RESTART_OPT(n) STMTS( \
  259. tcpbridgeOptions.curOptIdx = (n); \
  260. tcpbridgeOptions.pzCurOpt = NULL )
  261. #define START_OPT RESTART_OPT(1)
  262. #define USAGE(c) (*tcpbridgeOptions.pUsageProc)(&tcpbridgeOptions, c)
  263. #ifdef __cplusplus
  264. extern "C" {
  265. #endif
  266. /* * * * * *
  267. *
  268. * Declare the tcpbridge option descriptor.
  269. */
  270. extern tOptions tcpbridgeOptions;
  271. #if defined(ENABLE_NLS)
  272. # ifndef _
  273. # include <stdio.h>
  274. # ifndef HAVE_GETTEXT
  275. extern char * gettext(char const *);
  276. # else
  277. # include <libintl.h>
  278. # endif
  279. # ifndef ATTRIBUTE_FORMAT_ARG
  280. # define ATTRIBUTE_FORMAT_ARG(_a)
  281. # endif
  282. static inline char* aoGetsText(char const* pz) ATTRIBUTE_FORMAT_ARG(1);
  283. static inline char* aoGetsText(char const* pz) {
  284. if (pz == NULL) return NULL;
  285. return (char*)gettext(pz);
  286. }
  287. # define _(s) aoGetsText(s)
  288. # endif /* _() */
  289. # define OPT_NO_XLAT_CFG_NAMES STMTS(tcpbridgeOptions.fOptSet |= \
  290. OPTPROC_NXLAT_OPT_CFG;)
  291. # define OPT_NO_XLAT_OPT_NAMES STMTS(tcpbridgeOptions.fOptSet |= \
  292. OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG;)
  293. # define OPT_XLAT_CFG_NAMES STMTS(tcpbridgeOptions.fOptSet &= \
  294. ~(OPTPROC_NXLAT_OPT|OPTPROC_NXLAT_OPT_CFG);)
  295. # define OPT_XLAT_OPT_NAMES STMTS(tcpbridgeOptions.fOptSet &= \
  296. ~OPTPROC_NXLAT_OPT;)
  297. #else /* ENABLE_NLS */
  298. # define OPT_NO_XLAT_CFG_NAMES
  299. # define OPT_NO_XLAT_OPT_NAMES
  300. # define OPT_XLAT_CFG_NAMES
  301. # define OPT_XLAT_OPT_NAMES
  302. # ifndef _
  303. # define _(_s) _s
  304. # endif
  305. #endif /* ENABLE_NLS */
  306. #ifdef __cplusplus
  307. }
  308. #endif
  309. #endif /* AUTOOPTS_TCPBRIDGE_OPTS_H_GUARD */
  310. /* tcpbridge_opts.h ends here */