pimd/pim_cmd_common.h

   1 /*
   2  * PIM for IPv6 FRR
   3  * Copyright (C) 2022  Vmware, Inc.
   4  *                     Mobashshera Rasool <mrasool@vmware.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20 #ifndef PIM_CMD_COMMON_H
  21 #define PIM_CMD_COMMON_H
  22
  23 struct pim_upstream;
  24 struct pim_instance;
  25
  26 const char *pim_cli_get_vrf_name(struct vty *vty);
  27 int pim_process_join_prune_cmd(struct vty *vty, const char *jpi_str);
  28 int pim_process_no_join_prune_cmd(struct vty *vty);
  29 int pim_process_spt_switchover_infinity_cmd(struct vty *vty);
  30 int pim_process_spt_switchover_prefixlist_cmd(struct vty *vty,
  31                                               const char *plist);
  32 int pim_process_no_spt_switchover_cmd(struct vty *vty);
  33 int pim_process_pim_packet_cmd(struct vty *vty, const char *packet);
  34 int pim_process_no_pim_packet_cmd(struct vty *vty);
  35 int pim_process_keepalivetimer_cmd(struct vty *vty, const char *kat);
  36 int pim_process_no_keepalivetimer_cmd(struct vty *vty);
  37 int pim_process_rp_kat_cmd(struct vty *vty, const char *rpkat);
  38 int pim_process_no_rp_kat_cmd(struct vty *vty);
  39 int pim_process_register_suppress_cmd(struct vty *vty, const char *rst);
  40 int pim_process_no_register_suppress_cmd(struct vty *vty);
  41 int pim_process_rp_cmd(struct vty *vty, const char *rp_str,
  42                        const char *group_str);
  43 int pim_process_no_rp_cmd(struct vty *vty, const char *rp_str,
  44                           const char *group_str);
  45 int pim_process_rp_plist_cmd(struct vty *vty, const char *rp_str,
  46                              const char *prefix_list);
  47 int pim_process_no_rp_plist_cmd(struct vty *vty, const char *rp_str,
  48                                 const char *prefix_list);
  49
  50 int pim_process_ip_pim_cmd(struct vty *vty);
  51 int pim_process_no_ip_pim_cmd(struct vty *vty);
  52 int pim_process_ip_pim_passive_cmd(struct vty *vty, bool enable);
  53 int pim_process_ip_pim_drprio_cmd(struct vty *vty, const char *drpriority_str);
  54 int pim_process_no_ip_pim_drprio_cmd(struct vty *vty);
  55 int pim_process_ip_pim_hello_cmd(struct vty *vty, const char *hello_str,
  56                                  const char *hold_str);
  57 int pim_process_no_ip_pim_hello_cmd(struct vty *vty);
  58 int pim_process_ip_pim_activeactive_cmd(struct vty *vty, const char *no);
  59 int pim_process_ip_pim_boundary_oil_cmd(struct vty *vty, const char *oil);
  60 int pim_process_no_ip_pim_boundary_oil_cmd(struct vty *vty);
  61 int pim_process_ip_mroute_cmd(struct vty *vty, const char *interface,
  62                               const char *group_str, const char *source_str);
  63 int pim_process_no_ip_mroute_cmd(struct vty *vty, const char *interface,
  64                                  const char *group_str, const char *src_str);
  65 void json_object_pim_upstream_add(json_object *json, struct pim_upstream *up);
  66 void pim_show_rpf(struct pim_instance *pim, struct vty *vty, json_object *json);
  67 void pim_show_neighbors_secondary(struct pim_instance *pim, struct vty *vty);
  68 void pim_show_state(struct pim_instance *pim, struct vty *vty,
  69                     const char *src_or_group, const char *group,
  70                     json_object *json);
  71 void pim_show_statistics(struct pim_instance *pim, struct vty *vty,
  72                          const char *ifname, bool uj);
  73 void pim_show_upstream(struct pim_instance *pim, struct vty *vty,
  74                        pim_sgaddr *sg, json_object *json);
  75 void pim_show_join_desired(struct pim_instance *pim, struct vty *vty, bool uj);
  76 void pim_show_upstream_rpf(struct pim_instance *pim, struct vty *vty, bool uj);
  77 void pim_show_rpf_refresh_stats(struct vty *vty, struct pim_instance *pim,
  78                                 time_t now, json_object *json);
  79 bool pim_sgaddr_match(pim_sgaddr item, pim_sgaddr match);
  80 void json_object_pim_ifp_add(struct json_object *json, struct interface *ifp);
  81 void pim_print_ifp_flags(struct vty *vty, struct interface *ifp);
  82 void json_object_pim_upstream_add(json_object *json, struct pim_upstream *up);
  83 int pim_show_join_cmd_helper(const char *vrf, struct vty *vty, pim_addr s_or_g,
  84                              pim_addr g, const char *json);
  85 int pim_show_join_vrf_all_cmd_helper(struct vty *vty, const char *json);
  86 void pim_show_join(struct pim_instance *pim, struct vty *vty, pim_sgaddr *sg,
  87                    json_object *json);
  88 int pim_show_jp_agg_list_cmd_helper(const char *vrf, struct vty *vty);
  89 void pim_show_jp_agg_list(struct pim_instance *pim, struct vty *vty);
  90 int pim_show_membership_cmd_helper(const char *vrf, struct vty *vty, bool uj);
  91 void pim_show_membership(struct pim_instance *pim, struct vty *vty, bool uj);
  92 void pim_show_channel(struct pim_instance *pim, struct vty *vty, bool uj);
  93 int pim_show_channel_cmd_helper(const char *vrf, struct vty *vty, bool uj);
  94 int pim_show_interface_cmd_helper(const char *vrf, struct vty *vty, bool uj,
  95                                   bool mlag, const char *interface);
  96 int pim_show_interface_vrf_all_cmd_helper(struct vty *vty, bool uj, bool mlag,
  97                                           const char *interface);
  98 void pim_show_interfaces(struct pim_instance *pim, struct vty *vty, bool mlag,
  99                          json_object *json);
 100 void pim_show_interfaces_single(struct pim_instance *pim, struct vty *vty,
 101                                 const char *ifname, bool mlag,
 102                                 json_object *json);
 103 void ip_pim_ssm_show_group_range(struct pim_instance *pim, struct vty *vty,
 104                                  bool uj);
 105 int pim_show_nexthop_lookup_cmd_helper(const char *vrf, struct vty *vty,
 106                                        pim_addr source, pim_addr group);
 107 int pim_show_nexthop_cmd_helper(const char *vrf, struct vty *vty, bool uj);
 108 void pim_show_nexthop(struct pim_instance *pim, struct vty *vty, bool uj);
 109 int pim_show_neighbors_cmd_helper(const char *vrf, struct vty *vty,
 110                                   const char *json, const char *interface);
 111 int pim_show_neighbors_vrf_all_cmd_helper(struct vty *vty, const char *json,
 112                                           const char *interface);
 113 void pim_show_neighbors_single(struct pim_instance *pim, struct vty *vty,
 114                                const char *neighbor, json_object *json);
 115 void pim_show_neighbors(struct pim_instance *pim, struct vty *vty,
 116                         json_object *json);
 117 int gm_process_query_max_response_time_cmd(struct vty *vty,
 118                                            const char *qmrt_str);
 119 int gm_process_no_query_max_response_time_cmd(struct vty *vty);
 120 int gm_process_last_member_query_count_cmd(struct vty *vty,
 121                                            const char *lmqc_str);
 122 int gm_process_no_last_member_query_count_cmd(struct vty *vty);
 123 int gm_process_last_member_query_interval_cmd(struct vty *vty,
 124                                               const char *lmqi_str);
 125 int gm_process_no_last_member_query_interval_cmd(struct vty *vty);
 126 int pim_process_ssmpingd_cmd(struct vty *vty, enum nb_operation operation,
 127                              const char *src_str);
 128 void pim_cmd_show_ip_multicast_helper(struct pim_instance *pim,
 129                                       struct vty *vty);
 130 void show_multicast_interfaces(struct pim_instance *pim, struct vty *vty,
 131                                json_object *json);
 132 void show_mroute(struct pim_instance *pim, struct vty *vty, pim_sgaddr *sg,
 133                  bool fill, json_object *json);
 134 void show_mroute_count(struct pim_instance *pim, struct vty *vty,
 135                        json_object *json);
 136 void show_mroute_summary(struct pim_instance *pim, struct vty *vty,
 137                          json_object *json);
 138 int clear_ip_mroute_count_command(struct vty *vty, const char *name);
 139 struct vrf *pim_cmd_lookup(struct vty *vty, const char *name);
 140 void clear_mroute(struct pim_instance *pim);
 141 void clear_pim_statistics(struct pim_instance *pim);
 142 int pim_debug_pim_cmd(void);
 143 int pim_no_debug_pim_cmd(void);
 144 int pim_debug_pim_packets_cmd(const char *hello, const char *joins,
 145                               const char *registers, struct vty *vty);
 146 int pim_no_debug_pim_packets_cmd(const char *hello, const char *joins,
 147                                  const char *registers, struct vty *vty);
 148 int pim_show_rpf_helper(const char *vrf, struct vty *vty, bool json);
 149 int pim_show_rpf_vrf_all_helper(struct vty *vty, bool json);
 150 int pim_show_rp_helper(const char *vrf, struct vty *vty, const char *group_str,
 151                        const struct prefix *group, bool json);
 152 int pim_show_rp_vrf_all_helper(struct vty *vty, const char *group_str,
 153                                const struct prefix *group, bool json);
 154 int pim_show_secondary_helper(const char *vrf, struct vty *vty);
 155 int pim_show_statistics_helper(const char *vrf, struct vty *vty,
 156                                const char *word, bool uj);
 157 int pim_show_upstream_helper(const char *vrf, struct vty *vty, pim_addr s_or_g,
 158                              pim_addr g, bool json);
 159 int pim_show_upstream_vrf_all_helper(struct vty *vty, bool json);
 160 int pim_show_upstream_join_desired_helper(const char *vrf, struct vty *vty,
 161                                           bool uj);
 162 int pim_show_upstream_rpf_helper(const char *vrf, struct vty *vty, bool uj);
 163 int pim_show_state_helper(const char *vrf, struct vty *vty,
 164                           const char *s_or_g_str, const char *g_str, bool json);
 165 int pim_show_state_vrf_all_helper(struct vty *vty, const char *s_or_g_str,
 166                                   const char *g_str, bool json);
 167 int pim_show_multicast_helper(const char *vrf, struct vty *vty);
 168 int pim_show_multicast_vrf_all_helper(struct vty *vty);
 169 int pim_show_multicast_count_helper(const char *vrf, struct vty *vty,
 170                                     bool json);
 171 int pim_show_multicast_count_vrf_all_helper(struct vty *vty, bool json);
 172 int pim_show_mroute_helper(const char *vrf, struct vty *vty, pim_addr s_or_g,
 173                            pim_addr g, bool fill, bool json);
 174 int pim_show_mroute_vrf_all_helper(struct vty *vty, bool fill, bool json);
 175 int pim_show_mroute_count_helper(const char *vrf, struct vty *vty, bool json);
 176 int pim_show_mroute_count_vrf_all_helper(struct vty *vty, bool json);
 177 int pim_show_mroute_summary_helper(const char *vrf, struct vty *vty, bool json);
 178 int pim_show_mroute_summary_vrf_all_helper(struct vty *vty, bool json);
 179
 180 void pim_show_interface_traffic_single(struct pim_instance *pim,
 181                                        struct vty *vty, const char *ifname,
 182                                        bool uj);
 183 void pim_show_interface_traffic(struct pim_instance *pim, struct vty *vty,
 184                                 bool uj);
 185 int pim_show_interface_traffic_helper(const char *vrf, const char *if_name,
 186                                       struct vty *vty, bool uj);
 187 /*
 188  * Special Macro to allow us to get the correct pim_instance;
 189  */
 190 #define PIM_DECLVAR_CONTEXT_VRF(vrfptr, pimptr)                                \
 191         VTY_DECLVAR_CONTEXT_VRF(vrfptr);                                       \
 192         struct pim_instance *pimptr = vrfptr->info;                            \
 193         MACRO_REQUIRE_SEMICOLON() /* end */
 194
 195 #endif /* PIM_CMD_COMMON_H */