0ccbab4dc45be2030ba6b26f5c0af91d598325c3
[olsrd.git] / src / cfgparser / cfgfile_gen.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2005, Andreas Tonnesen(andreto@olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "olsrd_conf.h"
42 #include "../ipcalc.h"
43 #include "../net_olsr.h"
44 #include "../common/autobuf.h"
45
46 #include <stdarg.h>
47 #include <stdio.h>
48 #include <string.h>
49 #include <errno.h>
50 #include <sys/types.h>
51 #include <netinet/in.h>
52 #include <arpa/inet.h>
53
54 int olsrd_write_cnf(struct olsrd_config *cnf, const char *fname) {
55   FILE *fd;
56   struct autobuf abuf;
57
58   fd = fopen(fname, "w");
59
60   if (fd == NULL) {
61     fprintf(stderr, "Could not open file %s for writing\n%s\n", fname, strerror(errno));
62     return -1;
63   }
64
65   printf("Writing config to file \"%s\".... ", fname);
66   abuf_init(&abuf, 1024);
67   olsrd_write_cnf_autobuf(&abuf, cnf);
68   if (fwrite(abuf.buf, abuf.len, 1, fd) < (size_t)abuf.len) {
69     fprintf(stderr, "Error, could not write the complete config file.\n");
70   }
71   abuf_free(&abuf);
72   fclose(fd);
73
74   printf("DONE\n");
75
76   return 1;
77 }
78
79 static int
80 if_appendf(struct autobuf *autobuf, bool comments, const char *fmt, ...)  __attribute__ ((format(printf, 3, 4)));
81
82 static int
83 if_appendf(struct autobuf *autobuf, bool comments, const char *fmt, ...)
84 {
85   int rv;
86   va_list ap;
87   char *first;
88
89   if (!comments) {
90     va_start(ap, fmt);
91     first = va_arg(ap, char*);
92     va_end(ap);
93     if (*first) {
94       return 0;
95     }
96   }
97
98   va_start(ap, fmt);
99   rv = abuf_vappendf(autobuf, fmt, ap);
100   va_end(ap);
101   return rv;
102 }
103
104 static void olsrd_write_if_autobuf(struct autobuf *out, struct if_config_options *cnfi, bool comments) {
105   struct ipaddr_str ipbuf;
106   struct olsr_lq_mult *mult;
107
108   abuf_puts(out, "{\n");
109   if (comments) abuf_puts(out,
110     "    # Interface Mode is used to prevent unnecessary\n"
111     "    # packet forwarding on switched ethernet interfaces\n"
112     "    # valid Modes are \"mesh\" and \"ether\"\n"
113     "    # (default is \"mesh\")\n"
114     "    \n");
115   if_appendf(out, comments, "    %sMode \"%s\"\n",
116       cnfi->mode == DEF_IF_MODE ? "# " : "",
117       OLSR_IF_MODE[cnfi->mode]);
118   if (comments) abuf_puts(out,
119     "    \n"
120     "    # IPv4 broadcast address for outgoing OLSR packets.\n"
121     "    # One useful example would be 255.255.255.255\n"
122     "    # The second useful value would be to\n"
123     "    # specify the peer address of an ptp-tunnel.\n"
124     "    # another name of this parameter is \"IPv4Multicast\"\n"
125     "    # (default is 0.0.0.0, which triggers the usage of the\n"
126     "    # interface broadcast IP)\n"
127     "    \n");
128   if_appendf(out, comments, "    %sIp4Broadcast      %s\n",
129       cnfi->ipv4_multicast.v4.s_addr == 0 ? "# " : "",
130       inet_ntop(AF_INET, &cnfi->ipv4_multicast, ipbuf.buf, sizeof(ipbuf)));
131   if (comments) abuf_puts(out,
132     "    \n"
133     "    # IPv6 multicast address\n"
134     "    # (default is FF02::6D, the manet-router linklocal multicast)\n"
135     "    \n");
136   if_appendf(out, comments, "    %sIPv6Multicast %s\n",
137       memcmp(&cnfi->ipv6_multicast, &ipv6_def_multicast, sizeof(ipv6_def_multicast)) == 0 ? "# " : "",
138       inet_ntop(AF_INET6, &cnfi->ipv6_multicast, ipbuf.buf, sizeof(ipbuf)));
139   if (comments) abuf_puts(out,
140     "    \n"
141     "    # IPv4 src address for outgoing OLSR packages\n"
142     "    # (default is 0.0.0.0, which triggers usage of the interface IP)\n"
143     "    \n");
144   if_appendf(out, comments, "    %sIPv4Src %s\n",
145       cnfi->ipv4_src.v4.s_addr == 0 ? "# " : "",
146       inet_ntop(AF_INET, &cnfi->ipv4_src, ipbuf.buf, sizeof(ipbuf)));
147   if (comments) abuf_puts(out,
148     "    \n"
149     "    # IPv6 src prefix. OLSRd will choose one of the interface IPs\n"
150     "    # which matches the prefix of this parameter.\n"
151     "    # (default is 0::/0, which triggers the usage\n"
152     "    # of a not-linklocal interface IP)\n"
153     "    \n");
154   if_appendf(out, comments, "    %sIPv6Src %s\n",
155       cnfi->ipv6_src.prefix_len == 0 ? "# " : "",
156       inet_ntop(AF_INET6, &cnfi->ipv6_src, ipbuf.buf, sizeof(ipbuf)));
157   if (comments) abuf_puts(out,
158     "    \n"
159     "    # Emission intervals in seconds.\n"
160     "    # If not defined, Freifunk network defaults are used\n"
161     "    # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)\n"
162     "    \n");
163   if_appendf(out, comments, "    %sHelloInterval       %3.1f\n",
164       cnfi->hello_params.emission_interval == HELLO_INTERVAL ? "# " : "",
165       (double)cnfi->hello_params.emission_interval);
166   if_appendf(out, comments, "    %sHelloValidityTime   %3.1f\n",
167       cnfi->hello_params.validity_time == NEIGHB_HOLD_TIME ? "# " : "",
168       (double)cnfi->hello_params.validity_time);
169   if_appendf(out, comments, "    %sTcInterval          %3.1f\n",
170       cnfi->tc_params.emission_interval == TC_INTERVAL ? "# " : "",
171       (double)cnfi->tc_params.emission_interval);
172   if_appendf(out, comments, "    %sTcValidityTime      %3.1f\n",
173       cnfi->tc_params.validity_time == TOP_HOLD_TIME ? "# " : "",
174       (double)cnfi->tc_params.validity_time);
175   if_appendf(out, comments, "    %sMidInterval         %3.1f\n",
176       cnfi->mid_params.emission_interval == MID_INTERVAL ? "# " : "",
177       (double)cnfi->mid_params.emission_interval);
178   if_appendf(out, comments, "    %sMidValidityTime     %3.1f\n",
179       cnfi->mid_params.validity_time == MID_HOLD_TIME ? "# " : "",
180       (double)cnfi->mid_params.validity_time);
181   if_appendf(out, comments, "    %sHnaInterval         %3.1f\n",
182       cnfi->hna_params.emission_interval == HNA_INTERVAL ? "# " : "",
183       (double)cnfi->hna_params.emission_interval);
184   if_appendf(out, comments, "    %sHnaValidityTime     %3.1f\n",
185       cnfi->hna_params.validity_time == HNA_HOLD_TIME ? "# " : "",
186       (double)cnfi->hna_params.validity_time);
187   if (comments) abuf_puts(out,
188     "    \n"
189     "    # When multiple links exist between hosts\n"
190     "    # the weight of interface is used to determine\n"
191     "    # the link to use. Normally the weight is\n"
192     "    # automatically calculated by olsrd based\n"
193     "    # on the characteristics of the interface,\n"
194     "    # but here you can specify a fixed value.\n"
195     "    # Olsrd will choose links with the lowest value.\n"
196     "    # Note:\n"
197     "    # Interface weight is used only when LinkQualityLevel is set to 0.\n"
198     "    # For any other value of LinkQualityLevel, the interface ETX\n"
199     "    # value is used instead.\n");
200   if_appendf(out, comments, "    %sWeight %d\n",
201       !cnfi->weight.fixed ? "# " : "",
202       cnfi->weight.value);
203   if (comments) abuf_puts(out,
204     "    \n"
205     "    # If a certain route should be preferred\n"
206     "    # or ignored by the mesh, the Link Quality\n"
207     "    # value of a node can be multiplied with a factor\n"
208     "    # entered here. In the example the route\n"
209     "    # using 192.168.0.1 would rather be ignored.\n"
210     "    # A multiplier of 0.5 will result in a small\n"
211     "    # (bad) LinkQuality value and a high (bad)\n"
212     "    # ETX value.\n"
213     "    # Note:\n"
214     "    # Link quality multiplier is used only when\n"
215     "    # LinkQualityLevel is > 0.\n"
216     "    \n");
217   mult = cnfi->lq_mult;
218
219   if (mult == NULL) {
220     if (comments) abuf_puts(out, "    # LinkQualityMult 192.168.0.1 0.5\n");
221   } else {
222     while (mult != NULL) {
223       if_appendf(out, comments, "    LinkQualityMult    %s %0.2f\n",
224           olsr_ip_to_string(&ipbuf, &mult->addr),
225           (double)((float)(mult->value) / 65536.0f));
226       mult = mult->next;
227     }
228   }
229   abuf_puts(out, "}\n");
230 }
231
232 void olsrd_write_cnf_autobuf(struct autobuf *out, struct olsrd_config *cnf) {
233   struct ip_prefix_list *hna = cnf->hna_entries;
234   struct olsr_if *interf = cnf->interfaces;
235   struct plugin_entry *plugins = cnf->plugins;
236   struct plugin_param *pl_param;
237   struct ip_prefix_list *ipc_nets = cnf->ipc_nets;
238
239   struct ipaddr_str ipbuf;
240   bool first;
241
242   abuf_appendf(out, "#\n"
243       "# Configuration file for %s\n"
244       "# automatically generated by olsrd-cnf parser v. %s\n"
245       "#\n"
246       "\n",
247       olsrd_version, PARSER_VERSION);
248   abuf_puts(out,
249     "# OLSR.org routing daemon config file\n"
250     "# This file contains ALL available options and explanations about them\n"
251     "#\n"
252     "# Lines starting with a # are discarded\n"
253     "#\n"
254     "\n"
255     "#### ATTENTION for IPv6 users ####\n"
256     "# Because of limitations in the parser IPv6 addresses must NOT\n"
257     "# begin with a \":\", so please add a \"0\" as a prefix.\n"
258     "\n"
259     "###########################\n"
260     "### Basic configuration ###\n"
261     "###########################\n"
262     "# keep this settings at the beginning of your first configuration file\n"
263     "\n"
264     "# Debug level (0-9)\n"
265     "# If set to 0 the daemon runs in the background, unless \"NoFork\" is set to true\n"
266     "# (Default is 1)\n"
267     "\n");
268   abuf_appendf(out, "%sDebugLevel  %d\n",
269       cnf->debug_level == DEF_DEBUGLVL ? "# " : "",
270       cnf->debug_level);
271   abuf_puts(out,
272     "\n"
273     "# IP version to use (4 or 6)\n"
274     "# (Default is 4)\n"
275     "\n");
276   abuf_appendf(out, "%sIpVersion %d\n",
277       cnf->ip_version == DEF_IP_VERSION ? "# " : "",
278       cnf->ip_version == AF_INET ? 4 : 6);
279   abuf_puts(out,
280     "\n"
281     "#################################\n"
282     "### OLSRd agent configuration ###\n"
283     "#################################\n"
284     "# this parameters control the settings of the routing agent which are not\n"
285     "# related to the OLSR protocol and it's extensions\n"
286     "\n"
287     "# Clear the screen each time the internal state changes\n"
288     "# (Default is yes)\n"
289     "\n");
290   abuf_appendf(out, "%sClearScreen     %s\n",
291       cnf->clear_screen == DEF_CLEAR_SCREEN ? "# " : "",
292       cnf->clear_screen ? "yes" : "no");
293   abuf_puts(out,
294     "\n"
295     "# Should olsrd keep on running even if there are\n"
296     "# no interfaces available? This is a good idea\n"
297     "# for a PCMCIA/USB hotswap environment.\n"
298     "# (Default is yes)\n"
299     "\n");
300   abuf_appendf(out, "%sAllowNoInt  %s\n",
301       cnf->allow_no_interfaces == DEF_ALLOW_NO_INTS ? "# " : "",
302       cnf->allow_no_interfaces ? "yes" : "no");
303   abuf_puts(out,
304     "\n"
305     "# LockFile\n"
306     "# The lockfile is used to prevent multiple OLSR instances running at the same\n"
307     "# time.\n"
308     "# (Linux/BSD default is \"/var/run/olsrd-ipv(4/6).lock\")\n"
309     "# (Win32 default is \"<configfile>-ipv(4/6).lock\")\n"
310     "\n");
311   abuf_appendf(out, "%sLockFile \"%s\"\n",
312       cnf->lock_file == NULL ? "# " : "",
313       cnf->lock_file ? cnf->lock_file : "lockfile");
314   abuf_puts(out,
315     "\n"
316     "# Polling rate for OLSR sockets in seconds (float). \n"
317     "# (Default is 0.05)\n"
318     "\n");
319   abuf_appendf(out, "%sPollrate  %.2f\n",
320       cnf->pollrate == (float)DEF_POLLRATE ? "# " : "",
321       (double)cnf->pollrate);
322   abuf_puts(out,
323     "\n"
324     "# Interval to poll network interfaces for configuration changes (in seconds).\n"
325     "# Linux systems can detect interface statechange via netlink sockets.\n"
326     "# (Defaults is 2.5)\n"
327     "\n");
328   abuf_appendf(out, "%sNicChgsPollInt  %.1f\n",
329       cnf->nic_chgs_pollrate == (float)DEF_NICCHGPOLLRT ? "# " : "",
330       (double)cnf->nic_chgs_pollrate);
331   abuf_puts(out,
332     "\n"
333     "# TOS(type of service) value for the IP header of control traffic.\n"
334     "# (Default is 16)\n"
335     "\n");
336   abuf_appendf(out, "%sTosValue %u\n",
337       cnf->tos == DEF_TOS ? "# " : "",
338       cnf->tos);
339   abuf_puts(out,
340     "\n"
341     "# FIBMetric controls the metric value of the host-routes OLSRd sets.\n"
342     "# - \"flat\" means that the metric value is always 2. This is the preferred value\n"
343     "#   because it helps the linux kernel routing to clean up older routes\n"
344     "# - \"correct\" use the hopcount as the metric value.\n"
345     "# - \"approx\" use the hopcount as the metric value too, but does only update the\n"
346     "#   hopcount if the nexthop changes too\n"
347     "# (Default is \"flat\")\n"
348     "\n");
349   abuf_appendf(out, "%sFIBMetric \"%s\"\n",
350       cnf->fib_metric == DEF_FIB_METRIC ? "# " : "",
351       FIB_METRIC_TXT[cnf->fib_metric]);
352   abuf_puts(out,
353     "\n"
354     "#######################################\n"
355     "### Linux specific OLSRd extensions ###\n"
356     "#######################################\n"
357     "# these parameters are only working on linux at the moment, but might become\n"
358     "# useful on BSD in the future\n"
359     "\n"
360     "# SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip\n"
361     "# of the node. In addition to this an additional localhost device is created\n"
362     "# to make sure the returning traffic can be received.\n"
363     "# (Default is \"no\")\n"
364     "\n");
365   abuf_appendf(out, "%sSrcIpRoutes %s\n",
366       cnf->use_src_ip_routes == DEF_USE_SRCIP_ROUTES ? "# " : "",
367       cnf->use_src_ip_routes ? "yes" : "no");
368   abuf_puts(out,
369     "\n"
370     "# Specify the proto tag to be used for routes olsr inserts into kernel\n"
371     "# currently only implemented for linux\n"
372     "# valid values under linux are 1 .. 254\n"
373     "# 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)\n"
374     "# 2 KERNEL routes (not very wise to use)\n"
375     "# 3 BOOT (should in fact not be used by routing daemons)\n"
376     "# 4 STATIC \n"
377     "# 8 .. 15 various routing daemons (gated, zebra, bird, & co)\n"
378     "# (defaults to 0 which gets replaced by an OS-specific default value\n"
379     "# under linux 3 (BOOT) (for backward compatibility)\n"
380     "\n");
381   abuf_appendf(out, "%sRtProto %u\n",
382       cnf->rt_proto == DEF_RTPROTO ? "# " : "",
383       cnf->rt_proto);
384   abuf_puts(out,
385     "\n"
386     "# Specifies the routing Table olsr uses\n"
387     "# RtTable is for host routes, RtTableDefault for the route to the default\n"
388     "# internet gateway (2 in case of IPv6+NIIT) and RtTableTunnel is for\n"
389     "# routes to the ipip tunnels, valid values are 1 to 254\n"
390     "# There is a special parameter \"auto\" (choose default below)\n"
391     "# (with smartgw: default is 254/223/224)\n"
392     "# (without smartgw: default is 254/254/254, linux main table)\n"
393     "\n");
394   abuf_appendf(out, "RtTable %u\n",
395       cnf->rt_table);
396   abuf_appendf(out, "RtTableDefault %u\n",
397       cnf->rt_table_default);
398   abuf_appendf(out, "RtTableTunnel %u\n",
399       cnf->rt_table_tunnel);
400   abuf_puts(out,
401     "\n"
402     "# Specifies the policy rule priorities for the three routing tables and\n"
403     "# a special rule for smartgateway routing (see README-Olsr-Extensions)\n"
404     "# Priorities can only be set if three different routing tables are set.\n"
405     "# if set the values must obey to condition\n"
406     "# RtTablePriority < RtTableDefaultOlsrPriority\n"
407     "# < RtTableTunnelPriority < RtTableDefaultPriority\n"
408     "# There are two special parameters, \"auto\" (choose fitting to SmartGW\n"
409     "# mode) and \"none\" (do not set policy rule)\n"
410     "# (with smartgw: default is none/32776/32786/32796)\n"
411     "# (without smartgw: default is none/none/none/none)\n"
412     "\n");
413   abuf_appendf(out, "RtTablePriority %u\n",
414       cnf->rt_table_pri);
415   abuf_appendf(out, "RtTableDefaultOlsrPriority %u\n",
416       cnf->rt_table_default_pri);
417   abuf_appendf(out, "RtTableTunnelPriority %u\n",
418       cnf->rt_table_tunnel_pri);
419   abuf_appendf(out, "RtTableDefaultPriority %u\n",
420       cnf->rt_table_defaultolsr_pri);
421   abuf_puts(out,
422     "\n"
423     "# Activates (in IPv6 mode) the automatic use of NIIT\n"
424     "# (see README-Olsr-Extensions)\n"
425     "# (default is \"yes\")\n"
426     "\n");
427   abuf_appendf(out, "%sUseNiit %s\n",
428       cnf->use_niit == DEF_USE_NIIT ? "# " : "",
429       cnf->use_niit ? "yes" : "no");
430   abuf_puts(out,
431     "\n"
432     "# Activates the smartgateway ipip tunnel feature.\n"
433     "# See README-Olsr-Extensions for a description of smartgateways.\n"
434     "# (default is \"yes\")\n"
435     "\n");
436   abuf_appendf(out, "%sSmartGateway %s\n",
437       cnf->smart_gw_active == DEF_SMART_GW ? "# " : "",
438       cnf->smart_gw_active ? "yes" : "no");
439   abuf_puts(out,
440     "\n"
441     "# Signals that the server tunnel must always be removed on shutdown,\n"
442     "# irrespective of the interface up/down state during startup.\n"
443     "# (default is \"no\")\n"
444     "\n");
445   abuf_appendf(out, "%sSmartGatewayAlwaysRemoveServerTunnel %s\n",
446       cnf->smart_gw_always_remove_server_tunnel == DEF_SMART_GW_ALWAYS_REMOVE_SERVER_TUNNEL ? "# " : "",
447       cnf->smart_gw_always_remove_server_tunnel ? "yes" : "no");
448   abuf_puts(out,
449     "\n"
450     "# Determines the maximum number of gateways that can be in use at any given\n"
451     "# time. This setting is used to mitigate the effects of breaking connections\n"
452     "# (due to the selection of a new gateway) on a dynamic network.\n"
453     "# (default is 1)\n"
454     "\n");
455   abuf_appendf(out, "%sSmartGatewayUseCount %d\n",
456       cnf->smart_gw_use_count == DEF_GW_USE_COUNT ? "# " : "",
457       cnf->smart_gw_use_count);
458   abuf_puts(out,
459     "\n"
460     "# Determines the policy routing script that is executed during startup and\n"
461     "# shutdown of olsrd. The script is only executed when SmartGatewayUseCount\n"
462     "# is set to a value larger than 1. The script must setup policy routing\n"
463     "# rules such that multi-gateway mode works. A sample script is included.\n"
464     "# (default is not set)\n"
465     "\n");
466   abuf_appendf(out, "%sSmartGatewayPolicyRoutingScript %s\n",
467       !cnf->smart_gw_policyrouting_script ? "# " : "",
468       !cnf->smart_gw_policyrouting_script ? "" : cnf->smart_gw_policyrouting_script);
469   abuf_puts(out,
470     "\n"
471     "# Determines the egress interfaces that are part of the multi-gateway setup and\n"
472     "# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which\n"
473     "# case it must be explicitly set).\n"
474     "# (default is not set)\n"
475     "\n");
476   abuf_appendf(out, "%sSmartGatewayEgressInterfaces",
477       !cnf->smart_gw_egress_interfaces ? "# " : "");
478   {
479     struct sgw_egress_if * sgwegressif = olsr_cnf->smart_gw_egress_interfaces;
480     while (sgwegressif) {
481       abuf_appendf(out, " \"%s\"", sgwegressif->name);
482       sgwegressif = sgwegressif->next;
483     }
484     abuf_puts(out, "\n");
485   }
486   abuf_puts(out,
487     "\n"
488     "# Determines the offset of the smart gateway egress interfaces mark that are\n"
489     "# used in the policy routing rules in a multi-gateway setup. Only relevant\n"
490     "# when a multi-gateway setup is used.\n"
491     "# (default is 91)\n"
492     "\n");
493   abuf_appendf(out, "%sSmartGatewayMarkOffsetEgress %u\n",
494       cnf->smart_gw_mark_offset_egress == DEF_GW_MARK_OFFSET_EGRESS ? "# " : "",
495       cnf->smart_gw_mark_offset_egress);
496   abuf_puts(out,
497     "\n"
498     "# Determines the offset of the smart gateway tunnel interfaces mark that are\n"
499     "# used in the policy routing rules in a multi-gateway setup. Only relevant\n"
500     "# when a multi-gateway setup is used.\n"
501     "# The ranges [egress offset, egress offset + egress count] and\n"
502     "# [tunnel offset, tunnel offset + use count] are not allowed to overlap.\n"
503     "# (default is 101)\n"
504     "\n");
505   abuf_appendf(out, "%sSmartGatewayMarkOffsetTunnels %u\n",
506       cnf->smart_gw_mark_offset_tunnels == DEF_GW_MARK_OFFSET_TUNNELS ? "# " : "",
507       cnf->smart_gw_mark_offset_tunnels);
508   abuf_puts(out,
509     "\n"
510     "# Allows the selection of a smartgateway with NAT (only for IPv4)\n"
511     "# (default is \"yes\")\n"
512     "\n");
513   abuf_appendf(out, "%sSmartGatewayAllowNAT %s\n",
514       cnf->smart_gw_allow_nat == DEF_GW_ALLOW_NAT ? "# " : "",
515       cnf->smart_gw_allow_nat ? "yes" : "no");
516   abuf_puts(out,
517     "\n"
518     "# Determines the period (in milliseconds) on which a new smart gateway\n"
519     "# selection is performed.\n"
520     "# (default is 10000 milliseconds)\n"
521     "\n");
522   abuf_appendf(out, "%sSmartGatewayPeriod %d\n",
523       cnf->smart_gw_period == DEF_GW_PERIOD ? "# " : "",
524       cnf->smart_gw_period);
525   abuf_puts(out,
526     "\n"
527     "# Determines the number of times the link state database must be stable\n"
528     "# before a new smart gateway is selected.\n"
529     "# (default is 6)\n"
530     "\n");
531   abuf_appendf(out, "%sSmartGatewayStableCount %d\n",
532       cnf->smart_gw_stablecount == DEF_GW_STABLE_COUNT ? "# " : "",
533       cnf->smart_gw_stablecount);
534   abuf_puts(out,
535     "\n"
536     "# When another gateway than the current one has a cost of less than the cost\n"
537     "# of the current gateway multiplied by SmartGatewayThreshold then the smart\n"
538     "# gateway is switched to the other gateway. The unit is percentage.\n"
539     "# (defaults to 0)\n"
540     "\n");
541   abuf_appendf(out, "%sSmartGatewayThreshold  %d\n",
542       cnf->smart_gw_thresh == DEF_GW_THRESH ? "# " : "",
543       cnf->smart_gw_thresh);
544   abuf_puts(out,
545     "\n"
546     "# The weighing factor for the gateway uplink bandwidth (exit link, uplink).\n"
547     "# See README-Olsr-Extensions for a description of smart gateways.\n"
548     "# (default is 1)\n"
549     "\n");
550   abuf_appendf(out, "%sSmartGatewayWeightExitLinkUp  %d\n",
551       cnf->smart_gw_weight_exitlink_up == DEF_GW_WEIGHT_EXITLINK_UP ? "# " : "",
552       cnf->smart_gw_weight_exitlink_up);
553   abuf_puts(out,
554     "\n"
555     "# The weighing factor for the gateway downlink bandwidth (exit link, downlink).\n"
556     "# See README-Olsr-Extensions for a description of smart gateways.\n"
557     "# (default is 1)\n"
558     "\n");
559   abuf_appendf(out, "%sSmartGatewayWeightExitLinkDown  %d\n",
560       cnf->smart_gw_weight_exitlink_down == DEF_GW_WEIGHT_EXITLINK_DOWN ? "# " : "",
561       cnf->smart_gw_weight_exitlink_down);
562   abuf_puts(out,
563     "\n"
564     "# The weighing factor for the ETX costs.\n"
565     "# See README-Olsr-Extensions for a description of smart gateways.\n"
566     "# (default is 1)\n"
567     "\n");
568   abuf_appendf(out, "%sSmartGatewayWeightEtx  %d\n",
569       cnf->smart_gw_weight_etx == DEF_GW_WEIGHT_ETX ? "# " : "",
570       cnf->smart_gw_weight_etx);
571
572   abuf_puts(out,
573     "\n"
574     "# The divider for the ETX costs.\n"
575     "# See README-Olsr-Extensions for a description of smart gateways.\n"
576     "# (default is 0)\n"
577     "\n");
578   abuf_appendf(out, "%sSmartGatewayDividerEtx  %d\n",
579       cnf->smart_gw_divider_etx == DEF_GW_DIVIDER_ETX ? "# " : "",
580       cnf->smart_gw_divider_etx);
581   abuf_puts(out,
582     "\n"
583     "# Defines what kind of Uplink this node will publish as a\n"
584     "# smartgateway. The existence of the uplink is detected by\n"
585     "# a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.\n"
586     "# possible values are \"none\", \"ipv4\", \"ipv6\", \"both\"\n"
587     "# (default is \"both\")\n"
588     "\n");
589   abuf_appendf(out, "%sSmartGatewayUplink \"%s\"\n",
590       cnf->smart_gw_type == DEF_GW_TYPE ? "# " : "",
591       GW_UPLINK_TXT[cnf->smart_gw_type]);
592   abuf_puts(out,
593     "\n"
594     "# Specifies if the local ipv4 uplink use NAT\n"
595     "# (default is \"yes\")\n"
596     "\n");
597   abuf_appendf(out, "%sSmartGatewayUplinkNAT %s\n",
598       cnf->smart_gw_uplink_nat == DEF_GW_UPLINK_NAT ? "# " : "",
599       cnf->smart_gw_uplink_nat ? "yes" : "no");
600   abuf_puts(out,
601     "\n"
602     "# Specifies the speed of the uplink in kilobit/s.\n"
603     "# First parameter is upstream, second parameter is downstream\n"
604     "# (default is 128/1024)\n"
605     "\n");
606   abuf_appendf(out, "%sSmartGatewaySpeed %d %d\n",
607       cnf->smart_gw_uplink == DEF_UPLINK_SPEED && cnf->smart_gw_downlink == DEF_DOWNLINK_SPEED ? "# " : "",
608       cnf->smart_gw_uplink, cnf->smart_gw_downlink);
609   abuf_puts(out,
610     "\n"
611     "# Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix\n"
612     "# length of more than 64 is not allowed.\n"
613     "# (default is 0::/0\n"
614     "\n");
615   abuf_appendf(out, "%sSmartGatewayPrefix %s\n",
616       cnf->smart_gw_prefix.prefix_len == 0 ? "# " : "",
617       olsr_ip_prefix_to_string(&cnf->smart_gw_prefix));
618   abuf_puts(out,
619     "\n"
620     "##############################\n"
621     "### OLSR protocol settings ###\n"
622     "##############################\n"
623     "\n"
624     "# For testing purposes it may be nice to use another port for olsrd\n"
625     "# for using another port than the IANA assigned one \n"
626     "# for a production network, there should be a good reason!!\n"
627     "# valid values are integers >1, please be careful with using reserved\n"
628     "# port numbers\n"
629     "# (default is 698, the IANA assigned olsr-port)\n"
630     "\n");
631   abuf_appendf(out, "%sOlsrPort %u\n",
632       cnf->olsrport == DEF_OLSRPORT ? "# " : "",
633       cnf->olsrport);
634   abuf_puts(out,
635     "\n"
636     "# Sets the main IP (originator ip) of the router. This IP will NEVER\n"
637     "# change during the uptime of olsrd.\n"
638     "# (default is 0.0.0.0, which triggers usage of the IP of the first interface)\n"
639     "\n");
640   abuf_appendf(out, "MainIp %s\n",
641       olsr_ip_to_string(&ipbuf, &cnf->main_addr));
642   abuf_puts(out,
643     "\n"
644     "# The fixed willingness to use (0-7)\n"
645     "# If not set willingness will be calculated\n"
646     "# dynamically based on battery/power status\n"
647     "# (default is 3)\n"
648     "\n");
649   abuf_appendf(out, "%sWillingness     %u\n",
650       cnf->willingness == DEF_WILLINGNESS ? "# " : "",
651       cnf->willingness);
652   abuf_puts(out,
653     "\n"
654     "# HNA (Host network association) allows the OLSR to announce\n"
655     "# additional IPs or IP subnets to the net that are reachable\n"
656     "# through this node.\n"
657     "# Syntax for HNA4 is \"network-address    network-mask\"\n"
658     "# Syntax for HNA6 is \"network-address    prefix-length\"\n"
659     "# (default is no HNA)\n");
660   abuf_appendf(out, "Hna%u\n"
661     "{\n",
662     cnf->ip_version == AF_INET ? 4 : 6);
663   while (hna) {
664     struct ipaddr_str strbuf;
665     abuf_appendf(out, "    %s\n", olsr_ip_prefix_to_string(&hna->net));
666     hna = hna->next;
667   }
668   abuf_puts(out,
669     "}\n"
670     "\n"
671     "# Hysteresis for link sensing (only for hopcount metric)\n"
672     "# Hysteresis adds more robustness to the link sensing\n"
673     "# but delays neighbor registration.\n"
674     "# (defaults to yes)\n"
675     "\n");
676   abuf_appendf(out, "%sUseHysteresis %s\n",
677       cnf->use_hysteresis == DEF_USE_HYST ? "# " : "",
678       cnf->use_hysteresis ? "yes" : "no");
679   abuf_puts(out,
680     "\n"
681     "# Hysteresis parameters (only for hopcount metric)\n"
682     "# Do not alter these unless you know what you are doing!\n"
683     "# Set to auto by default. Allowed values are floating point\n"
684     "# values in the interval 0,1\n"
685     "# THR_LOW must always be lower than THR_HIGH!!\n"
686     "# (default is 0.5/0.8/0.3)\n"
687     "\n");
688   abuf_appendf(out, "%sHystScaling  %.2f\n",
689       cnf->hysteresis_param.scaling == (float)HYST_SCALING ? "# " : "",
690       (double)cnf->hysteresis_param.scaling);
691   abuf_appendf(out, "%sHystThrHigh  %.2f\n",
692       cnf->hysteresis_param.thr_high == (float)HYST_THRESHOLD_HIGH ? "# " : "",
693       (double)cnf->hysteresis_param.thr_high);
694   abuf_appendf(out, "%sHystThrLow  %.2f\n",
695       cnf->hysteresis_param.thr_low == (float)HYST_THRESHOLD_LOW ? "# " : "",
696       (double)cnf->hysteresis_param.thr_low);
697   abuf_puts(out,
698     "\n"
699     "# TC redundancy\n"
700     "# Specifies how much neighbor info should be sent in\n"
701     "# TC messages. Because of a design problem in the 0.5.x\n"
702     "# dijkstra implementation this value must be set to 2.\n"
703     "# 2 - send all neighbors\n"
704     "# (default is 2)\n"
705     "\n");
706   abuf_appendf(out, "%sTcRedundancy  %d\n",
707       cnf->tc_redundancy == TC_REDUNDANCY ? "# " : "",
708       cnf->tc_redundancy);
709   abuf_puts(out,
710     "\n"
711     "# MPR coverage specifies how many MPRs a node should\n"
712     "# try select to reach every 2 hop neighbor. Because of\n"
713     "# a design problem in the 0.5.x dijkstra algorithm this\n"
714     "# value should be set to 7.\n"
715     "# (default is 7)\n"
716     "\n");
717   abuf_appendf(out, "%sMprCoverage %d\n",
718       cnf->mpr_coverage == MPR_COVERAGE ? "# " : "",
719       cnf->mpr_coverage);
720   abuf_puts(out,
721     "\n"
722     "################################\n"
723     "### OLSR protocol extensions ###\n"
724     "################################\n"
725     "\n"
726     "# Link quality level switch between hopcount and \n"
727     "# cost-based (mostly ETX) routing. Because of\n"
728     "# a design problem in the 0.5.x dijkstra algorithm this\n"
729     "# value should not be set to 1.\n"
730     "# 0 = do not use link quality\n"
731     "# 2 = use link quality for MPR selection and routing\n"
732     "# (default is 2)\n"
733     "\n");
734   abuf_appendf(out, "%sLinkQualityLevel %d\n",
735       cnf->lq_level == DEF_LQ_LEVEL ? "# " : "",
736       cnf->lq_level);
737   abuf_puts(out,
738     "\n"
739     "# Link quality algorithm (only for lq level 2)\n"
740     "# (see README-Olsr-Extensions)\n"
741     "# - \"etx_float\", a floating point  ETX with exponential aging\n"
742     "# - \"etx_fpm\", same as ext_float, but with integer arithmetic\n"
743     "# - \"etx_ff\" (ETX freifunk), an etx variant which use all OLSR\n"
744     "#   traffic (instead of only hellos) for ETX calculation\n"
745     "# - \"etx_ffeth\", an incompatible variant of etx_ff that allows\n"
746     "#   ethernet links with ETX 0.1.\n"
747     "# (defaults to \"etx_ff\")\n"
748     "\n");
749   abuf_appendf(out, "%sLinkQualityAlgorithm    \"%s\"\n",
750       cnf->lq_algorithm == NULL ? "# " : "",
751       cnf->lq_algorithm == NULL ? DEF_LQ_ALGORITHM : cnf->lq_algorithm);
752   abuf_puts(out,
753     "\n"
754     "# Link quality aging factor (only for lq level 2)\n"
755     "# Tuning parameter for etx_float and etx_fpm, smaller values\n"
756     "# mean slower changes of ETX value. (allowed values are\n"
757     "# between 0.01 and 1.0)\n"
758     "# (default is 0.05)\n"
759     "\n");
760   abuf_appendf(out, "%sLinkQualityAging %.2f\n",
761       cnf->lq_aging == (float)DEF_LQ_AGING ? "# " : "",
762       (double)cnf->lq_aging);
763   abuf_puts(out,
764     "\n"
765     "# Fisheye mechanism for TCs (0 meansoff, 1 means on)\n"
766     "# (default is 1)\n"
767     "\n");
768   abuf_appendf(out, "%sLinkQualityFishEye  %d\n",
769       cnf->lq_fish == DEF_LQ_FISH ? "# " : "",
770       cnf->lq_fish);
771   abuf_puts(out,
772     "\n"
773     "#\n"
774     "# NatThreshold \n"
775     "#\n"
776     "# (currently this is only in the freifunk firmware)\n"
777     "# If the NAT-Endpoint (the preferred 0/0 HNA emitting node)\n"
778     "# is to be changed, the ETX value of the current 0/0 is \n"
779     "# multiplied with the NatThreshold value before being\n"
780     "# compared to the new one.\n"
781     "# The parameter can be a value between 0.1 and 1.0, but\n"
782     "# should be close to 1.0 if changed.\n"
783     "# WARNING: This parameter should not be used together with\n"
784     "# the etx_ffeth metric !!\n"
785     "# (defaults to 1.0)\n"
786     "\n");
787   abuf_appendf(out, "%sNatThreshold  %.1f\n",
788       cnf->lq_nat_thresh == (float)DEF_LQ_NAT_THRESH ? "# " : "",
789       (double)cnf->lq_nat_thresh);
790
791   abuf_puts(out,
792     "\n"
793     "#############################################################\n"
794     "### Configuration of the IPC to the windows GUI interface ###\n"
795     "#############################################################\n"
796     "\n"
797     "IpcConnect\n"
798     "{\n"
799     "    # Determines how many simultaneously\n"
800     "    # IPC connections that will be allowed\n"
801     "    # Setting this to 0 disables IPC\n"
802     "\n");
803   abuf_appendf(out, "  %sMaxConnections  %d\n",
804       cnf->ipc_connections == DEF_IPC_CONNECTIONS ? "# " : "",
805       cnf->ipc_connections);
806   abuf_puts(out,
807     "\n"
808     "    # By default only 127.0.0.1 is allowed\n"
809     "    # to connect. Here allowed hosts and networks can\n"
810     "    # be added\n"
811     "\n");
812
813   while (ipc_nets) {
814     if (ipc_nets->net.prefix_len == olsr_cnf->maxplen) {
815       abuf_appendf(out, "    Host %s\n", olsr_ip_to_string(&ipbuf, &ipc_nets->net.prefix));
816     } else {
817       abuf_appendf(out, "    Net  %s\n", olsr_ip_prefix_to_string(&ipc_nets->net));
818     }
819     ipc_nets = ipc_nets->next;
820   }
821   abuf_puts(out,
822     "}\n"
823     "\n"
824     "#####################################\n"
825     "### Example plugin configurations ###\n"
826     "#####################################\n"
827     "# Olsrd plugins to load\n"
828     "# This must be the absolute path to the file\n"
829     "# or the loader will use the following scheme:\n"
830     "# - Try the paths in the LD_LIBRARY_PATH \n"
831     "#   environment variable.\n"
832     "# - The list of libraries cached in /etc/ld.so.cache\n"
833     "# - /lib, followed by /usr/lib\n"
834     "\n");
835
836   while (plugins) {
837     abuf_appendf(out, "LoadPlugin \"%s\" {\n", plugins->name);
838     pl_param = plugins->params;
839     while (pl_param) {
840       abuf_appendf(out, "    PlParam \"%s\"\t\"%s\"\n", pl_param->key, pl_param->value);
841       pl_param = pl_param->next;
842     }
843     abuf_puts(out, "}\n"
844         "\n");
845     plugins = plugins->next;
846   }
847
848   abuf_puts(out,
849     "#############################################\n"
850     "### OLSRD default interface configuration ###\n"
851     "#############################################\n"
852     "# the default interface section can have the same values as the following\n"
853     "# interface configuration. It will allow you so set common options for all\n"
854     "# interfaces.\n"
855     "\n"
856     "InterfaceDefaults\n");
857   olsrd_write_if_autobuf(out, cnf->interface_defaults, false);
858   abuf_puts(out,
859     "\n"
860     "######################################\n"
861     "### OLSRd Interfaces configuration ###\n"
862     "######################################\n"
863     "# multiple interfaces can be specified for a single configuration block\n"
864     "# multiple configuration blocks can be specified\n"
865     "\n");
866   first = true;
867   while (interf) {
868     abuf_appendf(out, "Interface \"%s\"\n", interf->name);
869     olsrd_write_if_autobuf(out, interf->cnf, first);
870
871     first = false;
872     interf = interf->next;
873   }
874
875   abuf_puts(out,
876       "\n"
877       "# END AUTOGENERATED CONFIG\n");
878 }
879 /*
880  * Local Variables:
881  * c-basic-offset: 2
882  * indent-tabs-mode: nil
883  * End:
884  */