Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

README.md

Redfish Schema C Structure Generator

About

Redfish Schema C Structure Generator is a Python program which used to convert Redfish resource in JSON text format to C structure and vice versa(Redfish JSON-CStructure Converter). The functions in Redfish-JSON-C-Struct-Converter library provides the C language friendly structure which can be easily utilized in C programs.

Redfish Schema C Structure Generator generates C file and C header file for the specific version of Redfish schema released by SPFM. For example, ServiceRoot.v1_2_0.c under /ServiceRoot/ServiceRoot.v1_2_0 provides functions to convert ServiceRoot.v1_2_0.ServiceRoot property to predefined RedfishServiceRootV1_2_0_CS C structure. It also provides functions to convert RedfishServiceRootV1_2_0_CS C structure to JSON text file. All C files under /src are built into a single library. Other programs which built with Redfish-JSON-C-Struct-Converter library must links with this library and invokes the conversion functions as it needs.

Pre-requisists

Redfish Schema C Structure Generator is based on Python script. This library requires to build with below libraries.

Options for Redfish Schema C Structure Generator Program

Option Description Parameter
-all=[Directory] Process all Redfish schema under the given directory or the current working directory. Assign the directory which contains Redfish schema files.
-ErrorStop Stop processing all Redfish schemas. This option only works against to "-all". None
-file=[File] Process the specific Redfish schema file with absolute directory path. File path of Redfish schema.
-outputdir=[Output directory] Output file directory Path of output directory
-cmakeAdditionalIncludeDir CMake additional include file directory. The directories assigned to this option are added to CMake include_directories macro. Use semicolon as separator if there are multiple additional include directories") None
-proxy_host=[Proxy host] proxy host name Assign the proxy host name.
-proxy_port=[Proxy port] proxy port number Assign the proxy port number.
-logfile Message log to file. (RedfishCS.log) None
-ExtRefLocalFirst Search Redfish schema file from local disk first. Then through HTTP for the external JSON schema reference if local file is not found. None
-v Throw messages during C structure generation None
-edk2 Generate EDK2 open source definition and source code None
-Edk2AdditionalLibClass Along with "-edk2", additinoal library classes added to EDK2 INF file of each Redfish-JSON-C-Struct-Converter library. Use semicolon as separator if multiple library classes are used in INF file. For example: -Edk2AdditionalLibClass=Pachage1;Package2
-Edk2AdditionalPackage Along with "-edk2", additinoal EDK2 packages added to EDK2 INF file of each Redfish-JSON-C-Struct-Converter library. Use semicolon as separator if multiple EDK2 packages are used in INF file. For example: Pachage1;Package2
-Edk2RedfishJsonCsPackagePath Along with "-edk2", target EDK2 package for the generated EDK2 Redfish-JSON-C-Struct-Converter source files. Edk2RedfishJsonCsPackagePath is used for generating correct file path of Redfish-JSON-C-Struct-Converter EDK2 libraries and drivers in below file when use "-edk2" options.
- RedfishCsIntp/RedfishSchemaCsInterpreter_Component.dsc: Components to build
- RedfishCsIntp/RedfishSchemaCsInterpreter_Lib.dsc : Libraries to build
-Edk2RedfishJsonCsPackagePath=Edk2RedfishPkg
-Edk2RedfishJsonCsDriverAdditionalPackage Along with "-edk2", additinoal EDK2 packages for building EFI Redfish to C Structure DXE Driver. Use semicolon as separator if multiple EDK2 packages are used in INF file. -Edk2RedfishJsonCsDriverAdditionalPackage=RedfishPocPkg/RedfishPocPkg.dec;HpServerPkg/HpServerPkg.dec
-Edk2RedfishJsonCsDriverAdditionalLibrary Along with "-edk2", additinoal EDK2 libraries for building EFI Redfish to C Structure DXE Driver. Use semicolon as separator if multiple library classes are used in INF file. -Edk2RedfishJsonCsDriverAdditionalLibrary=JanssonLib

Example of using options

For generating C Structure for Redfish schema under folder.
   -logfile -ExtRefLocalFirst -cmakeAdditionalIncludeDir=C\Windows Kits/8.0/Include/km/crt;C:/jansson-2.11 -all=D:/Redfish2018.1

