]> git.proxmox.com Git - mirror_frr.git/blob - ospf6d/ospf6_proto.h
Merge pull request #10555 from anlancs/doc-comment
[mirror_frr.git] / ospf6d / ospf6_proto.h
1 /*
2 * Common protocol data and data structures.
3 * Copyright (C) 2003 Yasuhiro Ohara
4 *
5 * This file is part of GNU Zebra.
6 *
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
10 * later version.
11 *
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #ifndef OSPF6_PROTO_H
23 #define OSPF6_PROTO_H
24
25 /* OSPF protocol version */
26 #define OSPFV3_VERSION 3
27
28 /* TOS field normaly null */
29 #define DEFAULT_TOS_VALUE 0x0
30
31 #define ALLSPFROUTERS6 "ff02::5"
32 #define ALLDROUTERS6 "ff02::6"
33
34 #define OSPF6_ROUTER_BIT_W (1 << 3)
35 #define OSPF6_ROUTER_BIT_V (1 << 2)
36 #define OSPF6_ROUTER_BIT_E (1 << 1)
37 #define OSPF6_ROUTER_BIT_B (1 << 0)
38 #define OSPF6_ROUTER_BIT_NT (1 << 4)
39
40
41 /* OSPF options */
42 /* present in HELLO, DD, LSA */
43 #define OSPF6_OPT_SET(x, opt) ((x)[2] |= (opt))
44 #define OSPF6_OPT_ISSET(x, opt) ((x)[2] & (opt))
45 #define OSPF6_OPT_CLEAR(x, opt) ((x)[2] &= ~(opt))
46 #define OSPF6_OPT_SET_EXT(x, opt) ((x)[1] |= (opt))
47 #define OSPF6_OPT_ISSET_EXT(x, opt) ((x)[1] & (opt))
48 #define OSPF6_OPT_CLEAR_EXT(x, opt) ((x)[1] &= ~(opt))
49 #define OSPF6_OPT_CLEAR_ALL(x) ((x)[0] = (x)[1] = (x)[2] = 0)
50
51 #define OSPF6_OPT_AT (1 << 2) /* Authentication trailer Capability */
52 #define OSPF6_OPT_L (1 << 1) /* Link local signalling Capability */
53 #define OSPF6_OPT_AF (1 << 0) /* Address family Capability */
54 /* 2 bits reserved for OSPFv2 migrated options */
55 #define OSPF6_OPT_DC (1 << 5) /* Demand Circuit handling Capability */
56 #define OSPF6_OPT_R (1 << 4) /* Forwarding Capability (Any Protocol) */
57 #define OSPF6_OPT_N (1 << 3) /* Handling Type-7 LSA Capability */
58 #define OSPF6_OPT_MC (1 << 2) /* Multicasting Capability */
59 #define OSPF6_OPT_E (1 << 1) /* AS External Capability */
60 #define OSPF6_OPT_V6 (1 << 0) /* IPv6 forwarding Capability */
61
62 /* OSPF6 Prefix */
63 #define OSPF6_PREFIX_MIN_SIZE 4U /* .length == 0 */
64 struct ospf6_prefix {
65 uint8_t prefix_length;
66 uint8_t prefix_options;
67 union {
68 uint16_t _prefix_metric;
69 uint16_t _prefix_referenced_lstype;
70 } u;
71 #define prefix_metric u._prefix_metric
72 #define prefix_refer_lstype u._prefix_referenced_lstype
73 /* followed by one address_prefix */
74 struct in6_addr addr[];
75 };
76
77 #define OSPF6_PREFIX_OPTION_NU (1 << 0) /* No Unicast */
78 #define OSPF6_PREFIX_OPTION_LA (1 << 1) /* Local Address */
79 #define OSPF6_PREFIX_OPTION_MC (1 << 2) /* MultiCast */
80 #define OSPF6_PREFIX_OPTION_P (1 << 3) /* Propagate (NSSA) */
81 #define OSPF6_PREFIX_OPTION_DN \
82 (1 << 4) /* DN bit to prevent loops in VPN environment */
83
84 /* caddr_t OSPF6_PREFIX_BODY (struct ospf6_prefix *); */
85 #define OSPF6_PREFIX_BODY(x) ((caddr_t)(x) + sizeof(struct ospf6_prefix))
86
87 /* size_t OSPF6_PREFIX_SPACE (int prefixlength); */
88 #define OSPF6_PREFIX_SPACE(x) ((((x) + 31) / 32) * 4)
89
90 /* size_t OSPF6_PREFIX_SIZE (struct ospf6_prefix *); */
91 #define OSPF6_PREFIX_SIZE(x) \
92 (OSPF6_PREFIX_SPACE((x)->prefix_length) + sizeof(struct ospf6_prefix))
93
94 /* struct ospf6_prefix *OSPF6_PREFIX_NEXT (struct ospf6_prefix *); */
95 #define OSPF6_PREFIX_NEXT(x) \
96 ((struct ospf6_prefix *)((caddr_t)(x) + OSPF6_PREFIX_SIZE(x)))
97
98 extern void ospf6_prefix_in6_addr(struct in6_addr *in6, const void *prefix_buf,
99 const struct ospf6_prefix *p);
100 extern void ospf6_prefix_apply_mask(struct ospf6_prefix *op);
101 extern void ospf6_prefix_options_printbuf(uint8_t prefix_options, char *buf,
102 int size);
103 extern void ospf6_capability_printbuf(char capability, char *buf, int size);
104 extern void ospf6_options_printbuf(uint8_t *options, char *buf, int size);
105
106 #endif /* OSPF6_PROTO_H */