From nobody Mon Apr 29 20:29:12 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+79269+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+79269+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1628853454; cv=none; d=zohomail.com; s=zohoarc; b=Bwty44nipGtEqR4DEEdcSqsxRN/ulxXFfbP/UO0Wx5cuxIwAxWaGEIVvWu2M86rASVKqXcUTjzHhcbHK6Daj8JN9063AnmMALO/Pbs/QZLgSEjtCZ8XAxDxCOVFh7OjfCcyYJaPTvNfWGi7qNDrcb63PPBTf0gz214W55UWrAMk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1628853454; h=Cc:Date:From:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Sender:Subject:To; bh=pzhsj3m8hhOeJBQh+wx1K8LK/LszihX5QdGiwUfwSw0=; b=nBzdcDXi3YT8TltfTrAIxktkPBmIEPgX6TTz/Vk2HbmngRdS9+ovvwAwUmX/oCXGYwS3k1E+Rzk0ilSBNdCqaQyDYvbzqElZsKtKk093pxJBbAzLZcWRWAP3NGPSYEZFQuU7agKGbg1Up/IQqu/siCzIuXKtFB1joJdoUtLz+p4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+79269+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1628853454380332.59559033466496; Fri, 13 Aug 2021 04:17:34 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id o19aYY1788612xT0gPGo49Ou; Fri, 13 Aug 2021 04:17:33 -0700 X-Received: from mx0a-002e3701.pphosted.com (mx0a-002e3701.pphosted.com [148.163.147.86]) by mx.groups.io with SMTP id smtpd.web08.35235.1628853452978034616 for ; Fri, 13 Aug 2021 04:17:33 -0700 X-Received: from pps.filterd (m0134421.ppops.net [127.0.0.1]) by mx0b-002e3701.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 17DBFG4V010522; Fri, 13 Aug 2021 11:17:26 GMT X-Received: from g2t2354.austin.hpe.com (g2t2354.austin.hpe.com [15.233.44.27]) by mx0b-002e3701.pphosted.com with ESMTP id 3adhefatsd-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 13 Aug 2021 11:17:25 +0000 X-Received: from g2t2360.austin.hpecorp.net (g2t2360.austin.hpecorp.net [16.196.225.135]) by g2t2354.austin.hpe.com (Postfix) with ESMTP id 012559D; Fri, 13 Aug 2021 11:17:24 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g2t2360.austin.hpecorp.net (Postfix) with ESMTP id 6FB8337; Fri, 13 Aug 2021 11:17:22 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Nickle Wang , Liming Gao Subject: [edk2-devel] [PATCH V2] RedfishClientPkg/ConvertLib: Common code and header files Date: Fri, 13 Aug 2021 18:21:38 +0800 Message-Id: <20210813102138.12201-1-abner.chang@hpe.com> X-Proofpoint-ORIG-GUID: vMgVjvkOjIJ9BUrrjP-UdCf9ixhRcGfh X-Proofpoint-GUID: vMgVjvkOjIJ9BUrrjP-UdCf9ixhRcGfh X-Proofpoint-UnRewURL: 0 URL was un-rewritten MIME-Version: 1.0 X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,abner.chang@hpe.com X-Gm-Message-State: AjSfcC7udBGKyMDq7RP75uaZx1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1628853453; bh=+zavgQHXJrtozXtSSZtZC0asmkytZtLylTCnOi+B7Dg=; h=Cc:Date:From:Reply-To:Subject:To; b=dPDfVJRJTv3Si8wRPsS16EeurAS8PTM4HC6VnW29C+yH4C8lPT++19nPeT4NI3reRLx 9kKkhV6YjZeU6USQfxBoz9g1BakPAKti1nl6mrW/xmoDRF3EJiedYhuA+duijaXuV+HzQ RpqLnwkSdG9YnHBtWGva17JaNdYMcS1hkqk= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1628853456071100002 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" ConverterLib/ is the folder of script-generated JSON to C library for the each Redfish schema. The common code and header files in this patch are used by those libraries. Signed-off-by: Abner Chang Cc: Nickle Wang Cc: Liming Gao Reviewed-by: Nickle Wang --- .../ConverterLib/include/RedfishCsCommon.h | 125 ++ .../ConverterLib/include/RedfishDataTypeDef.h | 46 + .../src/RedfishCsMemoryInternal.h | 40 + .../ConverterLib/src/RedfishCsCommon.c | 1169 +++++++++++++++++ .../ConverterLib/src/RedfishCsMemory.c | 197 +++ 5 files changed, 1577 insertions(+) create mode 100644 RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h create mode 100644 RedfishClientPkg/ConverterLib/include/RedfishDataTypeDe= f.h create mode 100644 RedfishClientPkg/ConverterLib/src/RedfishCsMemoryIntern= al.h create mode 100644 RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c create mode 100644 RedfishClientPkg/ConverterLib/src/RedfishCsMemory.c diff --git a/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h b/Redf= ishClientPkg/ConverterLib/include/RedfishCsCommon.h new file mode 100644 index 0000000000..3084977cdf --- /dev/null +++ b/RedfishClientPkg/ConverterLib/include/RedfishCsCommon.h @@ -0,0 +1,125 @@ +/** @file + + (C) Copyright 2018-2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + + Copyright Notice: + Copyright 2019-2021 Distributed Management Task Force, Inc. All rights r= eserved. + License: BSD 3-Clause License. For full text see link: https://github.co= m/DMTF/Redfish-JSON-C-Struct-Converter/blob/master/LICENSE.md +**/ +#ifndef REDFISH_CS_COMMON_H_ +#define REDFISH_CS_COMMON_H_ + +#include "RedfishDataTypeDef.h" + +RedfishCS_Link * InitializeLinkHead (RedfishCS_Link *LinkHead); +RedfishCS_Link * InsertHeadLink (RedfishCS_Link *ListHead, RedfishCS_Link = *Entry); +RedfishCS_Link * InsertTailLink (RedfishCS_Link *ListHead, RedfishCS_Link = *Entry); +RedfishCS_Link * GetFirstLink (const RedfishCS_Link *List); +RedfishCS_Link * GetLastLink (const RedfishCS_Link *List); +RedfishCS_Link * GetNextLink (const RedfishCS_Link *List, const RedfishCS_= Link *Node); +RedfishCS_Link * GetPreviousLink ( const RedfishCS_Link *List, const Redfi= shCS_Link *Node); +RedfishCS_Link *RemoveLink ( const RedfishCS_Link *Link); +RedfishCS_bool IsLinkEmpty (const RedfishCS_Link *LinkHead); +RedfishCS_bool IsLinkAtEnd (const RedfishCS_Link *LinkHead, const RedfishC= S_Link *ThisLink); +RedfishCS_status recordCsRootMemory (void *memCs); +RedfishCS_status allocateRecordCsMemory (RedfishCS_void *rootCs, RedfishCS= _uint32 size, RedfishCS_void **Dst); +RedfishCS_status allocateRecordCsZeroMemory (RedfishCS_void *rootCs, Redfi= shCS_uint32 size, RedfishCS_void **Dst); +RedfishCS_status allocateArrayRecordCsMemory(RedfishCS_void *rootCs, Redfi= shCS_uint32 ArrayInstanceSize, RedfishCS_uint64 ArraySize, RedfishCS_void *= *Dst); +RedfishCS_status allocateDuplicateStr (void *Cs, char *Str, void **DstBuff= er); +RedfishCS_status DestoryCsMemory (RedfishCS_void *rootCs); + +typedef struct _RedfishCS_char_Array RedfishCS_char_Array; +typedef struct _RedfishCS_int64_Array RedfishCS_int64_Array; +typedef struct _RedfishCS_bool_Array RedfishCS_bool_Array; +typedef struct _RedfishCS_Link_Array RedfishCS_Link_Array; +typedef struct _RedfishCS_EmptyProp_KeyValue RedfishCS_EmptyProp_KeyValue; + +typedef enum { + RedfishCS_Type_CS =3D 1, + RedfishCS_Type_CS_EmptyProp, + RedfishCS_Type_JSON, + RedfishCS_Type_Uri +} RedfishCS_Type; + +typedef struct _RedfishCS_Header { + RedfishCS_Link LinkEntry; + RedfishCS_Type ResourceType; + RedfishCS_char *KeyName; + RedfishCS_char *ThisUri; +} RedfishCS_Header; + +typedef struct _RedfishCS_Type_Uri_Data { + RedfishCS_Header Header; + RedfishCS_char *Uri; +} RedfishCS_Type_Uri_Data; + +typedef struct _RedfishCS_Type_CS_Data { + RedfishCS_Header Header; + // + // Followed by C structure of resource. + // +} RedfishCS_Type_CS_Data; + +typedef struct _RedfishCS_Type_JSON_Data { + RedfishCS_Header Header; + RedfishCS_char *JsonText; +} RedfishCS_Type_JSON_Data; + +typedef struct _RedfishCS_Number { + RedfishCS_uint16 Value; + RedfishCS_uint16 MaxValue; + RedfishCS_uint16 MinValue; +} RedfishCS_Number; + +typedef struct _RedfishCS_char_Array { + RedfishCS_char_Array *Next; + RedfishCS_char *ArrayValue; +} RedfishCS_char_Array; + +typedef struct _RedfishCS_int64_Array { + RedfishCS_int64_Array *Next; + RedfishCS_int64 *ArrayValue; +} RedfishCS_int64_Array; + +typedef struct _RedfishCS_bool_Array { + RedfishCS_bool_Array *Next; + RedfishCS_bool *ArrayValue; +} RedfishCS_bool_Array; + +typedef struct _RedfishCS_Link_Array { + RedfishCS_Link_Array *Next; + RedfishCS_Link *ArrayValue; +} RedfishCS_Link_Array; + +typedef enum { + RedfishCS_Vague_DataType_String =3D 1, + RedfishCS_Vague_DataType_Int64, + RedfishCS_Vague_DataType_Bool +} RedfishCS_Vague_DataType; + +typedef union { + RedfishCS_char *CharPtr; + RedfishCS_bool *BoolPtr; + RedfishCS_int64 *Int64Ptr; +} RedfishCS_Vague_Ptr; + +typedef struct _RedfishCS_Vague { + RedfishCS_Vague_DataType DataType; + RedfishCS_Vague_Ptr DataValue; +} RedfishCS_Vague; + +typedef struct _RedfishCS_EmptyProp_KeyValue { + RedfishCS_EmptyProp_KeyValue *NextKeyValuePtr; + RedfishCS_char *KeyNamePtr; + RedfishCS_Vague *Value; +} RedfishCS_EmptyProp_KeyValue; + +typedef struct _RedfishCS_Type_EmptyProp_CS_Data { + RedfishCS_Header Header; + RedfishCS_uint32 NunmOfProperties; + RedfishCS_EmptyProp_KeyValue *KeyValuePtr; +} RedfishCS_Type_EmptyProp_CS_Data; + +#endif diff --git a/RedfishClientPkg/ConverterLib/include/RedfishDataTypeDef.h b/R= edfishClientPkg/ConverterLib/include/RedfishDataTypeDef.h new file mode 100644 index 0000000000..23d13a854c --- /dev/null +++ b/RedfishClientPkg/ConverterLib/include/RedfishDataTypeDef.h @@ -0,0 +1,46 @@ +/** @file + + (C) Copyright 2018-2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + + Copyright Notice: + Copyright 2019-2021 Distributed Management Task Force, Inc. All rights r= eserved. + License: BSD 3-Clause License. For full text see link: https://github.co= m/DMTF/Redfish-JSON-C-Struct-Converter/blob/master/LICENSE.md +**/ +#ifndef REDFISH_CS_DATA_TYPE_H_ +#define REDFISH_CS_DATA_TYPE_H_ + +#include + +typedef char RedfishCS_char; +typedef int RedfishCS_bool; +typedef signed char RedfishCS_int8; +typedef unsigned char RedfishCS_uint8; +typedef int RedfishCS_int16; +typedef int RedfishCS_int; +typedef unsigned int RedfishCS_uint16; +typedef long int RedfishCS_int32; +typedef unsigned long int RedfishCS_uint32; +typedef long long RedfishCS_int64; +typedef unsigned long long RedfishCS_uint64; +typedef void RedfishCS_void; + +#define RedfishCS_boolean_false 0 +#define RedfishCS_boolean_true 1 + +typedef RedfishCS_int64 RedfishCS_status; +#define RedfishCS_status_success 0 +#define RedfishCS_status_unsupported -1 +#define RedfishCS_status_invalid_parameter -2 +#define RedfishCS_status_insufficient_memory -3 +#define RedfishCS_status_not_found -4 +#define RedfishCS_status_unknown_error -5 + +typedef struct _RedfishCS_Link RedfishCS_Link; +struct _RedfishCS_Link { + RedfishCS_Link *BackLink; + RedfishCS_Link *ForwardLink; +}; + +#endif diff --git a/RedfishClientPkg/ConverterLib/src/RedfishCsMemoryInternal.h b/= RedfishClientPkg/ConverterLib/src/RedfishCsMemoryInternal.h new file mode 100644 index 0000000000..9d248bfd9f --- /dev/null +++ b/RedfishClientPkg/ConverterLib/src/RedfishCsMemoryInternal.h @@ -0,0 +1,40 @@ +/** @file + + (C) Copyright 2018-2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + + Copyright Notice: + Copyright 2019-2021 Distributed Management Task Force, Inc. All rights r= eserved. + License: BSD 3-Clause License. For full text see link: https://github.co= m/DMTF/Redfish-JSON-C-Struct-Converter/blob/master/LICENSE.md +**/ +#ifndef REDFISH_CS_MEMORY_INTERNAL_H_ +#define REDFISH_CS_MEMORY_INTERNAL_H_ + +#include "RedfishDataTypeDef.h" + +RedfishCS_Link * InitializeLinkHead (RedfishCS_Link *LinkHead); +RedfishCS_Link * InsertHeadLink (RedfishCS_Link *ListHead, RedfishCS_Link = *Entry); +RedfishCS_Link * InsertTailLink (RedfishCS_Link *ListHead, RedfishCS_Link = *Entry); +RedfishCS_Link * GetFirstLink (const RedfishCS_Link *List); +RedfishCS_Link * GetLastLink (const RedfishCS_Link *List); +RedfishCS_Link * GetNextLink (const RedfishCS_Link *List, const RedfishCS_= Link *Node); +RedfishCS_Link * GetPreviousLink ( const RedfishCS_Link *List, const Redfi= shCS_Link *Node); +RedfishCS_Link *RemoveLink ( const RedfishCS_Link *Link); +RedfishCS_bool IsLinkEmpty (const RedfishCS_Link *LinkHead); +RedfishCS_bool IsLinkAtEnd (const RedfishCS_Link *LinkHead, const RedfishC= S_Link *ThisLink); + +typedef struct _RedfishCS_Internal_memory_link { + RedfishCS_Link nextLink; + void *memoryPtr; +} RedfishCS_Internal_memory_link; + +typedef struct _RedfishCS_Internal_memory_root { + RedfishCS_Link nextRoot; + RedfishCS_Link memBlocks; + void *CsPtr; +} RedfishCS_Internal_memory_root; + +#endif + + diff --git a/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c b/RedfishC= lientPkg/ConverterLib/src/RedfishCsCommon.c new file mode 100644 index 0000000000..6064dde3e4 --- /dev/null +++ b/RedfishClientPkg/ConverterLib/src/RedfishCsCommon.c @@ -0,0 +1,1169 @@ +/** @file + + (C) Copyright 2018-2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + + Copyright Notice: + Copyright 2019-2021 Distributed Management Task Force, Inc. All rights r= eserved. + License: BSD 3-Clause License. For full text see link: https://github.co= m/DMTF/Redfish-JSON-C-Struct-Converter/blob/master/LICENSE.md +**/ + +#include "RedfishCsCommon.h" +#include "RedfishCsMemoryInternal.h" +#include +#include +#include + +RedfishCS_status GetRedfishPropertyVague(void *Cs, json_t *JsonObj, char *= Key, RedfishCS_Vague **DstBuffer); + +/** + This function initiates a Redfish C Structure link. + + ListHead The link list entry. + Return the list head. + +**/ +RedfishCS_Link *InitializeLinkHead (RedfishCS_Link *ListHead) +{ + ListHead->ForwardLink =3D ListHead; + ListHead->BackLink =3D ListHead; + return ListHead; +} + +/** + This function inserts the list to list head. + + ListHead The link list head. + Entry The list to insert. + + Return the list head. + +**/ +RedfishCS_Link *InsertHeadLink (RedfishCS_Link *ListHead, RedfishCS_Link *= Entry) +{ + Entry->ForwardLink =3D ListHead->ForwardLink; + Entry->BackLink =3D ListHead; + Entry->ForwardLink->BackLink =3D Entry; + ListHead->ForwardLink =3D Entry; + return ListHead; +} + +/** + This function inserts the list to list tail. + + ListHead The link list head. + Entry The list to insert. + + Return the list head. + +**/ +RedfishCS_Link *InsertTailLink (RedfishCS_Link *ListHead, RedfishCS_Link *= Entry) +{ + Entry->ForwardLink =3D ListHead; + Entry->BackLink =3D ListHead->BackLink; + Entry->BackLink->ForwardLink =3D Entry; + ListHead->BackLink =3D Entry; + return ListHead; +} + +/** + This function gets the first list from the list head. + + List The link list head. + + Return the first list * + +**/ +RedfishCS_Link *GetFirstLink (const RedfishCS_Link *List) +{ + return List->ForwardLink; +} + +/** + This function gets the last list from the list head. + + List The link list head. + + Return the last list. + +**/ +RedfishCS_Link *GetLastLink (const RedfishCS_Link *List) +{ + return List->BackLink; +} + +/** + This function gets the next list of Node. + + List The link list head. + Node The list we will get the next list from. + + Return the next list. + +**/ +RedfishCS_Link *GetNextLink (const RedfishCS_Link *List, const RedfishCS_L= ink *Node) +{ + return Node->ForwardLink; +} + +/** + This function gets the previous list of Node. + + List The link list head. + Node The list we will get the previous list from. + + Return the previous RedfishCS_Link * + +**/ +RedfishCS_Link *GetPreviousLink (const RedfishCS_Link *List, const Redfish= CS_Link *Node) +{ + return Node->BackLink; +} +/** + This function removes a list. + + Link The list to be removed. + + Return the next list. + +**/ +RedfishCS_Link *RemoveLink (const RedfishCS_Link *Link) +{ + Link->ForwardLink->BackLink =3D Link->BackLink; + Link->BackLink->ForwardLink =3D Link->ForwardLink; + return Link->ForwardLink; +} + +/** + This function checks if the list is empty. + + LinkHead The list head. + + Return true if it is empty otherwise it is not empty. + +**/ +RedfishCS_bool IsLinkEmpty (const RedfishCS_Link *LinkHead) +{ + return (RedfishCS_bool)(LinkHead->ForwardLink =3D=3D LinkHead); +} + +/** + This function checks if the list is at the end. + + LinkHead The list head. + ThisLink The list to check. + + Return true if it is at the end otherwise it is not. + +**/ +RedfishCS_bool IsLinkAtEnd (const RedfishCS_Link *LinkHead, const RedfishC= S_Link *ThisLink) +{ + return (RedfishCS_bool)(ThisLink->ForwardLink =3D=3D LinkHead); +} + +/** + This function duplicates a string. + + Cs The CStructure instance that owns the string. + Str String to be duplicated. + DstBuffer The buffer to retrieve the string. + + Return RedfishCS_status. + +**/ +RedfishCS_status allocateDuplicateStr (void *Cs, char *Str, void **DstBuff= er) +{ + RedfishCS_status Status; + + if (Str =3D=3D NULL || strlen(Str) =3D=3D 0) { + *DstBuffer =3D NULL; + return RedfishCS_status_success; + } + Status =3D allocateRecordCsMemory(Cs, (RedfishCS_int)strlen(Str) + 1, (v= oid **)DstBuffer); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + memcpy (*DstBuffer, Str, strlen(Str) + 1); + return RedfishCS_status_success; +} + +/** + This function creates an URI type CS by the Odata ID. + + JsonOj JSON object which has odata ID key. + ParentUri The parent URI of odata ID. + CsTypeUriData The pointer to retrieve the RedfishCS_Type_Uri_Data. + + Return RedfishCS_status. + +**/ +RedfishCS_status CreateCsUriByOdataId (json_t *JsonOj, RedfishCS_char *Par= entUri, RedfishCS_Type_Uri_Data **CsTypeUriData) +{ + json_t *TempJsonObj; + RedfishCS_Type_Uri_Data *CsTypeUri; + + CsTypeUri =3D NULL; + TempJsonObj =3D json_object_get(JsonOj, "@odata.id"); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + CsTypeUri =3D malloc (sizeof (RedfishCS_Type_Uri_Data)); + if (CsTypeUri =3D=3D NULL) { + return RedfishCS_status_insufficient_memory; + } + InitializeLinkHead (&CsTypeUri->Header.LinkEntry); + CsTypeUri->Header.ResourceType =3D RedfishCS_Type_Uri; + CsTypeUri->Header.ThisUri =3D ParentUri; + CsTypeUri->Header.KeyName =3D (RedfishCS_char *)strdup ("@odata.id"); + CsTypeUri->Uri =3D (RedfishCS_char *)strdup (json_string_value (TempJson= Obj)); + *CsTypeUriData =3D CsTypeUri; + return RedfishCS_status_success; +} + +/** + This function creates URI type CS by node. + + Cs The CStructure instance owns the string. + JsonOj JSON object which has NodeName key. + NodeName The JSON key name. + ParentUri The parent URI of odata ID. + CsTypeUriData The pointer to retrieve the RedfishCS_Type_Uri_Data. + + Return RedfishCS_status. + +**/ +RedfishCS_status CreateCsUriByNode (void *Cs, json_t *JsonOj, RedfishCS_ch= ar *NodeName, RedfishCS_char *ParentUri, RedfishCS_Type_Uri_Data **CsTypeUr= iData) +{ + json_t *TempJsonObj; + json_t *TempJsonObj2; + RedfishCS_Type_Uri_Data *CsTypeUri; + RedfishCS_status Status; + + CsTypeUri =3D NULL; + + if (NodeName !=3D NULL) { + TempJsonObj =3D json_object_get(JsonOj, NodeName); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + } else { + if (JsonOj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + TempJsonObj =3D JsonOj; + } + + TempJsonObj2 =3D json_object_get(TempJsonObj, "@odata.id"); + if (TempJsonObj2 !=3D NULL) { + Status =3D allocateRecordCsMemory (Cs, sizeof (RedfishCS_Type_Uri_Data= ), (void **)&CsTypeUri); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + InitializeLinkHead (&CsTypeUri->Header.LinkEntry); + CsTypeUri->Header.ResourceType =3D RedfishCS_Type_Uri; + CsTypeUri->Header.ThisUri =3D ParentUri; + Status =3D allocateDuplicateStr (Cs, NodeName, (void **)&CsTypeUri->He= ader.KeyName); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + *CsTypeUriData =3D CsTypeUri; + Status =3D allocateDuplicateStr (Cs, (char *)json_string_value (TempJs= onObj2), (void **)&CsTypeUri->Uri); + return Status; + } + return RedfishCS_status_invalid_parameter; +} +/** + This function creates JSON type CS by node. + + Cs The CStructure instance owns the string. + JsonOj JSON object which has NodeName key. + NodeName The JSON key name. + ParentUri The parent URI of odata ID. + CsTypeJsonData The pointer to retrieve the RedfishCS_Type_JSON_Data. + + Return RedfishCS_status. + +**/ +RedfishCS_status CreateCsJsonByNode (void *Cs, json_t *JsonObj, RedfishCS_= char *NodeName, RedfishCS_char *ParentUri, RedfishCS_Type_JSON_Data **CsTyp= eJsonData) +{ + json_t *TempJsonObj; + RedfishCS_Type_JSON_Data *CsTypeJson; + RedfishCS_char *TempChar; + RedfishCS_char *DumpStr; + RedfishCS_status Status; + + CsTypeJson =3D NULL; + if (NodeName !=3D NULL) { + TempJsonObj =3D json_object_get(JsonObj, NodeName); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + } else { + // Dump JSON from JsonObj. + TempJsonObj =3D JsonObj; + } + TempChar =3D json_dumps ((const json_t *)TempJsonObj, JSON_INDENT (2)); + if (TempChar !=3D NULL) { + Status =3D allocateRecordCsMemory (Cs, sizeof (RedfishCS_Type_JSON_Dat= a), (void **)&CsTypeJson); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + Status =3D allocateRecordCsMemory (Cs, (RedfishCS_int)strlen (TempChar= ) + 1, (void **)&DumpStr); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + strncpy (DumpStr, TempChar, strlen (TempChar) + 1); + InitializeLinkHead(&CsTypeJson->Header.LinkEntry); + CsTypeJson->Header.ResourceType =3D RedfishCS_Type_JSON; + CsTypeJson->Header.ThisUri =3D ParentUri; + Status =3D allocateDuplicateStr (Cs, NodeName, (void **)&CsTypeJson->H= eader.KeyName); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + CsTypeJson->JsonText =3D DumpStr; + *CsTypeJsonData =3D CsTypeJson; + return RedfishCS_status_success; + } + return RedfishCS_status_invalid_parameter; +} + +/** + This function creates an empty property type CS by node. + + Cs The CStructure instance owns the string. + JsonOj JSON object which has the NodeName. + NodeName The JSON key name. + ParentUri The parent URI of odata ID. + CsTypeEmptyPropCSData The pointer to retrieve the CsTypeEmptyPropCSData. + NunmOfProperties Number of properties in CS. + + Return RedfishCS_status. + +**/ +RedfishCS_status CreateEmptyPropCsJson(RedfishCS_void *Cs, json_t *JsonObj= , RedfishCS_char *NodeName, RedfishCS_char *ParentUri, RedfishCS_Type_Empty= Prop_CS_Data **CsTypeEmptyPropCSData, RedfishCS_uint32 NunmOfProperties) { + json_t *TempJsonObj; + RedfishCS_status Status; + RedfishCS_Type_EmptyProp_CS_Data *CsTypeEmptyPropCS; + RedfishCS_char *KeyName; + json_t *KeyValueObj; + RedfishCS_void *n; + RedfishCS_EmptyProp_KeyValue **KeyValuePtr; + RedfishCS_EmptyProp_KeyValue *KeyValue; + + CsTypeEmptyPropCS =3D NULL; + if (NodeName !=3D NULL) { + TempJsonObj =3D json_object_get(JsonObj, NodeName); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + } + Status =3D allocateRecordCsMemory(Cs, sizeof(RedfishCS_Type_EmptyProp_CS= _Data), (void **)&CsTypeEmptyPropCS); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + InitializeLinkHead(&CsTypeEmptyPropCS->Header.LinkEntry); + CsTypeEmptyPropCS->Header.ResourceType =3D RedfishCS_Type_CS_EmptyProp; + CsTypeEmptyPropCS->Header.ThisUri =3D ParentUri; + Status =3D allocateDuplicateStr(Cs, NodeName, (void **)&CsTypeEmptyPropC= S->Header.KeyName); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + CsTypeEmptyPropCS->NunmOfProperties =3D NunmOfProperties; + // + // Create instance for each key-value. + // + KeyValuePtr =3D &CsTypeEmptyPropCS->KeyValuePtr; + json_object_foreach_safe(TempJsonObj, n, KeyName, KeyValueObj) { + Status =3D allocateRecordCsMemory(Cs, sizeof(RedfishCS_EmptyProp_KeyVa= lue), (void **)&KeyValue); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + Status =3D allocateDuplicateStr(Cs, (char *)KeyName, (void **)&KeyValu= e->KeyNamePtr); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + Status =3D GetRedfishPropertyVague(Cs, TempJsonObj, (char *)KeyName, &= KeyValue->Value); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + + *KeyValuePtr =3D KeyValue; + KeyValuePtr =3D &KeyValue->NextKeyValuePtr; + } + + *CsTypeEmptyPropCSData =3D CsTypeEmptyPropCS; + return RedfishCS_status_success; +} +/** + This function checks if property type is supported. + + JsonOj JSON object of this property. + + Return RedfishCS_bool. + +**/ +RedfishCS_bool CheckSupportedPropTypeInEmptyProperty(json_t *JsonObj) { + // + // Only support below property types for the property is declared as + // empty property in schema. + // e.g. "properties": {} + // + if (json_is_string(JsonObj) || + json_is_integer(JsonObj) || + //json_is_real(JsonObj) || + json_is_number(JsonObj) || + json_is_boolean(JsonObj)) { + return RedfishCS_boolean_true; + } + return RedfishCS_boolean_false; +} + +/** + This function checks the properties in a empty property type JSON object. + Also returns the number of properties in NumOfProperty. + + JsonOj JSON object + NumOfProperty Pointer to retrieve the number of property in JSON object. + + Return RedfishCS_bool. + +**/ +RedfishCS_bool CheckEmptyPropJsonObject(json_t *JsonObj, RedfishCS_uint32 = *NumOfProperty) +{ + RedfishCS_char *NewKey; + json_t *Value; + RedfishCS_void *n; + RedfishCS_uint32 Num; + + Num =3D 0; + json_object_foreach_safe(JsonObj, n, NewKey, Value) { + if (!CheckSupportedPropTypeInEmptyProperty(Value)) { + return RedfishCS_boolean_false; + } + Num ++; + } + if (NumOfProperty !=3D NULL) { + *NumOfProperty =3D Num; + } + return RedfishCS_boolean_true; +} +/** + This function checks if this is a supported Redfish resource. + + Odata_Type The string to Odata type. + NameSpace The string to the Redfish schema name space. + Version The string to the Redfish schema version. + DataType The string to the data type defined in Redfish schema. + + Return RedfishCS_bool. + +**/ +RedfishCS_bool SupportedRedfishResource (RedfishCS_char *Odata_Type, Redfi= shCS_char *NameSpace, RedfishCS_char *Version, RedfishCS_char *DataType) +{ + RedfishCS_char *TargetDataType; + + if (Odata_Type =3D=3D NULL || NameSpace =3D=3D NULL || DataType =3D=3D N= ULL) { + return RedfishCS_boolean_false; + } + if (Version !=3D NULL) { + TargetDataType =3D malloc(strlen(NameSpace) + strlen(Version) + strlen= (DataType) + 16); // Plus 16 bytes to make more room. + = // Actually we just need 1 byte for "#" + = // Two bytes for "." and one byte for NULL terminator. + } else { + TargetDataType =3D malloc(strlen(NameSpace) + strlen(DataType) + 16); = // Plus 16 bytes to make more room. + //= Actually we just need 1 byte for "#" + //= Two bytes for "." and one byte for NULL terminator. + } + if (TargetDataType =3D=3D NULL) { + return RedfishCS_boolean_false; + } + TargetDataType [0] =3D 0; // Insert NULL terminator. + strcat (TargetDataType, "#"); + strcat (TargetDataType, NameSpace); + strcat (TargetDataType, "."); + if (Version !=3D NULL && (strcmp (Version, "noversioned") !=3D 0)) { + strcat(TargetDataType, Version); + strcat (TargetDataType, "."); + } + strcat (TargetDataType, DataType); + if (strcmp (Odata_Type, TargetDataType) =3D=3D 0) { + return RedfishCS_boolean_true; + } + free (TargetDataType); + return RedfishCS_boolean_false; +} +/** + This function creates JSON or URI type CS according to the + number of properties in JSON object. + + Cs he CStructure instance owns the new created CS. + JsonObj JSON object which has NodeName key. + NodeName The key name in JSON object. + ParentUri The parent URI. + LinkHead The list head to link with the new CS. + + Return RedfishCS_status. + +**/ +RedfishCS_status +CreateCsUriOrJsonByNode (void *Cs, json_t *JsonObj, RedfishCS_char *NodeNa= me, RedfishCS_char *ParentUri, RedfishCS_Link *LinkHead) +{ + json_t *JsonObjTemp; + RedfishCS_Type_Uri_Data *CsTypeUri; + RedfishCS_Type_JSON_Data *CsTypeJson; + RedfishCS_status Status; + + Status =3D RedfishCS_status_invalid_parameter; + JsonObjTemp =3D json_object_get (JsonObj, NodeName); + if (JsonObjTemp =3D=3D NULL) { + return RedfishCS_status_not_found; + } + if (json_object_size(JsonObjTemp) =3D=3D 1) { + Status =3D CreateCsUriByNode (Cs, JsonObj, NodeName, ParentUri, &CsTyp= eUri); + if (Status =3D=3D RedfishCS_status_success) { + InsertTailLink (LinkHead, &CsTypeUri->Header.LinkEntry); + return RedfishCS_status_success; + } + } else { + Status =3D CreateCsJsonByNode (Cs, JsonObj, NodeName, ParentUri, &CsTy= peJson); + if (Status =3D=3D RedfishCS_status_success) { + InsertTailLink (LinkHead, &CsTypeJson->Header.LinkEntry); + return RedfishCS_status_success; + } + } + return Status; +} +/** + This function creates JSON or URI array type CS according to the + number of properties in JSON object. + + Cs he CStructure instance owns the new created CS. + JsonObj JSON object which has NodeName. + NodeName The key name in JSON object. + ParentUri The parent URI. + LinkHead The list head to link with the new CS. + + Return RedfishCS_status. + +**/ +RedfishCS_status +CreateCsUriOrJsonByNodeArray (void *Cs, json_t *JsonObj, RedfishCS_char *N= odeName, RedfishCS_char *ParentUri, RedfishCS_Link *LinkHead) +{ + json_t *JsonObjTemp; + json_t *JsonObjArray; + RedfishCS_Type_Uri_Data *CsTypeUri; + RedfishCS_Type_JSON_Data *CsTypeJson; + RedfishCS_status Status; + RedfishCS_uint16 ArrayIndex; + + Status =3D RedfishCS_status_invalid_parameter; + JsonObjTemp =3D json_object_get (JsonObj, NodeName); + if (JsonObjTemp =3D=3D NULL) { + return RedfishCS_status_not_found; + } + if (json_array_size (JsonObjTemp) =3D=3D 0) { + return RedfishCS_status_success; + } + for (ArrayIndex =3D 0; ArrayIndex < (RedfishCS_uint16)json_array_size (J= sonObjTemp); ArrayIndex ++) { + JsonObjArray =3D json_array_get (JsonObjTemp, (size_t)ArrayIndex); + if (JsonObjArray =3D=3D NULL) { + continue; + } + if (json_object_size(JsonObjArray) =3D=3D 1) { + Status =3D CreateCsUriByNode (Cs, JsonObjArray, NULL, ParentUri, &Cs= TypeUri); + if (Status =3D=3D RedfishCS_status_success) { + InsertTailLink (LinkHead, &CsTypeUri->Header.LinkEntry); + } + } else { + Status =3D CreateCsJsonByNode (Cs, JsonObjArray, NULL, ParentUri, &C= sTypeJson); + if (Status =3D=3D RedfishCS_status_success) { + InsertTailLink (LinkHead, &CsTypeJson->Header.LinkEntry); + } + } + } + return RedfishCS_status_success; +} +/** + This function creates JSON object and CS. + + JsonRawText JSON raw text. + ResourceType The Redfish resource type. + ResourceVersion The Redfish resource version. + TypeName The Redfish type name. + JsonObjReturned Pointer to retrieve JSON object. + Cs Pointer to retrieve CS. + size The size of CS. + + Return RedfishCS_status. + +**/ +RedfishCS_status +CreateJsonPayloadAndCs (char *JsonRawText, char *ResourceType, char *Resou= rceVersion, char *TypeName, json_t **JsonObjReturned, void **Cs, int size) +{ + json_t *TempJsonObj; + RedfishCS_char *TempChar; + RedfishCS_Header *Header; + void *TempCS; + + if (JsonRawText =3D=3D NULL || + ResourceType =3D=3D NULL || + TypeName =3D=3D NULL || + Cs =3D=3D NULL || + size =3D=3D 0 + ) { + return RedfishCS_status_invalid_parameter; + } + *JsonObjReturned =3D json_loads(JsonRawText, 0, NULL); + if (*JsonObjReturned =3D=3D NULL) { + return RedfishCS_status_unknown_error; + } + TempJsonObj =3D json_object_get(*JsonObjReturned, "@odata.type"); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + TempChar =3D (RedfishCS_char *)json_string_value(TempJsonObj); + if (TempChar =3D=3D NULL || ! SupportedRedfishResource (TempChar, Resour= ceType, ResourceVersion, TypeName)) { + return RedfishCS_status_unsupported; + } + TempCS =3D malloc (size); + if (TempCS =3D=3D NULL) { + return RedfishCS_status_insufficient_memory; + } + memset (TempCS, 0, size); + Header =3D (RedfishCS_Header *)TempCS; + Header->ResourceType =3D RedfishCS_Type_CS; + Header->KeyName =3D NULL; + InitializeLinkHead (&Header->LinkEntry); + *Cs =3D TempCS; + return recordCsRootMemory (TempCS); +} +/** + This function returns a Redfish string property. + + Cs The owner of this property. + JsonObj The JSON object has the Key. + Key The key in JSON object. + DstBuffer Pointer to retrieve a string. + + Return RedfishCS_status. + +**/ +RedfishCS_status GetRedfishPropertyStr (void *Cs, json_t *JsonObj, char *K= ey, RedfishCS_char **DstBuffer) +{ + json_t *TempJsonObj; + RedfishCS_status Status; + + if (DstBuffer =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + *DstBuffer =3D NULL; + + TempJsonObj =3D json_object_get(JsonObj, Key); + if (TempJsonObj =3D=3D NULL){ + return RedfishCS_status_not_found; + } + Status =3D allocateDuplicateStr (Cs, (char *)json_string_value(TempJsonO= bj), (void **)DstBuffer); + return Status; +} +/** + This function returns a Redfish bool property. + + Cs The owner of this property. + JsonObj The JSON object has the Key. + Key The key in JSON object. + DstBuffer Pointer to retrieve a boolean. + + Return RedfishCS_status. + +**/ +RedfishCS_status GetRedfishPropertyBoolean (void *Cs, json_t *JsonObj, cha= r *Key, RedfishCS_bool **DstBuffer) +{ + json_t *TempJsonObj; + RedfishCS_status Status; + + if (DstBuffer =3D=3D NULL) { + return RedfishCS_status_not_found; + } + TempJsonObj =3D json_object_get(JsonObj, Key); + if (TempJsonObj =3D=3D NULL){ + return RedfishCS_status_not_found; + } + Status =3D allocateRecordCsMemory(Cs, sizeof(RedfishCS_bool), (void **)D= stBuffer); + if (Status !=3D RedfishCS_status_success){ + return Status; + } + if (json_is_true(TempJsonObj)) { + **DstBuffer =3D RedfishCS_boolean_true; + } else { + **DstBuffer =3D RedfishCS_boolean_false; + } + return RedfishCS_status_success; +} + +/** + This function returns Redfish a long long property. + + Cs The owner of this property. + JsonObj The JSON object has the Key. + Key The key in JSON object. + DstBuffer Pointer to retrieve a long long value. + + Return RedfishCS_status. + +**/ +RedfishCS_status GetRedfishPropertyInt64 (void *Cs, json_t *JsonObj, char = *Key, RedfishCS_int64 **Dst) +{ + RedfishCS_status Status; + const json_t *TempJsonObj; + + if (Dst =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + + TempJsonObj =3D json_object_get(JsonObj, Key); + if (TempJsonObj =3D=3D NULL) { + return RedfishCS_status_not_found; + } + Status =3D allocateRecordCsMemory(Cs, sizeof(RedfishCS_int64), (void **)= Dst); + if (Status !=3D RedfishCS_status_success){ + return Status; + } + **Dst =3D (RedfishCS_int64)json_integer_value(TempJsonObj); + return RedfishCS_status_success; +} +/** + This function returns a type-agnostic property. + + Cs The owner of this property. + JsonObj The JSON object has the Key. + Key The key in JSON object. + DstBuffer Pointer to retrieve a type agnostic value. + + Return RedfishCS_status. + +**/ +RedfishCS_status GetRedfishPropertyVague (void *Cs, json_t *JsonObj, char = *Key, RedfishCS_Vague **DstBuffer) +{ + json_t *TempJsonObj; + RedfishCS_status Status; + RedfishCS_Vague *VagueData; + + if (DstBuffer =3D=3D NULL) { + return RedfishCS_status_not_found; + } + TempJsonObj =3D json_object_get(JsonObj, Key); + if (TempJsonObj =3D=3D NULL){ + return RedfishCS_status_not_found; + } + Status =3D allocateRecordCsMemory(Cs, sizeof(RedfishCS_Vague), (void **)= &VagueData); + if (Status !=3D RedfishCS_status_success){ + return Status; + } + + if (json_is_string(TempJsonObj)) { + VagueData->DataType =3D RedfishCS_Vague_DataType_String; + Status =3D GetRedfishPropertyStr (Cs, JsonObj, Key, &VagueData->DataVa= lue.CharPtr); + } else if (json_is_integer(TempJsonObj)) { + VagueData->DataType =3D RedfishCS_Vague_DataType_Int64; + Status =3D GetRedfishPropertyInt64 (Cs, JsonObj, Key, &VagueData->Data= Value.Int64Ptr); + } else if (json_is_boolean(TempJsonObj)) { + VagueData->DataType =3D RedfishCS_Vague_DataType_Bool; + Status =3D GetRedfishPropertyBoolean (Cs, JsonObj, Key, &VagueData->Da= taValue.BoolPtr); + } else if (json_is_null(TempJsonObj)) { + *DstBuffer =3D NULL; // No value for this key + free (VagueData); + return RedfishCS_status_success; + } else { + return RedfishCS_status_unsupported; + } + if (Status =3D=3D RedfishCS_status_success) { + *DstBuffer =3D VagueData; + } + return Status; +} +/** + This function inserts a string JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + StringValue Value of string to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonStringObj (json_t *ParentJsonObj, char *Key, Re= dfishCS_char *StringValue) +{ + json_t *JsonValue; + RedfishCS_char NullStr[] =3D ""; + RedfishCS_char *InsertStr; + + InsertStr =3D StringValue; + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (InsertStr =3D=3D (char *)NULL) { + InsertStr =3D NullStr; + } + JsonValue =3D json_string(InsertStr); + if (JsonValue =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + if (json_object_set_new (ParentJsonObj, Key, JsonValue) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts a bool JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + BoolValue Value of a bool to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonBoolObj (json_t *ParentJsonObj, char *Key, Redf= ishCS_bool *BoolValue) +{ + json_t *JsonValue; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (BoolValue =3D=3D (RedfishCS_bool *)NULL) { + return RedfishCS_status_success; // No value for this key. + } + JsonValue =3D json_boolean((BOOLEAN)*BoolValue); + if (JsonValue =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + if (json_object_set_new (ParentJsonObj, Key, JsonValue) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts a long long value JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + Int64Value Value of a long long to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonInt64Obj (json_t *ParentJsonObj, char *Key, Red= fishCS_int64 *Int64Value) +{ + json_t *JsonValue; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (Int64Value =3D=3D (RedfishCS_int64 *)NULL) { + return RedfishCS_status_success; // No value for this key. + } + JsonValue =3D json_integer((json_int_t)*Int64Value); + if (JsonValue =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + if (json_object_set_new (ParentJsonObj, Key, JsonValue) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts a type-agnostic JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + VagueValue Value of a type agnostic value to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonVagueObj (json_t *ParentJsonObj, char *Key, Red= fishCS_Vague *VagueValue) +{ + json_t *JsonValue; + RedfishCS_char NullStr[] =3D ""; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (VagueValue =3D=3D (RedfishCS_Vague *)NULL) { + JsonValue =3D json_null(); // No value for this key. + } else if (VagueValue->DataType =3D=3D RedfishCS_Vague_DataType_String) { + if (VagueValue->DataValue.CharPtr =3D=3D NULL) { + JsonValue =3D json_string(NullStr); + } else { + JsonValue =3D json_string(VagueValue->DataValue.CharPtr); + } + } else if (VagueValue->DataType =3D=3D RedfishCS_Vague_DataType_Int64) { + JsonValue =3D json_integer((json_int_t)*VagueValue->DataValue.Int64Ptr= ); + } else if (VagueValue->DataType =3D=3D RedfishCS_Vague_DataType_Bool) { + JsonValue =3D json_boolean((BOOLEAN)*VagueValue->DataValue.BoolPtr); + } else { + return RedfishCS_status_invalid_parameter; + } + if (json_object_set_new (ParentJsonObj, Key, JsonValue) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts a link type JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + Link Value of a link type to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonLinkObj (json_t *JsonObj, char *Key, RedfishCS_= Link *Link) +{ + json_t *JsonTextObj; + RedfishCS_Type_JSON_Data *CsJsonHeader; + + if (Link =3D=3D NULL || JsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (IsLinkEmpty (Link)) { + return RedfishCS_status_success; + } + + CsJsonHeader =3D (RedfishCS_Type_JSON_Data *)GetFirstLink (Link); + if (CsJsonHeader->Header.ResourceType !=3D RedfishCS_Type_JSON && + CsJsonHeader->Header.ResourceType !=3D RedfishCS_Type_Uri) { + // Only support JSON/URI property for CStructure to JSON + return RedfishCS_status_unsupported; + } + if (CsJsonHeader->JsonText =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + + if (CsJsonHeader->Header.ResourceType =3D=3D RedfishCS_Type_JSON) { + JsonTextObj =3D json_loads(CsJsonHeader->JsonText, 0, NULL); + if (json_object_set_new (JsonObj, Key, JsonTextObj) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + } else { + JsonTextObj =3D json_string (CsJsonHeader->JsonText); + if (json_object_set_new (JsonObj, Key, JsonTextObj) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + } + + return RedfishCS_status_success; +} +/** + This function inserts an array of string JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + StringValueArray Value of a string array to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonStringArrayObj (json_t *ParentJsonObj, char *Ke= y, RedfishCS_char_Array *StringValueArray) +{ + json_t *ArrayJson; + json_t *ArrayMember; + RedfishCS_char_Array *NextArray; + RedfishCS_char NullStr[] =3D ""; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (StringValueArray =3D=3D (RedfishCS_char_Array *)NULL) { + return RedfishCS_status_success; // No value for this key. + } + ArrayJson =3D json_array(); + if (ArrayJson =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + NextArray =3D StringValueArray; + do { + if (NextArray->ArrayValue =3D=3D NULL) { + ArrayMember =3D json_string(NullStr); + } else { + ArrayMember =3D json_string(NextArray->ArrayValue); + } + if (json_array_append_new (ArrayJson, ArrayMember) !=3D 0) { + return RedfishCS_status_unsupported; + } + NextArray =3D NextArray->Next; + } while (NextArray !=3D NULL); + + if (json_object_set_new (ParentJsonObj, Key, ArrayJson) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts an array of bool JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + BoolValueArray Value of a bool array to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonBoolArrayObj (json_t *ParentJsonObj, char *Key,= RedfishCS_bool_Array *BoolValueArray) +{ + json_t *ArrayJson; + json_t *ArrayMember; + RedfishCS_bool_Array *NextArray; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (BoolValueArray =3D=3D (RedfishCS_bool_Array *)NULL) { + return RedfishCS_status_success; // No value for this key. + } + ArrayJson =3D json_array(); + if (ArrayJson =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + NextArray =3D BoolValueArray; + do { + ArrayMember =3D json_boolean((BOOLEAN)*NextArray->ArrayValue); + if (json_array_append_new (ArrayJson, ArrayMember) !=3D 0) { + return RedfishCS_status_unsupported; + } + NextArray =3D NextArray->Next; + } while (NextArray !=3D NULL); + + if (json_object_set_new (ParentJsonObj, Key, ArrayJson) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts an array of long long value JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + Int64ValueArray Value of a long long array to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonInt64ArrayObj (json_t *ParentJsonObj, char *Key= , RedfishCS_int64_Array *Int64ValueArray) +{ + json_t *ArrayJson; + json_t *ArrayMember; + RedfishCS_int64_Array *NextArray; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + if (Int64ValueArray =3D=3D (RedfishCS_int64_Array *)NULL) { + return RedfishCS_status_success; // No value for this key. + } + ArrayJson =3D json_array(); + if (ArrayJson =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + NextArray =3D Int64ValueArray; + do { + ArrayMember =3D json_integer(*NextArray->ArrayValue); + if (json_array_append_new (ArrayJson, ArrayMember) !=3D 0) { + return RedfishCS_status_unsupported; + } + NextArray =3D NextArray->Next; + } while (NextArray !=3D NULL); + + if (json_object_set_new (ParentJsonObj, Key, ArrayJson) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; +} +/** + This function inserts an array of link JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + LinkArray Value of a link array to insert. + + Return RedfishCS_status. + +**/ +RedfishCS_status InsertJsonLinkArrayObj (json_t *ParentJsonObj, char *Key,= RedfishCS_Link *LinkArray) +{ + json_t *ArrayJson; + json_t *ArrayMember; + RedfishCS_Type_Uri_Data *ThisLink; + + if (ParentJsonObj =3D=3D NULL) { + return RedfishCS_status_invalid_parameter; + } + + if (IsLinkEmpty (LinkArray)) { + return RedfishCS_status_success; + } + + ArrayJson =3D json_array(); + if (ArrayJson =3D=3D NULL) { + return RedfishCS_status_unsupported; + } + ThisLink =3D (RedfishCS_Type_Uri_Data *)GetFirstLink (LinkArray); + while (RedfishCS_boolean_true){ + if (ThisLink->Header.ResourceType !=3D RedfishCS_Type_Uri) { + return RedfishCS_status_invalid_parameter; + } + if (ThisLink->Uri !=3D (RedfishCS_char *)NULL) { + ArrayMember =3D json_string(ThisLink->Uri); + if (json_array_append_new (ArrayJson, ArrayMember) !=3D 0) { + return RedfishCS_status_unsupported; + } + } + if (IsLinkAtEnd (LinkArray, &ThisLink->Header.LinkEntry)) { + if (json_object_set_new (ParentJsonObj, Key, ArrayJson) =3D=3D -1) { + return RedfishCS_status_unsupported; + } + return RedfishCS_status_success; + } + ThisLink =3D (RedfishCS_Type_Uri_Data *)GetNextLink(LinkArray, &ThisLi= nk->Header.LinkEntry); + }; + return RedfishCS_status_success; +} +/** + This function inserts an empty property type JSON object. + + ParentJsonObj The parent JSON object + Key JSON key to insert. + Link Value of an empty property type link. + + Return RedfishCS_status. + +**/ +RedfishCS_status CsEmptyPropLinkToJson(json_t *ParentJsonObj, char *Key, R= edfishCS_Link *Link) { + RedfishCS_uint32 Index; + RedfishCS_Type_EmptyProp_CS_Data *EmptyProp_CS_Ptr; + RedfishCS_EmptyProp_KeyValue *KeyValuePtr; + json_t *JsonObj; + RedfishCS_status Status; + + EmptyProp_CS_Ptr =3D (RedfishCS_Type_EmptyProp_CS_Data *)GetFirstLink(Li= nk); + if (EmptyProp_CS_Ptr->Header.ResourceType !=3D RedfishCS_Type_CS_EmptyPr= op) { + return RedfishCS_status_unsupported; + } + + JsonObj =3D json_object(); + KeyValuePtr =3D EmptyProp_CS_Ptr->KeyValuePtr; + for (Index =3D 0; Index < EmptyProp_CS_Ptr->NunmOfProperties; Index++) { + Status =3D InsertJsonVagueObj(JsonObj, KeyValuePtr->KeyNamePtr, KeyVal= uePtr->Value); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + KeyValuePtr =3D KeyValuePtr->NextKeyValuePtr; + } + if (json_object_set_new(ParentJsonObj, Key, JsonObj) !=3D 0) { + return RedfishCS_status_unknown_error; + } + return RedfishCS_status_success; +} + diff --git a/RedfishClientPkg/ConverterLib/src/RedfishCsMemory.c b/RedfishC= lientPkg/ConverterLib/src/RedfishCsMemory.c new file mode 100644 index 0000000000..186de531eb --- /dev/null +++ b/RedfishClientPkg/ConverterLib/src/RedfishCsMemory.c @@ -0,0 +1,197 @@ +/** @file + + (C) Copyright 2018-2021 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + + Copyright Notice: + Copyright 2019-2021 Distributed Management Task Force, Inc. All rights r= eserved. + License: BSD 3-Clause License. For full text see link: https://github.co= m/DMTF/Redfish-JSON-C-Struct-Converter/blob/master/LICENSE.md +**/ + +#include "RedfishCsMemoryInternal.h" +#include +#include + +RedfishCS_Link CsMemRoot =3D {&CsMemRoot, &CsMemRoot}; + +/** + This function records the memory allocation to + the C Structure instance that owns the memory block. + + memCs C Structure instance. + Return RedfishCS_status + +**/ +RedfishCS_status recordCsRootMemory (void *memCs) +{ + RedfishCS_Internal_memory_root *memRoot; + + memRoot =3D malloc (sizeof(RedfishCS_Internal_memory_root)); + if (memRoot =3D=3D NULL) { + return RedfishCS_status_insufficient_memory; + } + InitializeLinkHead (&memRoot->nextRoot); + InitializeLinkHead (&memRoot->memBlocks); + memRoot->CsPtr =3D memCs; + InsertTailLink (&CsMemRoot, &memRoot->nextRoot); + return RedfishCS_status_success; +} +/** + This function allocates and records the memory allocation + to the C Structure instance that owns the memory block. + + rootCs C Structure instance. + size The size to allocate. + Dst Pointer to retrieve the pointer to memory + block. + Return RedfishCS_status + +**/ +RedfishCS_status allocateRecordCsMemory (RedfishCS_void *rootCs, RedfishCS= _uint32 size, RedfishCS_void **Dst) +{ + RedfishCS_Internal_memory_root *memRoot; + RedfishCS_Internal_memory_link *memLink; + + if (IsLinkEmpty (&CsMemRoot)) { + return RedfishCS_status_invalid_parameter; + } + memRoot =3D (RedfishCS_Internal_memory_root *)GetFirstLink (&CsMemRoot); + while (RedfishCS_boolean_true){ + if (memRoot->CsPtr =3D=3D rootCs) { + // Allocation memory and record it. + memLink =3D malloc (sizeof(RedfishCS_Internal_memory_link)); + if (memLink =3D=3D NULL) { + return RedfishCS_status_insufficient_memory; + } + *Dst =3D malloc (size); + if (*Dst =3D=3D NULL) { + free (memLink); + return RedfishCS_status_insufficient_memory; + } + memset (*Dst, 0, size); + memset (memLink, 0, sizeof(RedfishCS_Internal_memory_link)); + InitializeLinkHead (&memLink->nextLink); + memLink->memoryPtr =3D *Dst; + InsertTailLink (&memRoot->memBlocks, &memLink->nextLink); + return RedfishCS_status_success; + } + if (IsLinkAtEnd (&CsMemRoot, (RedfishCS_Link *)&memRoot->nextRoot)) { + break; + } + memRoot =3D (RedfishCS_Internal_memory_root *)GetNextLink (&CsMemRoot,= &memRoot->nextRoot); + }; + + return RedfishCS_status_invalid_parameter; +} +/** + This function allocates, records and zero out the memory + to the C Structure instance that owns the memory block. + + rootCs C Structure instance. + size The size to allocate. + Dst Pointer to retrieve the pointer to memory + block. + Return RedfishCS_status + +**/ +RedfishCS_status allocateRecordCsZeroMemory (RedfishCS_void *rootCs, Redfi= shCS_uint32 size, RedfishCS_void **Dst) +{ + RedfishCS_status Status; + + Status =3D allocateRecordCsMemory (rootCs, size, Dst); + if (Status !=3D RedfishCS_status_success || *Dst =3D=3D NULL) { + return Status; + } + memset (*Dst, 0, size); + return RedfishCS_status_success; +} +/** + This function destroies all memory allocations belong + to the C Structure instance. + + rootCs C Structure instance. + + Return RedfishCS_status + +**/ +RedfishCS_status DestoryCsMemory (RedfishCS_void *rootCs) +{ + RedfishCS_Internal_memory_root *memRoot; + RedfishCS_Internal_memory_link *memLink; + + if (IsLinkEmpty (&CsMemRoot)) { + return RedfishCS_status_invalid_parameter; + } + memRoot =3D (RedfishCS_Internal_memory_root *)GetFirstLink (&CsMemRoot); + while (RedfishCS_boolean_true){ + if (memRoot->CsPtr =3D=3D rootCs) { + if (IsLinkEmpty (&memRoot->memBlocks)) { + return RedfishCS_status_success; + } + while (RedfishCS_boolean_true) { + memLink =3D (RedfishCS_Internal_memory_link *)GetLastLink(&memRoot= ->memBlocks); + if (memLink->memoryPtr !=3D NULL) { + free (memLink->memoryPtr); + RemoveLink (&memLink->nextLink); + free (memLink); + } + if (IsLinkEmpty (&memRoot->memBlocks)) { + RemoveLink (&memRoot->nextRoot); + free (memRoot); + free (rootCs); + return RedfishCS_status_success; + } + } + } + if (IsLinkAtEnd (&CsMemRoot, (RedfishCS_Link *)&memRoot->nextRoot)) { + break; + } + memRoot =3D (RedfishCS_Internal_memory_root *)GetNextLink (&CsMemRoot,= &memRoot->nextRoot); + }; + return RedfishCS_status_invalid_parameter; +} + +/** + This function allocates an array of memory blocks owned + by the C Structure instance. + + rootCs C Structure instance. + ArrayInstanceSize Number of items in array. + ArraySize The size of each array. + Dst Pointer to retrieve the pointer to memory + block. + + Return RedfishCS_status + +**/ +RedfishCS_status allocateArrayRecordCsMemory(RedfishCS_void *rootCs, Redfi= shCS_uint32 ArrayInstanceSize, RedfishCS_uint64 ArraySize, RedfishCS_void *= *Dst) +{ + RedfishCS_uint16 Index; + RedfishCS_void *ArrayInstance; + RedfishCS_void *PreArrayInstance; + RedfishCS_status Status; + RedfishCS_uint16 SizeOfVoid; + + for (Index =3D 0; Index < ArraySize; Index ++) { + Status =3D allocateRecordCsMemory(rootCs, ArrayInstanceSize, &ArrayIns= tance); + if (Status !=3D RedfishCS_status_success) { + return Status; + } + memset (ArrayInstance, 0, ArrayInstanceSize); + if (Index =3D=3D 0) { + *Dst =3D ArrayInstance; + } else { + SizeOfVoid =3D sizeof (RedfishCS_void *); + if (SizeOfVoid =3D=3D sizeof (RedfishCS_uint32)) { + *((RedfishCS_uint32 *)PreArrayInstance) =3D (RedfishCS_uint32)(uns= igned long long)ArrayInstance; // Next link. + } else if (SizeOfVoid =3D=3D sizeof (RedfishCS_uint64)){ + *((RedfishCS_uint64 *)PreArrayInstance) =3D (RedfishCS_uint64)Arra= yInstance; // Next link. + } else { + return RedfishCS_status_invalid_parameter; + } + } + PreArrayInstance =3D ArrayInstance; + } + return RedfishCS_status_success; +} --=20 2.17.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#79269): https://edk2.groups.io/g/devel/message/79269 Mute This Topic: https://groups.io/mt/84861129/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-