fbb7fa163b414013b0b9af9de85b776a74b79756
[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   fwrite(abuf.buf, abuf.len, 1, fd);
69   abuf_free(&abuf);
70   fclose(fd);
71
72   printf("DONE\n");
73
74   return 1;
75 }
76
77 static int
78 if_appendf(struct autobuf *autobuf, bool comments, const char *fmt, ...)  __attribute__ ((format(printf, 3, 4)));
79
80 static int
81 if_appendf(struct autobuf *autobuf, bool comments, const char *fmt, ...)
82 {
83   int rv;
84   va_list ap;
85   char *first;
86
87   if (!comments) {
88     va_start(ap, fmt);
89     first = va_arg(ap, char*);
90     va_end(ap);
91     if (*first) {
92       return 0;
93     }
94   }
95
96   va_start(ap, fmt);
97   rv = abuf_vappendf(autobuf, fmt, ap);
98   va_end(ap);
99   return rv;
100 }
101
102 static void olsrd_write_if_autobuf(struct autobuf *out, struct if_config_options *cnfi, bool comments) {
103   struct ipaddr_str ipbuf;
104   struct olsr_lq_mult *mult;
105
106   abuf_puts(out, "{\n");
107   if (comments) abuf_puts(out,
108     "    # Interface Mode is used to prevent unnecessary\n"
109     "    # packet forwarding on switched ethernet interfaces\n"
110     "    # valid Modes are \"mesh\" and \"ether\"\n"
111     "    # (default is \"mesh\")\n"
112     "    \n");
113   if_appendf(out, comments, "    %sMode \"%s\"\n",
114       cnfi->mode == DEF_IF_MODE ? "# " : "",
115       OLSR_IF_MODE[cnfi->mode]);
116   if (comments) abuf_puts(out,
117     "    \n"
118     "    # IPv4 broadcast address for outgoing OLSR packets.\n"
119     "    # One usefull example would be 255.255.255.255\n"
120     "    # The second useful value would be to\n"
121     "    # specify the peer adress of an ptp-tunnel.\n"
122     "    # another name of this parameter is \"IPv4Multicast\"\n"
123     "    # (default is 0.0.0.0, which triggers the usage of the\n"
124     "    # interface broadcast IP)\n"
125     "    \n");
126   if_appendf(out, comments, "    %sIp4Broadcast      %s\n",
127       cnfi->ipv4_multicast.v4.s_addr == 0 ? "# " : "",
128       inet_ntop(AF_INET, &cnfi->ipv4_multicast, ipbuf.buf, sizeof(ipbuf)));
129   if (comments) abuf_puts(out,
130     "    \n"
131     "    # IPv6 multicast address\n"
132     "    # (default is FF02::6D, the manet-router linklocal multicast)\n"
133     "    \n");
134   if_appendf(out, comments, "    %sIPv6Multicast %s\n",
135       memcmp(&cnfi->ipv6_multicast, &ipv6_def_multicast, sizeof(ipv6_def_multicast)) == 0 ? "# " : "",
136       inet_ntop(AF_INET6, &cnfi->ipv6_multicast, ipbuf.buf, sizeof(ipbuf)));
137   if (comments) abuf_puts(out,
138     "    \n"
139     "    # IPv4 src address for outgoing OLSR packages\n"
140     "    # (default is 0.0.0.0, which triggers usage of the interface IP)\n"
141     "    \n");
142   if_appendf(out, comments, "    %sIPv4Src %s\n",
143       cnfi->ipv4_src.v4.s_addr == 0 ? "# " : "",
144       inet_ntop(AF_INET, &cnfi->ipv4_src, ipbuf.buf, sizeof(ipbuf)));
145   if (comments) abuf_puts(out,
146     "    \n"
147     "    # IPv6 src prefix. OLSRd will choose one of the interface IPs\n"
148     "    # which matches the prefix of this parameter.\n"
149     "    # (default is 0::/0, which triggers the usage\n"
150     "    # of a not-linklocal interface IP)\n"
151     "    \n");
152   if_appendf(out, comments, "    %sIPv6Src %s\n",
153       cnfi->ipv6_src.prefix_len == 0 ? "# " : "",
154       inet_ntop(AF_INET6, &cnfi->ipv6_src, ipbuf.buf, sizeof(ipbuf)));
155   if (comments) abuf_puts(out,
156     "    \n"
157     "    # Emission intervals in seconds.\n"
158     "    # If not defined, Freifunk network defaults are used\n"
159     "    # (default is 2.0/20.0 for Hello and 5.0/300.0 for Tc/Mid/Hna)\n"
160     "    \n");
161   if_appendf(out, comments, "    %sHelloInterval       %3.1f\n",
162       cnfi->hello_params.emission_interval == HELLO_INTERVAL ? "# " : "",
163       cnfi->hello_params.emission_interval);
164   if_appendf(out, comments, "    %sHelloValidityTime   %3.1f\n",
165       cnfi->hello_params.validity_time == NEIGHB_HOLD_TIME ? "# " : "",
166       cnfi->hello_params.validity_time);
167   if_appendf(out, comments, "    %sTcInterval          %3.1f\n",
168       cnfi->tc_params.emission_interval == TC_INTERVAL ? "# " : "",
169       cnfi->tc_params.emission_interval);
170   if_appendf(out, comments, "    %sTcValidityTime      %3.1f\n",
171       cnfi->tc_params.validity_time == TOP_HOLD_TIME ? "# " : "",
172       cnfi->tc_params.validity_time);
173   if_appendf(out, comments, "    %sMidInterval         %3.1f\n",
174       cnfi->mid_params.emission_interval == MID_INTERVAL ? "# " : "",
175       cnfi->mid_params.emission_interval);
176   if_appendf(out, comments, "    %sMidValidityTime     %3.1f\n",
177       cnfi->mid_params.validity_time == MID_HOLD_TIME ? "# " : "",
178       cnfi->mid_params.validity_time);
179   if_appendf(out, comments, "    %sHnaInterval         %3.1f\n",
180       cnfi->hna_params.emission_interval == HNA_INTERVAL ? "# " : "",
181       cnfi->hna_params.emission_interval);
182   if_appendf(out, comments, "    %sHnaValidityTime     %3.1f\n",
183       cnfi->hna_params.validity_time == HNA_HOLD_TIME ? "# " : "",
184       cnfi->hna_params.validity_time);
185   if (comments) abuf_puts(out,
186     "    \n"
187     "    # When multiple links exist between hosts\n"
188     "    # the weight of interface is used to determine\n"
189     "    # the link to use. Normally the weight is\n"
190     "    # automatically calculated by olsrd based\n"
191     "    # on the characteristics of the interface,\n"
192     "    # but here you can specify a fixed value.\n"
193     "    # Olsrd will choose links with the lowest value.\n"
194     "    # Note:\n"
195     "    # Interface weight is used only when LinkQualityLevel is set to 0.\n"
196     "    # For any other value of LinkQualityLevel, the interface ETX\n"
197     "    # value is used instead.\n");
198   if_appendf(out, comments, "    %sWeight %d\n",
199       !cnfi->weight.fixed ? "# " : "",
200       cnfi->weight.value);
201   if (comments) abuf_puts(out,
202     "    \n"
203     "    # If a certain route should be preferred\n"
204     "    # or ignored by the mesh, the Link Quality\n"
205     "    # value of a node can be multiplied with a factor\n"
206     "    # entered here. In the example the route\n"
207     "    # using 192.168.0.1 would rather be ignored.\n"
208     "    # A multiplier of 0.5 will result in a small\n"
209     "    # (bad) LinkQuality value and a high (bad)\n"
210     "    # ETX value.\n"
211     "    # Note:\n"
212     "    # Link quality multiplier is used only when\n"
213     "    # LinkQualityLevel is > 0.\n"
214     "    \n");
215   mult = cnfi->lq_mult;
216
217   if (mult == NULL) {
218     if (comments) abuf_puts(out, "    # LinkQualityMult 192.168.0.1 0.5\n");
219   } else {
220     while (mult != NULL) {
221       if_appendf(out, comments, "    LinkQualityMult    %s %0.2f\n",
222           olsr_ip_to_string(&ipbuf, &mult->addr),
223           (float)(mult->value) / 65536.0);
224       mult = mult->next;
225     }
226   }
227   abuf_puts(out, "}\n");
228 }
229
230 void olsrd_write_cnf_autobuf(struct autobuf *out, struct olsrd_config *cnf) {
231   struct ip_prefix_list *hna = cnf->hna_entries;
232   struct olsr_if *interf = cnf->interfaces;
233   struct plugin_entry *plugins = cnf->plugins;
234   struct plugin_param *pl_param;
235   struct ip_prefix_list *ipc_nets = cnf->ipc_nets;
236
237   struct ipaddr_str ipbuf;
238   bool first;
239
240   abuf_appendf(out, "#\n"
241       "# Configuration file for %s\n"
242       "# automatically generated by olsrd-cnf parser v. %s\n"
243       "#\n"
244       "\n",
245       olsrd_version, PARSER_VERSION);
246   abuf_puts(out,
247     "# OLSR.org routing daemon config file\n"
248     "# This file contains ALL available options and explanations about them\n"
249     "#\n"
250     "# Lines starting with a # are discarded\n"
251     "#\n"
252     "\n"
253     "#### ATTENTION for IPv6 users ####\n"
254     "# Because of limitations in the parser IPv6 addresses must NOT\n"
255     "# begin with a \":\", so please add a \"0\" as a prefix.\n"
256     "\n"
257     "###########################\n"
258     "### Basic configuration ###\n"
259     "###########################\n"
260     "# keep this settings at the beginning of your first configuration file\n"
261     "\n"
262     "# Debug level (0-9)\n"
263     "# If set to 0 the daemon runs in the background, unless \"NoFork\" is set to true\n"
264     "# (Default is 1)\n"
265     "\n");
266   abuf_appendf(out, "%sDebugLevel  %d\n",
267       cnf->debug_level == DEF_DEBUGLVL ? "# " : "",
268       cnf->debug_level);
269   abuf_puts(out,
270     "\n"
271     "# IP version to use (4 or 6)\n"
272     "# (Default is 4)\n"
273     "\n");
274   abuf_appendf(out, "%sIpVersion %d\n",
275       cnf->ip_version == DEF_IP_VERSION ? "# " : "",
276       cnf->ip_version == AF_INET ? 4 : 6);
277   abuf_puts(out,
278     "\n"
279     "#################################\n"
280     "### OLSRd agent configuration ###\n"
281     "#################################\n"
282     "# this parameters control the settings of the routing agent which are not\n"
283     "# related to the OLSR protocol and it's extensions\n"
284     "\n"
285     "# Clear the screen each time the internal state changes\n"
286     "# (Default is yes)\n"
287     "\n");
288   abuf_appendf(out, "%sClearScreen     %s\n",
289       cnf->clear_screen == DEF_CLEAR_SCREEN ? "# " : "",
290       cnf->clear_screen ? "yes" : "no");
291   abuf_puts(out,
292     "\n"
293     "# Should olsrd keep on running even if there are\n"
294     "# no interfaces available? This is a good idea\n"
295     "# for a PCMCIA/USB hotswap environment.\n"
296     "# (Default is yes)\n"
297     "\n");
298   abuf_appendf(out, "%sAllowNoInt  %s\n",
299       cnf->allow_no_interfaces == DEF_ALLOW_NO_INTS ? "# " : "",
300       cnf->allow_no_interfaces ? "yes" : "no");
301   abuf_puts(out,
302     "\n"
303     "# LockFile\n"
304     "# The lockfile is used to prevent multiple OLSR instances running at the same\n"
305     "# time.\n"
306     "# (Linux/BSD default is \"/var/run/olsrd-ipv(4/6).lock\")\n"
307     "# (Win32 default is \"<configfile>-ipv(4/6).lock\")\n"
308     "\n");
309   abuf_appendf(out, "%sLockFile \"%s\"\n",
310       cnf->lock_file == NULL ? "# " : "",
311       cnf->lock_file ? cnf->lock_file : "lockfile");
312   abuf_puts(out,
313     "\n"
314     "# Polling rate for OLSR sockets in seconds (float). \n"
315     "# (Default is 0.05)\n"
316     "\n");
317   abuf_appendf(out, "%sPollrate  %.2f\n",
318       cnf->pollrate == DEF_POLLRATE ? "# " : "",
319       cnf->pollrate);
320   abuf_puts(out,
321     "\n"
322     "# Interval to poll network interfaces for configuration changes (in seconds).\n"
323     "# Linux systems can detect interface statechange via netlink sockets.\n"
324     "# (Defaults is 2.5)\n"
325     "\n");
326   abuf_appendf(out, "%sNicChgsPollInt  %.1f\n",
327       cnf->nic_chgs_pollrate == DEF_NICCHGPOLLRT ? "# " : "",
328       cnf->nic_chgs_pollrate);
329   abuf_puts(out,
330     "\n"
331     "# TOS(type of service) value for the IP header of control traffic.\n"
332     "# (Default is 16)\n"
333     "\n");
334   abuf_appendf(out, "%sTosValue %u\n",
335       cnf->tos == DEF_TOS ? "# " : "",
336       cnf->tos);
337   abuf_puts(out,
338     "\n"
339     "# FIBMetric controls the metric value of the host-routes OLSRd sets.\n"
340     "# - \"flat\" means that the metric value is always 2. This is the preferred value\n"
341     "#   because it helps the linux kernel routing to clean up older routes\n"
342     "# - \"correct\" use the hopcount as the metric value.\n"
343     "# - \"approx\" use the hopcount as the metric value too, but does only update the\n"
344     "#   hopcount if the nexthop changes too\n"
345     "# (Default is \"flat\")\n"
346     "\n");
347   abuf_appendf(out, "%sFIBMetric \"%s\"\n",
348       cnf->fib_metric == DEF_FIB_METRIC ? "# " : "",
349       FIB_METRIC_TXT[cnf->fib_metric]);
350   abuf_puts(out,
351     "\n"
352     "#######################################\n"
353     "### Linux specific OLSRd extensions ###\n"
354     "#######################################\n"
355     "# these parameters are only working on linux at the moment, but might become\n"
356     "# useful on BSD in the future\n"
357     "\n"
358     "# SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip\n"
359     "# of the node. In addition to this an additional localhost device is created\n"
360     "# to make sure the returning traffic can be received.\n"
361     "# (Default is \"no\")\n"
362     "\n");
363   abuf_appendf(out, "%sSrcIpRoutes %s\n",
364       cnf->use_src_ip_routes == DEF_USE_SRCIP_ROUTES ? "# " : "",
365       cnf->use_src_ip_routes ? "yes" : "no");
366   abuf_puts(out,
367     "\n"
368     "# Specify the proto tag to be used for routes olsr inserts into kernel\n"
369     "# currently only implemented for linux\n"
370     "# valid values under linux are 1 .. 254\n"
371     "# 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)\n"
372     "# 2 KERNEL routes (not very wise to use)\n"
373     "# 3 BOOT (should in fact not be used by routing daemons)\n"
374     "# 4 STATIC \n"
375     "# 8 .. 15 various routing daemons (gated, zebra, bird, & co)\n"
376     "# (defaults to 0 which gets replaced by an OS-specific default value\n"
377     "# under linux 3 (BOOT) (for backward compatibility)\n"
378     "\n");
379   abuf_appendf(out, "%sRtProto %u\n",
380       cnf->rt_proto == DEF_RTPROTO ? "# " : "",
381       cnf->rt_proto);
382   abuf_puts(out,
383     "\n"
384     "# RtPolicy activates the usage of routing tables and policy rules for OLSRd\n"
385     "# routing. It's used to keep host and default route in different tables and\n"
386     "# to handle more complicated routing setups with SmartGateway\n"
387     "# (Default is \"yes\")\n"
388     "\n");
389   abuf_appendf(out, "%sRtPolicy %s\n",
390       cnf->rt_policy == DEF_RTPOLICY ? "# " : "",
391       cnf->rt_policy ? "yes" : "no");
392   abuf_puts(out,
393     "\n"
394     "# Specifies the routing Table olsr uses\n"
395     "# RtTable is for host routes, RtTableDefault for the route to the default\n"
396     "# internet gateway (2 in case of IPv6+NIIT) and RtTableTunnel is for\n"
397     "# routes to the ipip tunnels, valid values are 1 to 254\n"
398     "# (default is 254/112/113, the first is the \"main\" table in linux)\n"
399     "\n");
400   abuf_appendf(out, "%sRtTable %u\n",
401       cnf->rt_policy ? "# " : "",
402       cnf->rt_table);
403   abuf_appendf(out, "%sRtTableDefault %u\n",
404       cnf->rt_policy ? "# " : "",
405       cnf->rt_table_default);
406   abuf_appendf(out, "%sRtTableTunnel %u\n",
407       cnf->rt_policy ? "# " : "",
408       cnf->rt_table_tunnel);
409   abuf_puts(out,
410     "\n"
411     "# Specifies the policy rule priorities for the three routing tables and\n"
412     "# a special rule for smartgateway routing (see README-Olsr-Extensions)\n"
413     "# Priorities can only be set if three different routing tables are set.\n"
414     "# 0 means \"set no policy rule\", if set the values must obey to condition\n"
415     "# RtTablePriority < RtTableDefaultOlsrPriority\n"
416     "# < RtTableTunnelPriority < RtTableDefaultPriority\n"
417     "# (default is 32766/32776/32786/32796)\n"
418     "\n");
419   abuf_appendf(out, "%sRtTablePriority %u\n",
420       cnf->rt_policy ? "# " : "",
421       cnf->rt_table_pri);
422   abuf_appendf(out, "%sRtTableDefaultOlsrPriority %u\n",
423       cnf->rt_policy ? "# " : "",
424       cnf->rt_table_default_pri);
425   abuf_appendf(out, "%sRtTableTunnelPriority %u\n",
426       cnf->rt_policy ? "# " : "",
427       cnf->rt_table_tunnel_pri);
428   abuf_appendf(out, "%sRtTableDefaultPriority %u\n",
429       cnf->rt_policy ? "# " : "",
430       cnf->rt_table_defaultolsr_pri);
431   abuf_puts(out,
432     "\n"
433     "# Activates (in IPv6 mode) the automatic use of NIIT\n"
434     "# (see README-Olsr-Extensions)\n"
435     "# (default is \"yes\")\n"
436     "\n");
437   abuf_appendf(out, "%sUseNiit %s\n",
438       cnf->use_niit == DEF_USE_NIIT ? "# " : "",
439       cnf->use_niit ? "yes" : "no");
440   abuf_puts(out,
441     "\n"
442     "# Activates the smartgateway ipip tunnel feature.\n"
443     "# See README-Olsr-Extensions for a description of smartgateways.\n"
444     "# (default is \"yes\")\n"
445     "\n");
446   abuf_appendf(out, "%sSmartGateway %s\n",
447       cnf->smart_gw_active == DEF_SMART_GW ? "# " : "",
448       cnf->smart_gw_active ? "yes" : "no");
449   abuf_puts(out,
450     "\n"
451     "# Allows the selection of a smartgateway with NAT (only for IPv4)\n"
452     "# (default is \"yes\")\n"
453     "\n");
454   abuf_appendf(out, "%sSmartGatewayAllowNAT %s\n",
455       cnf->smart_gw_allow_nat == DEF_GW_ALLOW_NAT ? "# " : "",
456       cnf->smart_gw_allow_nat ? "yes" : "no");
457   abuf_puts(out,
458     "\n"
459     "# Defines what kind of Uplink this node will publish as a\n"
460     "# smartgateway. The existence of the uplink is detected by\n"
461     "# a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.\n"
462     "# possible values are \"none\", \"ipv4\", \"ipv6\", \"both\"\n"
463     "# (default is \"both\")\n"
464     "\n");
465   abuf_appendf(out, "%sSmartGatewayUplink \"%s\"\n",
466       cnf->smart_gw_type == DEF_GW_TYPE ? "# " : "",
467       GW_UPLINK_TXT[cnf->smart_gw_type]);
468   abuf_puts(out,
469     "\n"
470     "# Specifies if the local ipv4 uplink use NAT\n"
471     "# (default is \"yes\")\n"
472     "\n");
473   abuf_appendf(out, "%sSmartGatewayUplinkNAT %s\n",
474       cnf->smart_gw_uplink_nat == DEF_GW_UPLINK_NAT ? "# " : "",
475       cnf->smart_gw_uplink_nat ? "yes" : "no");
476   abuf_puts(out,
477     "\n"
478     "# Specifies the speed of the uplink in kilobit/s.\n"
479     "# First parameter is upstream, second parameter is downstream\n"
480     "# (default is 128/1024)\n"
481     "\n");
482   abuf_appendf(out, "%sSmartGatewaySpeed %d %d\n",
483       cnf->smart_gw_uplink == DEF_UPLINK_SPEED && cnf->smart_gw_downlink == DEF_DOWNLINK_SPEED ? "# " : "",
484       cnf->smart_gw_uplink, cnf->smart_gw_downlink);
485   abuf_puts(out,
486     "\n"
487     "# Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix\n"
488     "# length of more than 64 is not allowed.\n"
489     "# (default is 0::/0\n"
490     "\n");
491   abuf_appendf(out, "%sSmartGatewayPrefix %s\n",
492       cnf->smart_gw_prefix.prefix_len == 0 ? "# " : "",
493       olsr_ip_prefix_to_string(&cnf->smart_gw_prefix));
494   abuf_puts(out,
495     "\n"
496     "##############################\n"
497     "### OLSR protocol settings ###\n"
498     "##############################\n"
499     "\n"
500     "# For testing purposes it may be nice to use another port for olsrd\n"
501     "# for using another port than the IANA assigned one \n"
502     "# for a production network, there should be a good reason!!\n"
503     "# valid values are integers >1, please be careful with using reserved\n"
504     "# port numbers\n"
505     "# (default is 698, the IANA assigned olsr-port)\n"
506     "\n");
507   abuf_appendf(out, "%sOlsrPort %u\n",
508       cnf->olsrport == DEF_OLSRPORT ? "# " : "",
509       cnf->olsrport);
510   abuf_puts(out,
511     "\n"
512     "# Sets the main IP (originator ip) of the router. This IP will NEVER\n"
513     "# change during the uptime of olsrd.\n"
514     "# (default is 0.0.0.0, which triggers usage of the IP of the first interface)\n"
515     "\n");
516   abuf_appendf(out, "MainIp %s\n",
517       olsr_ip_to_string(&ipbuf, &cnf->main_addr));
518   abuf_puts(out,
519     "\n"
520     "# The fixed willingness to use (0-7)\n"
521     "# If not set willingness will be calculated\n"
522     "# dynamically based on battery/power status\n"
523     "# (default is 3)\n"
524     "\n");
525   abuf_appendf(out, "%sWillingness     %u\n",
526       cnf->willingness == DEF_WILLINGNESS ? "# " : "",
527       cnf->willingness);
528   abuf_puts(out,
529     "\n"
530     "# HNA (Host network association) allows the OLSR to announce\n"
531     "# additional IPs or IP subnets to the net that are reachable\n"
532     "# through this node.\n"
533     "# Syntax for HNA4 is \"network-address    network-mask\"\n"
534     "# Syntax for HNA6 is \"network-address    prefix-length\"\n"
535     "# (default is no HNA)\n");
536   abuf_appendf(out, "Hna%u\n"
537     "{\n",
538     cnf->ip_version == AF_INET ? 4 : 6);
539   while (hna) {
540     struct ipaddr_str strbuf;
541     abuf_appendf(out, "    %s\n", olsr_ip_prefix_to_string(&hna->net));
542     hna = hna->next;
543   }
544   abuf_puts(out,
545     "}\n"
546     "\n"
547     "# Hysteresis for link sensing (only for hopcount metric)\n"
548     "# Hysteresis adds more robustness to the link sensing\n"
549     "# but delays neighbor registration.\n"
550     "# (defaults to yes)\n"
551     "\n");
552   abuf_appendf(out, "%sUseHysteresis %s\n",
553       cnf->use_hysteresis == DEF_USE_HYST ? "# " : "",
554       cnf->use_hysteresis ? "yes" : "no");
555   abuf_puts(out,
556     "\n"
557     "# Hysteresis parameters (only for hopcount metric)\n"
558     "# Do not alter these unless you know what you are doing!\n"
559     "# Set to auto by default. Allowed values are floating point\n"
560     "# values in the interval 0,1\n"
561     "# THR_LOW must always be lower than THR_HIGH!!\n"
562     "# (default is 0.5/0.8/0.3)\n"
563     "\n");
564   abuf_appendf(out, "%sHystScaling  %.2f\n",
565       cnf->hysteresis_param.scaling == HYST_SCALING ? "# " : "",
566       cnf->hysteresis_param.scaling);
567   abuf_appendf(out, "%sHystThrHigh  %.2f\n",
568       cnf->hysteresis_param.thr_high == HYST_THRESHOLD_HIGH ? "# " : "",
569       cnf->hysteresis_param.thr_high);
570   abuf_appendf(out, "%sHystThrLow  %.2f\n",
571       cnf->hysteresis_param.thr_low == HYST_THRESHOLD_LOW ? "# " : "",
572       cnf->hysteresis_param.thr_low);
573   abuf_puts(out,
574     "\n"
575     "# TC redundancy\n"
576     "# Specifies how much neighbor info should be sent in\n"
577     "# TC messages. Because of a design problem in the 0.5.x\n"
578     "# dijkstra implementation this value must be set to 2.\n"
579     "# 2 - send all neighbors\n"
580     "# (default is 2)\n"
581     "\n");
582   abuf_appendf(out, "%sTcRedundancy  %d\n",
583       cnf->tc_redundancy == TC_REDUNDANCY ? "# " : "",
584       cnf->tc_redundancy);
585   abuf_puts(out,
586     "\n"
587     "# MPR coverage specifies how many MPRs a node should\n"
588     "# try select to reach every 2 hop neighbor. Because of\n"
589     "# a design problem in the 0.5.x dijkstra algorithm this\n"
590     "# value should be set to 7.\n"
591     "# (default is 7)\n"
592     "\n");
593   abuf_appendf(out, "%sMprCoverage %d\n",
594       cnf->mpr_coverage == MPR_COVERAGE ? "# " : "",
595       cnf->mpr_coverage);
596   abuf_puts(out,
597     "\n"
598     "################################\n"
599     "### OLSR protocol extensions ###\n"
600     "################################\n"
601     "\n"
602     "# Link quality level switch between hopcount and \n"
603     "# cost-based (mostly ETX) routing. Because of\n"
604     "# a design problem in the 0.5.x dijkstra algorithm this\n"
605     "# value should not be set to 1.\n"
606     "# 0 = do not use link quality\n"
607     "# 2 = use link quality for MPR selection and routing\n"
608     "# (default is 2)\n"
609     "\n");
610   abuf_appendf(out, "%sLinkQualityLevel %d\n",
611       cnf->lq_level == DEF_LQ_LEVEL ? "# " : "",
612       cnf->lq_level);
613   abuf_puts(out,
614     "\n"
615     "# Link quality algorithm (only for lq level 2)\n"
616     "# (see README-Olsr-Extensions)\n"
617     "# - \"etx_float\", a floating point  ETX with exponential aging\n"
618     "# - \"etx_fpm\", same as ext_float, but with integer arithmetic\n"
619     "# - \"etx_ff\" (ETX freifunk), an etx variant which use all OLSR\n"
620     "#   traffic (instead of only hellos) for ETX calculation\n"
621     "# - \"etx_ffeth\", an incompatible variant of etx_ff that allows\n"
622     "#   ethernet links with ETX 0.1.\n"
623     "# (defaults to \"etx_ff\")\n"
624     "\n");
625   abuf_appendf(out, "%sLinkQualityAlgorithm    \"%s\"\n",
626       cnf->lq_algorithm == NULL ? "# " : "",
627       cnf->lq_algorithm == NULL ? DEF_LQ_ALGORITHM : cnf->lq_algorithm);
628   abuf_puts(out,
629     "\n"
630     "# Link quality aging factor (only for lq level 2)\n"
631     "# Tuning parameter for etx_float and etx_fpm, smaller values\n"
632     "# mean slower changes of ETX value. (allowed values are\n"
633     "# between 0.01 and 1.0)\n"
634     "# (default is 0.05)\n"
635     "\n");
636   abuf_appendf(out, "%sLinkQualityAging %.2f\n",
637       cnf->lq_aging == DEF_LQ_AGING ? "# " : "",
638       cnf->lq_aging);
639   abuf_puts(out,
640     "\n"
641     "# Fisheye mechanism for TCs (0 meansoff, 1 means on)\n"
642     "# (default is 1)\n"
643     "\n");
644   abuf_appendf(out, "%sLinkQualityFishEye  %d\n",
645       cnf->lq_fish == DEF_LQ_FISH ? "# " : "",
646       cnf->lq_fish);
647   abuf_puts(out,
648     "\n"
649     "#\n"
650     "# NatThreshold \n"
651     "#\n"
652     "# (currently this is only in the freifunk firmware)\n"
653     "# If the NAT-Endpoint (the preferred 0/0 HNA emitting node)\n"
654     "# is to be changed, the ETX value of the current 0/0 is \n"
655     "# multiplied with the NatThreshold value before being\n"
656     "# compared to the new one.\n"
657     "# The parameter can be a value between 0.1 and 1.0, but\n"
658     "# should be close to 1.0 if changed.\n"
659     "# WARNING: This parameter should not be used together with\n"
660     "# the etx_ffeth metric !!\n"
661     "# (defaults to 1.0)\n"
662     "\n");
663   abuf_appendf(out, "%sNatThreshold  %.1f\n",
664       cnf->lq_nat_thresh == DEF_LQ_NAT_THRESH ? "# " : "",
665       cnf->lq_nat_thresh);
666
667   abuf_puts(out,
668     "\n"
669     "#############################################################\n"
670     "### Configuration of the IPC to the windows GUI interface ###\n"
671     "#############################################################\n"
672     "\n"
673     "IpcConnect\n"
674     "{\n"
675     "    # Determines how many simultaneously\n"
676     "    # IPC connections that will be allowed\n"
677     "    # Setting this to 0 disables IPC\n"
678     "\n");
679   abuf_appendf(out, "  %sMaxConnections  %d\n",
680       cnf->ipc_connections == DEF_IPC_CONNECTIONS ? "# " : "",
681       cnf->ipc_connections);
682   abuf_puts(out,
683     "\n"
684     "    # By default only 127.0.0.1 is allowed\n"
685     "    # to connect. Here allowed hosts and networks can\n"
686     "    # be added\n"
687     "\n");
688
689   while (ipc_nets) {
690     if (ipc_nets->net.prefix_len == olsr_cnf->maxplen) {
691       abuf_appendf(out, "    Host %s\n", olsr_ip_to_string(&ipbuf, &ipc_nets->net.prefix));
692     } else {
693       abuf_appendf(out, "    Net  %s\n", olsr_ip_prefix_to_string(&ipc_nets->net));
694     }
695     ipc_nets = ipc_nets->next;
696   }
697   abuf_puts(out,
698     "}\n"
699     "\n"
700     "#####################################\n"
701     "### Example plugin configurations ###\n"
702     "#####################################\n"
703     "# Olsrd plugins to load\n"
704     "# This must be the absolute path to the file\n"
705     "# or the loader will use the following scheme:\n"
706     "# - Try the paths in the LD_LIBRARY_PATH \n"
707     "#   environment variable.\n"
708     "# - The list of libraries cached in /etc/ld.so.cache\n"
709     "# - /lib, followed by /usr/lib\n"
710     "\n");
711
712   while (plugins) {
713     abuf_appendf(out, "LoadPlugin \"%s\" {\n", plugins->name);
714     pl_param = plugins->params;
715     while (pl_param) {
716       abuf_appendf(out, "    PlParam \"%s\"\t\"%s\"\n", pl_param->key, pl_param->value);
717       pl_param = pl_param->next;
718     }
719     abuf_puts(out, "}\n"
720         "\n");
721     plugins = plugins->next;
722   }
723
724   abuf_puts(out,
725     "#############################################\n"
726     "### OLSRD default interface configuration ###\n"
727     "#############################################\n"
728     "# the default interface section can have the same values as the following\n"
729     "# interface configuration. It will allow you so set common options for all\n"
730     "# interfaces.\n"
731     "\n"
732     "InterfaceDefaults\n");
733   olsrd_write_if_autobuf(out, cnf->interface_defaults, false);
734   abuf_puts(out,
735     "\n"
736     "######################################\n"
737     "### OLSRd Interfaces configuration ###\n"
738     "######################################\n"
739     "# multiple interfaces can be specified for a single configuration block\n"
740     "# multiple configuration blocks can be specified\n"
741     "\n");
742   first = true;
743   while (interf) {
744     abuf_appendf(out, "Interface \"%s\"\n", interf->name);
745     olsrd_write_if_autobuf(out, interf->cnf, first);
746
747     first = false;
748     interf = interf->next;
749   }
750
751   abuf_puts(out,
752       "\n"
753       "# END AUTOGENERATED CONFIG\n");
754 }
755 /*
756  * Local Variables:
757  * c-basic-offset: 2
758  * indent-tabs-mode: nil
759  * End:
760  */