Merge branch 'master' into mpr_rework
[oonf.git] / src-plugins / olsrv2 / olsrv2 / olsrv2.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef OLSRV2_H_
47 #define OLSRV2_H_
48
49 #include "common/common_types.h"
50 #include "common/netaddr.h"
51 #include "common/netaddr_acl.h"
52 #include "core/oonf_subsystem.h"
53
54 #include "nhdp/nhdp_domain.h"
55
56 /*! subsystem identifier */
57 #define OONF_OLSRV2_SUBSYSTEM "olsrv2"
58
59 /*! configuration section for OLSRv2 */
60 #define CFG_OLSRV2_SECTION OONF_OLSRV2_SUBSYSTEM
61
62 /*! routable IPv4 addresses (default configuration) */
63 #define OLSRV2_ROUTABLE_IPV4 "-169.254.0.0/16\0-127.0.0.0/8\0-224.0.0.0/12\0"
64
65 /*! routable IPv6 addresses (default configuration) */
66 #define OLSRV2_ROUTABLE_IPV6 "-fe80::/10\0-::1\0-ff00::/8\0"
67
68 /*! default IPv4 originator addresses */
69 #define OLSRV2_ORIGINATOR_IPV4 "-127.0.0.0/8\0-224.0.0.0/12\0"
70
71 /*! default IPv6 originator addresses */
72 #define OLSRV2_ORIGINATOR_IPV6 "-::1\0-ff00::/8\0"
73
74 /**
75  * Creates a cfg_schema_entry for a locally attached network
76  * @param p_name parameter name
77  * @param p_def parameter default value
78  * @param p_help help text for configuration entry
79  * @param args variable list of additional arguments
80  */
81 #define CFG_VALIDATE_LAN(p_name, p_def, p_help, args...)         _CFG_VALIDATE(p_name, p_def, p_help, .cb_validate = olsrv2_validate_lan, .validate_param = {{.i8 = {AF_INET, AF_INET6, -1,-1, -1}}, {.b = true}}, ##args )
82
83 EXPORT uint64_t olsrv2_get_tc_interval(void);
84 EXPORT uint64_t olsrv2_get_tc_validity(void);
85 EXPORT bool olsrv2_is_nhdp_routable(struct netaddr *addr);
86 EXPORT bool olsrv2_is_routable(struct netaddr *addr);
87 EXPORT bool olsrv2_mpr_shall_process(
88     struct rfc5444_reader_tlvblock_context *, uint64_t vtime);
89 EXPORT bool olsrv2_mpr_shall_forwarding(
90     struct rfc5444_reader_tlvblock_context *context,
91     struct netaddr *source_address, uint64_t vtime);
92 EXPORT int olsrv2_validate_lan(const struct cfg_schema_entry *entry,
93     const char *section_name, const char *value, struct autobuf *out);
94
95 /**
96  * @return validity time of former originator IDs
97  */
98 static INLINE uint64_t
99 olsrv2_get_old_originator_validity(void) {
100   return olsrv2_get_tc_validity() * 2;
101 }
102
103 #endif /* OLSRV2_H_ */