For generating C Structure for one Redfish schema file.
   -logfile -ExtRefLocalFirst -cmakeAdditionalIncludeDir=C\Windows Kits/8.0/Include/km/crt;C:/jansson-2.11 -file=F:/Folder/AccountService.v1_0_0.json

Assign proxy:
   -proxy_host=proxy.something.net -proxy_port=8080

Directories of C files generating

Directories of C source/header files generated by Redfish Schema C Structure Generator follow the naming of Redfish schema.

- src
  Source code of a variety of Redfish JSON-CStructure Converter of Redfish schema.
- include
  C header files a variety of Redfish JSON-CStructure Converter of Redfish schema.
- edk2
  EDK2 open source data type declarations for Redfish JSON-C structure converter library.
Under /src, directory must be created for each Redfish JSON schema ResourceTypeName .
For example,
  /src/ServiceRoot
    |_/Chassis
Under /src/ResourceTypeName, the directories must be created for each Redfish JSON schema type NameSpace.
For example,
  /src/ServiceRoot/ServiceRoot.v1_0_0
    |       |_____/ServiceRoot.v1_1_0
    |       |_____/ServiceRoot.v1_2_0
    |       |_____/ServiceRoot.v1_3_0
    |_/Chassis/Chassis.v1_0_0
          |___/Chassis.v2_0_0
C source file for the specific Redfish JSON schema must located under the corresponding directory.
For example,
  /src/ServiceRoot/ServiceRoot.v1_0_0/ServiceRoot.v1_0_0.c
            |_____/ServiceRoot.v1_1_0/ServiceRoot.v1_1_0.c
            |_____/ServiceRoot.v1_1_0/ServiceRoot.v1_2_0.c

Directories of CMAKE file generating

CMAKE file CMakeLists.txt is generated under src/_build. Use cmake to build Redfish JSON-CStructure Converter libraries.
  /src/_build/CMakeLists.txt

Directories for EDK2 open source

Under /edk2 (if use -edk2 option):The EDK2 INF file for each Redfish JSON-C structure converter library.
 Lib.inf is used to pull in Redfish JSON-C structure converter C file (under /src) into build process for building edk2 Redfish JSON-C structure converter library.
 C header is used to pulling Redfish JSON-C structure converter header file (under /src) into build process for building edk2 Redfish JSON-C structure converter library.
Under /RedfishCsIntp (if use -edk2 option): The EDK2 INF file for each Redfish JSON-C structure converter EFI driver.
 RedfishCsIntp/Include/RedfishInterpreter: Header file for building Redfish JSON-C structure converter EFI driver.
 RedfishCsIntp/RedfishSchemaInterpreter: EFI driver C file for building Redfish JSON-C structure converter EFI driver.

Naming of C Source Code

Use "Namesapce" of Redfish resource Type identifier as the naming of C source code.

Namespace = "ResourceTypeName.vMajorVersion_MinorVersion_Errata"
For example,  namespace for ServiceRoot 1.3.0 is ServiceRoot.v1_3_0. The naming of C source code must be ServiceRoot.v1_3_0.c

Naming of C Header File

Below is the naming of C header file of Redfish JSON-C structure converter.
Redfish_<ResourceTypeName>_<SchemaVersion>_CS.h
<ResourceTypeName> : For example, ServiceRoot
<SchemaVersion>    : For example, v1_2_0
CS                 : Means C Structure

The naming of header file for ServiceRoot.v1_2_0 schema will be Redfish_ServiceRoot_V1_2_0_CS.h.

C Source File of Redfish JSON-C Structure Converter

Provides three major functions for Redfish JSON-C structure converter. Those are Redfish JSON to C Structure converter, C Structure to Redfish JSON converter and destory JSON C structure.

The prototyoe and naming of function is shown as below,

Redfish JSON to C Structure:

   RedfishCS_status Json_<ResourceTypeName>_<SchemaVersion>_To_Cs (char *JsonRawText,  <RedfishCStructureName> **ReturnCS)
 For example,
    RedfishCS_status = *Json_ServiceRoot_V1_2_0_To_CS (char *JsonRawText, RedfishServiceRootV1_2_0_CS **ReturnCS);

