txtinfo: convert ACTIVATE_VTIME_TXTINFO into a plugin parameter
[olsrd.git] / lib / txtinfo / src / txtinfo_printers.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004
4  *
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include "txtinfo_printers.h"
43
44 #include <unistd.h>
45
46 #include "ipcalc.h"
47 #include "builddata.h"
48 #include "neighbor_table.h"
49 #include "mpr_selector_set.h"
50 #include "mid_set.h"
51 #include "routing_table.h"
52 #include "lq_plugin.h"
53 #include "gateway.h"
54 #include "../../info/info_types.h"
55
56 extern bool vtime;
57
58 bool isCommand(const char *str, unsigned int siw) {
59   switch (siw) {
60     case SIW_OLSRD_CONF:
61       return strstr(str, "/con");
62
63     case SIW_ALL:
64       return strstr(str, "/all");
65
66     case SIW_RUNTIME_ALL:
67       return strstr(str, "/runtime");
68
69     case SIW_STARTUP_ALL:
70       return strstr(str, "/startup");
71
72     case SIW_NEIGHBORS:
73       return strstr(str, "/nei");
74
75     case SIW_LINKS:
76       return strstr(str, "/lin");
77
78     case SIW_ROUTES:
79       return strstr(str, "/rou");
80
81     case SIW_HNA:
82       return strstr(str, "/hna");
83
84     case SIW_MID:
85       return strstr(str, "/mid");
86
87     case SIW_TOPOLOGY:
88       return strstr(str, "/top");
89
90     case SIW_GATEWAYS:
91       return strstr(str, "/gat");
92
93     case SIW_INTERFACES:
94       return strstr(str, "/int");
95
96     case SIW_2HOP:
97       return strstr(str, "/2ho");
98
99     case SIW_SGW:
100       return strstr(str, "/sgw");
101
102     case SIW_VERSION:
103       return strstr(str, "/ver");
104
105     case SIW_CONFIG:
106       return strstr(str, "/config");
107
108     case SIW_PLUGINS:
109       return strstr(str, "/plugins");
110
111     case SIW_NEIGHBORS_FREIFUNK:
112       return strstr(str, "/neighbours");
113
114     default:
115       return false;
116   }
117 }
118
119 void ipc_print_neighbors(struct autobuf *abuf, bool list_2hop) {
120   struct ipaddr_str buf1;
121   struct neighbor_entry *neigh;
122   struct neighbor_2_list_entry *list_2;
123   int thop_cnt;
124
125   abuf_puts(abuf, "Table: Neighbors\nIP address\tSYM\tMPR\tMPRS\tWill.");
126   if (list_2hop)
127     abuf_puts(abuf, "\n\t2hop interface adrress\n");
128   else
129     abuf_puts(abuf, "\t2 Hop Neighbors\n");
130
131   /* Neighbors */
132   OLSR_FOR_ALL_NBR_ENTRIES(neigh)
133       {
134         abuf_appendf(abuf, "%s\t%s\t%s\t%s\t%d\t", olsr_ip_to_string(&buf1, &neigh->neighbor_main_addr), (neigh->status == SYM) ? "YES" : "NO",
135             neigh->is_mpr ? "YES" : "NO", olsr_lookup_mprs_set(&neigh->neighbor_main_addr) ? "YES" : "NO", neigh->willingness);
136         thop_cnt = 0;
137
138         for (list_2 = neigh->neighbor_2_list.next; list_2 != &neigh->neighbor_2_list; list_2 = list_2->next) {
139           if (list_2hop)
140             abuf_appendf(abuf, "\t%s\n", olsr_ip_to_string(&buf1, &list_2->neighbor_2->neighbor_2_addr));
141           else
142             thop_cnt++;
143         }
144         if (!list_2hop) {
145           abuf_appendf(abuf, "%d\n", thop_cnt);
146         }
147       }OLSR_FOR_ALL_NBR_ENTRIES_END(neigh);
148   abuf_puts(abuf, "\n");
149 }
150
151 void ipc_print_links(struct autobuf *abuf) {
152   struct ipaddr_str buf1, buf2;
153   struct lqtextbuffer lqbuffer1, lqbuffer2;
154
155   struct link_entry *my_link = NULL;
156
157   if (vtime)
158     abuf_puts(abuf, "Table: Links\nLocal IP\tRemote IP\tVTime\tLQ\tNLQ\tCost\n");
159   else
160     abuf_puts(abuf, "Table: Links\nLocal IP\tRemote IP\tHyst.\tLQ\tNLQ\tCost\n");
161
162   /* Link set */
163   OLSR_FOR_ALL_LINK_ENTRIES(my_link)
164       {
165         if (vtime) {
166           int diff = (unsigned int) (my_link->link_timer->timer_clock - now_times);
167
168           abuf_appendf(abuf, "%s\t%s\t%d.%03d\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &my_link->local_iface_addr),
169               olsr_ip_to_string(&buf2, &my_link->neighbor_iface_addr),
170               diff / 1000, abs(diff % 1000),
171               get_link_entry_text(my_link, '\t', &lqbuffer1),
172               get_linkcost_text(my_link->linkcost, false, &lqbuffer2));
173         } else {
174           abuf_appendf(abuf, "%s\t%s\t0.00\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &my_link->local_iface_addr),
175               olsr_ip_to_string(&buf2, &my_link->neighbor_iface_addr), get_link_entry_text(my_link, '\t', &lqbuffer1),
176               get_linkcost_text(my_link->linkcost, false, &lqbuffer2));
177         }
178       }OLSR_FOR_ALL_LINK_ENTRIES_END(my_link);
179
180   abuf_puts(abuf, "\n");
181 }
182
183 void ipc_print_routes(struct autobuf *abuf) {
184   struct ipaddr_str buf1, buf2;
185   struct rt_entry *rt;
186   struct lqtextbuffer lqbuffer;
187
188   abuf_puts(abuf, "Table: Routes\nDestination\tGateway IP\tMetric\tETX\tInterface\n");
189
190   /* Walk the route table */
191   OLSR_FOR_ALL_RT_ENTRIES(rt)
192       {
193         abuf_appendf(abuf, "%s/%d\t%s\t%d\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &rt->rt_dst.prefix), rt->rt_dst.prefix_len,
194             olsr_ip_to_string(&buf2, &rt->rt_best->rtp_nexthop.gateway), rt->rt_best->rtp_metric.hops,
195             get_linkcost_text(rt->rt_best->rtp_metric.cost, true, &lqbuffer), if_ifwithindex_name(rt->rt_best->rtp_nexthop.iif_index));
196       }OLSR_FOR_ALL_RT_ENTRIES_END(rt);
197
198   abuf_puts(abuf, "\n");
199
200 }
201
202 void ipc_print_topology(struct autobuf *abuf) {
203   struct tc_entry *tc;
204
205   if (vtime)
206     abuf_puts(abuf, "Table: Topology\nDest. IP\tLast hop IP\tLQ\tNLQ\tCost\tVTime\n");
207   else
208     abuf_puts(abuf, "Table: Topology\nDest. IP\tLast hop IP\tLQ\tNLQ\tCost\n");
209
210   /* Topology */
211   OLSR_FOR_ALL_TC_ENTRIES(tc)
212       {
213         struct tc_edge_entry *tc_edge;
214         OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge)
215             {
216               if (tc_edge->edge_inv) {
217                 struct ipaddr_str dstbuf, addrbuf;
218                 struct lqtextbuffer lqbuffer1, lqbuffer2;
219                 if (vtime) {
220                   uint32_t vt = tc->validity_timer != NULL ? (tc->validity_timer->timer_clock - now_times) : 0;
221                   int diff = (int) (vt);
222                   abuf_appendf(abuf, "%s\t%s\t%s\t%s\t%d.%03d\n", olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr),
223                       olsr_ip_to_string(&addrbuf, &tc->addr),
224                       get_tc_edge_entry_text(tc_edge, '\t', &lqbuffer1),
225                       get_linkcost_text(tc_edge->cost, false, &lqbuffer2),
226                       diff / 1000, diff % 1000);
227                 } else {
228                   abuf_appendf(abuf, "%s\t%s\t%s\t%s\n", olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr), olsr_ip_to_string(&addrbuf, &tc->addr),
229                       get_tc_edge_entry_text(tc_edge, '\t', &lqbuffer1), get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
230                 }
231               }
232             }OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
233       }OLSR_FOR_ALL_TC_ENTRIES_END(tc);
234
235   abuf_puts(abuf, "\n");
236 }
237
238 void ipc_print_hna(struct autobuf *abuf) {
239   struct ip_prefix_list *hna;
240   struct hna_entry *tmp_hna;
241   struct hna_net *tmp_net;
242   struct ipaddr_str buf, mainaddrbuf;
243
244   if (vtime)
245     abuf_puts(abuf, "Table: HNA\nDestination\tGateway\tVTime\n");
246   else
247     abuf_puts(abuf, "Table: HNA\nDestination\tGateway\n");
248
249   /* Announced HNA entries */
250   for (hna = olsr_cnf->hna_entries; hna != NULL ; hna = hna->next) {
251     abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&buf, &hna->net.prefix), hna->net.prefix_len, olsr_ip_to_string(&mainaddrbuf, &olsr_cnf->main_addr));
252   }
253
254   /* HNA entries */
255   OLSR_FOR_ALL_HNA_ENTRIES(tmp_hna)
256         {
257
258           /* Check all networks */
259           for (tmp_net = tmp_hna->networks.next; tmp_net != &tmp_hna->networks; tmp_net = tmp_net->next) {
260             if (vtime) {
261               uint32_t vt = tmp_net->hna_net_timer != NULL ? (tmp_net->hna_net_timer->timer_clock - now_times) : 0;
262               int diff = (int) (vt);
263               abuf_appendf(abuf, "%s/%d\t%s\t\%d.%03d\n", olsr_ip_to_string(&buf, &tmp_net->hna_prefix.prefix),
264                   tmp_net->hna_prefix.prefix_len, olsr_ip_to_string(&mainaddrbuf, &tmp_hna->A_gateway_addr),
265                   diff / 1000, abs(diff % 1000));
266             } else {
267               abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&buf, &tmp_net->hna_prefix.prefix), tmp_net->hna_prefix.prefix_len,
268                   olsr_ip_to_string(&mainaddrbuf, &tmp_hna->A_gateway_addr));
269             }
270           }
271         }OLSR_FOR_ALL_HNA_ENTRIES_END(tmp_hna);
272
273   abuf_puts(abuf, "\n");
274 }
275
276 void ipc_print_mid(struct autobuf *abuf) {
277   int idx;
278   unsigned short is_first;
279   struct mid_entry *entry;
280   struct mid_address *alias;
281   if (vtime)
282     abuf_puts(abuf, "Table: MID\nIP address\tAlias\tVTime\n");
283   else
284     abuf_puts(abuf, "Table: MID\nIP address\tAliases\n");
285
286   /* MID */
287   for (idx = 0; idx < HASHSIZE; idx++) {
288     entry = mid_set[idx].next;
289
290     while (entry != &mid_set[idx]) {
291       struct ipaddr_str buf, buf2;
292       if (!vtime)
293         abuf_puts(abuf, olsr_ip_to_string(&buf, &entry->main_addr));
294
295       alias = entry->aliases;
296       is_first = 1;
297
298       while (alias) {
299         if (vtime) {
300           uint32_t vt = alias->vtime - now_times;
301           int diff = (int) (vt);
302
303           abuf_appendf(abuf, "%s\t%s\t%d.%03d\n",
304               olsr_ip_to_string(&buf, &entry->main_addr),
305               olsr_ip_to_string(&buf2, &alias->alias),
306               diff / 1000, abs(diff % 1000));
307         } else {
308           abuf_appendf(abuf, "%s%s", (is_first ? "\t" : ";"), olsr_ip_to_string(&buf, &alias->alias));
309         }
310         alias = alias->next_alias;
311         is_first = 0;
312       }
313       entry = entry->next;
314       if (!vtime)
315         abuf_puts(abuf, "\n");
316     }
317   }
318   abuf_puts(abuf, "\n");
319 }
320
321 void ipc_print_gateways(struct autobuf *abuf) {
322 #ifndef __linux__
323   abuf_puts(abuf, "Gateway mode is only supported in linux\n");
324 #else /* __linux__ */
325   static const char IPV4[] = "ipv4";
326   static const char IPV4_NAT[] = "ipv4(n)";
327   static const char IPV6[] = "ipv6";
328   static const char NONE[] = "-";
329
330   struct ipaddr_str buf;
331   struct gateway_entry *gw;
332   struct lqtextbuffer lqbuf;
333
334   // Status IP ETX Hopcount Uplink-Speed Downlink-Speed ipv4/ipv4-nat/- ipv6/- ipv6-prefix/-
335   abuf_puts(abuf, "Table: Gateways\nStatus\tGateway IP\tETX\tHopcnt\tUplink\tDownlnk\tIPv4\tIPv6\tPrefix\n");
336   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw)
337       {
338         char v4 = '-', v6 = '-';
339         const char *v4type = NONE, *v6type = NONE;
340         struct tc_entry *tc;
341
342         if ((tc = olsr_lookup_tc_entry(&gw->originator)) == NULL) {
343           continue;
344         }
345
346         if (gw == olsr_get_inet_gateway(false)) {
347           v4 = 's';
348         } else if (gw->ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit) && (olsr_cnf->smart_gw_allow_nat || !gw->ipv4nat)) {
349           v4 = 'u';
350         }
351
352         if (gw == olsr_get_inet_gateway(true)) {
353           v6 = 's';
354         } else if (gw->ipv6 && olsr_cnf->ip_version == AF_INET6) {
355           v6 = 'u';
356         }
357
358         if (gw->ipv4) {
359           v4type = gw->ipv4nat ? IPV4_NAT : IPV4;
360         }
361         if (gw->ipv6) {
362           v6type = IPV6;
363         }
364
365         abuf_appendf(abuf, "%c%c\t%s\t%s\t%d\t%u\t%u\t%s\t%s\t%s\n", v4, v6, olsr_ip_to_string(&buf, &gw->originator),
366             get_linkcost_text(tc->path_cost, true, &lqbuf), tc->hops, gw->uplink, gw->downlink, v4type, v6type,
367             gw->external_prefix.prefix_len == 0 ? NONE : olsr_ip_prefix_to_string(&gw->external_prefix));
368       }OLSR_FOR_ALL_GATEWAY_ENTRIES_END (gw)
369 #endif /* __linux__ */
370 }
371
372 #ifdef __linux__
373
374 /** interface names for smart gateway tunnel interfaces, IPv4 */
375 extern struct interfaceName * sgwTunnel4InterfaceNames;
376
377 /** interface names for smart gateway tunnel interfaces, IPv6 */
378 extern struct interfaceName * sgwTunnel6InterfaceNames;
379
380 /**
381  * Construct the sgw table for a given ip version
382  *
383  * @param abuf the string buffer
384  * @param ipv6 true for IPv6, false for IPv4
385  * @param fmtv the format for printing
386  */
387 static void sgw_ipvx(struct autobuf *abuf, bool ipv6, const char * fmth, const char * fmtv) {
388   struct interfaceName * sgwTunnelInterfaceNames;
389
390   abuf_appendf(abuf, "# Table: Smart Gateway IPv%s\n", ipv6 ? "6" : "4");
391   abuf_appendf(abuf, fmth, "#", "Originator", "Prefix", "Uplink", "Downlink", "PathCost", "IPv4", "IPv4-NAT", "IPv6", "Tunnel-Name", "Destination", "Cost");
392
393   sgwTunnelInterfaceNames = !ipv6 ? sgwTunnel4InterfaceNames : sgwTunnel6InterfaceNames;
394   if (olsr_cnf->smart_gw_active && sgwTunnelInterfaceNames) {
395     struct gateway_entry * current_gw = olsr_get_inet_gateway(ipv6);
396     int i;
397     for (i = 0; i < olsr_cnf->smart_gw_use_count; i++) {
398       struct interfaceName * node = &sgwTunnelInterfaceNames[i];
399       struct gateway_entry * gw = node->gw;
400
401       if (!gw) {
402         continue;
403       }
404
405       {
406         struct tc_entry* tc = olsr_lookup_tc_entry(&gw->originator);
407
408         struct ipaddr_str originatorStr;
409         const char * originator = olsr_ip_to_string(&originatorStr, &gw->originator);
410         struct ipaddr_str prefixIpStr;
411         const char * prefix = olsr_ip_to_string(&prefixIpStr, &gw->external_prefix.prefix);
412         union olsr_ip_addr netmask = { { 0 } };
413         struct ipaddr_str prefixMaskStr;
414         const char * prefixMASKStr;
415         char prefixAndMask[strlen(prefix) + 1 + INET_ADDRSTRLEN + 1];
416
417         if (!ipv6) {
418           prefix_to_netmask((uint8_t *) &netmask, sizeof(netmask.v4), gw->external_prefix.prefix_len);
419           prefixMASKStr = olsr_ip_to_string(&prefixMaskStr, &netmask);
420           snprintf(prefixAndMask, sizeof(prefixAndMask), "%s/%s", prefix, prefixMASKStr);
421         } else {
422           snprintf(prefixAndMask, sizeof(prefixAndMask), "%s/%d", prefix, gw->external_prefix.prefix_len);
423         }
424
425         abuf_appendf(abuf, fmtv, //
426             (current_gw && (current_gw == gw)) ? "*" : " ", // selected
427             originator, // Originator
428             prefixAndMask, // 4: Prefix IP / Prefix Mask, 6: Prefix IP / Prefix Length
429             gw->uplink, // Uplink
430             gw->downlink, // Downlink
431             !tc ? ROUTE_COST_BROKEN : tc->path_cost, // PathCost
432             gw->ipv4 ? "Y" : "N", // IPv4
433             gw->ipv4nat ? "Y" : "N", // IPv4-NAT
434             gw->ipv6 ? "Y" : "N", // IPv6
435             node->name, // Tunnel-Name
436             originator, // Destination
437             gw->path_cost // Cost
438             );
439       }
440     }
441   }
442 }
443 #endif /* __linux__ */
444
445 void ipc_print_sgw(struct autobuf *abuf) {
446 #ifndef __linux__
447   abuf_puts(abuf, "Gateway mode is only supported in linux\n");
448 #else
449
450   static const char * fmth4 = "%s%-15s %-31s %-9s %-9s %-10s %-4s %-8s %-4s %-15s %-15s %s\n";
451   static const char * fmtv4 = "%s%-15s %-31s %-9u %-9u %-10u %-4s %-8s %-4s %-15s %-15s %lld\n";
452 #if 0
453   static const char * fmth6 = "%s%-45s %-49s %-9s %-9s %-10s %-4s %-8s %-4s %-15s %-45s %s\n";
454   static const char * fmtv6 = "%s%-45s %-49s %-9u %-9u %-10u %-4s %-8s %-4s %-15s %-45s %lld\n";
455 #endif
456
457   sgw_ipvx(abuf, false, fmth4, fmtv4);
458   abuf_puts(abuf, "\n");
459 #if 0
460   sgw_ipvx(abuf, true, fmth6, fmtv6);
461   abuf_puts(abuf, "\n");
462 #endif
463 #endif /* __linux__ */
464 }
465
466 void ipc_print_version(struct autobuf *abuf) {
467   abuf_appendf(abuf, "Version: %s (built on %s on %s)\n", olsrd_version, build_date, build_host);
468 }
469
470 void ipc_print_olsrd_conf(struct autobuf *abuf) {
471   olsrd_write_cnf_autobuf(abuf, olsr_cnf);
472 }
473
474 void ipc_print_interfaces(struct autobuf *abuf) {
475   const struct olsr_if *ifs;
476   abuf_puts(abuf, "Table: Interfaces\nName\tState\tMTU\tWLAN\tSrc-Adress\tMask\tDst-Adress\n");
477   for (ifs = olsr_cnf->interfaces; ifs != NULL ; ifs = ifs->next) {
478     const struct interface_olsr * const rifs = ifs->interf;
479     abuf_appendf(abuf, "%s\t", ifs->name);
480     if (!rifs) {
481       abuf_puts(abuf, "DOWN\n");
482       continue;
483     }
484     abuf_appendf(abuf, "UP\t%d\t%s\t", rifs->int_mtu, rifs->is_wireless ? "Yes" : "No");
485
486     if (olsr_cnf->ip_version == AF_INET) {
487       struct ipaddr_str addrbuf, maskbuf, bcastbuf;
488       abuf_appendf(abuf, "%s\t%s\t%s\n", ip4_to_string(&addrbuf, rifs->int_addr.sin_addr), ip4_to_string(&maskbuf, rifs->int_netmask.sin_addr),
489           ip4_to_string(&bcastbuf, rifs->int_broadaddr.sin_addr));
490     } else {
491       struct ipaddr_str addrbuf, maskbuf;
492       abuf_appendf(abuf, "%s\t\t%s\n", ip6_to_string(&addrbuf, &rifs->int6_addr.sin6_addr), ip6_to_string(&maskbuf, &rifs->int6_multaddr.sin6_addr));
493     }
494   }
495   abuf_puts(abuf, "\n");
496 }
497