Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix issue #115: NexthopGroup member change is not supported #120

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix issue #115: NexthopGroup member change is not supported #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 122 additions & 56 deletions platform/saivpp/vpplib/SaiObjectDB.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,26 @@
#include "SaiObjectDB.h"

using namespace saivpp;
typedef struct _SaiChildRelation
{
sai_object_type_t parent_type;
// the attribute id in child object pointing to Parent object
sai_attr_id_t child_link_attr;
sai_attr_value_type_t child_link_attr_type;
} SaiChildRelation;

/*
Define the child relation between SAI objects. Child is dependent on parent object. For example, ROUTE_ENTRY is a child of VR.
Key: child object type
Value: list of child relations. Each child relation defines the parent object type, the attribute id in child object pointing
to Parent object and the attribute type.
Child objects defined in this map will be added to the parent object when the child object is created. From parent object, we
can get the child object by calling get_child_objs() method with the child object type.
* Define the child relation between SAI objects. Child is dependent on parent object. For example, ROUTE_ENTRY is a child of VR.
* Key: child object type
* Value: list of child relations. Each child relation defines the parent object type, the attribute id in child object pointing
* to Parent object and the attribute type.
* Child objects defined in this map will be added to the parent object when the child object is created. From parent object, we
* can get the child object by calling get_child_objs() method with the child object type.
*
* Technically, this definition is not needed. Through SAI meta, we can get find which attribute is type of object_id or object_list.
* From the attribute value and RealObjectIdManager::objectTypeQuery, we can find the parent object type. So we can create a complete
* graph of all SAI objects.
*/
std::map<sai_object_type_t, std::vector<SaiChildRelation>> sai_child_relation_defs = {
{SAI_OBJECT_TYPE_TUNNEL_MAP_ENTRY, {{SAI_OBJECT_TYPE_TUNNEL_MAP, SAI_TUNNEL_MAP_ENTRY_ATTR_TUNNEL_MAP, SAI_ATTR_VALUE_TYPE_OBJECT_ID}}},
{SAI_OBJECT_TYPE_TUNNEL, {{SAI_OBJECT_TYPE_TUNNEL_MAP, SAI_TUNNEL_ATTR_DECAP_MAPPERS, SAI_ATTR_VALUE_TYPE_OBJECT_LIST},
{SAI_OBJECT_TYPE_TUNNEL_MAP, SAI_TUNNEL_ATTR_ENCAP_MAPPERS, SAI_ATTR_VALUE_TYPE_OBJECT_LIST}}},
{SAI_OBJECT_TYPE_TUNNEL_TERM_TABLE_ENTRY, {{SAI_OBJECT_TYPE_TUNNEL, SAI_TUNNEL_TERM_TABLE_ENTRY_ATTR_ACTION_TUNNEL_ID, SAI_ATTR_VALUE_TYPE_OBJECT_ID}}},
{SAI_OBJECT_TYPE_NEXT_HOP_GROUP_MEMBER, {{SAI_OBJECT_TYPE_NEXT_HOP_GROUP, SAI_NEXT_HOP_GROUP_MEMBER_ATTR_NEXT_HOP_GROUP_ID, SAI_ATTR_VALUE_TYPE_OBJECT_ID}}},
{SAI_OBJECT_TYPE_ROUTE_ENTRY, {{SAI_OBJECT_TYPE_NEXT_HOP_GROUP, SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID, SAI_ATTR_VALUE_TYPE_OBJECT_ID}}},
};

static std::vector<std::string>
Expand Down Expand Up @@ -107,21 +105,20 @@ get_parent_oids(SwitchStateBase* switch_db, sai_object_type_t child_type, const
}