C Structure to Redfish JSON:

   RedfishCS_status Cs_<ResourceTypeName>_<SchemaVersion>_Json (<RedfishCStructureName> *CsPtr, RedfishCS_char **JsonText)
 For example,
   RedfishCS_status Cs_ServiceRoot_V1_2_0_To_Json (RedfishServiceRootV1_2_0_CS *RedfishCs, RedfishCS_char **JsonText);

Redfish JSON C Structure Destory: RedfishCS_status Cs___Json ( *CsPtr); For example, RedfishCS_status DestroyServiceRoot_V1_2_0_CS (RedfishServiceRoot_V1_2_0_ServiceRoot_CS *CSPtr);

C Header File of Redfish JSON-C Structure Converter

In most of implementations, C header file of Redfish JSON-C structure converter only defines C structure of certain Redfish Schema and prototype of conversion functions.

For example,
#ifndef _REDFISH_SERVICEROOT_V1_2_0_CSTRUCT_H_
#define _REDFISH_SERVICEROOT_V1_2_0_CSTRUCT_H_

#include "RedfishCsCommon.h"

typedef struct _RedfishServiceRoot_V1_2_0_ServiceRoot_CS {
  RedfishCS_Header                                  Header;
  RedfishCS_char                                    *odata_context;   
  RedfishCS_char                                    *odata_id;        
  RedfishCS_char                                    *odata_type;      
  RedfishCS_Link                                    AccountService;     // This is a link to the Account
                                                                        // Service.
  RedfishCS_Link                                    Chassis;            // This is a link to a collection
                                                                        // of Chassis.
  RedfishCS_Link                                    CompositionService; // This is a link to the
                                                                        // CompositionService.
  RedfishCS_char                                    *Description;     
  RedfishCS_Link                                    EventService;       // This is a link to the
                                                                        // EventService.
  RedfishCS_Link                                    Fabrics;            // A link to a collection of all
                                                                        // fabric entities.
  RedfishCS_char                                    *Id;              
  RedfishCS_Link                                    JsonSchemas;        // This is a link to a collection
                                                                        // of Json-Schema files.
  RedfishServiceRoot_V1_2_0_ServiceRoot_Links_CS    *Links;             // Contains references to other
                                                                        // resources that are related to
                                                                        // this resource.
  RedfishCS_Link                                    Managers;           // This is a link to a collection
                                                                        // of Managers.
  RedfishCS_char                                    *Name;            
  RedfishResource_Oem_CS                            *Oem;               // This is the
                                                                        // manufacturer/provider specific
                                                                        // extension moniker used to
                                                                        // divide the Oem object into
                                                                        // sections.
  RedfishCS_char                                    *RedfishVersion;    // The version of the Redfish
                                                                        // service.
  RedfishCS_Link                                    Registries;         // This is a link to a collection
                                                                        // of Registries.
  RedfishCS_Link                                    SessionService;     // This is a link to the Sessions
                                                                        // Service.
  RedfishCS_Link                                    StorageServices;    // A link to a collection of all
                                                                        // storage service entities.
  RedfishCS_Link                                    StorageSystems;     // This is a link to a collection
                                                                        // of storage systems.
  RedfishCS_Link                                    Systems;            // This is a link to a collection
                                                                        // of Systems.
  RedfishCS_Link                                    Tasks;              // This is a link to the Task
                                                                        // Service.
  RedfishCS_char                                    *UUID;              // Unique identifier for a
                                                                        // service instance. When SSDP is
                                                                        // used, this value should be an
                                                                        // exact match of the UUID value
                                                                        // returned in a 200OK from an
                                                                        // SSDP M-SEARCH request during
                                                                        // discovery.
  RedfishCS_Link                                    UpdateService;      // This is a link to the
                                                                        // UpdateService.
} RedfishServiceRoot_V1_2_0_ServiceRoot_CS;

RedfishServiceRootV1_2_0_CS *
Json_ServiceRoot_V1_2_0_To_CS (char *JsonRawText);

C Data Types

In order to flexibly support different bindings on top of Redfish-JSON-C-Struct-Converte, we use alternated data type instead of using native C data types. The alternated ones may replaced by bindings.

