# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
-DOT_GRAPH_MAX_NODES = 50
+DOT_GRAPH_MAX_NODES = 150
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
*/
/** @file
- * @defgroup libmemif
+ * @defgroup libmemif Example libmemif App
*/
#ifndef _LIBMEMIF_H_
static void flowprobe_export_entry (vlib_main_t * vm, flowprobe_entry_t * e);
/**
- * @file flow record generator graph node
+ * @file node.c
+ * flow record generator graph node
*/
typedef struct
#include <vppinfra/tw_timer_2t_1w_2048sl.h>
#include <vppinfra/bihash_vec8_8.h>
-/** @file Static http server definitions
-*/
+/** @file http_static.h
+ * Static http server definitions
+ */
typedef struct
{
#include <vppinfra/bihash_template.c>
-/** @file Static http server, sufficient to
- serve .html / .css / .js content.
-*/
+/** @file static_server.c
+ * Static http server, sufficient to
+ * serve .html / .css / .js content.
+ */
/*? %%clicmd:group_label Static HTTP Server %% ?*/
http_static_server_main_t http_static_server_main;
/** \brief send http data
@param hs - http session
@param data - the data vector to transmit
+ @param length - length of data
@param offset - transmit offset for this operation
@return offset for next transmit operation, may be unchanged w/ full fifo
*/
return (rv);
}
-/** \brief igmp hardware interface link up down
- @param vnm - vnet main
- @param hw_if_index - interface hw_if_index
- @param flags - hw interface flags
-
- If an interface goes down, remove its (S,G)s.
-*/
static walk_rc_t
igmp_sw_if_down (vnet_main_t * vnm, u32 sw_if_index, void *ctx)
{
return (WALK_CONTINUE);
}
+/** \brief igmp hardware interface link up down
+ @param vnm - vnet main
+ @param hw_if_index - interface hw_if_index
+ @param flags - hw interface flags
+
+ If an interface goes down, remove its (S,G)s.
+*/
static clib_error_t *
igmp_hw_interface_link_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
{
/**
* @brief igmp listen (RFC3376 Section 2).
* @param vm - vlib main
- * @param enable - 0 == remove (S,G), else add (S,G), aka. include/exclue
+ * @param enable - 0 == remove (S,G), else add (S,G), aka. include/exclude
* @param sw_if_index - interface sw_if_index
* @param saddr - source address
* @param gaddr - group address
- * @param cli_api_configured - if zero, an igmp report has been received on interface
*
* Add/del (S,G) on an interface. If user configured,
* send a status change report from the interface.
/**
* @brief igmp config lookup
- * @param im - igmp main
* @param sw_if_index - interface sw_if_index
*/
extern igmp_config_t *igmp_config_lookup (u32 sw_if_index);
/* VRF index */
u32 vrf_id;
- /* upstrema interface */
+ /* upstream interface */
u32 upstream_if;
/* downstream interfaces */
*
* Add/del IGMP proxy device. Interface must be IGMP enabled in HOST mode.
*/
-int igmp_proxy_device_add_del (u32 vfr_id, u32 sw_if_index, u8 add);
+int igmp_proxy_device_add_del (u32 vrf_id, u32 sw_if_index, u8 add);
/**
* @brief IGMP proxy device add/del interface
}
/** \brief igmp get next timer
- @param im - igmp main
Get next timer.
*/
* This function can be used by other VPP graph nodes to receive IP-FIX packets
* with a particular setid.
*
- * @param vlib_main_t Vlib main of the graph node which is interseted in
+ * @param vm Vlib main of the graph node which is interested in
* getting IP-Fix packet.
- * @param ipfix_client_add_del_t Structure describing the client node which
+ * @param info Structure describing the client node which
* is interested in getting the IP-Fix packets for
* a SetID.
*
/** Node index where packets have to be redirected. */
u32 client_node;
- /** Setid of IPFix for which client is intereseted in getting packets. */
+ /** Setid of IPFix for which client is interested in getting packets. */
u16 ipfix_setid;
/** Add(0) or del(1) operation. */
/** ipfix-collector next index where packets have to be redirected. */
u32 client_next_node;
- /** Setid of IPFix for which client is intereseted in getting packets. */
+ /** Setid of IPFix for which client is interested in getting packets. */
u16 set_id;
} ipfix_client;
* This function can be used by other VPP graph nodes to receive IP-FIX packets
* with a particular setid.
*
- * @param vlib_main_t Vlib main of the graph node which is interseted in
+ * @param vm Vlib main of the graph node which is interested in
* getting IP-Fix packet.
- * @param ipfix_client_add_del_t Structure describing the client node which
+ * @param info Structure describing the client node which
* is interested in getting the IP-Fix packets for
* a SetID.
*
* out udp probe packets for all configured sessions.
*
* @param vm vlib_main_t corresponding to the current thread.
- * @param node vlib_node_runtime_t data for this node.
- * @param frame vlib_frame_t whose contents should be dispatched.
+ * @param rt vlib_node_runtime_t data for this node.
+ * @param f vlib_frame_t whose contents should be dispatched.
*
*/
uword
/**
* Create or update an L3XC Policy
*
- * @param sw_if_index_index the input interface
+ * @param sw_if_index the input interface
+ * @param is_ipv6 - 0 if ip4, 1 if ip6
* @param rpaths The set of paths to add to the forwarding set
* @return error code
*/
/**
* Delete an L3XC.
*
- * @param sw_if_index_index the input interface
+ * @param sw_if_index the input interface
+ * @param is_ipv6 - 0 if ip4, 1 if ip6
*/
extern int l3xc_delete (u32 sw_if_index, u8 is_ip6);
extern void l3xc_walk (l3xc_walk_cb_t cb, void *ctx);
/**
- * Find a L3 XC object from an interfce and FIB protocol
+ * Find a L3 XC object from an interface and FIB protocol
*/
extern index_t l3xc_find (u32 sw_if_index, fib_protocol_t fproto);
* Fix global load-balancer parameters.
* @param ip4_address IPv4 source address used for encapsulated traffic
* @param ip6_address IPv6 source address used for encapsulated traffic
+ * @param sticky_buckets FIXME
+ * @param flow_timeout FIXME
* @return 0 on success. VNET_LB_ERR_XXX on error
*/
int lb_conf(ip4_address_t *ip4_address, ip6_address_t *ip6_address,
mactime_main_t mactime_main;
-/** \file time-base src-mac filter device-input feature arc implementation
+/** \file mactime.c
+ * time-base src-mac filter device-input feature arc implementation
*/
static void
mdata_main_t mdata_main;
-/** @file buffer metadata change tracker
+/** @file mdata.c
+ * buffer metadata change tracker
*/
static mdata_t mdata_none;
#include <vppinfra/hash.h>
#include <vppinfra/error.h>
-/** @file buffer metadata change tracker definitions
+/** @file mdata.h
+ * buffer metadata change tracker definitions
*/
typedef struct
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
* limitations under the License.
*/
/**
- * @file NAT plugin global declarations
+ * @file nat.c
+ * NAT plugin global declarations
*/
#ifndef __included_nat_h__
#define __included_nat_h__
u32 rx_fib_index,
u8 is_output);
-/* NAT address and port allacotaion function */
+/* NAT address and port allocation function */
typedef int (nat_alloc_out_addr_and_port_function_t) (snat_address_t *
addresses,
u32 fib_index,
/* vector of outside fibs */
nat_outside_fib_t *outside_fibs;
- /* Vector of twice NAT addresses for extenal hosts */
+ /* Vector of twice NAT addresses for external hosts */
snat_address_t *twice_nat_addresses;
/* sw_if_indices whose intfc addresses should be auto-added */
#define is_affinity_sessions(s) (s->flags & SNAT_SESSION_FLAG_AFFINITY)
/** \brief Check if NAT interface is inside.
- @param i NAT interfce
+ @param i NAT interface
@return 1 if inside interface
*/
#define nat_interface_is_inside(i) i->flags & NAT_INTERFACE_FLAG_IS_INSIDE
/** \brief Check if NAT interface is outside.
- @param i NAT interfce
+ @param i NAT interface
@return 1 if outside interface
*/
#define nat_interface_is_outside(i) i->flags & NAT_INTERFACE_FLAG_IS_OUTSIDE
/**
* @brief Add external address to NAT44 pool
*
+ * @param sm snat global configuration data
* @param addr IPv4 address
* @param vrf_id VRF id of tenant, ~0 means independent of VRF
* @param twice_nat 1 if twice NAT address
/**
* @brief Delete external address from NAT44 pool
*
+ * @param sm snat global configuration data
* @param addr IPv4 address
* @param delete_sm 1 if delete static mapping using address
* @param twice_nat 1 if twice NAT address
int is_del);
/**
- * @brief Add/delete NAT44 pool address from specific interfce
+ * @brief Add/delete NAT44 pool address from specific interface
*
* @param sw_if_index software index of the interface
* @param is_del 1 = delete, 0 = add
- * @param twice_nat 1 = twice NAT address for extenal hosts
+ * @param twice_nat 1 = twice NAT address for external hosts
*
* @return 0 on success, non-zero value otherwise
*/
/**
* @brief Delete NAT44 endpoint-dependent session
*
+ * @param sm snat global configuration data
* @param addr IPv4 address
* @param port L4 port number
* @param proto L4 protocol
u32 vrf_id, int is_in);
/**
- * @brief Free NAT44 session data (lookup keys, external addrres port)
+ * @brief Free NAT44 session data (lookup keys, external address port)
*
+ * @param sm snat global configuration data
* @param s NAT session
* @param thread_index thread index
* @param is_ha is HA event
u32 thread_index, u8 is_ha);
/**
+<<<<<<< bdfe5955f59a735fd8d70e9026f8c1867a4c8cc6
* @brief Set NAT44 session limit (session limit, vrf id)
*
* @param session_limit Session limit
/**
* @brief Free NAT44 ED session data (lookup keys, external addrres port)
+=======
+ * @brief Free NAT44 ED session data (lookup keys, external address port)
+>>>>>>> docs: clean up make docs job
*
* @param s NAT session
* @param thread_index thread index
/**
* @brief Find or create NAT user
*
+ * @param sm snat global configuration data
* @param addr IPv4 address
* @param fib_index FIB table index
* @param thread_index thread index
/**
* @brief Allocate new NAT session or recycle last used
*
+ * @param sm snat global configuration data
* @param u NAT user
* @param thread_index thread index
+ * @param now time now
*
* @return session data structure on success otherwise zero value
*/
/**
* @brief Allocate NAT endpoint-dependent session
*
+ * @param sm snat global configuration data
* @param thread_index thread index
+ * @param now time now
*
* @return session data structure on success otherwise zero value
*/
* @param fib_index FIB table index
* @param thread_index thread index
* @param k allocated address and port pair
- * @param port_per_thread number of ports per threead
+ * @param port_per_thread number of ports per thread
* @param snat_thread_index NAT thread index
*
* @return 0 on success, non-zero value otherwise
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
* @param[in,out] node NAT node runtime
* @param[in] thread_index thread index
* @param[in,out] b0 buffer containing packet to be translated
+ * @param[in,out] ip0 ip header
* @param[out] p_proto protocol used for matching
* @param[out] p_value address and port after NAT translation
* @param[out] p_dont_translate if packet should not be translated
#ifndef included_api_common_h
#define included_api_common_h
-/** \file API common definitions
+/** \file api_common.h
+ * API common definitions
* See api_doc.md for more info
*/
extern int dpo_is_adj(const dpo_id_t *dpo);
/**
- * @biref Format a DPO_id_t oject
+ * @brief Format a DPO_id_t oject
*/
extern u8 *format_dpo_id(u8 * s, va_list * args);
/**
- * @biref format a DPO type
+ * @brief format a DPO type
*/
extern u8 *format_dpo_type(u8 * s, va_list * args);
}
/**
- * @breif Enurmerate the times of sleep between walks
+ * @brief Enurmerate the times of sleep between walks
*/
typedef enum fib_walk_sleep_type_t_
{
void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
/**
- * @brie get first IPv6 interface address
+ * @brief get first IPv6 interface address
*/
ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
}
/**
- * @brif Show/display one tenant
+ * @brief Show/display one tenant
*/
static u8 *
format_lisp_gpe_tenant (u8 * s, va_list * ap)
* limitations under the License.
*/
/**
- @dir vnet/vnet/lldp
+ @dir src/vnet/lldp
@brief Link Layer Discovery Protocol (LLDP) implementation
*/
fib_route_path_t *rpath);
/**
- * @vrief return the tunnel index from the sw_if_index
+ * @brief return the tunnel index from the sw_if_index
*/
extern int vnet_mpls_tunnel_get_index (u32 sw_if_index);
* limitations under the License.
*/
/**
- * @file RFC5424 syslog protocol implementation
+ * @file syslog.c
+ * RFC5424 syslog protocol implementation
*/
#include <unistd.h>
* limitations under the License.
*/
/**
- * @file RFC5424 syslog protocol declarations
+ * @file syslog.h
+ * RFC5424 syslog protocol declarations
*/
#ifndef __included_syslog_h__
#define __included_syslog_h__
* limitations under the License.
*/
/**
- * @file syslog protocol UDP transport layer implementation (RFC5426)
+ * @file syslog_udp.c
+ * syslog protocol UDP transport layer implementation (RFC5426)
*/
#include <vnet/syslog/syslog_udp.h>
* limitations under the License.
*/
/**
- * @file syslog protocol UDP transport layer declaration (RFC5426)
+ * @file syslog_udp.h
+ * syslog protocol UDP transport layer declaration (RFC5426)
*/
#ifndef __included_syslog_udp_h__
#define __included_syslog_udp_h__
#include <vppinfra/random.h>
-/** \file Random number support
+/** \file random.c
+ Random number support
*/
/** \brief Default random seed for standalone version of library.
Code Review / vpp.git / commitdiff