info: split out neighbors and 2hop printer functions
[olsrd.git] / lib / txtinfo / src / olsrd_txtinfo.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 "olsrd_txtinfo.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 static void ipc_print_neighbors_internal(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_neighbors(struct autobuf *abuf) {
152   ipc_print_neighbors_internal(abuf, false);
153 }
154
155 void ipc_print_links(struct autobuf *abuf) {
156   struct ipaddr_str buf1, buf2;
157   struct lqtextbuffer lqbuffer1, lqbuffer2;
158
159   struct link_entry *my_link = NULL;
160
161   if (vtime)
162     abuf_puts(abuf, "Table: Links\nLocal IP\tRemote IP\tVTime\tLQ\tNLQ\tCost\n");
163   else
164     abuf_puts(abuf, "Table: Links\nLocal IP\tRemote IP\tHyst.\tLQ\tNLQ\tCost\n");
165
166   /* Link set */
167   OLSR_FOR_ALL_LINK_ENTRIES(my_link)
168       {
169         if (vtime) {
170           int diff = (unsigned int) (my_link->link_timer->timer_clock - now_times);
171
172           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),
173               olsr_ip_to_string(&buf2, &my_link->neighbor_iface_addr),
174               diff / 1000, abs(diff % 1000),
175               get_link_entry_text(my_link, '\t', &lqbuffer1),
176               get_linkcost_text(my_link->linkcost, false, &lqbuffer2));
177         } else {
178           abuf_appendf(abuf, "%s\t%s\t0.00\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &my_link->local_iface_addr),
179               olsr_ip_to_string(&buf2, &my_link->neighbor_iface_addr), get_link_entry_text(my_link, '\t', &lqbuffer1),
180               get_linkcost_text(my_link->linkcost, false, &lqbuffer2));
181         }
182       }OLSR_FOR_ALL_LINK_ENTRIES_END(my_link);
183
184   abuf_puts(abuf, "\n");
185 }
186
187 void ipc_print_routes(struct autobuf *abuf) {
188   struct ipaddr_str buf1, buf2;
189   struct rt_entry *rt;
190   struct lqtextbuffer lqbuffer;
191
192   abuf_puts(abuf, "Table: Routes\nDestination\tGateway IP\tMetric\tETX\tInterface\n");
193
194   /* Walk the route table */
195   OLSR_FOR_ALL_RT_ENTRIES(rt)
196       {
197         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,
198             olsr_ip_to_string(&buf2, &rt->rt_best->rtp_nexthop.gateway), rt->rt_best->rtp_metric.hops,
199             get_linkcost_text(rt->rt_best->rtp_metric.cost, true, &lqbuffer), if_ifwithindex_name(rt->rt_best->rtp_nexthop.iif_index));
200       }OLSR_FOR_ALL_RT_ENTRIES_END(rt);
201
202   abuf_puts(abuf, "\n");
203
204 }
205
206 void ipc_print_topology(struct autobuf *abuf) {
207   struct tc_entry *tc;
208
209   if (vtime)
210     abuf_puts(abuf, "Table: Topology\nDest. IP\tLast hop IP\tLQ\tNLQ\tCost\tVTime\n");
211   else
212     abuf_puts(abuf, "Table: Topology\nDest. IP\tLast hop IP\tLQ\tNLQ\tCost\n");
213
214   /* Topology */
215   OLSR_FOR_ALL_TC_ENTRIES(tc)
216       {
217         struct tc_edge_entry *tc_edge;
218         OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge)
219             {
220               if (tc_edge->edge_inv) {
221                 struct ipaddr_str dstbuf, addrbuf;
222                 struct lqtextbuffer lqbuffer1, lqbuffer2;
223                 if (vtime) {
224                   uint32_t vt = tc->validity_timer != NULL ? (tc->validity_timer->timer_clock - now_times) : 0;
225                   int diff = (int) (vt);
226                   abuf_appendf(abuf, "%s\t%s\t%s\t%s\t%d.%03d\n", olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr),
227                       olsr_ip_to_string(&addrbuf, &tc->addr),
228                       get_tc_edge_entry_text(tc_edge, '\t', &lqbuffer1),
229                       get_linkcost_text(tc_edge->cost, false, &lqbuffer2),
230                       diff / 1000, diff % 1000);
231                 } else {
232                   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),
233                       get_tc_edge_entry_text(tc_edge, '\t', &lqbuffer1), get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
234                 }
235               }
236             }OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
237       }OLSR_FOR_ALL_TC_ENTRIES_END(tc);
238
239   abuf_puts(abuf, "\n");
240 }
241
242 void ipc_print_hna(struct autobuf *abuf) {
243   struct ip_prefix_list *hna;
244   struct hna_entry *tmp_hna;
245   struct hna_net *tmp_net;
246   struct ipaddr_str buf, mainaddrbuf;
247
248   if (vtime)
249     abuf_puts(abuf, "Table: HNA\nDestination\tGateway\tVTime\n");
250   else
251     abuf_puts(abuf, "Table: HNA\nDestination\tGateway\n");
252
253   /* Announced HNA entries */
254   for (hna = olsr_cnf->hna_entries; hna != NULL ; hna = hna->next) {
255     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));
256   }
257
258   /* HNA entries */
259   OLSR_FOR_ALL_HNA_ENTRIES(tmp_hna)
260         {
261
262           /* Check all networks */
263           for (tmp_net = tmp_hna->networks.next; tmp_net != &tmp_hna->networks; tmp_net = tmp_net->next) {
264             if (vtime) {
265               uint32_t vt = tmp_net->hna_net_timer != NULL ? (tmp_net->hna_net_timer->timer_clock - now_times) : 0;
266               int diff = (int) (vt);
267               abuf_appendf(abuf, "%s/%d\t%s\t\%d.%03d\n", olsr_ip_to_string(&buf, &tmp_net->hna_prefix.prefix),
268                   tmp_net->hna_prefix.prefix_len, olsr_ip_to_string(&mainaddrbuf, &tmp_hna->A_gateway_addr),
269                   diff / 1000, abs(diff % 1000));
270             } else {
271               abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&buf, &tmp_net->hna_prefix.prefix), tmp_net->hna_prefix.prefix_len,
272                   olsr_ip_to_string(&mainaddrbuf, &tmp_hna->A_gateway_addr));
273             }
274           }
275         }OLSR_FOR_ALL_HNA_ENTRIES_END(tmp_hna);
276
277   abuf_puts(abuf, "\n");
278 }
279
280 void ipc_print_mid(struct autobuf *abuf) {
281   int idx;
282   unsigned short is_first;
283   struct mid_entry *entry;
284   struct mid_address *alias;
285   if (vtime)
286     abuf_puts(abuf, "Table: MID\nIP address\tAlias\tVTime\n");
287   else
288     abuf_puts(abuf, "Table: MID\nIP address\tAliases\n");
289
290   /* MID */
291   for (idx = 0; idx < HASHSIZE; idx++) {
292     entry = mid_set[idx].next;
293
294     while (entry != &mid_set[idx]) {
295       struct ipaddr_str buf, buf2;
296       if (!vtime)
297         abuf_puts(abuf, olsr_ip_to_string(&buf, &entry->main_addr));
298
299       alias = entry->aliases;
300       is_first = 1;
301
302       while (alias) {
303         if (vtime) {
304           uint32_t vt = alias->vtime - now_times;
305           int diff = (int) (vt);
306
307           abuf_appendf(abuf, "%s\t%s\t%d.%03d\n",
308               olsr_ip_to_string(&buf, &entry->main_addr),
309               olsr_ip_to_string(&buf2, &alias->alias),
310               diff / 1000, abs(diff % 1000));
311         } else {
312           abuf_appendf(abuf, "%s%s", (is_first ? "\t" : ";"), olsr_ip_to_string(&buf, &alias->alias));
313         }
314         alias = alias->next_alias;
315         is_first = 0;
316       }
317       entry = entry->next;
318       if (!vtime)
319         abuf_puts(abuf, "\n");
320     }
321   }
322   abuf_puts(abuf, "\n");
323 }
324
325 void ipc_print_gateways(struct autobuf *abuf) {
326 #ifndef __linux__
327   abuf_puts(abuf, "Gateway mode is only supported in linux\n");
328 #else /* __linux__ */
329   static const char IPV4[] = "ipv4";
330   static const char IPV4_NAT[] = "ipv4(n)";
331   static const char IPV6[] = "ipv6";
332   static const char NONE[] = "-";
333
334   struct ipaddr_str buf;
335   struct gateway_entry *gw;
336   struct lqtextbuffer lqbuf;
337
338   // Status IP ETX Hopcount Uplink-Speed Downlink-Speed ipv4/ipv4-nat/- ipv6/- ipv6-prefix/-
339   abuf_puts(abuf, "Table: Gateways\nStatus\tGateway IP\tETX\tHopcnt\tUplink\tDownlnk\tIPv4\tIPv6\tPrefix\n");
340   OLSR_FOR_ALL_GATEWAY_ENTRIES(gw)
341       {
342         char v4 = '-', v6 = '-';
343         const char *v4type = NONE, *v6type = NONE;
344         struct tc_entry *tc;
345
346         if ((tc = olsr_lookup_tc_entry(&gw->originator)) == NULL) {
347           continue;
348         }
349
350         if (gw == olsr_get_inet_gateway(false)) {
351           v4 = 's';
352         } else if (gw->ipv4 && (olsr_cnf->ip_version == AF_INET || olsr_cnf->use_niit) && (olsr_cnf->smart_gw_allow_nat || !gw->ipv4nat)) {
353           v4 = 'u';
354         }
355
356         if (gw == olsr_get_inet_gateway(true)) {
357           v6 = 's';
358         } else if (gw->ipv6 && olsr_cnf->ip_version == AF_INET6) {
359           v6 = 'u';
360         }
361
362         if (gw->ipv4) {
363           v4type = gw->ipv4nat ? IPV4_NAT : IPV4;
364         }
365         if (gw->ipv6) {
366           v6type = IPV6;
367         }
368
369         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),
370             get_linkcost_text(tc->path_cost, true, &lqbuf), tc->hops, gw->uplink, gw->downlink, v4type, v6type,
371             gw->external_prefix.prefix_len == 0 ? NONE : olsr_ip_prefix_to_string(&gw->external_prefix));
372       }OLSR_FOR_ALL_GATEWAY_ENTRIES_END (gw)
373 #endif /* __linux__ */
374 }
375
376 #ifdef __linux__
377
378 /** interface names for smart gateway tunnel interfaces, IPv4 */
379 extern struct interfaceName * sgwTunnel4InterfaceNames;
380
381 /** interface names for smart gateway tunnel interfaces, IPv6 */
382 extern struct interfaceName * sgwTunnel6InterfaceNames;
383
384 /**
385  * Construct the sgw table for a given ip version
386  *
387  * @param abuf the string buffer
388  * @param ipv6 true for IPv6, false for IPv4
389  * @param fmtv the format for printing
390  */
391 static void sgw_ipvx(struct autobuf *abuf, bool ipv6, const char * fmth, const char * fmtv) {
392   struct interfaceName * sgwTunnelInterfaceNames;
393
394   abuf_appendf(abuf, "# Table: Smart Gateway IPv%s\n", ipv6 ? "6" : "4");
395   abuf_appendf(abuf, fmth, "#", "Originator", "Prefix", "Uplink", "Downlink", "PathCost", "IPv4", "IPv4-NAT", "IPv6", "Tunnel-Name", "Destination", "Cost");
396
397   sgwTunnelInterfaceNames = !ipv6 ? sgwTunnel4InterfaceNames : sgwTunnel6InterfaceNames;
398   if (olsr_cnf->smart_gw_active && sgwTunnelInterfaceNames) {
399     struct gateway_entry * current_gw = olsr_get_inet_gateway(ipv6);
400     int i;
401     for (i = 0; i < olsr_cnf->smart_gw_use_count; i++) {
402       struct interfaceName * node = &sgwTunnelInterfaceNames[i];
403       struct gateway_entry * gw = node->gw;
404
405       if (!gw) {
406         continue;
407       }
408
409       {
410         struct tc_entry* tc = olsr_lookup_tc_entry(&gw->originator);
411
412         struct ipaddr_str originatorStr;
413         const char * originator = olsr_ip_to_string(&originatorStr, &gw->originator);
414         struct ipaddr_str prefixIpStr;
415         const char * prefix = olsr_ip_to_string(&prefixIpStr, &gw->external_prefix.prefix);
416         union olsr_ip_addr netmask = { { 0 } };
417         struct ipaddr_str prefixMaskStr;
418         const char * prefixMASKStr;
419         char prefixAndMask[strlen(prefix) + 1 + INET_ADDRSTRLEN + 1];
420
421         if (!ipv6) {
422           prefix_to_netmask((uint8_t *) &netmask, sizeof(netmask.v4), gw->external_prefix.prefix_len);
423           prefixMASKStr = olsr_ip_to_string(&prefixMaskStr, &netmask);
424           snprintf(prefixAndMask, sizeof(prefixAndMask), "%s/%s", prefix, prefixMASKStr);
425         } else {
426           snprintf(prefixAndMask, sizeof(prefixAndMask), "%s/%d", prefix, gw->external_prefix.prefix_len);
427         }
428
429         abuf_appendf(abuf, fmtv, //
430             (current_gw && (current_gw == gw)) ? "*" : " ", // selected
431             originator, // Originator
432             prefixAndMask, // 4: Prefix IP / Prefix Mask, 6: Prefix IP / Prefix Length
433             gw->uplink, // Uplink
434             gw->downlink, // Downlink
435             !tc ? ROUTE_COST_BROKEN : tc->path_cost, // PathCost
436             gw->ipv4 ? "Y" : "N", // IPv4
437             gw->ipv4nat ? "Y" : "N", // IPv4-NAT
438             gw->ipv6 ? "Y" : "N", // IPv6
439             node->name, // Tunnel-Name
440             originator, // Destination
441             gw->path_cost // Cost
442             );
443       }
444     }
445   }
446 }
447 #endif /* __linux__ */
448
449 void ipc_print_sgw(struct autobuf *abuf) {
450 #ifndef __linux__
451   abuf_puts(abuf, "Gateway mode is only supported in linux\n");
452 #else
453
454   static const char * fmth4 = "%s%-15s %-31s %-9s %-9s %-10s %-4s %-8s %-4s %-15s %-15s %s\n";
455   static const char * fmtv4 = "%s%-15s %-31s %-9u %-9u %-10u %-4s %-8s %-4s %-15s %-15s %lld\n";
456 #if 0
457   static const char * fmth6 = "%s%-45s %-49s %-9s %-9s %-10s %-4s %-8s %-4s %-15s %-45s %s\n";
458   static const char * fmtv6 = "%s%-45s %-49s %-9u %-9u %-10u %-4s %-8s %-4s %-15s %-45s %lld\n";
459 #endif
460
461   sgw_ipvx(abuf, false, fmth4, fmtv4);
462   abuf_puts(abuf, "\n");
463 #if 0
464   sgw_ipvx(abuf, true, fmth6, fmtv6);
465   abuf_puts(abuf, "\n");
466 #endif
467 #endif /* __linux__ */
468 }
469
470 void ipc_print_version(struct autobuf *abuf) {
471   abuf_appendf(abuf, "Version: %s (built on %s on %s)\n", olsrd_version, build_date, build_host);
472 }
473
474 void ipc_print_olsrd_conf(struct autobuf *abuf) {
475   olsrd_write_cnf_autobuf(abuf, olsr_cnf);
476 }
477
478 void ipc_print_interfaces(struct autobuf *abuf) {
479   const struct olsr_if *ifs;
480   abuf_puts(abuf, "Table: Interfaces\nName\tState\tMTU\tWLAN\tSrc-Adress\tMask\tDst-Adress\n");
481   for (ifs = olsr_cnf->interfaces; ifs != NULL ; ifs = ifs->next) {
482     const struct interface_olsr * const rifs = ifs->interf;
483     abuf_appendf(abuf, "%s\t", ifs->name);
484     if (!rifs) {
485       abuf_puts(abuf, "DOWN\n");
486       continue;
487     }
488     abuf_appendf(abuf, "UP\t%d\t%s\t", rifs->int_mtu, rifs->is_wireless ? "Yes" : "No");
489
490     if (olsr_cnf->ip_version == AF_INET) {
491       struct ipaddr_str addrbuf, maskbuf, bcastbuf;
492       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),
493           ip4_to_string(&bcastbuf, rifs->int_broadaddr.sin_addr));
494     } else {
495       struct ipaddr_str addrbuf, maskbuf;
496       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));
497     }
498   }
499   abuf_puts(abuf, "\n");
500 }
501
502 void ipc_print_twohop(struct autobuf *abuf) {
503   ipc_print_neighbors_internal(abuf, true);
504 }