Normalize olsr_clock namespace
[olsrd.git] / src / olsr_cfg_gen.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, 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 #include "olsr_cfg_gen.h"
43 #include "olsr_protocol.h"
44 #include "ipcalc.h"
45 #include "olsr_ip_prefix_list.h"
46 #include "olsr_clock.h"
47
48 #include <errno.h>
49
50 static INLINE void
51 append_reltime(struct autobuf *abuf, const char *name, uint32_t val, uint32_t deflt, bool first)
52 {
53   struct millitxt_buf buf;
54
55   if (val != deflt) {
56     abuf_appendf(abuf, "    %s\t%s\n", name, olsr_clock_to_string(&buf, val));
57   } else if (first) {
58     abuf_appendf(abuf, "    #%s\t%s\n", name, olsr_clock_to_string(&buf, val));
59   }
60 }
61
62 void
63 olsr_write_cnf_buf(struct autobuf *abuf, struct olsr_config *cnf, bool write_more_comments)
64 {
65   char ipv6_buf[INET6_ADDRSTRLEN];     /* buffer for IPv6 inet_ntop */
66   struct millitxt_buf tbuf;
67   const char *s;
68
69   abuf_appendf(abuf, "#\n" "# Generated config file for %s\n" "#\n\n", olsrd_version);
70
71   /* IP version */
72   abuf_appendf(abuf, "# IP version to use (4 or 6)\n" "IpVersion\t%d\n\n", cnf->ip_version == AF_INET ? 4 : 6);
73
74   /* FIB Metric */
75   abuf_appendf(abuf, "# FIBMetric (\"%s\", \"%s\", or \"%s\")\n"
76                "FIBMetric\t\"%s\"\n\n",
77                CFG_FIBM_FLAT, CFG_FIBM_CORRECT, CFG_FIBM_APPROX,
78                FIBM_FLAT == cnf->fib_metric ? CFG_FIBM_FLAT : FIBM_CORRECT == cnf->fib_metric ? CFG_FIBM_CORRECT : CFG_FIBM_APPROX);
79
80   /* HNA IPv4/IPv6 */
81   abuf_appendf(abuf, "# HNA IPv%d routes\n"
82                "# syntax: netaddr/prefix\n" "Hna%d {\n", cnf->ip_version == AF_INET ? 4 : 6, cnf->ip_version == AF_INET ? 4 : 6);
83   if (!list_is_empty(&cnf->hna_entries)) {
84     struct ip_prefix_entry *h, *iterator;
85
86     OLSR_FOR_ALL_IPPREFIX_ENTRIES(&cnf->hna_entries, h, iterator) {
87       struct ipprefix_str strbuf;
88       abuf_appendf(abuf, "    %s\n", ip_prefix_to_string(cnf->ip_version, &strbuf, &h->net));
89     }
90   }
91   abuf_appendf(abuf, "}\n\n");
92
93   /* No interfaces */
94   abuf_appendf(abuf, "# Should olsrd keep on running even if there are\n"
95                "# no interfaces available? This is a good idea\n"
96                "# for a PCMCIA/USB hotswap environment.\n"
97                "# \"yes\" OR \"no\"\n" "AllowNoInt\t%s\n\n", cnf->allow_no_interfaces ? "yes" : "no");
98
99   /* TOS */
100   abuf_appendf(abuf, "# TOS(type of service) to use. Default is 16\n" "TosValue\t%d\n\n", cnf->tos);
101
102   /* RtProto */
103   abuf_appendf(abuf, "# Routing proto flag to use. Operating system default is 0\n" "RtProto\t\t%d\n\n", cnf->rt_proto);
104
105   /* RtTable */
106   abuf_appendf(abuf, "# Policy Routing Table to use. Default is 254\n" "RtTable\t\t%d\n\n", cnf->rt_table);
107
108   /* RtTableDefault */
109   abuf_appendf(abuf,
110                "# Policy Routing Table to use for the default Route. Default is 0 (Take the same table as specified by RtTable)\n"
111                "RtTableDefault\t\t%d\n\n", cnf->rt_table_default);
112
113   /* Willingness */
114   abuf_appendf(abuf, "# The fixed willingness to use(0-7)\n"
115                "# If not set willingness will be calculated\n"
116                "# dynammically based on battery/power status\n"
117                "%sWillingness\t%d\n\n", cnf->willingness_auto ? "#" : "", cnf->willingness_auto ? 4 : cnf->willingness);
118
119   /* Pollrate */
120   abuf_appendf(abuf, "# Polling rate in seconds(float).\n"
121                "# Auto uses default value 0.05 sec\n" "Pollrate\t%s\n",
122                olsr_clock_to_string(&tbuf, cnf->pollrate));
123
124   /* NIC Changes Pollrate */
125   abuf_appendf(abuf, "# Interval to poll network interfaces for configuration\n"
126                "# changes. Defaults to 2.5 seconds\n" "NicChgsPollInt\t%s\n",
127                olsr_clock_to_string(&tbuf, cnf->nic_chgs_pollrate));
128
129   /* TC redundancy */
130   abuf_appendf(abuf, "# TC redundancy\n"
131                "# Specifies how much neighbor info should\n"
132                "# be sent in TC messages\n"
133                "# Possible values are:\n"
134                "# 0 - only send MPR selectors\n"
135                "# 1 - send MPR selectors and MPRs\n"
136                "# 2 - send all neighbors\n" "# defaults to 0\n" "TcRedundancy\t%d\n\n", cnf->tc_redundancy);
137
138   /* MPR coverage */
139   abuf_appendf(abuf, "# MPR coverage\n"
140                "# Specifies how many MPRs a node should\n"
141                "# try select to reach every 2 hop neighbor\n"
142                "# Can be set to any integer >0\n" "# defaults to 1\n" "MprCoverage\t%d\n\n", cnf->mpr_coverage);
143
144   abuf_appendf(abuf, "# Fish Eye algorithm\n"
145                "# 0 = do not use fish eye\n" "# 1 = use fish eye\n" "LinkQualityFishEye\t%d\n\n", cnf->lq_fish);
146
147   abuf_appendf(abuf, "# NAT threshold\n" "NatThreshold\t%s\n\n", olsr_clock_to_string(&tbuf, cnf->lq_nat_thresh));
148
149   abuf_appendf(abuf, "# Clear screen when printing debug output?\n" "ClearScreen\t%s\n\n", cnf->clear_screen ? "yes" : "no");
150
151   /* Plugins */
152   abuf_appendf(abuf, "# Olsrd plugins to load\n"
153                "# This must be the absolute path to the file\n"
154                "# or the loader will use the following scheme:\n"
155                "# - Try the paths in the LD_LIBRARY_PATH \n"
156                "#   environment variable.\n"
157                "# - The list of libraries cached in /etc/ld.so.cache\n" "# - /lib, followed by /usr/lib\n\n");
158   if (cnf->plugins) {
159     struct plugin_entry *pe;
160     for (pe = cnf->plugins; pe != NULL; pe = pe->next) {
161       struct plugin_param *pp;
162       abuf_appendf(abuf, "LoadPlugin \"%s\" {\n", pe->name);
163       for (pp = pe->params; pp != NULL; pp = pp->next) {
164         abuf_appendf(abuf, "    PlParam \"%s\"\t\"%s\"\n", pp->key, pp->value);
165       }
166       abuf_appendf(abuf, "}\n");
167     }
168   }
169   abuf_appendf(abuf, "\n");
170
171   append_reltime(abuf, "TcInterval", cnf->tc_params.emission_interval, TC_INTERVAL, true);
172   append_reltime(abuf, "TcValidityTime", cnf->tc_params.validity_time, TOP_HOLD_TIME, true);
173   append_reltime(abuf, "MidInterval", cnf->mid_params.emission_interval, MID_INTERVAL, true);
174   append_reltime(abuf, "MidValidityTime", cnf->mid_params.validity_time, MID_HOLD_TIME, true);
175   append_reltime(abuf, "HnaInterval", cnf->hna_params.emission_interval, HNA_INTERVAL, true);
176   append_reltime(abuf, "HnaValidityTime", cnf->hna_params.validity_time, HNA_HOLD_TIME, true);
177
178   abuf_puts(abuf, "\n");
179
180   /* Interfaces */
181   abuf_appendf(abuf, "# Interfaces\n"
182                "# Multiple interfaces with the same configuration\n"
183                "# can shar the same config block. Just list the\n" "# interfaces(e.g. Interface \"eth0\" \"eth2\"\n");
184   /* Interfaces */
185   if (cnf->if_configs) {
186     struct olsr_if_config *in;
187     bool first;
188     for (in = cnf->if_configs, first = write_more_comments; in != NULL; in = in->next, first = false) {
189       abuf_appendf(abuf, "Interface \"%s\" {\n", in->name);
190
191       if (first) {
192         abuf_appendf(abuf, "    # IPv4 broadcast address to use. The\n"
193                      "    # one usefull example would be 255.255.255.255\n"
194                      "    # If not defined the broadcastaddress\n" "    # every card is configured with is used\n\n");
195       }
196
197       if (in->cnf->ipv4_broadcast.v4.s_addr) {
198         abuf_appendf(abuf, "    Ip4Broadcast\t%s\n", inet_ntoa(in->cnf->ipv4_broadcast.v4));
199       } else if (first) {
200         abuf_appendf(abuf, "    #Ip4Broadcast\t255.255.255.255\n");
201       }
202
203       if (first) {
204         abuf_appendf(abuf, "\n    # IPv6 address type to use.\n"
205                      "    # Must be 'auto', 'site-local', 'unique-local' or 'global'\n\n");
206       }
207       if (in->cnf->ipv6_addrtype == OLSR_IP6T_SITELOCAL)
208         s = CFG_IP6T_SITELOCAL;
209       else if (in->cnf->ipv6_addrtype == OLSR_IP6T_UNIQUELOCAL)
210         s = CFG_IP6T_UNIQUELOCAL;
211       else if (in->cnf->ipv6_addrtype == OLSR_IP6T_GLOBAL)
212         s = CFG_IP6T_GLOBAL;
213       else
214         s = CFG_IP6T_AUTO;
215       abuf_appendf(abuf, "    Ip6AddrType\t%s\n\n", s);
216
217       if (first) {
218         abuf_appendf(abuf, "\n"
219                      "    # IPv6 multicast address to use when\n"
220                      "    # using site-local addresses.\n" "    # If not defined, ff05::15 is used\n");
221       }
222       abuf_appendf(abuf, "    Ip6MulticastSite\t%s\n",
223                    inet_ntop(AF_INET6, &in->cnf->ipv6_multi_site.v6, ipv6_buf, sizeof(ipv6_buf)));
224       if (first) {
225         abuf_appendf(abuf, "\n    # IPv6 multicast address to use when\n"
226                      "    # using global addresses\n" "    # If not defined, ff0e::1 is used\n");
227       }
228       abuf_appendf(abuf, "    Ip6MulticastGlobal\t%s\n",
229                    inet_ntop(AF_INET6, &in->cnf->ipv6_multi_glbl.v6, ipv6_buf, sizeof(ipv6_buf)));
230       if (first) {
231         abuf_appendf(abuf, "\n");
232       }
233       abuf_appendf(abuf, "    # Olsrd can autodetect changes in\n"
234                    "    # interface configurations. Enabled by default\n"
235                    "    # turn off to save CPU.\n" "    AutoDetectChanges: %s\n\n", in->cnf->autodetect_chg ? "yes" : "no");
236
237       if (first) {
238         abuf_appendf(abuf, "    # Emission and validity intervals.\n"
239                      "    # If not defined, RFC proposed values will\n" "    # in most cases be used.\n");
240       }
241       append_reltime(abuf, "HelloInterval", in->cnf->hello_params.emission_interval, HELLO_INTERVAL, first);
242       append_reltime(abuf, "HelloValidityTime", in->cnf->hello_params.validity_time, NEIGHB_HOLD_TIME, first);
243       if (in->cnf->lq_mult == NULL) {
244         if (first) {
245           abuf_appendf(abuf, "    #LinkQualityMult\tdefault 1.0\n");
246         }
247       } else {
248         struct olsr_lq_mult *mult;
249         for (mult = in->cnf->lq_mult; mult != NULL; mult = mult->next) {
250           abuf_appendf(abuf, "    LinkQualityMult\t%s %0.2f\n",
251                        inet_ntop(cnf->ip_version, &mult->addr, ipv6_buf, sizeof(ipv6_buf)), (float)mult->value / 65536.0);
252         }
253       }
254
255       if (first) {
256         abuf_appendf(abuf, "    # When multiple links exist between hosts\n"
257                      "    # the weight of interface is used to determine\n"
258                      "    # the link to use. Normally the weight is\n"
259                      "    # automatically calculated by olsrd based\n"
260                      "    # on the characteristics of the interface,\n"
261                      "    # but here you can specify a fixed value.\n"
262                      "    # Olsrd will choose links with the lowest value.\n"
263                      "    # Note:\n"
264                      "    # Interface weight is used only when LinkQualityLevel is 0.\n"
265                      "    # For any other value of LinkQualityLevel, the interface ETX\n" "    # value is used instead.\n\n");
266       }
267       if (in->cnf->weight.fixed) {
268         abuf_appendf(abuf, "    Weight\t %d\n", in->cnf->weight.value);
269       } else if (first) {
270         abuf_appendf(abuf, "    #Weight\t 0\n");
271       }
272
273       abuf_appendf(abuf, "}\n\n");
274     }
275   }
276 }
277
278 /*
279  * Local Variables:
280  * c-basic-offset: 2
281  * indent-tabs-mode: nil
282  * End:
283  */