| /* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later */ |
| #include "compiler.h" |
| #include "msgbuf.h" |
| #include <libpldm/pdr.h> |
| #include <libpldm/platform.h> |
| |
| #include <assert.h> |
| #include <endian.h> |
| #include <stdint.h> |
| #include <stdlib.h> |
| #include <string.h> |
| #include <errno.h> |
| |
| #define PDR_ENTITY_ASSOCIATION_MIN_SIZE \ |
| (sizeof(struct pldm_pdr_hdr) + \ |
| sizeof(struct pldm_pdr_entity_association)) |
| |
| #define PDR_FRU_RECORD_SET_MIN_SIZE \ |
| (sizeof(struct pldm_pdr_hdr) + sizeof(struct pldm_pdr_fru_record_set)) |
| |
| typedef struct pldm_pdr_record { |
| uint32_t record_handle; |
| uint32_t size; |
| uint8_t *data; |
| struct pldm_pdr_record *next; |
| bool is_remote; |
| uint16_t terminus_handle; |
| } pldm_pdr_record; |
| |
| typedef struct pldm_pdr { |
| uint32_t record_count; |
| uint32_t size; |
| pldm_pdr_record *first; |
| pldm_pdr_record *last; |
| } pldm_pdr; |
| |
| LIBPLDM_CC_NONNULL |
| static inline uint32_t get_next_record_handle(const pldm_pdr *repo, |
| const pldm_pdr_record *record) |
| { |
| if (record == repo->last) { |
| return 0; |
| } |
| return record->next->record_handle; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| int pldm_pdr_add(pldm_pdr *repo, const uint8_t *data, uint32_t size, |
| bool is_remote, uint16_t terminus_handle, |
| uint32_t *record_handle) |
| { |
| uint32_t curr = 0; |
| |
| if (!repo || !data || !size) { |
| return -EINVAL; |
| } |
| |
| if (record_handle && *record_handle) { |
| curr = *record_handle; |
| } else if (repo->last) { |
| curr = repo->last->record_handle; |
| if (curr == UINT32_MAX) { |
| return -EOVERFLOW; |
| } |
| curr += 1; |
| } else { |
| curr = 1; |
| } |
| |
| pldm_pdr_record *record = malloc(sizeof(pldm_pdr_record)); |
| if (!record) { |
| return -ENOMEM; |
| } |
| |
| if (data) { |
| record->data = malloc(size); |
| if (!record->data) { |
| free(record); |
| return -ENOMEM; |
| } |
| memcpy(record->data, data, size); |
| } |
| |
| record->size = size; |
| record->is_remote = is_remote; |
| record->terminus_handle = terminus_handle; |
| record->record_handle = curr; |
| |
| if (record_handle && !*record_handle && data) { |
| /* If record handle is 0, that is an indication for this API to |
| * compute a new handle. For that reason, the computed handle |
| * needs to be populated in the PDR header. For a case where the |
| * caller supplied the record handle, it would exist in the |
| * header already. |
| */ |
| struct pldm_pdr_hdr *hdr = (void *)record->data; |
| hdr->record_handle = htole32(record->record_handle); |
| } |
| |
| record->next = NULL; |
| |
| assert(!repo->first == !repo->last); |
| if (repo->first == NULL) { |
| repo->first = record; |
| repo->last = record; |
| } else { |
| repo->last->next = record; |
| repo->last = record; |
| } |
| |
| repo->size += record->size; |
| ++repo->record_count; |
| |
| if (record_handle) { |
| *record_handle = record->record_handle; |
| } |
| |
| return 0; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_pdr *pldm_pdr_init(void) |
| { |
| pldm_pdr *repo = malloc(sizeof(pldm_pdr)); |
| if (!repo) { |
| return NULL; |
| } |
| repo->record_count = 0; |
| repo->size = 0; |
| repo->first = NULL; |
| repo->last = NULL; |
| |
| return repo; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_pdr_destroy(pldm_pdr *repo) |
| { |
| if (!repo) { |
| return; |
| } |
| |
| pldm_pdr_record *record = repo->first; |
| while (record != NULL) { |
| pldm_pdr_record *next = record->next; |
| if (record->data) { |
| free(record->data); |
| record->data = NULL; |
| } |
| free(record); |
| record = next; |
| } |
| free(repo); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| const pldm_pdr_record *pldm_pdr_find_record(const pldm_pdr *repo, |
| uint32_t record_handle, |
| uint8_t **data, uint32_t *size, |
| uint32_t *next_record_handle) |
| { |
| if (!repo || !data || !size || !next_record_handle) { |
| return NULL; |
| } |
| |
| if (!record_handle && (repo->first != NULL)) { |
| record_handle = repo->first->record_handle; |
| } |
| |
| pldm_pdr_record *record = repo->first; |
| while (record != NULL) { |
| if (record->record_handle == record_handle) { |
| *size = record->size; |
| *data = record->data; |
| *next_record_handle = |
| get_next_record_handle(repo, record); |
| return record; |
| } |
| record = record->next; |
| } |
| |
| *size = 0; |
| *next_record_handle = 0; |
| return NULL; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| const pldm_pdr_record * |
| pldm_pdr_get_next_record(const pldm_pdr *repo, |
| const pldm_pdr_record *curr_record, uint8_t **data, |
| uint32_t *size, uint32_t *next_record_handle) |
| { |
| if (!repo || !curr_record || !data || !size || !next_record_handle) { |
| return NULL; |
| } |
| |
| if (curr_record == repo->last) { |
| *data = NULL; |
| *size = 0; |
| *next_record_handle = get_next_record_handle(repo, curr_record); |
| return NULL; |
| } |
| |
| *next_record_handle = get_next_record_handle(repo, curr_record->next); |
| *data = curr_record->next->data; |
| *size = curr_record->next->size; |
| return curr_record->next; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| const pldm_pdr_record * |
| pldm_pdr_find_record_by_type(const pldm_pdr *repo, uint8_t pdr_type, |
| const pldm_pdr_record *curr_record, uint8_t **data, |
| uint32_t *size) |
| { |
| if (!repo) { |
| return NULL; |
| } |
| |
| pldm_pdr_record *record = repo->first; |
| if (curr_record != NULL) { |
| record = curr_record->next; |
| } |
| while (record != NULL) { |
| struct pldm_pdr_hdr *hdr = (struct pldm_pdr_hdr *)record->data; |
| if (hdr->type == pdr_type) { |
| if (data && size) { |
| *size = record->size; |
| *data = record->data; |
| } |
| return record; |
| } |
| record = record->next; |
| } |
| |
| if (size) { |
| *size = 0; |
| } |
| return NULL; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| uint32_t pldm_pdr_get_record_count(const pldm_pdr *repo) |
| { |
| assert(repo != NULL); |
| |
| return repo->record_count; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| uint32_t pldm_pdr_get_repo_size(const pldm_pdr *repo) |
| { |
| assert(repo != NULL); |
| |
| return repo->size; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| uint32_t pldm_pdr_get_record_handle(const pldm_pdr *repo LIBPLDM_CC_UNUSED, |
| const pldm_pdr_record *record) |
| { |
| assert(repo != NULL); |
| assert(record != NULL); |
| |
| return record->record_handle; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| uint16_t pldm_pdr_get_terminus_handle(const pldm_pdr *repo LIBPLDM_CC_UNUSED, |
| const pldm_pdr_record *record) |
| { |
| assert(repo != NULL); |
| assert(record != NULL); |
| |
| return record->terminus_handle; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| bool pldm_pdr_record_is_remote(const pldm_pdr_record *record) |
| { |
| assert(record != NULL); |
| |
| return record->is_remote; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| int pldm_pdr_add_fru_record_set(pldm_pdr *repo, uint16_t terminus_handle, |
| uint16_t fru_rsi, uint16_t entity_type, |
| uint16_t entity_instance_num, |
| uint16_t container_id, |
| uint32_t *bmc_record_handle) |
| { |
| if (!repo || !bmc_record_handle) { |
| return -EINVAL; |
| } |
| |
| uint8_t data[sizeof(struct pldm_pdr_hdr) + |
| sizeof(struct pldm_pdr_fru_record_set)]; |
| |
| struct pldm_pdr_hdr *hdr = (struct pldm_pdr_hdr *)&data; |
| hdr->version = 1; |
| hdr->record_handle = *bmc_record_handle; |
| hdr->type = PLDM_PDR_FRU_RECORD_SET; |
| hdr->record_change_num = 0; |
| hdr->length = htole16(sizeof(struct pldm_pdr_fru_record_set)); |
| struct pldm_pdr_fru_record_set *fru = |
| (struct pldm_pdr_fru_record_set *)((uint8_t *)hdr + |
| sizeof(struct pldm_pdr_hdr)); |
| fru->terminus_handle = htole16(terminus_handle); |
| fru->fru_rsi = htole16(fru_rsi); |
| fru->entity_type = htole16(entity_type); |
| fru->entity_instance_num = htole16(entity_instance_num); |
| fru->container_id = htole16(container_id); |
| |
| return pldm_pdr_add(repo, data, sizeof(data), false, terminus_handle, |
| bmc_record_handle); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| const pldm_pdr_record *pldm_pdr_fru_record_set_find_by_rsi( |
| const pldm_pdr *repo, uint16_t fru_rsi, uint16_t *terminus_handle, |
| uint16_t *entity_type, uint16_t *entity_instance_num, |
| uint16_t *container_id) |
| { |
| if (!repo || !terminus_handle || !entity_type || !entity_instance_num || |
| !container_id) { |
| return NULL; |
| } |
| |
| uint8_t *data = NULL; |
| uint32_t size = 0; |
| const pldm_pdr_record *curr_record = pldm_pdr_find_record_by_type( |
| repo, PLDM_PDR_FRU_RECORD_SET, NULL, &data, &size); |
| while (curr_record != NULL) { |
| struct pldm_pdr_fru_record_set *fru = |
| (struct pldm_pdr_fru_record_set |
| *)(data + sizeof(struct pldm_pdr_hdr)); |
| if (fru->fru_rsi == htole16(fru_rsi)) { |
| *terminus_handle = le16toh(fru->terminus_handle); |
| *entity_type = le16toh(fru->entity_type); |
| *entity_instance_num = |
| le16toh(fru->entity_instance_num); |
| *container_id = le16toh(fru->container_id); |
| return curr_record; |
| } |
| data = NULL; |
| curr_record = pldm_pdr_find_record_by_type( |
| repo, PLDM_PDR_FRU_RECORD_SET, curr_record, &data, |
| &size); |
| } |
| |
| *terminus_handle = 0; |
| *entity_type = 0; |
| *entity_instance_num = 0; |
| *container_id = 0; |
| |
| return NULL; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| /* NOLINTNEXTLINE(readability-identifier-naming) */ |
| void pldm_pdr_update_TL_pdr(const pldm_pdr *repo, uint16_t terminus_handle, |
| uint8_t tid, uint8_t tl_eid, bool valid_bit) |
| { |
| uint8_t *out_data = NULL; |
| uint32_t size = 0; |
| const pldm_pdr_record *record; |
| record = pldm_pdr_find_record_by_type(repo, PLDM_TERMINUS_LOCATOR_PDR, |
| NULL, &out_data, &size); |
| |
| do { |
| if (record != NULL) { |
| struct pldm_terminus_locator_pdr *pdr = |
| (struct pldm_terminus_locator_pdr *)out_data; |
| struct pldm_terminus_locator_type_mctp_eid *value = |
| (struct pldm_terminus_locator_type_mctp_eid *) |
| pdr->terminus_locator_value; |
| if (pdr->terminus_handle == terminus_handle && |
| pdr->tid == tid && value->eid == tl_eid) { |
| pdr->validity = valid_bit; |
| break; |
| } |
| } |
| record = pldm_pdr_find_record_by_type(repo, |
| PLDM_TERMINUS_LOCATOR_PDR, |
| record, &out_data, &size); |
| } while (record); |
| } |
| |
| static bool pldm_record_handle_in_range(uint32_t record_handle, |
| uint32_t first_record_handle, |
| uint32_t last_record_handle) |
| { |
| return record_handle >= first_record_handle && |
| record_handle <= last_record_handle; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_pdr_find_child_container_id_index_range_exclude( |
| const pldm_pdr *repo, uint16_t entity_type, uint16_t entity_instance, |
| uint8_t child_index, uint32_t range_exclude_start_handle, |
| uint32_t range_exclude_end_handle, uint16_t *container_id) |
| { |
| pldm_pdr_record *record; |
| if (!repo) { |
| return -EINVAL; |
| } |
| |
| for (record = repo->first; record; record = record->next) { |
| bool is_container_entity_instance_number; |
| struct pldm_pdr_entity_association *pdr; |
| bool is_container_entity_type; |
| struct pldm_entity *child; |
| struct pldm_pdr_hdr *hdr; |
| bool in_range; |
| |
| // pldm_pdr_add() takes only uint8_t* data as an argument. |
| // The expectation here is the pldm_pdr_hdr is the first field of the record data |
| hdr = (struct pldm_pdr_hdr *)record->data; |
| if (hdr->type != PLDM_PDR_ENTITY_ASSOCIATION) { |
| continue; |
| } |
| in_range = pldm_record_handle_in_range( |
| record->record_handle, range_exclude_start_handle, |
| range_exclude_end_handle); |
| if (in_range) { |
| continue; |
| } |
| |
| // this cast is valid with respect to alignment because |
| // struct pldm_pdr_hdr is declared with __attribute__((packed)) |
| pdr = (void *)(record->data + sizeof(struct pldm_pdr_hdr)); |
| if (child_index >= pdr->num_children) { |
| continue; |
| } |
| |
| child = (&pdr->children[child_index]); |
| is_container_entity_type = pdr->container.entity_type == |
| entity_type; |
| is_container_entity_instance_number = |
| pdr->container.entity_instance_num == entity_instance; |
| if (is_container_entity_type && |
| is_container_entity_instance_number) { |
| *container_id = le16toh(child->entity_container_id); |
| return 0; |
| } |
| } |
| return -ENOKEY; |
| } |
| |
| typedef struct pldm_entity_association_tree { |
| pldm_entity_node *root; |
| uint16_t last_used_container_id; |
| } pldm_entity_association_tree; |
| |
| typedef struct pldm_entity_node { |
| pldm_entity entity; |
| pldm_entity parent; |
| uint16_t remote_container_id; |
| pldm_entity_node *first_child; |
| pldm_entity_node *next_sibling; |
| uint8_t association_type; |
| } pldm_entity_node; |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity pldm_entity_extract(pldm_entity_node *node) |
| { |
| assert(node != NULL); |
| |
| return node->entity; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| uint16_t |
| pldm_entity_node_get_remote_container_id(const pldm_entity_node *entity) |
| { |
| assert(entity != NULL); |
| |
| return entity->remote_container_id; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity_association_tree *pldm_entity_association_tree_init(void) |
| { |
| pldm_entity_association_tree *tree = |
| malloc(sizeof(pldm_entity_association_tree)); |
| if (!tree) { |
| return NULL; |
| } |
| tree->root = NULL; |
| tree->last_used_container_id = 0; |
| |
| return tree; |
| } |
| |
| LIBPLDM_CC_NONNULL |
| static pldm_entity_node *find_insertion_at(pldm_entity_node *start, |
| uint16_t entity_type) |
| { |
| /* Insert after the the last node that matches the input entity type, or |
| * at the end if no such match occurs |
| */ |
| while (start->next_sibling != NULL) { |
| uint16_t this_type = start->entity.entity_type; |
| pldm_entity_node *next = start->next_sibling; |
| if (this_type == entity_type && |
| (this_type != next->entity.entity_type)) { |
| break; |
| } |
| start = start->next_sibling; |
| } |
| |
| return start; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity_node *pldm_entity_association_tree_add( |
| pldm_entity_association_tree *tree, pldm_entity *entity, |
| uint16_t entity_instance_number, pldm_entity_node *parent, |
| uint8_t association_type) |
| { |
| return pldm_entity_association_tree_add_entity(tree, entity, |
| entity_instance_number, |
| parent, association_type, |
| false, true, 0xffff); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity_node *pldm_entity_association_tree_add_entity( |
| pldm_entity_association_tree *tree, pldm_entity *entity, |
| uint16_t entity_instance_number, pldm_entity_node *parent, |
| uint8_t association_type, bool is_remote, bool is_update_container_id, |
| uint16_t container_id) |
| { |
| if ((!tree) || (!entity)) { |
| return NULL; |
| } |
| |
| if (entity_instance_number != 0xffff && parent != NULL) { |
| pldm_entity node; |
| node.entity_type = entity->entity_type; |
| node.entity_instance_num = entity_instance_number; |
| if (pldm_is_current_parent_child(parent, &node)) { |
| return NULL; |
| } |
| } |
| if (association_type != PLDM_ENTITY_ASSOCIAION_PHYSICAL && |
| association_type != PLDM_ENTITY_ASSOCIAION_LOGICAL) { |
| return NULL; |
| } |
| pldm_entity_node *node = malloc(sizeof(pldm_entity_node)); |
| if (!node) { |
| return NULL; |
| } |
| node->first_child = NULL; |
| node->next_sibling = NULL; |
| node->parent.entity_type = 0; |
| node->parent.entity_instance_num = 0; |
| node->parent.entity_container_id = 0; |
| node->entity.entity_type = entity->entity_type; |
| node->entity.entity_instance_num = |
| entity_instance_number != 0xffff ? entity_instance_number : 1; |
| node->association_type = association_type; |
| node->remote_container_id = 0; |
| if (tree->root == NULL) { |
| if (parent != NULL) { |
| free(node); |
| return NULL; |
| } |
| tree->root = node; |
| /* container_id 0 here indicates this is the top-most entry */ |
| node->entity.entity_container_id = 0; |
| node->remote_container_id = node->entity.entity_container_id; |
| } else if (parent != NULL && parent->first_child == NULL) { |
| /* Ensure next_container_id() will yield a valid ID */ |
| if (tree->last_used_container_id == UINT16_MAX) { |
| free(node); |
| return NULL; |
| } |
| |
| parent->first_child = node; |
| node->parent = parent->entity; |
| |
| if (is_remote) { |
| node->remote_container_id = entity->entity_container_id; |
| } |
| if (is_update_container_id) { |
| if (container_id != 0xffff) { |
| node->entity.entity_container_id = container_id; |
| } else { |
| /* We will have returned above */ |
| assert(tree->last_used_container_id != |
| UINT16_MAX); |
| node->entity.entity_container_id = |
| ++tree->last_used_container_id; |
| } |
| } else { |
| node->entity.entity_container_id = |
| entity->entity_container_id; |
| } |
| |
| if (!is_remote) { |
| node->remote_container_id = |
| node->entity.entity_container_id; |
| } |
| } else { |
| pldm_entity_node *start = parent == NULL ? tree->root : |
| parent->first_child; |
| pldm_entity_node *prev = |
| find_insertion_at(start, entity->entity_type); |
| if (!prev) { |
| free(node); |
| return NULL; |
| } |
| pldm_entity_node *next = prev->next_sibling; |
| if (prev->entity.entity_type == entity->entity_type) { |
| if (prev->entity.entity_instance_num == UINT16_MAX) { |
| free(node); |
| return NULL; |
| } |
| node->entity.entity_instance_num = |
| entity_instance_number != 0xffff ? |
| entity_instance_number : |
| prev->entity.entity_instance_num + 1; |
| } |
| prev->next_sibling = node; |
| node->parent = prev->parent; |
| node->next_sibling = next; |
| node->entity.entity_container_id = |
| prev->entity.entity_container_id; |
| node->remote_container_id = entity->entity_container_id; |
| } |
| entity->entity_instance_num = node->entity.entity_instance_num; |
| if (is_update_container_id) { |
| entity->entity_container_id = node->entity.entity_container_id; |
| } |
| return node; |
| } |
| |
| static void get_num_nodes(pldm_entity_node *node, size_t *num) |
| { |
| if (node == NULL) { |
| return; |
| } |
| |
| ++(*num); |
| get_num_nodes(node->next_sibling, num); |
| get_num_nodes(node->first_child, num); |
| } |
| |
| static void entity_association_tree_visit(pldm_entity_node *node, |
| pldm_entity *entities, size_t *index) |
| { |
| if (node == NULL) { |
| return; |
| } |
| |
| pldm_entity *entity = &entities[*index]; |
| ++(*index); |
| entity->entity_type = node->entity.entity_type; |
| entity->entity_instance_num = node->entity.entity_instance_num; |
| entity->entity_container_id = node->entity.entity_container_id; |
| |
| entity_association_tree_visit(node->next_sibling, entities, index); |
| entity_association_tree_visit(node->first_child, entities, index); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_entity_association_tree_visit(pldm_entity_association_tree *tree, |
| pldm_entity **entities, size_t *size) |
| { |
| if (!tree || !entities || !size) { |
| return; |
| } |
| |
| *size = 0; |
| if (tree->root == NULL) { |
| return; |
| } |
| |
| get_num_nodes(tree->root, size); |
| *entities = malloc(*size * sizeof(pldm_entity)); |
| if (!entities) { |
| return; |
| } |
| size_t index = 0; |
| entity_association_tree_visit(tree->root, *entities, &index); |
| } |
| |
| static void entity_association_tree_destroy(pldm_entity_node *node) |
| { |
| if (node == NULL) { |
| return; |
| } |
| |
| entity_association_tree_destroy(node->next_sibling); |
| entity_association_tree_destroy(node->first_child); |
| free(node); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_entity_association_tree_destroy(pldm_entity_association_tree *tree) |
| { |
| if (!tree) { |
| return; |
| } |
| |
| entity_association_tree_destroy(tree->root); |
| free(tree); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| bool pldm_entity_is_node_parent(pldm_entity_node *node) |
| { |
| assert(node != NULL); |
| |
| return node->first_child != NULL; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity pldm_entity_get_parent(pldm_entity_node *node) |
| { |
| assert(node != NULL); |
| |
| return node->parent; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| bool pldm_entity_is_exist_parent(pldm_entity_node *node) |
| { |
| if (!node) { |
| return false; |
| } |
| |
| if (node->parent.entity_type == 0 && |
| node->parent.entity_instance_num == 0 && |
| node->parent.entity_container_id == 0) { |
| return false; |
| } |
| |
| return true; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| uint8_t pldm_entity_get_num_children(pldm_entity_node *node, |
| uint8_t association_type) |
| { |
| if (!node) { |
| return 0; |
| } |
| |
| if (!(association_type == PLDM_ENTITY_ASSOCIAION_PHYSICAL || |
| association_type == PLDM_ENTITY_ASSOCIAION_LOGICAL)) { |
| return 0; |
| } |
| |
| size_t count = 0; |
| pldm_entity_node *curr = node->first_child; |
| while (curr != NULL) { |
| if (curr->association_type == association_type) { |
| ++count; |
| } |
| curr = curr->next_sibling; |
| } |
| |
| assert(count < UINT8_MAX); |
| return count < UINT8_MAX ? count : 0; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| bool pldm_is_current_parent_child(pldm_entity_node *parent, pldm_entity *node) |
| { |
| if (!parent || !node) { |
| return false; |
| } |
| |
| pldm_entity_node *curr = parent->first_child; |
| while (curr != NULL) { |
| if (node->entity_type == curr->entity.entity_type && |
| node->entity_instance_num == |
| curr->entity.entity_instance_num) { |
| return true; |
| } |
| curr = curr->next_sibling; |
| } |
| |
| return false; |
| } |
| |
| static int entity_association_pdr_add_children( |
| pldm_entity_node *curr, pldm_pdr *repo, uint16_t size, |
| uint8_t contained_count, uint8_t association_type, bool is_remote, |
| uint16_t terminus_handle, uint32_t record_handle) |
| { |
| uint8_t *start; |
| uint8_t *pdr; |
| int rc; |
| |
| pdr = calloc(1, size); |
| if (!pdr) { |
| return -ENOMEM; |
| } |
| |
| start = pdr; |
| |
| struct pldm_pdr_hdr *hdr = (struct pldm_pdr_hdr *)start; |
| hdr->version = 1; |
| hdr->record_handle = record_handle; |
| hdr->type = PLDM_PDR_ENTITY_ASSOCIATION; |
| hdr->record_change_num = 0; |
| hdr->length = htole16(size - sizeof(struct pldm_pdr_hdr)); |
| start += sizeof(struct pldm_pdr_hdr); |
| |
| uint16_t *container_id = (uint16_t *)start; |
| *container_id = htole16(curr->first_child->entity.entity_container_id); |
| start += sizeof(uint16_t); |
| *start = association_type; |
| start += sizeof(uint8_t); |
| |
| pldm_entity *entity = (pldm_entity *)start; |
| entity->entity_type = htole16(curr->entity.entity_type); |
| entity->entity_instance_num = htole16(curr->entity.entity_instance_num); |
| entity->entity_container_id = htole16(curr->entity.entity_container_id); |
| start += sizeof(pldm_entity); |
| |
| *start = contained_count; |
| start += sizeof(uint8_t); |
| |
| pldm_entity_node *node = curr->first_child; |
| while (node != NULL) { |
| if (node->association_type == association_type) { |
| pldm_entity *entity = (pldm_entity *)start; |
| entity->entity_type = htole16(node->entity.entity_type); |
| entity->entity_instance_num = |
| htole16(node->entity.entity_instance_num); |
| entity->entity_container_id = |
| htole16(node->entity.entity_container_id); |
| start += sizeof(pldm_entity); |
| } |
| node = node->next_sibling; |
| } |
| |
| rc = pldm_pdr_add(repo, pdr, size, is_remote, terminus_handle, |
| &record_handle); |
| free(pdr); |
| return rc; |
| } |
| |
| static int entity_association_pdr_add_entry(pldm_entity_node *curr, |
| pldm_pdr *repo, bool is_remote, |
| uint16_t terminus_handle, |
| uint32_t record_handle) |
| { |
| uint8_t num_logical_children = pldm_entity_get_num_children( |
| curr, PLDM_ENTITY_ASSOCIAION_LOGICAL); |
| uint8_t num_physical_children = pldm_entity_get_num_children( |
| curr, PLDM_ENTITY_ASSOCIAION_PHYSICAL); |
| int rc; |
| |
| if (num_logical_children) { |
| uint16_t logical_pdr_size = |
| sizeof(struct pldm_pdr_hdr) + sizeof(uint16_t) + |
| sizeof(uint8_t) + sizeof(pldm_entity) + |
| sizeof(uint8_t) + |
| (num_logical_children * sizeof(pldm_entity)); |
| rc = entity_association_pdr_add_children( |
| curr, repo, logical_pdr_size, num_logical_children, |
| PLDM_ENTITY_ASSOCIAION_LOGICAL, is_remote, |
| terminus_handle, record_handle); |
| if (rc < 0) { |
| return rc; |
| } |
| } |
| |
| if (num_physical_children) { |
| uint16_t physical_pdr_size = |
| sizeof(struct pldm_pdr_hdr) + sizeof(uint16_t) + |
| sizeof(uint8_t) + sizeof(pldm_entity) + |
| sizeof(uint8_t) + |
| (num_physical_children * sizeof(pldm_entity)); |
| rc = entity_association_pdr_add_children( |
| curr, repo, physical_pdr_size, num_physical_children, |
| PLDM_ENTITY_ASSOCIAION_PHYSICAL, is_remote, |
| terminus_handle, record_handle); |
| if (rc < 0) { |
| return rc; |
| } |
| } |
| |
| return 0; |
| } |
| |
| static bool is_present(pldm_entity entity, pldm_entity **entities, |
| size_t num_entities) |
| { |
| if (entities == NULL || num_entities == 0) { |
| return true; |
| } |
| size_t i = 0; |
| while (i < num_entities) { |
| if ((*entities + i)->entity_type == entity.entity_type) { |
| return true; |
| } |
| i++; |
| } |
| return false; |
| } |
| |
| static int entity_association_pdr_add(pldm_entity_node *curr, pldm_pdr *repo, |
| pldm_entity **entities, |
| size_t num_entities, bool is_remote, |
| uint16_t terminus_handle, |
| uint32_t record_handle) |
| { |
| int rc; |
| |
| if (curr == NULL) { |
| return 0; |
| } |
| |
| if (is_present(curr->entity, entities, num_entities)) { |
| rc = entity_association_pdr_add_entry( |
| curr, repo, is_remote, terminus_handle, record_handle); |
| if (rc) { |
| return rc; |
| } |
| } |
| |
| rc = entity_association_pdr_add(curr->next_sibling, repo, entities, |
| num_entities, is_remote, |
| terminus_handle, record_handle); |
| if (rc) { |
| return rc; |
| } |
| |
| return entity_association_pdr_add(curr->first_child, repo, entities, |
| num_entities, is_remote, |
| terminus_handle, record_handle); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| int pldm_entity_association_pdr_add(pldm_entity_association_tree *tree, |
| pldm_pdr *repo, bool is_remote, |
| uint16_t terminus_handle) |
| { |
| if (!tree || !repo) { |
| return 0; |
| } |
| |
| return entity_association_pdr_add(tree->root, repo, NULL, 0, is_remote, |
| terminus_handle, 0); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| int pldm_entity_association_pdr_add_from_node( |
| pldm_entity_node *node, pldm_pdr *repo, pldm_entity **entities, |
| size_t num_entities, bool is_remote, uint16_t terminus_handle) |
| { |
| return pldm_entity_association_pdr_add_from_node_with_record_handle( |
| node, repo, entities, num_entities, is_remote, terminus_handle, |
| 0); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| int pldm_entity_association_pdr_add_from_node_with_record_handle( |
| pldm_entity_node *node, pldm_pdr *repo, pldm_entity **entities, |
| size_t num_entities, bool is_remote, uint16_t terminus_handle, |
| uint32_t record_handle) |
| { |
| if (!node || !repo || !entities) { |
| return -EINVAL; |
| } |
| |
| return entity_association_pdr_add(node, repo, entities, num_entities, |
| is_remote, terminus_handle, |
| record_handle); |
| } |
| |
| static void find_entity_ref_in_tree(pldm_entity_node *tree_node, |
| pldm_entity entity, pldm_entity_node **node) |
| { |
| bool is_entity_container_id; |
| bool is_entity_instance_num; |
| bool is_type; |
| |
| if (tree_node == NULL) { |
| return; |
| } |
| |
| is_type = tree_node->entity.entity_type == entity.entity_type; |
| is_entity_instance_num = tree_node->entity.entity_instance_num == |
| entity.entity_instance_num; |
| is_entity_container_id = tree_node->entity.entity_container_id == |
| entity.entity_container_id; |
| |
| if (is_type && is_entity_instance_num && is_entity_container_id) { |
| *node = tree_node; |
| return; |
| } |
| |
| find_entity_ref_in_tree(tree_node->first_child, entity, node); |
| find_entity_ref_in_tree(tree_node->next_sibling, entity, node); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_find_entity_ref_in_tree(pldm_entity_association_tree *tree, |
| pldm_entity entity, pldm_entity_node **node) |
| { |
| if (!tree || !node) { |
| return; |
| } |
| |
| find_entity_ref_in_tree(tree->root, entity, node); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_pdr_remove_pdrs_by_terminus_handle(pldm_pdr *repo, |
| uint16_t terminus_handle) |
| { |
| if (!repo) { |
| return; |
| } |
| |
| bool removed = false; |
| |
| pldm_pdr_record *record = repo->first; |
| pldm_pdr_record *prev = NULL; |
| while (record != NULL) { |
| pldm_pdr_record *next = record->next; |
| if (record->terminus_handle == terminus_handle) { |
| if (repo->first == record) { |
| repo->first = next; |
| } else { |
| prev->next = next; |
| } |
| if (repo->last == record) { |
| repo->last = prev; |
| } |
| if (record->data) { |
| free(record->data); |
| } |
| --repo->record_count; |
| repo->size -= record->size; |
| free(record); |
| removed = true; |
| } else { |
| prev = record; |
| } |
| record = next; |
| } |
| |
| if (removed == true) { |
| record = repo->first; |
| uint32_t record_handle = 0; |
| while (record != NULL) { |
| record->record_handle = ++record_handle; |
| if (record->data != NULL) { |
| struct pldm_pdr_hdr *hdr = |
| (struct pldm_pdr_hdr *)(record->data); |
| hdr->record_handle = |
| htole32(record->record_handle); |
| } |
| record = record->next; |
| } |
| } |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_pdr_remove_remote_pdrs(pldm_pdr *repo) |
| { |
| if (!repo) { |
| return; |
| } |
| |
| bool removed = false; |
| |
| pldm_pdr_record *record = repo->first; |
| pldm_pdr_record *prev = NULL; |
| while (record != NULL) { |
| pldm_pdr_record *next = record->next; |
| if (record->is_remote == true) { |
| if (repo->first == record) { |
| repo->first = next; |
| } else { |
| prev->next = next; |
| } |
| if (repo->last == record) { |
| repo->last = prev; |
| } |
| if (record->data) { |
| free(record->data); |
| } |
| --repo->record_count; |
| repo->size -= record->size; |
| free(record); |
| removed = true; |
| } else { |
| prev = record; |
| } |
| record = next; |
| } |
| |
| if (removed == true) { |
| record = repo->first; |
| uint32_t record_handle = 0; |
| while (record != NULL) { |
| record->record_handle = ++record_handle; |
| if (record->data != NULL) { |
| struct pldm_pdr_hdr *hdr = |
| (struct pldm_pdr_hdr *)(record->data); |
| hdr->record_handle = |
| htole32(record->record_handle); |
| } |
| record = record->next; |
| } |
| } |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_pdr_record *pldm_pdr_find_last_in_range(const pldm_pdr *repo, |
| uint32_t first, uint32_t last) |
| { |
| pldm_pdr_record *record = NULL; |
| pldm_pdr_record *curr; |
| |
| if (!repo) { |
| return NULL; |
| } |
| for (curr = repo->first; curr; curr = curr->next) { |
| if (first > curr->record_handle || last < curr->record_handle) { |
| continue; |
| } |
| if (!record || curr->record_handle > record->record_handle) { |
| record = curr; |
| } |
| } |
| |
| return record; |
| } |
| |
| static void entity_association_tree_find_if_remote(pldm_entity_node *node, |
| pldm_entity *entity, |
| pldm_entity_node **out, |
| bool is_remote) |
| { |
| if (node == NULL) { |
| return; |
| } |
| bool is_entity_type; |
| bool is_entity_instance_num; |
| |
| is_entity_type = node->entity.entity_type == entity->entity_type; |
| is_entity_instance_num = node->entity.entity_instance_num == |
| entity->entity_instance_num; |
| |
| if (!is_remote || |
| node->remote_container_id == entity->entity_container_id) { |
| if (is_entity_type && is_entity_instance_num) { |
| entity->entity_container_id = |
| node->entity.entity_container_id; |
| *out = node; |
| return; |
| } |
| } |
| entity_association_tree_find_if_remote(node->next_sibling, entity, out, |
| is_remote); |
| entity_association_tree_find_if_remote(node->first_child, entity, out, |
| is_remote); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity_node *pldm_entity_association_tree_find_with_locality( |
| pldm_entity_association_tree *tree, pldm_entity *entity, bool is_remote) |
| { |
| if (!tree || !entity) { |
| return NULL; |
| } |
| pldm_entity_node *node = NULL; |
| entity_association_tree_find_if_remote(tree->root, entity, &node, |
| is_remote); |
| return node; |
| } |
| |
| static void entity_association_tree_find(pldm_entity_node *node, |
| pldm_entity *entity, |
| pldm_entity_node **out) |
| { |
| if (node == NULL) { |
| return; |
| } |
| |
| if (node->entity.entity_type == entity->entity_type && |
| node->entity.entity_instance_num == entity->entity_instance_num) { |
| entity->entity_container_id = node->entity.entity_container_id; |
| *out = node; |
| return; |
| } |
| entity_association_tree_find(node->next_sibling, entity, out); |
| entity_association_tree_find(node->first_child, entity, out); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| pldm_entity_node * |
| pldm_entity_association_tree_find(pldm_entity_association_tree *tree, |
| pldm_entity *entity) |
| { |
| if (!tree || !entity) { |
| return NULL; |
| } |
| |
| pldm_entity_node *node = NULL; |
| entity_association_tree_find(tree->root, entity, &node); |
| return node; |
| } |
| |
| static int entity_association_tree_copy(pldm_entity_node *org_node, |
| pldm_entity_node **new_node) |
| { |
| int rc; |
| |
| if (org_node == NULL) { |
| return 0; |
| } |
| |
| *new_node = malloc(sizeof(pldm_entity_node)); |
| if (!*new_node) { |
| return -ENOMEM; |
| } |
| |
| (*new_node)->parent = org_node->parent; |
| (*new_node)->entity = org_node->entity; |
| (*new_node)->association_type = org_node->association_type; |
| (*new_node)->remote_container_id = org_node->remote_container_id; |
| (*new_node)->first_child = NULL; |
| (*new_node)->next_sibling = NULL; |
| |
| rc = entity_association_tree_copy(org_node->first_child, |
| &((*new_node)->first_child)); |
| if (rc) { |
| goto cleanup; |
| } |
| |
| rc = entity_association_tree_copy(org_node->next_sibling, |
| &((*new_node)->next_sibling)); |
| if (rc) { |
| entity_association_tree_destroy((*new_node)->first_child); |
| goto cleanup; |
| } |
| |
| return 0; |
| |
| cleanup: |
| free(*new_node); |
| *new_node = NULL; |
| return rc; |
| } |
| |
| LIBPLDM_ABI_DEPRECATED_UNSAFE |
| void pldm_entity_association_tree_copy_root( |
| pldm_entity_association_tree *org_tree, |
| pldm_entity_association_tree *new_tree) |
| { |
| assert(org_tree != NULL); |
| assert(new_tree != NULL); |
| |
| new_tree->last_used_container_id = org_tree->last_used_container_id; |
| entity_association_tree_copy(org_tree->root, &(new_tree->root)); |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_entity_association_tree_copy_root_check( |
| pldm_entity_association_tree *org_tree, |
| pldm_entity_association_tree *new_tree) |
| { |
| if (!org_tree || !new_tree) { |
| return -EINVAL; |
| } |
| |
| new_tree->last_used_container_id = org_tree->last_used_container_id; |
| return entity_association_tree_copy(org_tree->root, &(new_tree->root)); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_entity_association_tree_destroy_root( |
| pldm_entity_association_tree *tree) |
| { |
| if (!tree) { |
| return; |
| } |
| |
| entity_association_tree_destroy(tree->root); |
| tree->last_used_container_id = 0; |
| tree->root = NULL; |
| } |
| |
| LIBPLDM_ABI_STABLE |
| bool pldm_is_empty_entity_assoc_tree(pldm_entity_association_tree *tree) |
| { |
| return ((tree->root == NULL) ? true : false); |
| } |
| |
| LIBPLDM_ABI_STABLE |
| void pldm_entity_association_pdr_extract(const uint8_t *pdr, uint16_t pdr_len, |
| size_t *num_entities, |
| pldm_entity **entities) |
| { |
| if (!pdr || !num_entities || !entities) { |
| return; |
| } |
| if (pdr_len < PDR_ENTITY_ASSOCIATION_MIN_SIZE) { |
| return; |
| } |
| |
| struct pldm_pdr_hdr *hdr = (struct pldm_pdr_hdr *)pdr; |
| if (hdr->type != PLDM_PDR_ENTITY_ASSOCIATION) { |
| return; |
| } |
| |
| const uint8_t *start = (uint8_t *)pdr; |
| |
| if (UINTPTR_MAX - (uintptr_t)start < |
| (sizeof(struct pldm_pdr_hdr) + le16toh(hdr->length))) { |
| return; |
| } |
| |
| if (pdr_len < (sizeof(struct pldm_pdr_hdr) + le16toh(hdr->length))) { |
| return; |
| } |
| |
| const uint8_t *end = |
| start + sizeof(struct pldm_pdr_hdr) + le16toh(hdr->length); |
| start += sizeof(struct pldm_pdr_hdr); |
| |
| if ((uintptr_t)end - (uintptr_t)start < |
| sizeof(struct pldm_pdr_entity_association)) { |
| return; |
| } |
| struct pldm_pdr_entity_association *entity_association_pdr = |
| (struct pldm_pdr_entity_association *)start; |
| |
| if (entity_association_pdr->num_children == UINT8_MAX) { |
| return; |
| } |
| |
| size_t l_num_entities = entity_association_pdr->num_children + 1; |
| if (l_num_entities < 2) { |
| return; |
| } |
| |
| if (UINT8_MAX < l_num_entities) { |
| return; |
| } |
| |
| pldm_entity *l_entities = calloc(l_num_entities, sizeof(pldm_entity)); |
| if (!l_entities) { |
| return; |
| } |
| l_entities[0].entity_type = |
| le16toh(entity_association_pdr->container.entity_type); |
| l_entities[0].entity_instance_num = |
| le16toh(entity_association_pdr->container.entity_instance_num); |
| l_entities[0].entity_container_id = |
| le16toh(entity_association_pdr->container.entity_container_id); |
| pldm_entity *curr_entity = entity_association_pdr->children; |
| for (size_t i = 1; i < l_num_entities; i++, curr_entity++) { |
| l_entities[i].entity_type = le16toh(curr_entity->entity_type); |
| l_entities[i].entity_instance_num = |
| le16toh(curr_entity->entity_instance_num); |
| l_entities[i].entity_container_id = |
| le16toh(curr_entity->entity_container_id); |
| } |
| |
| *num_entities = l_num_entities; |
| *entities = l_entities; |
| } |
| |
| /* Find the position of record in pldm_pdr repo and place new_record in |
| * the same position. |
| */ |
| LIBPLDM_CC_NONNULL |
| static int pldm_pdr_replace_record(pldm_pdr *repo, pldm_pdr_record *record, |
| pldm_pdr_record *prev, |
| pldm_pdr_record *new_record) |
| { |
| if (repo->size < record->size) { |
| return -EOVERFLOW; |
| } |
| |
| if (repo->size + new_record->size < new_record->size) { |
| return -EOVERFLOW; |
| } |
| |
| if (repo->first == record) { |
| repo->first = new_record; |
| } else { |
| prev->next = new_record; |
| } |
| new_record->next = record->next; |
| |
| if (repo->last == record) { |
| repo->last = new_record; |
| } |
| |
| repo->size = (repo->size - record->size) + new_record->size; |
| return 0; |
| } |
| |
| /* Insert a new record to pldm_pdr repo to a position that comes after |
| * pldm_pdr_record record. |
| */ |
| LIBPLDM_CC_NONNULL |
| static int pldm_pdr_insert_record(pldm_pdr *repo, pldm_pdr_record *record, |
| pldm_pdr_record *new_record) |
| { |
| if (repo->size + new_record->size < new_record->size) { |
| return -EOVERFLOW; |
| } |
| |
| if (repo->record_count == UINT32_MAX) { |
| return -EOVERFLOW; |
| } |
| |
| new_record->next = record->next; |
| record->next = new_record; |
| |
| if (repo->last == record) { |
| repo->last = new_record; |
| } |
| |
| repo->size = repo->size + new_record->size; |
| ++repo->record_count; |
| return 0; |
| } |
| |
| /* Find the position of PDR when its record handle is known |
| */ |
| LIBPLDM_CC_NONNULL |
| static bool pldm_pdr_find_record_by_handle(pldm_pdr_record **record, |
| pldm_pdr_record **prev, |
| uint32_t record_handle) |
| { |
| while (*record != NULL) { |
| if ((*record)->record_handle == record_handle) { |
| return true; |
| } |
| *prev = *record; |
| *record = (*record)->next; |
| } |
| return false; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_entity_association_pdr_add_contained_entity_to_remote_pdr( |
| pldm_pdr *repo, pldm_entity *entity, uint32_t pdr_record_handle) |
| { |
| if (!repo || !entity) { |
| return -EINVAL; |
| } |
| |
| pldm_pdr_record *record = repo->first; |
| pldm_pdr_record *prev = repo->first; |
| int rc = 0; |
| uint16_t header_length = 0; |
| uint8_t num_children = 0; |
| struct pldm_msgbuf _src; |
| struct pldm_msgbuf *src = &_src; |
| struct pldm_msgbuf _dst; |
| struct pldm_msgbuf *dst = &_dst; |
| |
| pldm_pdr_find_record_by_handle(&record, &prev, pdr_record_handle); |
| |
| if (!record) { |
| return -EINVAL; |
| } |
| // Initialize msg buffer for record and record->data |
| rc = pldm_msgbuf_init_errno(src, PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| record->data, record->size); |
| if (rc) { |
| return rc; |
| } |
| |
| // check if adding another entity to record causes overflow before |
| // allocating memory for new_record. |
| if (record->size + sizeof(pldm_entity) < sizeof(pldm_entity)) { |
| return -EOVERFLOW; |
| } |
| pldm_pdr_record *new_record = malloc(sizeof(pldm_pdr_record)); |
| if (!new_record) { |
| return -ENOMEM; |
| } |
| |
| new_record->data = malloc(record->size + sizeof(pldm_entity)); |
| if (!new_record->data) { |
| rc = -ENOMEM; |
| goto cleanup_new_record; |
| } |
| |
| new_record->record_handle = record->record_handle; |
| new_record->size = record->size + sizeof(struct pldm_entity); |
| new_record->is_remote = record->is_remote; |
| |
| // Initialize new PDR record with data from original PDR record. |
| // Start with adding the header of original PDR |
| rc = pldm_msgbuf_init_errno(dst, PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| new_record->data, new_record->size); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| pldm_msgbuf_copy(dst, src, uint32_t, hdr_record_handle); |
| pldm_msgbuf_copy(dst, src, uint8_t, hdr_version); |
| pldm_msgbuf_copy(dst, src, uint8_t, hdr_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, hdr_record_change_num); |
| // extract the header length from record and increment size with |
| // size of pldm_entity before inserting the value into new_record. |
| rc = pldm_msgbuf_extract(src, header_length); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| static_assert(UINT16_MAX < (SIZE_MAX - sizeof(pldm_entity)), |
| "Fix the following bounds check."); |
| if (header_length + sizeof(pldm_entity) > UINT16_MAX) { |
| rc = -EOVERFLOW; |
| goto cleanup_new_record_data; |
| } |
| header_length += sizeof(pldm_entity); |
| pldm_msgbuf_insert(dst, header_length); |
| pldm_msgbuf_copy(dst, src, uint16_t, container_id); |
| pldm_msgbuf_copy(dst, src, uint8_t, association_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_instance_num); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_container_id); |
| // extract value of number of children from record and increment it |
| // by 1 before insert the value to new record. |
| rc = pldm_msgbuf_extract(src, num_children); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| if (num_children == UINT8_MAX) { |
| rc = -EOVERFLOW; |
| goto cleanup_new_record_data; |
| } |
| num_children += 1; |
| pldm_msgbuf_insert(dst, num_children); |
| //Add all children of original PDR to new PDR |
| for (int i = 0; i < num_children - 1; i++) { |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_instance_num); |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_container_id); |
| } |
| |
| // Add new contained entity as a child of new PDR |
| rc = pldm_msgbuf_destroy(src); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| rc = pldm_msgbuf_init_errno(src, sizeof(struct pldm_entity), entity, |
| sizeof(struct pldm_entity)); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_instance_num); |
| pldm_msgbuf_copy(dst, src, uint16_t, child_entity_container_id); |
| |
| rc = pldm_msgbuf_destroy(src); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| rc = pldm_msgbuf_destroy(dst); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| rc = pldm_pdr_replace_record(repo, record, prev, new_record); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| free(record->data); |
| free(record); |
| return rc; |
| cleanup_new_record_data: |
| free(new_record->data); |
| cleanup_new_record: |
| free(new_record); |
| return rc; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_entity_association_pdr_create_new(pldm_pdr *repo, |
| uint32_t pdr_record_handle, |
| pldm_entity *parent, |
| pldm_entity *entity, |
| uint32_t *entity_record_handle) |
| { |
| if (!repo || !parent || !entity || !entity_record_handle) { |
| return -EINVAL; |
| } |
| |
| if (pdr_record_handle == UINT32_MAX) { |
| return -EOVERFLOW; |
| } |
| |
| bool pdr_added = false; |
| uint16_t new_pdr_size; |
| uint16_t container_id = 0; |
| void *container_id_addr; |
| struct pldm_msgbuf _dst; |
| struct pldm_msgbuf *dst = &_dst; |
| struct pldm_msgbuf _src_p; |
| struct pldm_msgbuf *src_p = &_src_p; |
| struct pldm_msgbuf _src_c; |
| struct pldm_msgbuf *src_c = &_src_c; |
| int rc = 0; |
| |
| pldm_pdr_record *prev = repo->first; |
| pldm_pdr_record *record = repo->first; |
| pdr_added = pldm_pdr_find_record_by_handle(&record, &prev, |
| pdr_record_handle); |
| if (!pdr_added) { |
| return -ENOENT; |
| } |
| |
| static_assert(PDR_ENTITY_ASSOCIATION_MIN_SIZE < UINT16_MAX, |
| "Truncation ahead"); |
| new_pdr_size = PDR_ENTITY_ASSOCIATION_MIN_SIZE; |
| pldm_pdr_record *new_record = malloc(sizeof(pldm_pdr_record)); |
| if (!new_record) { |
| return -ENOMEM; |
| } |
| |
| new_record->data = malloc(new_pdr_size); |
| if (!new_record->data) { |
| rc = -ENOMEM; |
| goto cleanup_new_record; |
| } |
| |
| // Initialise new PDR to be added with the header, size and handle. |
| // Set the position of new PDR |
| *entity_record_handle = pdr_record_handle + 1; |
| new_record->record_handle = *entity_record_handle; |
| new_record->size = new_pdr_size; |
| new_record->is_remote = false; |
| |
| rc = pldm_msgbuf_init_errno(dst, PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| new_record->data, new_record->size); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| // header record handle |
| pldm_msgbuf_insert(dst, *entity_record_handle); |
| // header version |
| pldm_msgbuf_insert_uint8(dst, 1); |
| // header type |
| pldm_msgbuf_insert_uint8(dst, PLDM_PDR_ENTITY_ASSOCIATION); |
| // header change number |
| pldm_msgbuf_insert_uint16(dst, 0); |
| // header length |
| pldm_msgbuf_insert_uint16(dst, |
| (new_pdr_size - sizeof(struct pldm_pdr_hdr))); |
| |
| // Data for new PDR is obtained from parent PDR and new contained entity |
| // is added as the child |
| rc = pldm_msgbuf_init_errno(src_p, sizeof(struct pldm_entity), parent, |
| sizeof(*parent)); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| rc = pldm_msgbuf_init_errno(src_c, sizeof(struct pldm_entity), entity, |
| sizeof(*entity)); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| container_id_addr = NULL; |
| // extract pointer for container ID and save the address |
| rc = pldm_msgbuf_span_required(dst, sizeof(container_id), |
| (void **)&container_id_addr); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| assert(container_id_addr); |
| pldm_msgbuf_insert_uint8(dst, PLDM_ENTITY_ASSOCIAION_PHYSICAL); |
| pldm_msgbuf_copy(dst, src_p, uint16_t, entity_type); |
| pldm_msgbuf_copy(dst, src_p, uint16_t, entity_instance_num); |
| pldm_msgbuf_copy(dst, src_p, uint16_t, entity_container_id); |
| // number of children |
| pldm_msgbuf_insert_uint8(dst, 1); |
| |
| // Add new entity as child |
| pldm_msgbuf_copy(dst, src_c, uint16_t, child_entity_type); |
| pldm_msgbuf_copy(dst, src_c, uint16_t, child_entity_instance_num); |
| // Extract and insert child entity container ID and add same value to |
| // container ID of entity |
| pldm_msgbuf_extract(src_c, container_id); |
| pldm_msgbuf_insert(dst, container_id); |
| container_id = htole16(container_id); |
| memcpy(container_id_addr, &container_id, sizeof(uint16_t)); |
| |
| rc = pldm_msgbuf_destroy(dst); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| rc = pldm_msgbuf_destroy(src_p); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| rc = pldm_msgbuf_destroy(src_c); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| rc = pldm_pdr_insert_record(repo, record, new_record); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| |
| return rc; |
| cleanup_new_record_data: |
| free(new_record->data); |
| cleanup_new_record: |
| free(new_record); |
| return rc; |
| } |
| |
| LIBPLDM_CC_NONNULL |
| static bool pldm_entity_cmp(const struct pldm_entity *l, |
| const struct pldm_entity *r) |
| { |
| return l->entity_type == r->entity_type && |
| l->entity_instance_num == r->entity_instance_num && |
| l->entity_container_id == r->entity_container_id; |
| } |
| |
| /* Find record handle of a PDR record from PDR repo and |
| * entity |
| */ |
| LIBPLDM_CC_NONNULL |
| static int pldm_entity_association_find_record_handle_by_entity( |
| pldm_pdr *repo, pldm_entity *entity, bool is_remote, |
| uint32_t *record_handle) |
| { |
| uint8_t num_children = 0; |
| uint8_t hdr_type = 0; |
| int rc = 0; |
| size_t skip_data_size = 0; |
| pldm_pdr_record *record = repo->first; |
| struct pldm_msgbuf _dst; |
| struct pldm_msgbuf *dst = &_dst; |
| |
| while (record != NULL) { |
| rc = pldm_msgbuf_init_errno(dst, |
| PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| record->data, record->size); |
| if (rc) { |
| return rc; |
| } |
| skip_data_size = sizeof(uint32_t) + sizeof(uint8_t); |
| pldm_msgbuf_span_required(dst, skip_data_size, NULL); |
| pldm_msgbuf_extract(dst, hdr_type); |
| if (record->is_remote != is_remote || |
| hdr_type != PLDM_PDR_ENTITY_ASSOCIATION) { |
| goto cleanup; |
| } |
| skip_data_size = sizeof(uint16_t) + sizeof(uint16_t) + |
| sizeof(uint16_t) + sizeof(uint8_t) + |
| sizeof(struct pldm_entity); |
| pldm_msgbuf_span_required(dst, skip_data_size, NULL); |
| pldm_msgbuf_extract(dst, num_children); |
| for (int i = 0; i < num_children; ++i) { |
| struct pldm_entity e; |
| |
| if ((rc = pldm_msgbuf_extract(dst, e.entity_type)) || |
| (rc = pldm_msgbuf_extract(dst, |
| e.entity_instance_num)) || |
| (rc = pldm_msgbuf_extract(dst, |
| e.entity_container_id))) { |
| return rc; |
| } |
| |
| if (pldm_entity_cmp(entity, &e)) { |
| *record_handle = record->record_handle; |
| return 0; |
| } |
| } |
| cleanup: |
| rc = pldm_msgbuf_destroy(dst); |
| if (rc) { |
| return rc; |
| } |
| record = record->next; |
| } |
| return 0; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_entity_association_pdr_remove_contained_entity( |
| pldm_pdr *repo, pldm_entity *entity, bool is_remote, |
| uint32_t *pdr_record_handle) |
| { |
| uint16_t header_length = 0; |
| uint8_t num_children = 0; |
| struct pldm_msgbuf _src; |
| struct pldm_msgbuf *src = &_src; |
| struct pldm_msgbuf _dst; |
| struct pldm_msgbuf *dst = &_dst; |
| int rc; |
| pldm_pdr_record *record; |
| pldm_pdr_record *prev; |
| |
| if (!repo || !entity || !pdr_record_handle) { |
| return -EINVAL; |
| } |
| record = repo->first; |
| prev = repo->first; |
| |
| rc = pldm_entity_association_find_record_handle_by_entity( |
| repo, entity, is_remote, pdr_record_handle); |
| if (rc) { |
| return rc; |
| } |
| pldm_pdr_find_record_by_handle(&record, &prev, *pdr_record_handle); |
| if (!record) { |
| return -EINVAL; |
| } |
| // Initialize msg buffer for record and record->data |
| rc = pldm_msgbuf_init_errno(src, PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| record->data, record->size); |
| if (rc) { |
| return rc; |
| } |
| // check if removing an entity from record causes overflow before |
| // allocating memory for new_record. |
| if (record->size < sizeof(pldm_entity)) { |
| return -EOVERFLOW; |
| } |
| pldm_pdr_record *new_record = malloc(sizeof(pldm_pdr_record)); |
| if (!new_record) { |
| return -ENOMEM; |
| } |
| new_record->data = malloc(record->size - sizeof(pldm_entity)); |
| if (!new_record->data) { |
| rc = -ENOMEM; |
| goto cleanup_new_record; |
| } |
| new_record->record_handle = record->record_handle; |
| new_record->size = record->size - sizeof(struct pldm_entity); |
| new_record->is_remote = record->is_remote; |
| |
| // Initialize new PDR record with data from original PDR record. |
| // Start with adding the header of original PDR |
| rc = pldm_msgbuf_init_errno(dst, PDR_ENTITY_ASSOCIATION_MIN_SIZE, |
| new_record->data, new_record->size); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| pldm_msgbuf_copy(dst, src, uint32_t, hdr_record_handle); |
| pldm_msgbuf_copy(dst, src, uint8_t, hdr_version); |
| pldm_msgbuf_copy(dst, src, uint8_t, hdr_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, hdr_record_change_num); |
| // extract the header length from record and decrement size with |
| // size of pldm_entity before inserting the value into new_record. |
| rc = pldm_msgbuf_extract(src, header_length); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| if (header_length < sizeof(pldm_entity)) { |
| rc = -EOVERFLOW; |
| goto cleanup_new_record_data; |
| } |
| header_length -= sizeof(pldm_entity); |
| pldm_msgbuf_insert(dst, header_length); |
| pldm_msgbuf_copy(dst, src, uint16_t, container_id); |
| pldm_msgbuf_copy(dst, src, uint8_t, association_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_type); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_instance_num); |
| pldm_msgbuf_copy(dst, src, uint16_t, entity_container_id); |
| // extract value of number of children from record and decrement it |
| // by 1 before insert the value to new record. |
| rc = pldm_msgbuf_extract(src, num_children); |
| if (rc) { |
| goto cleanup_new_record_data; |
| } |
| if (num_children == 1) { |
| prev->next = record->next; |
| free(record->data); |
| free(record); |
| goto cleanup_new_record_data; |
| } else if (num_children < 1) { |
| rc = -EOVERFLOW; |
| goto cleanup_new_record_data; |
| } |
| num_children -= 1; |
| pldm_msgbuf_insert(dst, num_children); |
| //Add all children of original PDR to new PDR |
| for (int i = 0; i < num_children + 1; ++i) { |
| struct pldm_entity e; |
| |
| if ((rc = pldm_msgbuf_extract(src, e.entity_type)) || |
| (rc = pldm_msgbuf_extract(src, e.entity_instance_num)) || |
| (rc = pldm_msgbuf_extract(src, e.entity_container_id))) { |
| goto cleanup_new_record_data; |
| } |
| |
| if (pldm_entity_cmp(entity, &e)) { |
| continue; |
| } |
| |
| pldm_msgbuf_insert(dst, e.entity_type); |
| pldm_msgbuf_insert(dst, e.entity_instance_num); |
| pldm_msgbuf_insert(dst, e.entity_container_id); |
| } |
| |
| if ((rc = pldm_msgbuf_destroy(src)) || |
| (rc = pldm_msgbuf_destroy(dst)) || |
| (rc = pldm_pdr_replace_record(repo, record, prev, new_record))) { |
| goto cleanup_new_record_data; |
| } |
| |
| free(record->data); |
| free(record); |
| return rc; |
| |
| cleanup_new_record_data: |
| free(new_record->data); |
| cleanup_new_record: |
| free(new_record); |
| return rc; |
| } |
| |
| /* API to find the PDR record that is previous to a given PLDM PDR |
| * record in a given PLDM PDR repository |
| */ |
| LIBPLDM_CC_NONNULL |
| static pldm_pdr_record *pldm_pdr_get_prev_record(pldm_pdr *repo, |
| pldm_pdr_record *record) |
| { |
| pldm_pdr_record *prev = NULL; |
| pldm_pdr_record *curr = repo->first; |
| |
| while (curr != NULL) { |
| if (curr->record_handle == record->record_handle) { |
| break; |
| } |
| prev = curr; |
| curr = curr->next; |
| } |
| return prev; |
| } |
| |
| /* API to check if a PLDM PDR record is present in a PLDM PDR repository |
| */ |
| LIBPLDM_CC_NONNULL |
| static bool is_prev_record_present(pldm_pdr *repo, pldm_pdr_record *record) |
| { |
| if (repo->first == record) { |
| return true; |
| } |
| |
| return pldm_pdr_get_prev_record(repo, record) != NULL; |
| } |
| |
| /* API to check if FRU RSI of record matches the given record set identifier. |
| * Returns 1 if the provided FRU record matches the provided record set identifier, |
| * 0 if it does not, otherwise -EINVAL if the arguments are invalid. |
| */ |
| LIBPLDM_CC_NONNULL |
| static int pldm_pdr_record_matches_fru_rsi(const pldm_pdr_record *record, |
| uint16_t rsi) |
| { |
| uint16_t record_fru_rsi = 0; |
| uint8_t *skip_data = NULL; |
| uint8_t skip_data_size = 0; |
| struct pldm_msgbuf _dst; |
| struct pldm_msgbuf *dst = &_dst; |
| int rc = 0; |
| |
| rc = pldm_msgbuf_init_errno(dst, PDR_FRU_RECORD_SET_MIN_SIZE, |
| record->data, record->size); |
| if (rc) { |
| return rc; |
| } |
| skip_data_size = sizeof(struct pldm_pdr_hdr) + sizeof(uint16_t); |
| pldm_msgbuf_span_required(dst, skip_data_size, (void **)&skip_data); |
| pldm_msgbuf_extract(dst, record_fru_rsi); |
| |
| rc = pldm_msgbuf_destroy(dst); |
| if (rc) { |
| return rc; |
| } |
| return record_fru_rsi == rsi; |
| } |
| |
| /* API to remove PLDM PDR record from a PLDM PDR repository |
| */ |
| LIBPLDM_CC_NONNULL_ARGS(1, 2) |
| static int pldm_pdr_remove_record(pldm_pdr *repo, pldm_pdr_record *record, |
| pldm_pdr_record *prev) |
| { |
| if (!is_prev_record_present(repo, record)) { |
| return -EINVAL; |
| } |
| |
| assert(repo->size >= record->size); |
| if (repo->size < record->size) { |
| return -EOVERFLOW; |
| } |
| |
| if (repo->first == record) { |
| repo->first = record->next; |
| } else { |
| if (prev != NULL) { |
| prev->next = record->next; |
| } |
| } |
| |
| if (repo->last == record) { |
| repo->last = prev; |
| if (prev != NULL) { |
| prev->next = NULL; |
| } |
| } |
| repo->record_count -= 1; |
| repo->size -= record->size; |
| free(record->data); |
| free(record); |
| |
| return 0; |
| } |
| |
| LIBPLDM_ABI_TESTING |
| int pldm_pdr_remove_fru_record_set_by_rsi(pldm_pdr *repo, uint16_t fru_rsi, |
| bool is_remote, |
| uint32_t *record_handle) |
| { |
| pldm_pdr_record *record; |
| pldm_pdr_record *prev = NULL; |
| size_t skip_data_size = sizeof(uint32_t) + sizeof(uint8_t); |
| uint8_t hdr_type = 0; |
| int rc = 0; |
| int match; |
| |
| if (!repo || !record_handle) { |
| return -EINVAL; |
| } |
| record = repo->first; |
| |
| while (record != NULL) { |
| struct pldm_msgbuf _buf; |
| struct pldm_msgbuf *buf = &_buf; |
| rc = pldm_msgbuf_init_errno(buf, PDR_FRU_RECORD_SET_MIN_SIZE, |
| record->data, record->size); |
| if (rc) { |
| return rc; |
| } |
| pldm_msgbuf_span_required(buf, skip_data_size, NULL); |
| if ((rc = pldm_msgbuf_extract(buf, hdr_type))) { |
| return rc; |
| } |
| if (record->is_remote != is_remote || |
| hdr_type != PLDM_PDR_FRU_RECORD_SET) { |
| goto cleanup; |
| } |
| match = pldm_pdr_record_matches_fru_rsi(record, fru_rsi); |
| if (match < 0) { |
| return match; |
| } |
| if (match) { |
| *record_handle = record->record_handle; |
| prev = pldm_pdr_get_prev_record(repo, record); |
| return pldm_pdr_remove_record(repo, record, prev); |
| } |
| cleanup: |
| rc = pldm_msgbuf_destroy(buf); |
| if (rc) { |
| return rc; |
| } |
| record = record->next; |
| } |
| return rc; |
| } |