summaryrefslogtreecommitdiff
path: root/src/vf/spp_forward.h
blob: b2965a676737531e0fb97526c15dd965be11a653 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
#ifndef __SPP_FORWARD_H__
#define __SPP_FORWARD_H__

/**
 * @file
 * SPP Forwarder and Merger
 *
 * Forwarder
 * This component provides function for packet processing from one port
 * to one port. Incoming packets from port are to be transferred to
 * specific one port. The direction of this transferring is specified
 * by port command.
 * Merger
 * This component provides packet forwarding function from multiple
 * ports to one port. Incoming packets from multiple ports are to be
 * transferred to one specific port. The flow of this merging process
 * is specified by port command.
 */

/** Clear info */
void spp_forward_init(void);

/**
 * Update forward info
 *
 * @param component
 *  The pointer to struct spp_component_info.@n
 *  The data for updating the internal data of forwarder and merger.
 *
 * @retval 0  succeeded.
 * @retval -1 failed.
 */
int spp_forward_update(struct spp_component_info *component);

/**
 * Merge/Forward
 *
 * @param id
 *  The unique component ID.
 *
 * @retval 0  succeeded.
 * @retval -1 failed.
 */
int spp_forward(int id);

/**
 * Merge/Forward get component status
 *
 * @param lcore_id
 *  The logical core ID for forwarder and merger.
 * @param id
 *  The unique component ID.
 * @param params
 *  The pointer to struct spp_iterate_core_params.@n
 *  Detailed data of forwarder/merger status.
 *
 * @retval 0  succeeded.
 * @retval -1 failed.
 */
int spp_forward_get_component_status(
		unsigned int lcore_id, int id,
		struct spp_iterate_core_params *params);

#endif /* __SPP_FORWARD_H__ */