1 /*********************************************************************
2 * Copyright 2017-2018 Network Device Education Foundation, Inc. ("NetDEF")
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; see the file COPYING; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 * bfdctl.h: all BFDd control socket protocol definitions.
22 * Rafael Zalamena <rzalamena@opensourcerouting.org>
28 #include <netinet/in.h>
34 * Auxiliary definitions
38 struct sockaddr_in sa_sin
;
39 struct sockaddr_in6 sa_sin6
;
47 #define BPC_DEF_DETECTMULTIPLIER 3
48 #define BPC_DEF_RECEIVEINTERVAL 300 /* milliseconds */
49 #define BPC_DEF_TRANSMITINTERVAL 300 /* milliseconds */
50 #define BPC_DEF_ECHOINTERVAL 50 /* milliseconds */
53 enum bfd_peer_status
{
54 BPS_SHUTDOWN
= 0, /* == PTM_BFD_ADM_DOWN, "adm-down" */
55 BPS_DOWN
= 1, /* == PTM_BFD_DOWN, "down" */
56 BPS_INIT
= 2, /* == PTM_BFD_INIT, "init" */
57 BPS_UP
= 3, /* == PTM_BFD_UP, "up" */
63 struct sockaddr_any bpc_peer
;
64 struct sockaddr_any bpc_local
;
67 char bpc_label
[MAXNAMELEN
];
70 char bpc_localif
[MAXNAMELEN
+ 1];
73 char bpc_vrfname
[MAXNAMELEN
+ 1];
75 bool bpc_has_detectmultiplier
;
76 uint8_t bpc_detectmultiplier
;
78 bool bpc_has_recvinterval
;
79 uint64_t bpc_recvinterval
;
81 bool bpc_has_txinterval
;
82 uint64_t bpc_txinterval
;
84 bool bpc_has_echointerval
;
85 uint64_t bpc_echointerval
;
91 /* Status information */
92 enum bfd_peer_status bpc_bps
;
94 uint32_t bpc_remoteid
;
96 uint8_t bpc_remotediag
;
97 uint8_t bpc_remote_detectmultiplier
;
98 uint64_t bpc_remote_recvinterval
;
99 uint64_t bpc_remote_txinterval
;
100 uint64_t bpc_remote_echointerval
;
101 uint64_t bpc_lastevent
;
106 * Protocol definitions
108 enum bc_msg_version
{
121 /* Notify flags to use with bcm_notify. */
122 #define BCM_NOTIFY_ALL ((uint64_t)-1)
123 #define BCM_NOTIFY_PEER_STATE (1ULL << 0)
124 #define BCM_NOTIFY_CONFIG (1ULL << 1)
125 #define BCM_NOTIFY_NONE 0
127 /* Response 'status' definitions. */
128 #define BCM_RESPONSE_OK "ok"
129 #define BCM_RESPONSE_ERROR "error"
131 /* Notify operation. */
132 #define BCM_NOTIFY_PEER_STATUS "status"
133 #define BCM_NOTIFY_CONFIG_ADD "add"
134 #define BCM_NOTIFY_CONFIG_DELETE "delete"
135 #define BCM_NOTIFY_CONFIG_UPDATE "update"
137 /* Notification special ID. */
138 #define BCM_NOTIFY_ID 0
140 struct bfd_control_msg
{
141 /* Total length without the header. */
144 * Message request/response id.
145 * All requests will have a correspondent response with the
151 /* Message version. */
153 /* Message payload. */