sai_status_t
SaiObjectDB::add(
SaiObjectDB::create_or_update(
_In_ sai_object_type_t object_type,
_In_ const std::string& id,
_In_ sai_object_id_t switch_id,
_In_ uint32_t attr_count,
_In_ const sai_attribute_t *attr_list)
_In_ const sai_attribute_t *attr_list,
_In_ bool is_create)
{
sai_status_t status;
auto child_def_it = sai_child_relation_defs.find(object_type);
if (child_def_it == sai_child_relation_defs.end()) {
// Not an interesting type
return SAI_STATUS_SUCCESS;
}
sai_object_id_t oid;
sai_deserialize_object_id(id, oid);

//Get Parent object type and OID
const sai_attribute_value_t *attr_val;
uint32_t attr_index;
Expand All @@ -131,15 +128,30 @@ SaiObjectDB::add(
status = find_attrib_in_list(attr_count, attr_list, child_def.child_link_attr,
&attr_val, &attr_index);
if (status != SAI_STATUS_SUCCESS) {
// attribute not found
return SAI_STATUS_SUCCESS;
// attribute not found. move to next child relation.
continue;
}

if (!is_create) {
//update the parent-child relationship
remove_child_from_parent(object_type, id, child_def);
}

auto sai_parents = m_sai_parent_objs[child_def.parent_type];
std::shared_ptr<SaiDBObject> sai_parent;

std::vector<std::string> parent_ids = get_parent_oids(attr_val, child_def);

for (auto parent_id: parent_ids) {
sai_object_id_t parent_oid;
sai_deserialize_object_id(parent_id, parent_oid);
sai_object_type_t parent_type = RealObjectIdManager::objectTypeQuery(parent_oid);
if (parent_type != child_def.parent_type) {
/*
* a child may refer to different type of parents with the same parent OID attribute. For example,
* ROUTE_ENTRY uses SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID to refer to NEXT_HOP or NEXT_HOP_GROUP.
*/
continue;
}
auto parent_it = sai_parents.find(parent_id);
if (parent_it == sai_parents.end()) {
//The Parent object hasn't been created. create the Parent object
Expand All @@ -149,16 +161,73 @@ SaiObjectDB::add(
sai_parent = parent_it->second;
}
m_sai_parent_objs[child_def.parent_type] = sai_parents;
// multiple copies of child objects can exist as leaf of different parent objects. There can even
// be a copy as parent object if it is created as child first then another object is added as its child.
// Today SaiDBObject is just a wrapper to the underlaying object in switch_db
// until it becomes a parent object, where parent-child relationship is maintained. When the object is
// deleted, it will be removed from the child list of parent objects and from the SaiObjectDB if it is
// also a parent object. Since SaiDBObject is a simple wrapper if it is a child object, it is ok to have
// multiple copies. If we are going to extend it to keep other information, we need to make sure that
// a single copy exists in the SaiObjectDB.
auto sai_child = std::make_shared<SaiDBObject>(m_switch_db, object_type, id);
sai_parent->add_child(sai_child);
SWSS_LOG_DEBUG("Add child %s to parent %s of type %s", id.c_str(), parent_id.c_str(),
sai_serialize_object_type(child_def.parent_type).c_str());
SWSS_LOG_INFO("Add child %s:%s to parent %s:%s",
sai_serialize_object_type(object_type).c_str(), id.c_str(),
sai_serialize_object_type(child_def.parent_type).c_str(), parent_id.c_str());
}
}

return SAI_STATUS_SUCCESS;
}

/**
* @brief Removes a child object from its parent in the SaiObjectDB for the give child-parent relationship definition.
*
* This function removes a child object from its parent in the SaiObjectDB. It takes the object type, the ID of the child object,
* and the child-parent relationship definition as input parameters.
* The function retrieves the parent object IDs using the get_parent_oids() function and iterates over each parent ID.
* For each parent ID, it checks if the parent object exists in the SaiObjectDB. If the parent object is not found, a warning
* message is logged and the function returns SAI_STATUS_SUCCESS.
* If the parent object is found, the function removes the child object from the parent object using the remove_child()
* function and logs a debug message.
*
* @param object_type The type of the child object.
* @param id The ID of the child object.
* @param child_def The child-parent relationship definition.
*/
void
SaiObjectDB::remove_child_from_parent(
_In_ sai_object_type_t object_type,
_In_ const std::string& id,
_In_ const SaiChildRelation& child_def)
{
std::vector<std::string> parent_ids = get_parent_oids(m_switch_db, object_type, id, child_def);
auto sai_parents = m_sai_parent_objs[child_def.parent_type];
for (auto parent_id: parent_ids) {
sai_object_id_t parent_oid;
sai_deserialize_object_id(parent_id, parent_oid);
sai_object_type_t parent_type = RealObjectIdManager::objectTypeQuery(parent_oid);
if (parent_type != child_def.parent_type) {
/*
* a child may refer to different type of parents with the same parent OID attribute. For example,
* ROUTE_ENTRY uses SAI_ROUTE_ENTRY_ATTR_NEXT_HOP_ID to refer to NEXT_HOP or NEXT_HOP_GROUP.
*/
continue;
}
auto parent_it = sai_parents.find(parent_id);
if (parent_it == sai_parents.end()) {
SWSS_LOG_WARN("Parent object %s:%s is not found in SaiObjectDB",
sai_serialize_object_type(child_def.parent_type).c_str(), parent_id.c_str());
return;
} else {
//remove the child from sai_parent
parent_it->second->remove_child(object_type, id);
SWSS_LOG_INFO("Remove child %s:%s from parent %s:%s of type %s",
sai_serialize_object_type(object_type).c_str(), id.c_str(),
sai_serialize_object_type(child_def.parent_type).c_str(), parent_id.c_str());
}
}
}
sai_status_t
SaiObjectDB::remove(
_In_ sai_object_type_t object_type,
Expand Down Expand Up @@ -186,20 +255,7 @@ SaiObjectDB::remove(
//Get Parent object type and OID
auto& child_defs = child_def_it->second;
for (auto child_def: child_defs) {
std::vector<std::string> parent_ids = get_parent_oids(m_switch_db, object_type, id, child_def);
auto sai_parents = m_sai_parent_objs[child_def.parent_type];
for (auto parent_id: parent_ids) {
auto parent_it = sai_parents.find(parent_id);
if (parent_it == sai_parents.end()) {
SWSS_LOG_WARN("Parent object is not found in SaiObjectDB %s", parent_id.c_str());
return SAI_STATUS_SUCCESS;
} else {
//remove the child from sai_parent
parent_it->second->remove_child(object_type, id);
SWSS_LOG_DEBUG("Remove child %s from parent %s of type %s", id.c_str(), parent_id.c_str(),
sai_serialize_object_type(child_def.parent_type).c_str());
}
}
remove_child_from_parent(object_type, id, child_def);
}
return SAI_STATUS_SUCCESS;
}
Expand All @@ -217,9 +273,6 @@ SaiObjectDB::get(
auto sai_parent_it = sai_parent_type_it->second.find(id);
if (sai_parent_it != sai_parent_type_it->second.end()) {
return sai_parent_it->second;
} else {
SWSS_LOG_WARN("Parent is not found in SaiObjectDB %s", id.c_str());
return std::shared_ptr<SaiDBObject>();
}
}
// check if the object exists
Expand Down Expand Up @@ -293,26 +346,25 @@ SaiObject::get_attr_name(_In_ sai_attr_id_t attr_id) const
return meta->attridname;
}
}
sai_status_t
SaiCachedObject::get_attr(sai_attribute_t &attr) const

