:orphan: .. index:: pair: group; Routing Table configuration .. _doxid-group__tapi__conf__route: Routing Table configuration =========================== .. toctree:: :hidden: struct_tapi_cfg_rt_nexthop.rst struct_tapi_cfg_rt_params.rst struct_tapi_rt_entry.rst Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_rt_entry` :ref:`tapi_rt_entry_t`; typedef struct :ref:`tapi_cfg_rt_nexthop` :ref:`tapi_cfg_rt_nexthop`; typedef struct :ref:`tapi_cfg_rt_params` :ref:`tapi_cfg_rt_params`; // structs struct :ref:`tapi_cfg_rt_nexthop`; struct :ref:`tapi_cfg_rt_params`; struct :ref:`tapi_rt_entry`; // global functions int :ref:`tapi_cfg_get_route_table`(const char* ta, int addr_family, :ref:`tapi_rt_entry_t`** rt_tbl, unsigned int* n); void :ref:`tapi_cfg_rt_params_init`(:ref:`tapi_cfg_rt_params`* params); int :ref:`tapi_cfg_add_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* rt_hndl); int :ref:`tapi_cfg_add_full_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, int table, :ref:`cfg_handle`* cfg_hndl); static int :ref:`tapi_cfg_add_typed_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* cfg_hndl); int :ref:`tapi_cfg_modify_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* rt_hndl); :ref:`te_errno` :ref:`tapi_cfg_modify_route2`(const char* ta, :ref:`tapi_cfg_rt_params`* params, :ref:`cfg_handle`* rt_hndl); int :ref:`tapi_cfg_modify_full_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, int table, :ref:`cfg_handle`* cfg_hndl); static int :ref:`tapi_cfg_modify_typed_route`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* cfg_hndl); int :ref:`tapi_cfg_del_route_tmp`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt); int :ref:`tapi_cfg_del_route`(:ref:`cfg_handle`* rt_hndl); static int :ref:`tapi_cfg_add_route_via_gw`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr); static int :ref:`tapi_cfg_del_route_via_gw`(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr); :ref:`te_errno` :ref:`tapi_cfg_add_route_simple`(const char* ta, const struct sockaddr* target, int prefixlen, const struct sockaddr* gw, const char* dev); :ref:`te_errno` :ref:`tapi_cfg_del_route_simple`(const char* ta, const struct sockaddr* target, int prefixlen, const struct sockaddr* gw, const char* dev); :ref:`te_errno` :ref:`tapi_cfg_add_route2`(const char* ta, :ref:`tapi_cfg_rt_params`* params, :ref:`cfg_handle`* rt_hndl); // macros #define :ref:`TAPI_RT_GW` #define :ref:`TAPI_RT_IF` #define :ref:`TAPI_RT_METRIC` #define :ref:`TAPI_RT_SRC` #define :ref:`TAPI_RT_TABLE` #define :ref:`TAPI_RT_TABLE_LOCAL` #define :ref:`TAPI_RT_TABLE_MAIN` #define :ref:`TAPI_RT_TOS` #define :ref:`TYPE_NAMESIZE` .. _details-group__tapi__conf__route: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Typedefs -------- .. index:: pair: typedef; tapi_rt_entry_t .. _doxid-group__tapi__conf__route_1gac1361e7f1db1f74056684269dfd19180: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_rt_entry` tapi_rt_entry_t Routing entry data structure .. index:: pair: typedef; tapi_cfg_rt_nexthop .. _doxid-group__tapi__conf__route_1ga6821dbd45a9dd2b895479880e78a5129: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_cfg_rt_nexthop` tapi_cfg_rt_nexthop Nexthop of a multipath route. .. index:: pair: typedef; tapi_cfg_rt_params .. _doxid-group__tapi__conf__route_1ga34282da095de41fb9b46b451c580bdf5: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_cfg_rt_params` tapi_cfg_rt_params Structure storing parameters of :ref:`tapi_cfg_add_route2() `. Global Functions ---------------- .. index:: pair: function; tapi_cfg_get_route_table .. _doxid-group__tapi__conf__route_1ga904268c880445cbc1b0d1b82142a1854: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_get_route_table(const char* ta, int addr_family, :ref:`tapi_rt_entry_t`** rt_tbl, unsigned int* n) Gets routing table on the specified Test Agent Function allocates memory with malloc(), which should be freed with free() by the caller. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name * - addr_family - Address family of the routes (AF_INET) * - rt_tbl - Pointer to the routing table (OUT) * - n - The number of entries in the table (OUT) .. rubric:: Returns: 0 on success, and TE errno in case of failure. .. index:: pair: function; tapi_cfg_rt_params_init .. _doxid-group__tapi__conf__route_1gaf40b65aef3c6caa29051fa1d8d7f7ee3: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_cfg_rt_params_init(:ref:`tapi_cfg_rt_params`* params) Initialize :ref:`tapi_cfg_rt_params ` fields. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - params - Pointer to :ref:`tapi_cfg_rt_params ` structure. .. index:: pair: function; tapi_cfg_add_route .. _doxid-group__tapi__conf__route_1gab7c11c0fa0a9f4f8f909e1be2c89eddc: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_add_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* rt_hndl) Add a new route to some destination address with a lot of additional route attributes For more information about the meaning of parameters see "man route". .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - addr_family - Address family of destination and gateway addresses * - dst_addr - Destination address * - prefix - Prefix for destination address * - gw_addr - Gateway address * - dev - Interface name (for direct route) * - src_addr - Default source address * - flags - Flags to be added for the route (see route flags in net/route.h system header) * - metric - Route metric * - tos - Type of service * - mtu - TCP Maximum Segment Size (MSS) on the route * - win - TCP window size for connections over this route * - irtt - initial round trip time (irtt) for TCP connections over this route (in milliseconds) * - rt_hndl - Route handle (OUT) * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_add_full_route .. _doxid-group__tapi__conf__route_1ga7e2b94d19c8d3ce042434868860ffe19: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_add_full_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, int table, :ref:`cfg_handle`* cfg_hndl) Same as :ref:`tapi_cfg_add_route() ` but allows to specify a route type and route table id NOTE: currently only "blackhole" and "unicast" types are supported. .. index:: pair: function; tapi_cfg_add_typed_route .. _doxid-group__tapi__conf__route_1gaaedd89763152bdb1f2d86554b7593219: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_add_typed_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* cfg_hndl) Same as :ref:`tapi_cfg_add_route() ` but allows to specify a route type NOTE: currently only "blackhole" and "unicast" types are supported. .. index:: pair: function; tapi_cfg_modify_route .. _doxid-group__tapi__conf__route_1ga36f366c1d59732fdde8c90840cdf0fbb: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_modify_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* rt_hndl) Changes attribute of the existing route. For more information about the meaning of parameters see "man route". .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - addr_family - Address family of destination and gateway addresses * - dst_addr - Destination address * - prefix - Prefix for destination address * - gw_addr - Gateway address * - dev - Interface name (for direct route) * - src_addr - Default source address * - flags - Flags to be added for the route (see route flags in net/route.h system header) * - metric - Route metric * - tos - Route type of service * - mtu - TCP Maximum Segment Size (MSS) on the route * - win - TCP window size for connections over this route * - irtt - initial round trip time (irtt) for TCP connections over this route (in milliseconds) * - rt_hndl - Route handle (OUT) * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_modify_route2 .. _doxid-group__tapi__conf__route_1ga34e5ad1d55d1c855be25e70350267a24: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_modify_route2(const char* ta, :ref:`tapi_cfg_rt_params`* params, :ref:`cfg_handle`* rt_hndl) Modify existing route. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - params - Route parameters. * - rt_hndl - Where to save configurator handle of a route (may be ``NULL``). .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_modify_full_route .. _doxid-group__tapi__conf__route_1gac3ad51a13b694172f3f1ef67490cc1ce: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_modify_full_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, int table, :ref:`cfg_handle`* cfg_hndl) Same as :ref:`tapi_cfg_modify_route() ` but allows to specify a route type and route table id NOTE: currently only "blackhole" and "unicast" types are supported. .. index:: pair: function; tapi_cfg_modify_typed_route .. _doxid-group__tapi__conf__route_1ga13c54705e03ce9d54a8d7a2506404a51: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_modify_typed_route(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, const char* type, uint32_t flags, int metric, int tos, int mtu, int win, int irtt, :ref:`cfg_handle`* cfg_hndl) Same as :ref:`tapi_cfg_modify_route() ` but allows to specify a route type. NOTE: currently "unicast" type is supported, so the function behaves exactly like :ref:`tapi_cfg_modify_route() `. .. index:: pair: function; tapi_cfg_del_route_tmp .. _doxid-group__tapi__conf__route_1ga3fbff1b0ecb0032cffb8d8fbc7dd58b1: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_del_route_tmp(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr, const char* dev, const void* src_addr, uint32_t flags, int metric, int tos, int mtu, int win, int irtt) Delete specified route For more information about the meaning of parameters see "man route". .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - addr_family - Address family of destination and gateway addresses * - dst_addr - Destination address * - prefix - Prefix for destination address * - gw_addr - Gateway address * - dev - Interface name (for direct route) * - src_addr - Default source address * - flags - Flags to be added for the route (see route flags in net/route.h system header) * - metric - Route metric * - tos - Route type of service * - mtu - TCP Maximum Segment Size (MSS) on the route * - win - TCP window size for connections over this route * - irtt - initial round trip time (irtt) for TCP connections over this route (in milliseconds) * - 0 - - on success .. rubric:: Returns: Status code .. index:: pair: function; tapi_cfg_del_route .. _doxid-group__tapi__conf__route_1ga29b97ea81b6265bae2a23e4d8d3f651c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_del_route(:ref:`cfg_handle`* rt_hndl) Delete route by handle got with :ref:`tapi_cfg_add_route() ` function .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rt_hndl - Route handle .. rubric:: Returns: 0 on success, and TE errno on failure .. index:: pair: function; tapi_cfg_add_route_via_gw .. _doxid-group__tapi__conf__route_1gac4dc4e54c9ead4c17476d4aa683d81e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_add_route_via_gw(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr) Add a new indirect route (via a gateway) on specified Test agent .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent * - addr_family - Address family of destination and gateway addresses * - dst_addr - Destination address * - prefix - Prefix for destination address * - gw_addr - Gateway address .. rubric:: Returns: 0 - on success, or TE error code .. index:: pair: function; tapi_cfg_del_route_via_gw .. _doxid-group__tapi__conf__route_1gaf5effd97bf709d26ff242ca153b1a3e6: .. ref-code-block:: cpp :class: doxyrest-title-code-block static int tapi_cfg_del_route_via_gw(const char* ta, int addr_family, const void* dst_addr, int prefix, const void* gw_addr) Deletes route added with 'tapi_cfg_add_route_via_gw' function .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - addr_family - Address family of destination and gateway addresses * - dst_addr - Destination address * - prefix - Prefix for destination address * - gw_addr - Gateway address .. rubric:: Returns: 0 - on success, or TE error code .. index:: pair: function; tapi_cfg_add_route_simple .. _doxid-group__tapi__conf__route_1ga6fd4d40169146511a7e171b0b1664fca: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_add_route_simple(const char* ta, const struct sockaddr* target, int prefixlen, const struct sockaddr* gw, const char* dev) Add a new simple route to destination network or host address Added route can be removed with :ref:`tapi_cfg_del_route_simple() ` .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test agent name * - target - Destination network or host address * - prefixlen - Prefix length of destination address * - gw - Gateway address to route packets via a gateway, may be ``NULL`` for direct route * - dev - Interface name, force the route to be associated with the specified device. May be ``NULL`` if ``gw`` is defined .. rubric:: Returns: Status code .. rubric:: See also: :ref:`tapi_cfg_add_route_via_gw `, :ref:`tapi_cfg_add_route ` .. index:: pair: function; tapi_cfg_del_route_simple .. _doxid-group__tapi__conf__route_1gaea1f99e6f366d3053ceef5b979c5ced8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_del_route_simple(const char* ta, const struct sockaddr* target, int prefixlen, const struct sockaddr* gw, const char* dev) Delete a route added with :ref:`tapi_cfg_add_route_simple() `, use the same argument values .. index:: pair: function; tapi_cfg_add_route2 .. _doxid-group__tapi__conf__route_1ga1e064f70d157141af88d4be14ecd284d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_cfg_add_route2(const char* ta, :ref:`tapi_cfg_rt_params`* params, :ref:`cfg_handle`* rt_hndl) Add a new route. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Test Agent name. * - params - Route parameters. * - rt_hndl - Where to save configurator handle of a new route (may be ``NULL``). .. rubric:: Returns: Status code. Macros ------ .. index:: pair: define; TAPI_RT_GW .. _doxid-group__tapi__conf__route_1gafe921d478d9a42e5e1d08111e26a7315: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_GW Route is indirect and has gateway address .. index:: pair: define; TAPI_RT_IF .. _doxid-group__tapi__conf__route_1ga40ecfe32e7cc4e882cb89a6b85264592: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_IF Route is direct, so interface name is specified .. index:: pair: define; TAPI_RT_METRIC .. _doxid-group__tapi__conf__route_1gafda0e6ce6935a27df0f17359257454c5: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_METRIC Metric is specified for the route .. index:: pair: define; TAPI_RT_SRC .. _doxid-group__tapi__conf__route_1gaf8bddc9edbc017be97a671998995ef88: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_SRC Default source address is specified for the route .. index:: pair: define; TAPI_RT_TABLE .. _doxid-group__tapi__conf__route_1gaf8a92ecb4ee39d97311ed1075a62f200: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_TABLE Table ID for the route .. index:: pair: define; TAPI_RT_TABLE_LOCAL .. _doxid-group__tapi__conf__route_1gac5771d4279a659bcecd9fb0721c793a1: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_TABLE_LOCAL Local table maintained by kernel .. index:: pair: define; TAPI_RT_TABLE_MAIN .. _doxid-group__tapi__conf__route_1ga6396e982fa5bd226cbca48cd858ca5f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_TABLE_MAIN Default table for normal rules .. index:: pair: define; TAPI_RT_TOS .. _doxid-group__tapi__conf__route_1gae050020370116a943654ff691259aa82: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_RT_TOS Type of service is specified for the route .. index:: pair: define; TYPE_NAMESIZE .. _doxid-group__tapi__conf__route_1gacd621a509bbc510d8bcafd3659179fa0: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TYPE_NAMESIZE Maximum length of the route type name