<p>Joe has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/16160">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_pjsip_registrar: Remove unavailable contacts if exceeds max_contacts<br><br>The behavior of max_contacts and remove_existing are connected. If<br>remove_existing is enabled, the soonest expiring contacts are removed.<br>This may occur when there is an unavailable contact. Similarly,<br>when remove_existing is not enabled, registrations from good<br>endpoints are rejected in favor of retaining unavailable contacts.<br><br>This commit changes this behavior, to remove unavailable contacts<br>when they exceed max_contacts, if there are any, regardless of the<br>setting of remove_existing.<br><br>ASTERISK-29525<br><br>Change-Id: Ia2711b08f2b4d1177411b1be23e970d7fdff5784<br>---<br>A doc/CHANGES-staging/res_pjsip_registrar.txt<br>M include/asterisk/res_pjsip.h<br>M res/res_pjsip/location.c<br>M res/res_pjsip_registrar.c<br>4 files changed, 85 insertions(+), 13 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/60/16160/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/CHANGES-staging/res_pjsip_registrar.txt b/doc/CHANGES-staging/res_pjsip_registrar.txt</span><br><span>new file mode 100644</span><br><span>index 0000000..b1aa86e</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/res_pjsip_registrar.txt</span><br><span>@@ -0,0 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: res_pjsip_registrar</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Proritize removal of unavailable contacts when remove_existing</span><br><span style="color: hsl(120, 100%, 40%);">+is set. Remove unavailable contacts when exceeding max_contacts</span><br><span style="color: hsl(120, 100%, 40%);">+even when remove_existing is not set.</span><br><span>diff --git a/include/asterisk/res_pjsip.h b/include/asterisk/res_pjsip.h</span><br><span>index 3d5b504..dd63719 100644</span><br><span>--- a/include/asterisk/res_pjsip.h</span><br><span>+++ b/include/asterisk/res_pjsip.h</span><br><span>@@ -945,6 +945,9 @@</span><br><span> </span><br><span> /*! \brief Return only reachable or unknown contacts */</span><br><span> AST_SIP_CONTACT_FILTER_REACHABLE = (1 << 0),</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! \brief Return only unreachable contacts */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_SIP_CONTACT_FILTER_UNREACHABLE = (1 << 4),</span><br><span> };</span><br><span> </span><br><span> /*!</span><br><span>diff --git a/res/res_pjsip/location.c b/res/res_pjsip/location.c</span><br><span>index cef5ad7..2953e7b 100644</span><br><span>--- a/res/res_pjsip/location.c</span><br><span>+++ b/res/res_pjsip/location.c</span><br><span>@@ -191,6 +191,24 @@</span><br><span> return unreachable ? CMP_MATCH : 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Internal callback function which contains only contact which is unreachable */</span><br><span style="color: hsl(120, 100%, 40%);">+static int contact_only_unreachable(void *obj, void *arg, int flags)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_sip_contact *contact = obj;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_sip_contact_status *status;</span><br><span style="color: hsl(120, 100%, 40%);">+ int unreachable;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ status = ast_sip_get_contact_status(contact);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!status) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ unreachable = (status->status == UNAVAILABLE);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(status, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return unreachable ? 0 : CMP_MATCH;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor)</span><br><span> {</span><br><span> return ast_sip_location_retrieve_first_aor_contact_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);</span><br><span>@@ -237,6 +255,10 @@</span><br><span> ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (flags & AST_SIP_CONTACT_FILTER_UNREACHABLE) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_only_unreachable, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> if (flags & AST_SIP_CONTACT_FILTER_REACHABLE) {</span><br><span> ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_remove_unreachable, NULL);</span><br><span> }</span><br><span>diff --git a/res/res_pjsip_registrar.c b/res/res_pjsip_registrar.c</span><br><span>index 6fe4058..ce7611d 100644</span><br><span>--- a/res/res_pjsip_registrar.c</span><br><span>+++ b/res/res_pjsip_registrar.c</span><br><span>@@ -481,8 +481,31 @@</span><br><span> {</span><br><span> struct ast_sip_contact *left_contact = left;</span><br><span> struct ast_sip_contact *right_contact = right;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_sip_contact_status *left_status;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_sip_contact_status *right_status;</span><br><span style="color: hsl(120, 100%, 40%);">+ int left_unreachable;</span><br><span style="color: hsl(120, 100%, 40%);">+ int right_unreachable;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /* Sort from soonest to expire to last to expire */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* If contact is unreachable move to top of list */</span><br><span style="color: hsl(120, 100%, 40%);">+ left_status = ast_sip_get_contact_status(left_contact);</span><br><span style="color: hsl(120, 100%, 40%);">+ right_status = ast_sip_get_contact_status(right_contact);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (left_status && right_status) {</span><br><span style="color: hsl(120, 100%, 40%);">+ left_unreachable = (left_status->status == UNAVAILABLE);</span><br><span style="color: hsl(120, 100%, 40%);">+ right_unreachable = (right_status->status == UNAVAILABLE);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(left_status);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(right_status);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (left_unreachable == right_unreachable) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Either both available or both unavailable */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Sort from soonest to expire to last to expire */</span><br><span style="color: hsl(120, 100%, 40%);">+ return ast_tvcmp(left_contact->expiration_time, right_contact->expiration_time);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (left_unreachable) return -1;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (right_unreachable) return 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* No status from one or both contacts, return by expiration */</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(left_status);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(right_status);</span><br><span> return ast_tvcmp(left_contact->expiration_time, right_contact->expiration_time);</span><br><span> }</span><br><span> </span><br><span>@@ -496,6 +519,7 @@</span><br><span> * shouldn't need to remove more than a handful of contacts.</span><br><span> * I expect we'll typically be removing only one contact.</span><br><span> */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> AST_VECTOR_ADD_SORTED(contact_vec, contact, vec_contact_cmp);</span><br><span> if (AST_VECTOR_SIZE(contact_vec) == AST_VECTOR_MAX_SIZE(contact_vec)) {</span><br><span> /*</span><br><span>@@ -512,7 +536,7 @@</span><br><span> </span><br><span> /*!</span><br><span> * \internal</span><br><span style="color: hsl(0, 100%, 40%);">- * \brief Remove excess existing contacts that expire the soonest.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Remove excess existing contacts that are unavailable or expire soonest.</span><br><span> * \since 13.18.0</span><br><span> *</span><br><span> * \param contacts Container of unmodified contacts that could remove.</span><br><span>@@ -534,6 +558,7 @@</span><br><span> if (AST_VECTOR_INIT(&contact_vec, to_remove + 1)) {</span><br><span> return;</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE, vec_contact_add, &contact_vec);</span><br><span> </span><br><span> /*</span><br><span>@@ -545,7 +570,7 @@</span><br><span> ast_assert(AST_VECTOR_SIZE(&contact_vec) == to_remove);</span><br><span> to_remove = AST_VECTOR_SIZE(&contact_vec);</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /* Remove the excess contacts that expire the soonest */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Remove the excess contacts that are unavailable or expire the soonest */</span><br><span> while (to_remove--) {</span><br><span> struct ast_sip_contact *contact;</span><br><span> </span><br><span>@@ -596,6 +621,7 @@</span><br><span> int permanent = 0;</span><br><span> int contact_count;</span><br><span> struct ao2_container *existing_contacts = NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ao2_container *unavail_contacts = NULL;</span><br><span> pjsip_contact_hdr *contact_hdr = (pjsip_contact_hdr *)&rdata->msg_info.msg->hdr;</span><br><span> struct registrar_contact_details details = { 0, };</span><br><span> pjsip_tx_data *tdata;</span><br><span>@@ -666,16 +692,32 @@</span><br><span> /* Total contacts after this registration */</span><br><span> contact_count = ao2_container_count(contacts) - permanent + added - deleted;</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> if (contact_count > aor->max_contacts) {</span><br><span style="color: hsl(0, 100%, 40%);">- /* Enforce the maximum number of contacts */</span><br><span style="color: hsl(0, 100%, 40%);">- ast_sip_report_failed_acl(endpoint, rdata, "registrar_attempt_exceeds_maximum_configured_contacts");</span><br><span style="color: hsl(0, 100%, 40%);">- ast_log(LOG_WARNING, "Registration attempt from endpoint '%s' (%s:%d) to AOR '%s' will exceed max contacts of %u\n",</span><br><span style="color: hsl(0, 100%, 40%);">- ast_sorcery_object_get_id(endpoint), rdata->pkt_info.src_name, rdata->pkt_info.src_port,</span><br><span style="color: hsl(0, 100%, 40%);">- aor_name, aor->max_contacts);</span><br><span style="color: hsl(0, 100%, 40%);">- response->code = 403;</span><br><span style="color: hsl(0, 100%, 40%);">- pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), details.pool);</span><br><span style="color: hsl(0, 100%, 40%);">- ao2_cleanup(existing_contacts);</span><br><span style="color: hsl(0, 100%, 40%);">- return;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Get unreachable contact total */</span><br><span style="color: hsl(120, 100%, 40%);">+ int unavail_count = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ unavail_contacts = ast_sip_location_retrieve_aor_contacts_filtered(aor, AST_SIP_CONTACT_FILTER_UNREACHABLE);</span><br><span style="color: hsl(120, 100%, 40%);">+ unavail_count = ao2_container_count(unavail_contacts);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Check to see if removing those will not help */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (contact_count - unavail_count > aor->max_contacts) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Enforce the maximum number of contacts */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_sip_report_failed_acl(endpoint, rdata, "registrar_attempt_exceeds_maximum_configured_contacts");</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_WARNING, "Registration attempt from endpoint '%s' (%s:%d) to AOR '%s' will exceed max contacts of %u\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_sorcery_object_get_id(endpoint), rdata->pkt_info.src_name, rdata->pkt_info.src_port,</span><br><span style="color: hsl(120, 100%, 40%);">+ aor_name, aor->max_contacts);</span><br><span style="color: hsl(120, 100%, 40%);">+ response->code = 403;</span><br><span style="color: hsl(120, 100%, 40%);">+ pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), details.pool);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(existing_contacts);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Remove any unreachable contacts */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(LOG_WARNING, "Unreachable contacts being removed from endpoint '%s' so max_contacts will not be exceeded\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_sorcery_object_get_id(endpoint));</span><br><span style="color: hsl(120, 100%, 40%);">+ remove_excess_contacts(unavail_contacts, contacts, aor->max_contacts - contact_count);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_cleanup(unavail_contacts);</span><br><span> }</span><br><span> </span><br><span> user_agent_hdr = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &USER_AGENT, NULL);</span><br><span>@@ -867,7 +909,7 @@</span><br><span> /* Total contacts after this registration */</span><br><span> contact_count = ao2_container_count(existing_contacts) + updated + added;</span><br><span> if (contact_count > aor->max_contacts) {</span><br><span style="color: hsl(0, 100%, 40%);">- /* Remove excess existing contacts that expire the soonest */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Remove excess existing contacts that are unavailable or expire soonest */</span><br><span> remove_excess_contacts(existing_contacts, contacts, contact_count - aor->max_contacts);</span><br><span> }</span><br><span> ao2_ref(existing_contacts, -1);</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/16160">change 16160</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/16160"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 16 </div>
<div style="display:none"> Gerrit-Change-Id: Ia2711b08f2b4d1177411b1be23e970d7fdff5784 </div>
<div style="display:none"> Gerrit-Change-Number: 16160 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Joe <ynadiv@corpit.xyz> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>