1/*
2 *  This file is free software: you may copy, redistribute and/or modify it
3 *  under the terms of the GNU General Public License as published by the
4 *  Free Software Foundation, either version 2 of the License, or (at your
5 *  option) any later version.
6 *
7 *  This file is distributed in the hope that it will be useful, but
8 *  WITHOUT ANY WARRANTY; without even the implied warranty of
9 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
10 *  General Public License for more details.
11 *
12 *  You should have received a copy of the GNU General Public License
13 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
14 *
15 * This file incorporates work covered by the following copyright and
16 * permission notice:
17 *
18Copyright 2011 by Matthieu Boutier and Juliusz Chroboczek
19
20Permission is hereby granted, free of charge, to any person obtaining a copy
21of this software and associated documentation files (the "Software"), to deal
22in the Software without restriction, including without limitation the rights
23to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
24copies of the Software, and to permit persons to whom the Software is
25furnished to do so, subject to the following conditions:
26
27The above copyright notice and this permission notice shall be included in
28all copies or substantial portions of the Software.
29
30THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
33AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
35OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
36THE SOFTWARE.
37*/
38
39#ifndef BABEL_INTERFACE_H
40#define BABEL_INTERFACE_H
41
42#include <zebra.h>
43#include "zclient.h"
44#include "vty.h"
45
46#define CONFIG_DEFAULT 0
47#define CONFIG_NO 1
48#define CONFIG_YES 2
49
50/* babeld interface informations */
51struct babel_interface {
52    unsigned short flags;                     /* see below */
53    unsigned short cost;
54    int channel;
55    struct timeval hello_timeout;
56    struct timeval update_timeout;
57    struct timeval flush_timeout;
58    struct timeval update_flush_timeout;
59    unsigned char *ipv4;
60    int buffered;
61    int bufsize;
62    char have_buffered_hello;
63    char have_buffered_id;
64    char have_buffered_nh;
65    char have_buffered_prefix;
66    unsigned char buffered_id[16];
67    unsigned char buffered_nh[4];
68    unsigned char buffered_prefix[16];
69    unsigned char *sendbuf;
70    struct buffered_update *buffered_updates;
71    int num_buffered_updates;
72    int update_bufsize;
73    time_t bucket_time;
74    unsigned int bucket;
75    time_t last_update_time;
76    unsigned short hello_seqno;
77    unsigned hello_interval;
78    unsigned update_interval;
79
80    /* For filter type slot. */
81#define BABEL_FILTER_IN  0
82#define BABEL_FILTER_OUT 1
83#define BABEL_FILTER_MAX 2
84    struct access_list *list[BABEL_FILTER_MAX];               /* Access-list. */
85    struct prefix_list *prefix[BABEL_FILTER_MAX];             /* Prefix-list. */
86};
87
88typedef struct babel_interface babel_interface_nfo;
89static inline babel_interface_nfo* babel_get_if_nfo(struct interface *ifp)
90{
91    return ((babel_interface_nfo*) ifp->info);
92}
93
94/* babel_interface_nfo flags */
95#define BABEL_IF_IS_UP         (1 << 0)
96#define BABEL_IF_WIRED         (1 << 1)
97#define BABEL_IF_SPLIT_HORIZON (1 << 2)
98#define BABEL_IF_LQ            (1 << 3)
99#define BABEL_IF_FARAWAY       (1 << 4)
100
101/* Only INTERFERING can appear on the wire. */
102#define BABEL_IF_CHANNEL_UNKNOWN 0
103#define BABEL_IF_CHANNEL_INTERFERING 255
104#define BABEL_IF_CHANNEL_NONINTERFERING -2
105
106static inline int
107if_up(struct interface *ifp)
108{
109    return (if_is_operative(ifp) &&
110            ifp->connected != NULL &&
111            (babel_get_if_nfo(ifp)->flags & BABEL_IF_IS_UP));
112}
113
114/* types:
115 struct interface _ifp, struct listnode node */
116#define FOR_ALL_INTERFACES(_ifp, _node)                                              \
117    for(ALL_LIST_ELEMENTS_RO(iflist, _node, _ifp))
118
119/* types:
120 struct interface *ifp, struct connected *_connected, struct listnode *node */
121#define FOR_ALL_INTERFACES_ADDRESSES(ifp, _connected, _node)                   \
122    for(ALL_LIST_ELEMENTS_RO(ifp->connected, _node, _connected))
123
124struct buffered_update {
125    unsigned char id[8];
126    unsigned char prefix[16];
127    unsigned char plen;
128    unsigned char pad[3];
129};
130
131
132/* init function */
133void babel_if_init(void);
134
135/* Callback functions for zebra client */
136int babel_interface_up (int, struct zclient *, zebra_size_t);
137int babel_interface_down (int, struct zclient *, zebra_size_t);
138int babel_interface_add (int, struct zclient *, zebra_size_t);
139int babel_interface_delete (int, struct zclient *, zebra_size_t);
140int babel_interface_address_add (int, struct zclient *, zebra_size_t);
141int babel_interface_address_delete (int, struct zclient *, zebra_size_t);
142
143unsigned jitter(babel_interface_nfo *, int);
144unsigned update_jitter(babel_interface_nfo *babel_ifp, int urgent);
145/* return "true" if "address" is one of our ipv6 addresses */
146int is_interface_ll_address(struct interface *ifp, const unsigned char *address);
147/* Send retraction to all, and reset all interfaces statistics. */
148void babel_interface_close_all(void);
149extern int babel_enable_if_config_write (struct vty *);
150
151
152#endif
153