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>
This commit is contained in:
Rafael Zalamena 2021-06-25 16:00:09 -03:00
parent 858252d0c5
commit c72d97a5d9
3 changed files with 13 additions and 11 deletions

View file

@ -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 */ /* 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 *peer,
const struct in_addr *local, const struct in_addr *local,
const char *mesh_group_name) const char *mesh_group_name)
@ -1131,7 +1131,7 @@ static void pim_msdp_peer_free(struct pim_msdp_peer *mp)
} }
/* delete the peer config */ /* 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) if (*mp == NULL)
return; 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 */ /* Delete active peer session if any */
if (mbr->mp) { if (mbr->mp) {
pim_msdp_peer_do_del(&mbr->mp); pim_msdp_peer_del(&mbr->mp);
} }
listnode_delete(mg->mbr_list, mbr); 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 */ /* SIP is being removed - tear down all active peer sessions */
for (ALL_LIST_ELEMENTS_RO(mg->mbr_list, mbr_node, mbr)) { for (ALL_LIST_ELEMENTS_RO(mg->mbr_list, mbr_node, mbr)) {
if (mbr->mp) if (mbr->mp)
pim_msdp_peer_do_del(&mbr->mp); pim_msdp_peer_del(&mbr->mp);
} }
if (PIM_DEBUG_MSDP_EVENTS) { if (PIM_DEBUG_MSDP_EVENTS) {
zlog_debug("MSDP mesh-group %s src cleared", 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. */ /* Create data structures and start TCP connection. */
for (ALL_LIST_ELEMENTS_RO(mg->mbr_list, mbr_node, mbr)) 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); mg->mesh_group_name);
if (PIM_DEBUG_MSDP_EVENTS) 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 valid SIP has been configured add peer session */
if (mg->src_ip.s_addr != INADDR_ANY) 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); mg->mesh_group_name);
if (PIM_DEBUG_MSDP_EVENTS) if (PIM_DEBUG_MSDP_EVENTS)

View file

@ -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); 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 pim PIM instance
* \param peer_addr peer address * \param peer_addr peer address
* \param local_addr local listening address * \param local_addr local listening address
* \param mesh_group_name mesh group name (or `NULL` for peers without group). * \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 *peer_addr,
const struct in_addr *local_addr, const struct in_addr *local_addr,
const char *mesh_group_name); 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. * 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. * Changes peer source address.

View file

@ -1120,7 +1120,7 @@ int routing_control_plane_protocols_control_plane_protocol_pim_address_family_ms
pim = vrf->info; pim = vrf->info;
yang_dnode_get_ip(&peer_ip, args->dnode, "./peer-ip"); yang_dnode_get_ip(&peer_ip, args->dnode, "./peer-ip");
yang_dnode_get_ip(&source_ip, args->dnode, "./source-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); &source_ip.ipaddr_v4, NULL);
nb_running_set_entry(args->dnode, mp); nb_running_set_entry(args->dnode, mp);
break; break;
@ -1141,7 +1141,7 @@ int routing_control_plane_protocols_control_plane_protocol_pim_address_family_ms
break; break;
case NB_EV_APPLY: case NB_EV_APPLY:
mp = nb_running_unset_entry(args->dnode); mp = nb_running_unset_entry(args->dnode);
pim_msdp_peer_do_del(&mp); pim_msdp_peer_del(&mp);
break; break;
} }