sai_status_t
SaiObject::get_mandatory_attr(sai_attribute_t &attr) const
{
for (uint32_t ii = 0; ii < m_attr_count; ii++) {
if (m_attr_list[ii].id == attr.id) {
return transfer_attributes(m_type, 1, &(m_attr_list[ii]), &attr, false);
}
auto status = get_attr(attr);
if (SAI_STATUS_SUCCESS != status) {
SWSS_LOG_ERROR("Failed to get attribute %s from object %s", get_attr_name(attr.id), m_id.c_str());
}
return SAI_STATUS_ITEM_NOT_FOUND;
return status;
}

sai_status_t
SaiCachedObject::get_mandatory_attr(sai_attribute_t &attr) const
SaiCachedObject::get_attr(sai_attribute_t &attr) const
{
for (uint32_t ii = 0; ii < m_attr_count; ii++) {
if (m_attr_list[ii].id == attr.id) {
return transfer_attributes(m_type, 1, &(m_attr_list[ii]), &attr, false);
}
}
SWSS_LOG_ERROR("Failed to get attribute %d from object %s", get_attr_name(attr.id), m_id.c_str());
return SAI_STATUS_ITEM_NOT_FOUND;
}

Expand All @@ -323,13 +375,27 @@ SaiDBObject::get_attr(sai_attribute_t &attr) const
return m_switch_db->get(m_type, m_id, 1, &attr);
}

SaiModDBObject::SaiModDBObject(SwitchStateBase* switch_db, sai_object_type_t type, const std::string& id,
uint32_t attr_count, const sai_attribute_t *attr_list) :
SaiObject(switch_db, type, id), m_attr_count(attr_count), m_attr_list(attr_list)
{
m_sai_db_obj = switch_db->get_sai_object(type, id);
if (!m_sai_db_obj) {
SWSS_LOG_ERROR("SaiModDBObject: the object is not found in switch_db %s", id.c_str());
}
}

sai_status_t
SaiDBObject::get_mandatory_attr(sai_attribute_t &attr) const
SaiModDBObject::get_attr(sai_attribute_t &attr) const
{
/* we could make a copy of all the attributes and cache in this object*/
auto status = m_switch_db->get(m_type, m_id, 1, &attr);
if (SAI_STATUS_SUCCESS != status) {
SWSS_LOG_ERROR("Failed to get attribute %d from object %s", get_attr_name(attr.id), m_id.c_str());
for (uint32_t ii = 0; ii < m_attr_count; ii++) {
if (m_attr_list[ii].id == attr.id) {
return transfer_attributes(m_type, 1, &(m_attr_list[ii]), &attr, false);
}
}
return status;
}
if (m_sai_db_obj) {
return m_sai_db_obj->get_attr(attr);
} else {
return SAI_STATUS_ITEM_NOT_FOUND;
}
}
Loading