Rename "subsystems" directory to "base"
[oonf.git] / include / oonf / 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 <oonf/oonf.h>
50 #include <oonf/libcommon/netaddr.h>
51 #include <oonf/libcommon/netaddr_acl.h>
52 #include <oonf/libcore/oonf_subsystem.h>
53
54 #include <oonf/nhdp/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 EXPORT uint64_t olsrv2_get_tc_interval(void);
75 EXPORT uint64_t olsrv2_get_tc_validity(void);
76 EXPORT bool olsrv2_is_nhdp_routable(struct netaddr *addr);
77 EXPORT bool olsrv2_is_routable(struct netaddr *addr);
78 EXPORT bool olsrv2_mpr_shall_process(struct rfc5444_reader_tlvblock_context *, uint64_t vtime);
79 EXPORT bool olsrv2_mpr_shall_forwarding(
80   struct rfc5444_reader_tlvblock_context *context, struct netaddr *source_address, uint64_t vtime);
81 EXPORT void olsrv2_generate_tcs(bool);
82 EXPORT uint64_t olsrv2_set_tc_interval(uint64_t new_interval);
83 EXPORT uint64_t olsrv2_set_tc_validity(uint64_t new_interval);
84
85 /**
86  * @return validity time of former originator IDs
87  */
88 static INLINE uint64_t
89 olsrv2_get_old_originator_validity(void) {
90   return olsrv2_get_tc_validity() * 2;
91 }
92
93 #endif /* OLSRV2_H_ */