C Data Type Redfish C Structure Data Type Description
bool RedfishCS_bool Boolean, true or false.
Refer to Redfish-JSON-C-Struct-Converter Defined C Data Types
char RedfishCS_char 8-bit character.
signed char RedfishCS_int8 8-bit signed value.
unsigned char RedfishCS_uint8 8-bit unsigned value.
int RedfishCS_int16 Integer in range [−32,767, +32,767]
unsigned int RedfishCS_uint16 Integer in range [0, 65535]
long int RedfishCS_int32 Integer in range [−2,147,483,647, +2,147,483,647]
unsigned long int RedfishCS_uint32 Integer in range [0, 4,294,967,295]
long long RedfishCS_int64 Integer in range [−9,223,372,036,854,775,807, +9,223,372,036,854,775,807]
unsigned long long RedfishCS_uint64 Integer in range [0, 2^64 - 1]
double RedfishCS_double Double-precision floating-point
float RedfishCS_float Single-precision floating-point

Redfish-JSON-C-Struct-Converter Defined C Data Types

Data Type Description
RedfishCS_boolean_false Means 0 or false
RedfishCS_boolean_true Means 1 or true

Redfish-JSON-C-Struct-Converter Defined Return Stastus

Data Type Value
RedfishCS_status_successe 0
RedfishCS_status_unsupported -1
RedfishCS_status_invalid_parameter -2
RedfishCS_status_insufficient_memory -3
RedfishCS_status_not_found -4
RedfishCS_status_unknown_error -5

Redfish-JSON-C-Struct-Converter Defined Structure

Redfish-JSON-C-Struct Defined Structure Description
RedfishCS_linklist Linked list used in Redfish-JSON-C-Struct, this structure is used to link to the next Redfish C structure.

typedef struct _RedfishCS_linklist {
RedfishCS_linklist BackLinkList;
RedfishCS_linklist NextLinkList;
};

RedfishCS_Header Redfish C Structure Header, the header of each Redfish C structure.

typedef struct _RedfishCS_Header {
RedfishCS_Link LinkEntry;
RedfishCS_Type ResourceType;
RedfishCS_char *KeyName;
RedfishCS_char *ThisUri;
} RedfishCS_Header;

RedfishCS_Type Redfish C Structure Type, the type of information this Redfish C structure provides.

typedef enum {
RedfishCS_Type_CS = 1,
RedfishCS_Type_CS_EmptyProp,
RedfishCS_Type_JSON,
RedfishCS_Type_Uri
} RedfishCS_Type;

See below definitions for each type

RedfishCS_Type_Uri_Data Redfish C Structure of URI information, this type of Redfish C structure provides the URI to Redfish resource.

typedef struct _RedfishCS_Type_Uri_Data {
RedfishCS_Header Header;
RedfishCS_char *Uri;
} RedfishCS_Type_Uri_Data;

RedfishCS_Type_CS_Data Redfish C Structure of Redfish resource, this type of Redfish C structure provides Redfish resource in C structure format.

typedef struct _RedfishCS_Type_CS_Data {
RedfishCS_Header Header;
//
// Followed by C structure of resource.
// The format of following structure is JSON--Struct-Converter specific
//
} RedfishCS_Type_CS_Data;

RedfishCS_Type_EmptyProp_CS_Data Redfish C Structure of Redfish resource which property is declared as empty property ("properties": {}), this type of Redfish C structure provides Redfish resource in C structure format.
Only support below types of JSON value, the JSON object nested in the property is not supported,

JSON type string
JSON type number
JSON type integer<br/
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;

RedfishCS_Type_JSON_Data Redfish C Structure of resource in JSON text format, this type prvides the Redfish resource in Json text format.

typedef struct _RedfishCS_Type_JSON_Data {
RedfishCS_Header Header;
RedfishCS_char *JsonText;
} RedfishCS_Type_JSON_Data;

RedfishCS_Vague Redfish C Structure of JSON property which data type could be boolean, int or string.

typedef enum {
RedfishCS_Vague_DataType_String = 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;

README.md for Each Converter

README.md is provided in each Redfish-JSON-C-Struct-Converter under script-generated /src directory. See src/ServiceRoot/ServiceRoot.v1_1_0/README.md for the example.

Redfish Schema Release Validation

  • DSP8010_Schema_2018.1
  • DSP8010_Schema_2019.1
  • DSP8010_Schema_2020.4

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages