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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/**
* bfd.h: BFD definitions and structures
*
* @copyright Copyright (C) 2015 Cumulus Networks, Inc.
*
* This file is part of GNU Zebra.
*
* GNU Zebra 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, or (at your option) any
* later version.
*
* GNU Zebra 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 _ZEBRA_BFD_H
#define _ZEBRA_BFD_H
#include "lib/json.h"
#include "lib/zclient.h"
#ifdef __cplusplus
extern "C" {
#endif
#define BFD_DEF_MIN_RX 300
#define BFD_MIN_MIN_RX 50
#define BFD_MAX_MIN_RX 60000
#define BFD_DEF_MIN_TX 300
#define BFD_MIN_MIN_TX 50
#define BFD_MAX_MIN_TX 60000
#define BFD_DEF_DETECT_MULT 3
#define BFD_MIN_DETECT_MULT 2
#define BFD_MAX_DETECT_MULT 255
#define BFD_GBL_FLAG_IN_SHUTDOWN (1 << 0) /* The daemon in shutdown */
struct bfd_gbl {
uint16_t flags;
};
#define BFD_FLAG_PARAM_CFG (1 << 0) /* parameters have been configured */
#define BFD_FLAG_BFD_REG (1 << 1) /* Peer registered with BFD */
#define BFD_FLAG_BFD_TYPE_MULTIHOP (1 << 2) /* Peer registered with BFD as multihop */
#define BFD_FLAG_BFD_CBIT_ON (1 << 3) /* Peer registered with CBIT set to on */
#define BFD_FLAG_BFD_CHECK_CONTROLPLANE (1 << 4) /* BFD and controlplane daemon are linked */
#define BFD_STATUS_UNKNOWN (1 << 0) /* BFD session status never received */
#define BFD_STATUS_DOWN (1 << 1) /* BFD session status is down */
#define BFD_STATUS_UP (1 << 2) /* BFD session status is up */
#define BFD_STATUS_ADMIN_DOWN (1 << 3) /* BFD session is admin down */
#define BFD_PROFILE_NAME_LEN 64
#define BFD_SET_CLIENT_STATUS(current_status, new_status) \
do { \
(current_status) = \
(((new_status) == BFD_STATUS_ADMIN_DOWN) ? \
BFD_STATUS_DOWN : (new_status));\
} while (0)
enum bfd_sess_type {
BFD_TYPE_NOT_CONFIGURED,
BFD_TYPE_SINGLEHOP,
BFD_TYPE_MULTIHOP
};
struct bfd_info {
uint16_t flags;
uint8_t detect_mult;
uint32_t desired_min_tx;
uint32_t required_min_rx;
time_t last_update;
uint8_t status;
enum bfd_sess_type type;
char profile[BFD_PROFILE_NAME_LEN];
};
extern struct bfd_info *bfd_info_create(void);
extern void bfd_info_free(struct bfd_info **bfd_info);
extern int bfd_validate_param(struct vty *vty, const char *dm_str,
const char *rx_str, const char *tx_str,
uint8_t *dm_val, uint32_t *rx_val,
uint32_t *tx_val);
extern void bfd_set_param(struct bfd_info **bfd_info, uint32_t min_rx,
uint32_t min_tx, uint8_t detect_mult,
const char *profile, int defaults, int *command);
extern void bfd_peer_sendmsg(struct zclient *zclient, struct bfd_info *bfd_info,
int family, void *dst_ip, void *src_ip,
char *if_name, int ttl, int multihop, int cbit,
int command, int set_flag, vrf_id_t vrf_id);
extern const char *bfd_get_command_dbg_str(int command);
extern struct interface *bfd_get_peer_info(struct stream *s, struct prefix *dp,
struct prefix *sp, int *status,
int *remote_cbit,
vrf_id_t vrf_id);
const char *bfd_get_status_str(int status);
extern void bfd_show_param(struct vty *vty, struct bfd_info *bfd_info,
int bfd_tag, int extra_space, bool use_json,
json_object *json_obj);
extern void bfd_show_info(struct vty *vty, struct bfd_info *bfd_info,
int multihop, int extra_space, bool use_json,
json_object *json_obj);
extern void bfd_client_sendmsg(struct zclient *zclient, int command,
vrf_id_t vrf_id);
extern void bfd_gbl_init(void);
extern void bfd_gbl_exit(void);
/*
* BFD new API.
*/
/**
* BFD session registration arguments.
*/
struct bfd_session_arg {
/**
* BFD command.
*
* Valid commands:
* - `ZEBRA_BFD_DEST_REGISTER`
* - `ZEBRA_BFD_DEST_DEREGISTER`
*/
int32_t command;
/**
* BFD family type.
*
* Supported types:
* - `AF_INET`
* - `AF_INET6`.
*/
uint32_t family;
/** Source address. */
struct in6_addr src;
/** Source address. */
struct in6_addr dst;
/** Multi hop indicator. */
uint8_t mhop;
/** Expected TTL. */
uint8_t ttl;
/** C bit (Control Plane Independent bit) indicator. */
uint8_t cbit;
/** Interface name size. */
uint8_t ifnamelen;
/** Interface name. */
char ifname[64];
/** Daemon or session VRF. */
vrf_id_t vrf_id;
/** Profile name length. */
uint8_t profilelen;
/** Profile name. */
char profile[BFD_PROFILE_NAME_LEN];
/*
* Deprecation fields: these fields should be removed once `ptm-bfd`
* no longer uses this interface.
*/
/** Minimum required receive interval (in microseconds). */
uint32_t min_rx;
/** Minimum desired transmission interval (in microseconds). */
uint32_t min_tx;
/** Detection multiplier. */
uint32_t detection_multiplier;
/** BFD client information output. */
struct bfd_info *bfd_info;
/** Write registration indicator. */
uint8_t set_flag;
};
/**
* Send a message to BFD daemon through the zebra client.
*
* \param zc the zebra client context.
* \param arg the BFD session command arguments.
*
* \returns `-1` on failure otherwise `0`.
*
* \see bfd_session_arg.
*/
extern int zclient_bfd_command(struct zclient *zc, struct bfd_session_arg *arg);
#ifdef __cplusplus
}
#endif
#endif /* _ZEBRA_BFD_H */
|
