colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnm: fix assertions in NMSettingVlan's priority API

Browse Source 
Most of these functions did not ever return failure. The functions
were assertin that the input was valid (and then returned a special
value). But they did not fail under regular conditions.

Fix the gtk-doc for some of these to not claim to be able to fail.

For some (like nm_setting_vlan_add_priority_str() and
nm_setting_vlan_get_priority()), actually let them fail for valid
input (instead of asserting).
This commit is contained in:
Thomas Haller
2019-08-02 08:46:38 +02:00
parent af4a41cc4c
commit b5793b74ca
1 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
libnm-core/nm-setting-vlan.c
View File

@@ -221,7 +221,7 @@ check_replace_duplicate_priority (GSList *list, guint32 from, guint32 to)
* the Linux SKB priorities to 802.1p priorities.
*
* Returns: %TRUE if the entry was successfully added to the list, or it
* overwrote the old value, %FALSE if error
* overwrote the old value, %FALSE if @str is not a valid mapping.
*/
gboolean
nm_setting_vlan_add_priority_str (NMSettingVlan *setting,
@@ -235,11 +235,11 @@ nm_setting_vlan_add_priority_str (NMSettingVlan *setting,
g_return_val_if_fail (map == NM_VLAN_INGRESS_MAP || map == NM_VLAN_EGRESS_MAP, FALSE);
g_return_val_if_fail (str && str[0], FALSE);
list = get_map (setting, map);
item = priority_map_new_from_str (map, str);
if (!item)
g_return_val_if_reached (FALSE);
return FALSE;
list = get_map (setting, map);
/* Duplicates get replaced */
if (check_replace_duplicate_priority (list, item->from, item->to)) {
@@ -264,7 +264,7 @@ nm_setting_vlan_add_priority_str (NMSettingVlan *setting,
* #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map
* properties of this setting.
*
* Returns: return the number of ingress/egress priority entries, -1 if error
* Returns: return the number of ingress/egress priority entries.
**/
gint32
nm_setting_vlan_get_num_priorities (NMSettingVlan *setting, NMVlanPriorityMap map)
@@ -280,13 +280,13 @@ nm_setting_vlan_get_num_priorities (NMSettingVlan *setting, NMVlanPriorityMap ma
* @setting: the #NMSettingVlan
* @map: the type of priority map
* @idx: the zero-based index of the ingress/egress priority map entry
* @out_from: (out): on return the value of the priority map's 'from' item
* @out_to: (out): on return the value of priority map's 'to' item
* @out_from: (out) (allow-none): on return the value of the priority map's 'from' item
* @out_to: (out) (allow-none): on return the value of priority map's 'to' item
*
* Retrieve one of the entries of the #NMSettingVlan:ingress_priority_map
* or #NMSettingVlan:egress_priority_map properties of this setting.
*
* Returns: %TRUE if a priority map was returned, %FALSE if error
* Returns: returns %TRUE if @idx is in range. Otherwise %FALSE.
**/
gboolean
nm_setting_vlan_get_priority (NMSettingVlan *setting,
@@ -295,21 +295,23 @@ nm_setting_vlan_get_priority (NMSettingVlan *setting,
guint32 *out_from,
guint32 *out_to)
{
GSList *list = NULL;
NMVlanQosMapping *item = NULL;
NMVlanQosMapping *item;
GSList *list;
g_return_val_if_fail (NM_IS_SETTING_VLAN (setting), FALSE);
g_return_val_if_fail (map == NM_VLAN_INGRESS_MAP || map == NM_VLAN_EGRESS_MAP, FALSE);
g_return_val_if_fail (out_from != NULL, FALSE);
g_return_val_if_fail (out_to != NULL, FALSE);
g_return_val_if_fail (NM_IN_SET (map, NM_VLAN_INGRESS_MAP, NM_VLAN_EGRESS_MAP), FALSE);
list = get_map (setting, map);
g_return_val_if_fail (idx < g_slist_length (list), FALSE);
item = g_slist_nth_data (list, idx);
g_assert (item);
*out_from = item->from;
*out_to = item->to;
if (!item) {
NM_SET_OUT (out_from, 0);
NM_SET_OUT (out_to, 0);
return FALSE;
}
NM_SET_OUT (out_from, item->from);
NM_SET_OUT (out_to, item->to);
return TRUE;
}
@@ -331,8 +333,7 @@ nm_setting_vlan_get_priority (NMSettingVlan *setting,
* If @map is #NM_VLAN_EGRESS_MAP then @from is the Linux SKB priority value and
* @to is the outgoing 802.1q VLAN Priority Code Point (PCP) value.
*
* Returns: %TRUE if the new priority mapping was successfully added to the
* list, %FALSE if error
* Returns: %TRUE.
*/
gboolean
nm_setting_vlan_add_priority (NMSettingVlan *setting,