pimd: make function names consistent

Rename functions (`pim_msdp_peer_new` => `pim_msdp_peer_add` and
`pim_msdp_peer_do_del` => `pim_msdp_peer_del`) to keep consistency and
update the `pim_msdp_peer_add` documentation to tell users that this is
also used for non meshed group peers.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>

diff --git a/pimd/pim_msdp.c b/pimd/pim_msdp.c
index e50f86dfe805cc6324d31bcba8fa7532c7908ab6..be2df7693c3d84effdbf929f600787a64908ec45 100644 (file)
--- a/pimd/pim_msdp.c
+++ b/pimd/pim_msdp.c
@@ -1044,7 +1044,7 @@ static void pim_msdp_addr2su(union sockunion *su, struct in_addr addr)
 }
 
 /* 11.2.A1: create a new peer and transition state to listen or connecting */
-struct pim_msdp_peer *pim_msdp_peer_new(struct pim_instance *pim,
+struct pim_msdp_peer *pim_msdp_peer_add(struct pim_instance *pim,
                                        const struct in_addr *peer,
                                        const struct in_addr *local,
                                        const char *mesh_group_name)
@@ -1131,7 +1131,7 @@ static void pim_msdp_peer_free(struct pim_msdp_peer *mp)
 }
 
 /* delete the peer config */
-void pim_msdp_peer_do_del(struct pim_msdp_peer **mp)
+void pim_msdp_peer_del(struct pim_msdp_peer **mp)
 {
        if (*mp == NULL)
                return;
@@ -1264,7 +1264,7 @@ void pim_msdp_mg_mbr_del(struct pim_msdp_mg *mg, struct pim_msdp_mg_mbr *mbr)
 {
        /* Delete active peer session if any */
        if (mbr->mp) {
-               pim_msdp_peer_do_del(&mbr->mp);
+               pim_msdp_peer_del(&mbr->mp);
        }
 
        listnode_delete(mg->mbr_list, mbr);
@@ -1288,7 +1288,7 @@ static void pim_msdp_src_del(struct pim_msdp_mg *mg)
        /* SIP is being removed - tear down all active peer sessions */
        for (ALL_LIST_ELEMENTS_RO(mg->mbr_list, mbr_node, mbr)) {
                if (mbr->mp)
-                       pim_msdp_peer_do_del(&mbr->mp);
+                       pim_msdp_peer_del(&mbr->mp);
        }
        if (PIM_DEBUG_MSDP_EVENTS) {
                zlog_debug("MSDP mesh-group %s src cleared",
@@ -1447,7 +1447,7 @@ void pim_msdp_mg_src_add(struct pim_instance *pim, struct pim_msdp_mg *mg,
 
        /* Create data structures and start TCP connection. */
        for (ALL_LIST_ELEMENTS_RO(mg->mbr_list, mbr_node, mbr))
-               mbr->mp = pim_msdp_peer_new(pim, &mbr->mbr_ip, &mg->src_ip,
+               mbr->mp = pim_msdp_peer_add(pim, &mbr->mbr_ip, &mg->src_ip,
                                            mg->mesh_group_name);
 
        if (PIM_DEBUG_MSDP_EVENTS)
@@ -1467,7 +1467,7 @@ struct pim_msdp_mg_mbr *pim_msdp_mg_mbr_add(struct pim_instance *pim,
 
        /* if valid SIP has been configured add peer session */
        if (mg->src_ip.s_addr != INADDR_ANY)
-               mbr->mp = pim_msdp_peer_new(pim, &mbr->mbr_ip, &mg->src_ip,
+               mbr->mp = pim_msdp_peer_add(pim, &mbr->mbr_ip, &mg->src_ip,
                                            mg->mesh_group_name);
 
        if (PIM_DEBUG_MSDP_EVENTS)

diff --git a/pimd/pim_msdp.h b/pimd/pim_msdp.h
index 1a133fd26050bce9d2e7639c2273cdac3242d249..6bf02f2b9faaba62256a7960c52feebb6eb55404 100644 (file)
--- a/pimd/pim_msdp.h
+++ b/pimd/pim_msdp.h
@@ -283,14 +283,16 @@ struct pim_msdp_mg_mbr *pim_msdp_mg_mbr_add(struct pim_instance *pim,
 void pim_msdp_mg_mbr_del(struct pim_msdp_mg *mg, struct pim_msdp_mg_mbr *mbr);
 
 /**
- * Allocates MSDP peer data structure and starts state machine.
+ * Allocates MSDP peer data structure, adds peer to group name
+ * `mesh_group_name` and starts state machine. If no group name is provided then
+ * the peer will work standalone.
  *
  * \param pim PIM instance
  * \param peer_addr peer address
  * \param local_addr local listening address
  * \param mesh_group_name mesh group name (or `NULL` for peers without group).
  */
-struct pim_msdp_peer *pim_msdp_peer_new(struct pim_instance *pim,
+struct pim_msdp_peer *pim_msdp_peer_add(struct pim_instance *pim,
                                        const struct in_addr *peer_addr,
                                        const struct in_addr *local_addr,
                                        const char *mesh_group_name);
@@ -298,7 +300,7 @@ struct pim_msdp_peer *pim_msdp_peer_new(struct pim_instance *pim,
 /**
  * Stops peer state machine and free memory.
  */
-void pim_msdp_peer_do_del(struct pim_msdp_peer **mp);
+void pim_msdp_peer_del(struct pim_msdp_peer **mp);
 
 /**
  * Changes peer source address.

diff --git a/pimd/pim_nb_config.c b/pimd/pim_nb_config.c
index 3afa6e7e169a4f3b2c903adc6d16c383a0a1822d..d69ab3aeb63fb1aad08a0fc098d6a878ef3e4766 100644 (file)
--- a/pimd/pim_nb_config.c
+++ b/pimd/pim_nb_config.c
@@ -1120,7 +1120,7 @@ int routing_control_plane_protocols_control_plane_protocol_pim_address_family_ms
                pim = vrf->info;
                yang_dnode_get_ip(&peer_ip, args->dnode, "./peer-ip");
                yang_dnode_get_ip(&source_ip, args->dnode, "./source-ip");
-               mp = pim_msdp_peer_new(pim, &peer_ip.ipaddr_v4,
+               mp = pim_msdp_peer_add(pim, &peer_ip.ipaddr_v4,
                                       &source_ip.ipaddr_v4, NULL);
                nb_running_set_entry(args->dnode, mp);
                break;
@@ -1141,7 +1141,7 @@ int routing_control_plane_protocols_control_plane_protocol_pim_address_family_ms
                break;
        case NB_EV_APPLY:
                mp = nb_running_unset_entry(args->dnode);
-               pim_msdp_peer_do_del(&mp);
+               pim_msdp_peer_del(&mp);
                break;
        }