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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/* BGP I/O.
* Implements packet I/O in a pthread.
* Copyright (C) 2017 Cumulus Networks
* Quentin Young
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file COPYING; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
* MA 02110-1301 USA
*/
#ifndef _FRR_BGP_IO_H
#define _FRR_BGP_IO_H
#define BGP_WRITE_PACKET_MAX 10U
#define BGP_READ_PACKET_MAX 10U
#include "bgpd/bgpd.h"
#include "frr_pthread.h"
/**
* Initializes data structures and flags for the write thread.
*
* This function should be called from the main thread before
* bgp_writes_start() is invoked.
*/
extern void bgp_io_init(void);
/**
* Ensure that the BGP IO thread is actually up and running
*
* This function must be called immediately after the thread
* has been created for running. This is because we want
* to make sure that the io thread is ready before other
* threads start attempting to use it.
*/
extern void bgp_io_running(void);
/**
* Start function for write thread.
*
* @param arg - unused
*/
extern void *bgp_io_start(void *arg);
/**
* Start function for write thread.
*
* Uninitializes all resources and stops the thread.
*
* @param result - where to store data result, unused
*/
extern int bgp_io_stop(void **result, struct frr_pthread *fpt);
/**
* Turns on packet writing for a peer.
*
* After this function is called, any packets placed on peer->obuf will be
* written to peer->fd until no more packets remain.
*
* Additionally, it becomes unsafe to perform socket actions on peer->fd.
*
* @param peer - peer to register
*/
extern void bgp_writes_on(struct peer *peer);
/**
* Turns off packet writing for a peer.
*
* After this function returns, packets placed on peer->obuf will not be
* written to peer->fd by the I/O thread.
*
* After this function returns it becomes safe to perform socket actions on
* peer->fd.
*
* @param peer - peer to deregister
* @param flush - as described
*/
extern void bgp_writes_off(struct peer *peer);
/**
* Turns on packet reading for a peer.
*
* After this function is called, any packets received on peer->fd will be read
* and copied into the FIFO queue peer->ibuf.
*
* Additionally, it becomes unsafe to perform socket actions on peer->fd.
*
* Whenever one or more packets are placed onto peer->ibuf, a task of type
* THREAD_EVENT will be placed on the main thread whose handler is
*
* bgp_packet.c:bgp_process_packet()
*
* @param peer - peer to register
*/
extern void bgp_reads_on(struct peer *peer);
/**
* Turns off packet reading for a peer.
*
* After this function is called, any packets received on peer->fd will not be
* read by the I/O thread.
*
* After this function returns it becomes safe to perform socket actions on
* peer->fd.
*
* @param peer - peer to deregister
*/
extern void bgp_reads_off(struct peer *peer);
#endif /* _FRR_BGP_IO_H */
|
