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