From nobody Thu Apr 25 22:13:25 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+70028+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+70028+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090719; cv=none; d=zohomail.com; s=zohoarc; b=OqFZzB6HTF1SxWlpqnSD97fmvBJwhcpJ4ItVWXIOQfxJ3QbNbq2v9IUapZ8AYrimXT/6tQ5B2+82tnqwi1lDH1svxM8+QLICXgdsjSqgFzleKbBj+EHzwUhtvhbo0AHuNf7i5SOf5URVnNXIydVq1VM2ePfcWo18ZQ8SY+QAuCw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090719; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:Message-ID:Reply-To:References:Sender:Subject:To; bh=gnyuJgovf7E4HfZdcHnHvzi7ZLBKpzP+ca4RjnegEIM=; b=LPkvKBcYFIdBsQRlALsuS0FUshptqiGAue0ugYsPYWDN928xnaEQAOzCXjh4uQ/T4xSluyUR1XbENoJgKRKfznpwMiv3+fko/Vp7mJ/FbVG+UJlNL7bGE9YRAFeE5jBeFN2Q5hhBG6orQqA3QInifd9O14BElEaHmjAhd61bs5w= 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+70028+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090719483340.67103802251324; Thu, 7 Jan 2021 23:25:19 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id qDUQYY1788612xy2afG5RGJ1; Thu, 07 Jan 2021 23:25:19 -0800 X-Received: from mx0a-002e3701.pphosted.com (mx0a-002e3701.pphosted.com [148.163.147.86]) by mx.groups.io with SMTP id smtpd.web09.830.1610090718657532627 for ; Thu, 07 Jan 2021 23:25:18 -0800 X-Received: from pps.filterd (m0150241.ppops.net [127.0.0.1]) by mx0a-002e3701.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 1087HxJw022160; Fri, 8 Jan 2021 07:25:10 GMT X-Received: from g4t3426.houston.hpe.com (g4t3426.houston.hpe.com [15.241.140.75]) by mx0a-002e3701.pphosted.com with ESMTP id 35xd6rsunj-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 08 Jan 2021 07:25:10 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3426.houston.hpe.com (Postfix) with ESMTP id C2A5159; Fri, 8 Jan 2021 07:25:09 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 74C2B48; Fri, 8 Jan 2021 07:25:08 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Liming Gao , Leif Lindholm , Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 1/6] RedfishPkg/Ucs2Utf8lib: UCS2 to UFT8 manipulation library Date: Fri, 8 Jan 2021 14:37:08 +0800 Message-Id: <20210108063713.8853-2-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: j1tuUI5X3PNIX0dbuzLJ68O0x1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090719; bh=H+ZkTR+8Vpa36y2pw/28ivgpaSCV1WPwzTSxbYWw5sI=; h=Cc:Date:From:Reply-To:Subject:To; b=VPuy/m7NXBzzaIFQR44F4qZydvlsAw4/fLYt8zOo62xBu+XMxPWdO5x3UY7GPTryNk5 /QdRXIYVYyst1DJHieL5kEO3UfAbWtzZ9vVNqc/p6VAjPnGVwoJru0fjaYwS13kCCNrqh 1vZtHdSFe3KuliLDnyA1qh4eg9M5DVD213s= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" This library provides UCS2 to UFT8 or vise versa functions to manipulate UCS2/UTF8 strings. This library is currently used by edk2 port of open source jansson library. Signed-off-by: Abner Chang Cc: Liming Gao Cc: Leif Lindholm Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Nickle Wang Acked-by: Leif Lindholm --- RedfishPkg/RedfishPkg.dec | 4 + RedfishPkg/RedfishLibs.dsc.inc | 1 + RedfishPkg/RedfishPkg.dsc | 1 + .../BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf | 31 ++ RedfishPkg/Include/Library/BaseUcs2Utf8Lib.h | 61 +++ .../Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c | 421 ++++++++++++++++++ 6 files changed, 519 insertions(+) create mode 100644 RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf create mode 100644 RedfishPkg/Include/Library/BaseUcs2Utf8Lib.h create mode 100644 RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c diff --git a/RedfishPkg/RedfishPkg.dec b/RedfishPkg/RedfishPkg.dec index 89a2a6de1e..4cae8c3a4a 100644 --- a/RedfishPkg/RedfishPkg.dec +++ b/RedfishPkg/RedfishPkg.dec @@ -20,6 +20,10 @@ ## @libraryclass Platform Redfish Host Interface Library # Platform implementation-specific Redfish Host Interface. RedfishPlatformHostInterfaceLib|Include/Library/RedfishHostInterfaceLib.h + ## @libraryclass This library provides UCS2 to UTF8 manipulation + # functions. + # + Ucs2Utf8Lib|Include/Library/BaseUcs2Utf8Lib.h =20 ## @libraryclass Platform Redfish Credential Library # Platform implementation-specific Redfish Credential Interface. diff --git a/RedfishPkg/RedfishLibs.dsc.inc b/RedfishPkg/RedfishLibs.dsc.inc index df21664f4e..271d838db6 100644 --- a/RedfishPkg/RedfishLibs.dsc.inc +++ b/RedfishPkg/RedfishLibs.dsc.inc @@ -12,5 +12,6 @@ ## !if $(REDFISH_ENABLE) =3D=3D TRUE RestExLib|RedfishPkg/Library/DxeRestExLib/DxeRestExLib.inf + Ucs2Utf8Lib|RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf !endif =20 diff --git a/RedfishPkg/RedfishPkg.dsc b/RedfishPkg/RedfishPkg.dsc index 5d9476bc79..15355493e2 100644 --- a/RedfishPkg/RedfishPkg.dsc +++ b/RedfishPkg/RedfishPkg.dsc @@ -50,5 +50,6 @@ RedfishPkg/Library/PlatformHostInterfaceLibNull/PlatformHostInterfaceLib= Null.inf RedfishPkg/Library/PlatformCredentialLibNull/PlatformCredentialLibNull.i= nf RedfishPkg/Library/DxeRestExLib/DxeRestExLib.inf + RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf =20 !include RedfishPkg/Redfish.dsc.inc diff --git a/RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf b/Redfi= shPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf new file mode 100644 index 0000000000..beb7e77892 --- /dev/null +++ b/RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf @@ -0,0 +1,31 @@ +## @file +# UCS2 to UTF8 manipulation library. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
+# (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x0001001b + BASE_NAME =3D BaseUcs2Utf8Lib + FILE_GUID =3D 536646C3-46D0-4B12-ABC4-CDE1A33B5256 + MODULE_TYPE =3D BASE + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D Ucs2Utf8Lib + +# +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 RISCV64 +# + +[Sources] + BaseUcs2Utf8Lib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + RedfishPkg/RedfishPkg.dec + + diff --git a/RedfishPkg/Include/Library/BaseUcs2Utf8Lib.h b/RedfishPkg/Incl= ude/Library/BaseUcs2Utf8Lib.h new file mode 100644 index 0000000000..c6989617df --- /dev/null +++ b/RedfishPkg/Include/Library/BaseUcs2Utf8Lib.h @@ -0,0 +1,61 @@ +/** @file + UCS2 to UTF8 manipulation library header file. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef BASE_UCS2UTF8_LIB_H_ +#define BASE_UCS2UTF8_LIB_H_ + +/// +/// L"\u0000" +/// +#define UNICODE_FORMAT_LEN 6 +#define UNICODE_FORMAT_CHAR_LEN 2 +#define UNICODE_FORMAT_CHAR_SIZE 3 + +#define UTF8_BUFFER_FOR_UCS2_MAX_SIZE 3 + +/** + Convert a UCS2 string to a UTF8 encoded string. + + @param[in] Ucs2Str The provided UCS2 string. + @param[out] Utf8StrAddr The converted UTF8 string address. = Caller + is responsible for Free this string. + + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES System runs out of resources. + @retval EFI_SUCCESS The UTF8 encoded string has been co= nverted. + +**/ +EFI_STATUS +UCS2StrToUTF8 ( + IN CHAR16 *Ucs2Str, + OUT CHAR8 **Utf8StrAddr + ); + +/** + Convert a UTF8 encoded string to a UCS2 string. + + @param[in] Utf8Str The provided UTF8 encoded string. + @param[out] Ucs2StrAddr The converted UCS2 string address. = Caller + is responsible for Free this string. + + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not vali= d to + convert to UCS2 string. + One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES System runs out of resources. + @retval EFI_SUCCESS The UCS2 string has been converted. + +**/ +EFI_STATUS +UTF8StrToUCS2 ( + IN CHAR8 *Utf8Str, + OUT CHAR16 **Ucs2StrAddr + ); + +#endif diff --git a/RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c b/Redfish= Pkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c new file mode 100644 index 0000000000..891423734b --- /dev/null +++ b/RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.c @@ -0,0 +1,421 @@ +/** @file + UCS2 to UTF8 manipulation library. + + Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#include +#include +#include +#include +#include +#include + +/** + Since each UCS2 character can be represented by 1-3 UTF8 encoded charact= ers, + this function is used to retrieve the UTF8 encoding size for a UCS2 char= acter. + + @param[in] Utf8Buffer The buffer for UTF8 encoded data. + + @retval Return the size of UTF8 encoding string or 0 if it is not f= or + UCS2 format. + +**/ +UINT8 +GetUTF8SizeForUCS2 ( + IN CHAR8 *Utf8Buffer + ) +{ + CHAR8 TempChar; + UINT8 Utf8Size; + + ASSERT (Utf8Buffer !=3D NULL); + + TempChar =3D *Utf8Buffer; + if ((TempChar & 0xF0) =3D=3D 0xF0) { + + // + // This format is not for UCS2. + // + return 0; + } + + Utf8Size =3D 1; + if ((TempChar & 0x80) =3D=3D 0x80) { + if ((TempChar & 0xC0) =3D=3D 0xC0) { + + Utf8Size ++; + if ((TempChar & 0xE0) =3D=3D 0xE0) { + + Utf8Size ++; + } + } + } + + return Utf8Size; +} + +/** + Since each UCS2 character can be represented by the format: \uXXXX, this= function + is used to retrieve the UCS2 character from a Unicode format. + Call MUST make sure there are at least 6 Bytes in the input UTF8 buffer. + + @param[in] Utf8Buffer The buffer for UTF8 encoded data. + @param[out] Ucs2Char The converted UCS2 character. + + @retval EFI_INVALID_PARAMETER Non-Ascii characters found in the h= exadecimal + digits string, and can't be convert= ed to a UCS2 + character. + @retval EFI_SUCCESS The UCS2 character has been retriev= ed. + +**/ +EFI_STATUS +GetUCS2CharByFormat ( + IN CHAR8 *Utf8Buffer, + OUT CHAR16 *Ucs2Char + ) +{ + UINT8 Num1; + UINT8 Num2; + UINT8 Index; + CHAR8 Ucs2CharFormat[UNICODE_FORMAT_CHAR_SIZE]; /// two Hexadecimal= digits Ascii string, like "3F" + + for (Index =3D 0; Index < 4; Index ++) { + if ((*(Utf8Buffer + 2 + Index) & 0x80) !=3D 0x00) { + return EFI_INVALID_PARAMETER; + } + } + + ZeroMem (Ucs2CharFormat, UNICODE_FORMAT_CHAR_SIZE); + + // + // Get the First Number, Offset is 2 + // + CopyMem (Ucs2CharFormat, Utf8Buffer + 2, UNICODE_FORMAT_CHAR_LEN); + Num1 =3D (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); + + // + // Get the Second Number, Offset is 4 + // + CopyMem (Ucs2CharFormat, Utf8Buffer + 4, UNICODE_FORMAT_CHAR_LEN); + Num2 =3D (UINT8) AsciiStrHexToUintn (Ucs2CharFormat); + + // + // Ucs2Char is Little-Endian + // + *((CHAR8 *) Ucs2Char) =3D Num2; + *(((CHAR8 *) Ucs2Char) + 1) =3D Num1; + + return EFI_SUCCESS; +} + +/** + Convert a UCS2 character to UTF8 encoding string. + + @param[in] Ucs2Char The provided UCS2 character. + @param[out] Utf8Buffer The converted UTF8 encoded data. + + @retval Return the size of UTF8 encoding data for this UCS2 charact= er. + +**/ +UINT8 +UCS2CharToUTF8 ( + IN CHAR16 Ucs2Char, + OUT CHAR8 *Utf8Buffer + ) +{ + UINT16 Ucs2Number; + + ASSERT (Utf8Buffer !=3D NULL); + + Ucs2Number =3D (UINT16) Ucs2Char; + if (Ucs2Number <=3D 0x007F) { + + // + // UTF8 format: 0xxxxxxx + // + *Utf8Buffer =3D Ucs2Char & 0x7F; + return 1; + + } else if (Ucs2Number >=3D 0x0080 && Ucs2Number <=3D 0x07FF) { + + // + // UTF8 format: 110xxxxx 10xxxxxx + // + *(Utf8Buffer + 1) =3D (Ucs2Char & 0x3F) | 0x80; + *Utf8Buffer =3D ((Ucs2Char >> 6) & 0x1F) | 0xC0; + return 2; + + } else { /// Ucs2Number >=3D 0x0800 && Ucs2Number <=3D 0xFFFF + + // + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx + // + *(Utf8Buffer + 2) =3D (Ucs2Char & 0x3F) | 0x80; + *(Utf8Buffer + 1) =3D ((Ucs2Char >> 6) & 0x3F) | 0x80; + *Utf8Buffer =3D ((Ucs2Char >> 12) & 0x0F) | 0xE0; + return 3; + } +} + +/** + Convert a UTF8 encoded data to a UCS2 character. + + @param[in] Utf8Buffer The provided UTF8 encoded data. + @param[out] Ucs2Char The converted UCS2 character. + + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not vali= d or + not for UCS2 character. + @retval EFI_SUCCESS The converted UCS2 character. + +**/ +EFI_STATUS +UTF8ToUCS2Char ( + IN CHAR8 *Utf8Buffer, + OUT CHAR16 *Ucs2Char + ) +{ + UINT8 Utf8Size; + CHAR8 *Ucs2Buffer; + CHAR8 TempChar1; + CHAR8 TempChar2; + CHAR8 TempChar3; + + ASSERT (Utf8Buffer !=3D NULL && Ucs2Char !=3D NULL); + ZeroMem (Ucs2Char, sizeof (CHAR16)); + Ucs2Buffer =3D (CHAR8 *) Ucs2Char; + + Utf8Size =3D GetUTF8SizeForUCS2 (Utf8Buffer); + switch (Utf8Size) { + + case 1: + + // + // UTF8 format: 0xxxxxxx + // + TempChar1 =3D *Utf8Buffer; + if ((TempChar1 & 0x80) !=3D 0x00) { + return EFI_INVALID_PARAMETER; + } + + *Ucs2Buffer =3D TempChar1; + *(Ucs2Buffer + 1) =3D 0; + break; + + case 2: + + // + // UTF8 format: 110xxxxx 10xxxxxx + // + TempChar1 =3D *Utf8Buffer; + if ((TempChar1 & 0xE0) !=3D 0xC0) { + return EFI_INVALID_PARAMETER; + } + + TempChar2 =3D *(Utf8Buffer + 1); + if ((TempChar2 & 0xC0) !=3D 0x80) { + return EFI_INVALID_PARAMETER; + } + + *Ucs2Buffer =3D (TempChar1 << 6) + (TempChar2 & 0x3F); + *(Ucs2Buffer + 1) =3D (TempChar1 >> 2) & 0x07; + break; + + case 3: + + // + // UTF8 format: 1110xxxx 10xxxxxx 10xxxxxx + // + TempChar1 =3D *Utf8Buffer; + if ((TempChar1 & 0xF0) !=3D 0xE0) { + return EFI_INVALID_PARAMETER; + } + + TempChar2 =3D *(Utf8Buffer + 1); + if ((TempChar2 & 0xC0) !=3D 0x80) { + return EFI_INVALID_PARAMETER; + } + + TempChar3 =3D *(Utf8Buffer + 2); + if ((TempChar3 & 0xC0) !=3D 0x80) { + return EFI_INVALID_PARAMETER; + } + + *Ucs2Buffer =3D (TempChar2 << 6) + (TempChar3 & 0x3F); + *(Ucs2Buffer + 1) =3D (TempChar1 << 4) + ((TempChar2 >> 2) & 0x0F); + + break; + + default: + + return EFI_INVALID_PARAMETER; + } + + return EFI_SUCCESS; +} + +/** + Convert a UCS2 string to a UTF8 encoded string. + + @param[in] Ucs2Str The provided UCS2 string. + @param[out] Utf8StrAddr The converted UTF8 string address. = Caller + is responsible for Free this string. + + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES System runs out of resources. + @retval EFI_SUCCESS The UTF8 encoded string has been co= nverted. + +**/ +EFI_STATUS +UCS2StrToUTF8 ( + IN CHAR16 *Ucs2Str, + OUT CHAR8 **Utf8StrAddr + ) +{ + UINTN Ucs2StrIndex; + UINTN Ucs2StrLength; + CHAR8 *Utf8Str; + UINTN Utf8StrLength; + UINTN Utf8StrIndex; + CHAR8 Utf8Buffer[UTF8_BUFFER_FOR_UCS2_MAX_SIZE]; + UINT8 Utf8BufferSize; + + if (Ucs2Str =3D=3D NULL || Utf8StrAddr =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + Ucs2StrLength =3D StrLen (Ucs2Str); + Utf8StrLength =3D 0; + + for (Ucs2StrIndex =3D 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex ++) { + + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); + Utf8BufferSize =3D UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], Utf8Buffer); + Utf8StrLength +=3D Utf8BufferSize; + } + + Utf8Str =3D AllocateZeroPool (Utf8StrLength + 1); + if (Utf8Str =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Utf8StrIndex =3D 0; + for (Ucs2StrIndex =3D 0; Ucs2StrIndex < Ucs2StrLength; Ucs2StrIndex ++) { + + ZeroMem (Utf8Buffer, sizeof (Utf8Buffer)); + Utf8BufferSize =3D UCS2CharToUTF8 (Ucs2Str[Ucs2StrIndex], Utf8Buffer); + + CopyMem (Utf8Str + Utf8StrIndex, Utf8Buffer, Utf8BufferSize); + Utf8StrIndex +=3D Utf8BufferSize; + } + + Utf8Str[Utf8StrIndex] =3D '\0'; + *Utf8StrAddr =3D Utf8Str; + + return EFI_SUCCESS; +} + +/** + Convert a UTF8 encoded string to a UCS2 string. + + @param[in] Utf8Str The provided UTF8 encoded string. + @param[out] Ucs2StrAddr The converted UCS2 string address. = Caller + is responsible for Free this string. + + @retval EFI_INVALID_PARAMETER The UTF8 encoded string is not vali= d to + convert to UCS2 string. + One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES System runs out of resources. + @retval EFI_SUCCESS The UCS2 string has been converted. + +**/ +EFI_STATUS +UTF8StrToUCS2 ( + IN CHAR8 *Utf8Str, + OUT CHAR16 **Ucs2StrAddr + ) +{ + EFI_STATUS Status; + UINTN Utf8StrIndex; + UINTN Utf8StrLength; + UINTN Ucs2StrIndex; + UINT8 Utf8BufferSize; + CHAR16 *Ucs2StrTemp; + + if (Utf8Str =3D=3D NULL || Ucs2StrAddr =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // It is not an Ascii string, calculate string length. + // + Utf8StrLength =3D 0; + while (*(Utf8Str + Utf8StrLength) !=3D '\0') { + Utf8StrLength ++; + } + + // + // UCS2 string shall not be longer than the UTF8 string. + // + Ucs2StrTemp =3D AllocateZeroPool ((Utf8StrLength + 1) * sizeof (CHAR16)); + if (Ucs2StrTemp =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Utf8StrIndex =3D 0; + Ucs2StrIndex =3D 0; + while (Utf8Str[Utf8StrIndex] !=3D '\0') { + + if (CompareMem (Utf8Str + Utf8StrIndex, "\\u", 2) =3D=3D 0 && + Utf8StrLength - Utf8StrIndex >=3D UNICODE_FORMAT_LEN) { + + Status =3D GetUCS2CharByFormat (Utf8Str + Utf8StrIndex, Ucs2StrTemp = + Ucs2StrIndex); + if (!EFI_ERROR (Status)) { + + Utf8StrIndex +=3D UNICODE_FORMAT_LEN; + Ucs2StrIndex ++; + } else { + + StrCpyS (Ucs2StrTemp + Ucs2StrIndex, 3, L"\\u"); + + Ucs2StrIndex +=3D 2; + Utf8StrIndex +=3D 2; + } + } else { + + Utf8BufferSize =3D GetUTF8SizeForUCS2 (Utf8Str + Utf8StrIndex); + if (Utf8BufferSize =3D=3D 0 || Utf8StrLength - Utf8StrIndex < Utf8Bu= fferSize) { + + FreePool (Ucs2StrTemp); + return EFI_INVALID_PARAMETER; + } + + Status =3D UTF8ToUCS2Char (Utf8Str + Utf8StrIndex, Ucs2StrTemp + Ucs= 2StrIndex); + if (EFI_ERROR (Status)) { + + FreePool (Ucs2StrTemp); + return EFI_INVALID_PARAMETER; + } + + Ucs2StrIndex ++; + Utf8StrIndex +=3D Utf8BufferSize; + } + } + + *Ucs2StrAddr =3D AllocateZeroPool ((Ucs2StrIndex + 1) * sizeof (CHAR16)); + if (*Ucs2StrAddr =3D=3D NULL) { + + FreePool (Ucs2StrTemp); + return EFI_OUT_OF_RESOURCES; + } + + StrCpyS (*Ucs2StrAddr, Ucs2StrIndex + 1, Ucs2StrTemp); + *(*Ucs2StrAddr + Ucs2StrIndex) =3D L'\0'; + FreePool (Ucs2StrTemp); + + return EFI_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 (#70028): https://edk2.groups.io/g/devel/message/70028 Mute This Topic: https://groups.io/mt/79519379/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- From nobody Thu Apr 25 22:13:25 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+70030+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+70030+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090728; cv=none; d=zohomail.com; s=zohoarc; b=A7LnhA8Sz7MXVkZilNy7ClDkl79b9GS5Hq+BOR+1xVfJPERSZLJOkNPS8s0r6RsM4XWo6jFCchr/YrjShGTb0AmSZTTWgnuz1dy92gbemSy80icUZf9Pxx8FYGLFAJsX7HK0S4BRuxz+U+1TlAEcBDuGe3rawmSSNlzLBsmPZcs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090728; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=pCnZsXifASTnShREPihpV4WCwA4rKOYCq5a6UTzIt04=; b=k5bUQqO02qXrdT0IQc99nXlAL/iuatvgfysXZO/TNunwcwRr4ksWrHgzr01qNPN9V7ZpUgNz2zz42h9kC87+KrjTFAMvSFxnBM+atJBFW1qSlGAfvp9RzZkWL/8aGaWdOurKsxrLTAxSrPKXuOJCvpCpidg+JSqWvdlIumSdoqo= 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+70030+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090728786616.2247474487; Thu, 7 Jan 2021 23:25:28 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id nZlQYY1788612x32ELIN1Kyu; Thu, 07 Jan 2021 23:25:26 -0800 X-Received: from mx0a-002e3701.pphosted.com (mx0a-002e3701.pphosted.com [148.163.147.86]) by mx.groups.io with SMTP id smtpd.web10.823.1610090721022995480 for ; Thu, 07 Jan 2021 23:25:21 -0800 X-Received: from pps.filterd (m0150241.ppops.net [127.0.0.1]) by mx0a-002e3701.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 1087Hf5K021988; Fri, 8 Jan 2021 07:25:12 GMT X-Received: from g4t3425.houston.hpe.com (g4t3425.houston.hpe.com [15.241.140.78]) by mx0a-002e3701.pphosted.com with ESMTP id 35xd6rsunq-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 08 Jan 2021 07:25:12 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3425.houston.hpe.com (Postfix) with ESMTP id BCC938D; Fri, 8 Jan 2021 07:25:11 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 06CCF48; Fri, 8 Jan 2021 07:25:09 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Andrew Fish , Laszlo Ersek , Leif Lindholm , Michael D Kinney , Liming Gao , Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 2/6] edk2: jansson submodule for edk2 JSON library Date: Fri, 8 Jan 2021 14:37:09 +0800 Message-Id: <20210108063713.8853-3-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-Proofpoint-UnRewURL: 0 URL was un-rewritten MIME-Version: 1.0 X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: AJoFvzAmzPI2naAEIqlz55AQx1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090726; bh=0GLn1se/5YsUMrAdow3meDL6Y+AL210R2eqqdHarhk4=; h=Cc:Date:From:Reply-To:Subject:To; b=JSPh34Y2m4LDRY7shBTt+5KWygotqc4Q0YIdxzOteTlLoafQmv7b0tOzp/kA0/0WdGG qWLClSg2x6bj1XHGH0ktHmkCe/jiRgIWWBSRYvXv147KFrsxRizGWwCPQJOLQXrBagMV4 3DDKBClXPrC07MsGYShaTV7okPMgzIOckCs= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add git submodule "jansson" library, which is the open source project (https://github.com/akheron/jansson) used to manipulate JSON data structure. jansson library is wrapped as edk2 JsonLib and the use cases will be the edk2 Redfish feature drivers and edk2 port of libredfish (https://github.com/DMTF/libredfish). jansson open source project is under MIT license. (refer to ReadMe.rst under edk2). Signed-off-by: Abner Chang Cc: Andrew Fish Cc: Laszlo Ersek Cc: Leif Lindholm Cc: Michael D Kinney Cc: Liming Gao Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Nickle Wang Acked-by: Leif Lindholm --- .gitmodules | 3 +++ ReadMe.rst | 1 + RedfishPkg/Library/JsonLib/jansson | 1 + 3 files changed, 5 insertions(+) create mode 160000 RedfishPkg/Library/JsonLib/jansson diff --git a/.gitmodules b/.gitmodules index c3a4e4aeca..0f06c09a29 100644 --- a/.gitmodules +++ b/.gitmodules @@ -17,3 +17,6 @@ path =3D BaseTools/Source/C/BrotliCompress/brotli url =3D https://github.com/google/brotli ignore =3D untracked +[submodule "RedfishPkg/Library/JsonLib/jansson"] + path =3D RedfishPkg/Library/JsonLib/jansson + url =3D https://github.com/akheron/jansson diff --git a/ReadMe.rst b/ReadMe.rst index c3c8178373..b754378646 100644 --- a/ReadMe.rst +++ b/ReadMe.rst @@ -93,6 +93,7 @@ that are covered by additional licenses. - `MdeModulePkg/Library/BrotliCustomDecompressLib/brotli `__ - `MdeModulePkg/Universal/RegularExpressionDxe/oniguruma `__ - `UnitTestFrameworkPkg/Library/CmockaLib/cmocka `__ +- `RedfishPkg/Library/JsonLib/jansson `__ =20 The EDK II Project is composed of packages. The maintainers for each packa= ge are listed in `Maintainers.txt `__. diff --git a/RedfishPkg/Library/JsonLib/jansson b/RedfishPkg/Library/JsonLi= b/jansson new file mode 160000 index 0000000000..e9ebfa7e77 --- /dev/null +++ b/RedfishPkg/Library/JsonLib/jansson @@ -0,0 +1 @@ +Subproject commit e9ebfa7e77a6bee77df44e096b100e7131044059 --=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 (#70030): https://edk2.groups.io/g/devel/message/70030 Mute This Topic: https://groups.io/mt/79519381/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- From nobody Thu Apr 25 22:13:25 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+70025+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+70025+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090721; cv=none; d=zohomail.com; s=zohoarc; b=Qa5zuM7NBbAcPsoRSdxZWqpS0b/xpA/ZA6X+atJQj1aj/HKrrVOEbXVYwjju7YHZE33DkImMncNBuIvgZWxPULwyvcJfhuWwca99WeFPvAOEQtQ8wocLXDumHwa+J8PbUQLkYi/U0vVr5JRu3ZhjnyXUyZROrZnxj7+5cFFByIs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090721; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:Message-ID:Reply-To:References:Sender:Subject:To; bh=Bra+m/dGshOc/lomIZxG0oFNYnVx/Pcpn8gvc9HDBYs=; b=bQ76hblJveUTqI2a1wwYFKT/XR5NeE/VIgz86+Nkt4uFs47FjF91KguknAB+UYFOL0DygN66/Op4njBjkKTuselS2EyTDakKUHLbDkYCrC6Ee/oRsbxyYOQ6RdKKRfgH8q0V38NmrZ8PBjZoWGWHfjMXvbrGvB+y2uifCRWIrd0= 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+70025+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090721612791.4047631932666; Thu, 7 Jan 2021 23:25:21 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id Nj8sYY1788612xPAf04rChUn; Thu, 07 Jan 2021 23:25:21 -0800 X-Received: from mx0a-002e3701.pphosted.com (mx0a-002e3701.pphosted.com [148.163.147.86]) by mx.groups.io with SMTP id smtpd.web09.829.1610090715540980732 for ; Thu, 07 Jan 2021 23:25:15 -0800 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 1087IvkX028096; Fri, 8 Jan 2021 07:25:14 GMT X-Received: from g4t3426.houston.hpe.com (g4t3426.houston.hpe.com [15.241.140.75]) by mx0b-002e3701.pphosted.com with ESMTP id 35xf6ms7fq-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 08 Jan 2021 07:25:14 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3426.houston.hpe.com (Postfix) with ESMTP id 4F0A061; Fri, 8 Jan 2021 07:25:13 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 17EAF48; Fri, 8 Jan 2021 07:25:11 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Leif Lindholm , Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 3/6] RedfishPkg/RedfishCrtLib: Redfish C runtime library Date: Fri, 8 Jan 2021 14:37:10 +0800 Message-Id: <20210108063713.8853-4-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: 0YAaUjjBrUtGlrS6D8BDXYB4x1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090721; bh=9C173XK2F+0JZZWIt0vjC975NlScXNT3+T6XFry8iRA=; h=Cc:Date:From:Reply-To:Subject:To; b=pFvzs0aUqO1ze26A6NO8cMCXb9EOQgC9TMQoB9fIT9JkD+Z1WY80fsd7CVRH5wCtmQB x+GCznxh5HQ53D9+ws73FzrY20iocZjXlI5dpsfghSVtlNP8kozAVAhm+sTns9yt6aJB1 41ZD7rg5rZm0tT+KMeqGqWo0sJAnPcUVaRI= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Redfish CRT library is currently used by edk2 JsonLib (open source jansson project) and edk2 RedfishLib (libredfish open source project). Redfish CrtLib library provides the necessary C runtime equivalent edk2 functions for open source projects. Signed-off-by: Abner Chang Cc: Leif Lindholm Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Nickle Wang Acked-by: Leif Lindholm --- RedfishPkg/RedfishPkg.dec | 12 + RedfishPkg/RedfishLibs.dsc.inc | 2 + RedfishPkg/RedfishPkg.dsc | 1 + .../RedfishCrtLib/RedfishCrtLib.inf | 38 + RedfishPkg/PrivateInclude/Crt/assert.h | 16 + RedfishPkg/PrivateInclude/Crt/errno.h | 16 + RedfishPkg/PrivateInclude/Crt/limits.h | 16 + RedfishPkg/PrivateInclude/Crt/math.h | 16 + RedfishPkg/PrivateInclude/Crt/stdarg.h | 15 + RedfishPkg/PrivateInclude/Crt/stddef.h | 16 + RedfishPkg/PrivateInclude/Crt/stdio.h | 15 + RedfishPkg/PrivateInclude/Crt/stdlib.h | 16 + RedfishPkg/PrivateInclude/Crt/string.h | 16 + RedfishPkg/PrivateInclude/Crt/sys/time.h | 15 + RedfishPkg/PrivateInclude/Crt/sys/types.h | 15 + RedfishPkg/PrivateInclude/Crt/time.h | 15 + .../PrivateInclude/Library/RedfishCrtLib.h | 242 ++++++ .../RedfishCrtLib/RedfishCrtLib.c | 809 ++++++++++++++++++ RedfishPkg/RedfishPkg.ci.yaml | 19 + 19 files changed, 1310 insertions(+) create mode 100644 RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.i= nf create mode 100644 RedfishPkg/PrivateInclude/Crt/assert.h create mode 100644 RedfishPkg/PrivateInclude/Crt/errno.h create mode 100644 RedfishPkg/PrivateInclude/Crt/limits.h create mode 100644 RedfishPkg/PrivateInclude/Crt/math.h create mode 100644 RedfishPkg/PrivateInclude/Crt/stdarg.h create mode 100644 RedfishPkg/PrivateInclude/Crt/stddef.h create mode 100644 RedfishPkg/PrivateInclude/Crt/stdio.h create mode 100644 RedfishPkg/PrivateInclude/Crt/stdlib.h create mode 100644 RedfishPkg/PrivateInclude/Crt/string.h create mode 100644 RedfishPkg/PrivateInclude/Crt/sys/time.h create mode 100644 RedfishPkg/PrivateInclude/Crt/sys/types.h create mode 100644 RedfishPkg/PrivateInclude/Crt/time.h create mode 100644 RedfishPkg/PrivateInclude/Library/RedfishCrtLib.h create mode 100644 RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c diff --git a/RedfishPkg/RedfishPkg.dec b/RedfishPkg/RedfishPkg.dec index 4cae8c3a4a..9f8b85778d 100644 --- a/RedfishPkg/RedfishPkg.dec +++ b/RedfishPkg/RedfishPkg.dec @@ -16,10 +16,15 @@ [Includes] Include =20 +[Includes.Common.Private] + PrivateInclude # Private header files for C RTL. + PrivateInclude/Crt # Private header files for C RTL. + [LibraryClasses] ## @libraryclass Platform Redfish Host Interface Library # Platform implementation-specific Redfish Host Interface. RedfishPlatformHostInterfaceLib|Include/Library/RedfishHostInterfaceLib.h + ## @libraryclass This library provides UCS2 to UTF8 manipulation # functions. # @@ -33,6 +38,13 @@ # This library is only intended to be used by UEFI network stack modul= es. RestExLib|Include/Library/RestExLib.h =20 +[LibraryClasses.Common.Private] + ## @libraryclass Provides the private C runtime library functions. + # CRT library is currently used by edk2 JsonLib (open source + # jansson project) and edk2 RedfishLib (libredfish open source + # project). + RedfishCrtLib|PrivateInclude/Library/RedfishCrtLib.h + [Protocols] ## Include/Protocol/RedfishDiscover.h gEfiRedfishDiscoverProtocolGuid =3D { 0x5db12509, 0x4550, 0x4347, {= 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }} diff --git a/RedfishPkg/RedfishLibs.dsc.inc b/RedfishPkg/RedfishLibs.dsc.inc index 271d838db6..2e54f90dc2 100644 --- a/RedfishPkg/RedfishLibs.dsc.inc +++ b/RedfishPkg/RedfishLibs.dsc.inc @@ -13,5 +13,7 @@ !if $(REDFISH_ENABLE) =3D=3D TRUE RestExLib|RedfishPkg/Library/DxeRestExLib/DxeRestExLib.inf Ucs2Utf8Lib|RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf + BaseSortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf + RedfishCrtLib|RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf !endif =20 diff --git a/RedfishPkg/RedfishPkg.dsc b/RedfishPkg/RedfishPkg.dsc index 15355493e2..420da0f2a9 100644 --- a/RedfishPkg/RedfishPkg.dsc +++ b/RedfishPkg/RedfishPkg.dsc @@ -51,5 +51,6 @@ RedfishPkg/Library/PlatformCredentialLibNull/PlatformCredentialLibNull.i= nf RedfishPkg/Library/DxeRestExLib/DxeRestExLib.inf RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf + RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf =20 !include RedfishPkg/Redfish.dsc.inc diff --git a/RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf b/Re= dfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf new file mode 100644 index 0000000000..5c1c7cffa6 --- /dev/null +++ b/RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf @@ -0,0 +1,38 @@ +## @file +# Redfish C Runtime Library for opensource projects. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
+# (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x0001001b + BASE_NAME =3D RedfishCrtLib + FILE_GUID =3D 8263B8AC-D021-425D-B337-3EC96F5DC19B + MODULE_TYPE =3D DXE_DRIVER + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D RedfishCrtLib|DXE_DRIVER UEFI_APPLICA= TION UEFI_DRIVER + +# +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 RISCV64 +# + +[Sources] + RedfishCrtLib.c + +[LibraryClasses] + BaseLib + BaseSortLib + DebugLib + MemoryAllocationLib + UefiRuntimeServicesTableLib + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + RedfishPkg/RedfishPkg.dec + + diff --git a/RedfishPkg/PrivateInclude/Crt/assert.h b/RedfishPkg/PrivateInc= lude/Crt/assert.h new file mode 100644 index 0000000000..9dc71e81cd --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/assert.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_ASSERT_H_ +#define REDFISH_CRT_ASSERT_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/errno.h b/RedfishPkg/PrivateIncl= ude/Crt/errno.h new file mode 100644 index 0000000000..b9c00ac6d8 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/errno.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_ERRNO_H_ +#define REDFISH_CRT_ERRNO_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/limits.h b/RedfishPkg/PrivateInc= lude/Crt/limits.h new file mode 100644 index 0000000000..f665234dba --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/limits.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_LIMITS_H_ +#define REDFISH_CRT_LIMITS_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/math.h b/RedfishPkg/PrivateInclu= de/Crt/math.h new file mode 100644 index 0000000000..6e36bfb642 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/math.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_MATH_H_ +#define REDFISH_CRT_MATH_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/stdarg.h b/RedfishPkg/PrivateInc= lude/Crt/stdarg.h new file mode 100644 index 0000000000..411275b58e --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/stdarg.h @@ -0,0 +1,15 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef REDFISH_CRT_STDARG_H_ +#define REDFISH_CRT_STDARG_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/stddef.h b/RedfishPkg/PrivateInc= lude/Crt/stddef.h new file mode 100644 index 0000000000..86af6f8340 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/stddef.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_STDDEF_H_ +#define REDFISH_CRT_STDDEF_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/stdio.h b/RedfishPkg/PrivateIncl= ude/Crt/stdio.h new file mode 100644 index 0000000000..a6b8c32df6 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/stdio.h @@ -0,0 +1,15 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef REDFISH_CRT_STDIO_H_ +#define REDFISH_CRT_STDIO_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/stdlib.h b/RedfishPkg/PrivateInc= lude/Crt/stdlib.h new file mode 100644 index 0000000000..b4c455ba3e --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/stdlib.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_STDLIB_H_ +#define REDFISH_CRT_STDLIB_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/string.h b/RedfishPkg/PrivateInc= lude/Crt/string.h new file mode 100644 index 0000000000..1def1ec1f0 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/string.h @@ -0,0 +1,16 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_STRING_H_ +#define REDFISH_CRT_STRING_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/sys/time.h b/RedfishPkg/PrivateI= nclude/Crt/sys/time.h new file mode 100644 index 0000000000..3ae791ae68 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/sys/time.h @@ -0,0 +1,15 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef REDFISH_CRT_SYS_TIME_H_ +#define REDFISH_CRT_SYS_TIME_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/sys/types.h b/RedfishPkg/Private= Include/Crt/sys/types.h new file mode 100644 index 0000000000..e69510849d --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/sys/types.h @@ -0,0 +1,15 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef REDFISH_CRT_SYS_TYPES_H_ +#define REDFISH_CRT_SYS_TYPES_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Crt/time.h b/RedfishPkg/PrivateInclu= de/Crt/time.h new file mode 100644 index 0000000000..e378c31ab8 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Crt/time.h @@ -0,0 +1,15 @@ +/** @file + Include file to support building the third-party jansson library. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef REDFISH_CRT_TIME_H_ +#define REDFISH_CRT_TIME_H_ + +#include + +#endif diff --git a/RedfishPkg/PrivateInclude/Library/RedfishCrtLib.h b/RedfishPkg= /PrivateInclude/Library/RedfishCrtLib.h new file mode 100644 index 0000000000..28a493d782 --- /dev/null +++ b/RedfishPkg/PrivateInclude/Library/RedfishCrtLib.h @@ -0,0 +1,242 @@ +/** @file + Redfish CRT wrapper functions. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef REDFISH_CRT_LIB_H_ +#define REDFISH_CRT_LIB_H_ + +#include +#include +#include +#include + +#define MAX_STRING_SIZE 0x10000000 + +// Minimum value for an object of type long long int. +#define LLONG_MIN MIN_INT64 + +// Maximum value for an object of type long long int. +#define LLONG_MAX MAX_INT64 + +// We dont support double on edk2 +#define HUGE_VAL 0 + +#if defined(MDE_CPU_X64) || defined(MDE_CPU_AARCH64) || defined(MDE_CPU_RI= SCV64) +// +// With GCC we would normally use SIXTY_FOUR_BIT_LONG, but MSVC needs +// SIXTY_FOUR_BIT, because 'long' is 32-bit and only 'long long' is +// 64-bit. Since using 'long long' works fine on GCC too, just do that. +// +#define SIXTY_FOUR_BIT +#elif defined(MDE_CPU_IA32) || defined(MDE_CPU_ARM) || defined(MDE_CPU_EBC) +#define THIRTY_TWO_BIT +#endif + +// +// Map all va_xxxx elements to VA_xxx defined in MdePkg/Include/Base.h +// +#if !defined(__CC_ARM) // if va_list is not already defined +#define va_list VA_LIST +#define va_arg VA_ARG +#define va_start VA_START +#define va_end VA_END +#else // __CC_ARM +#define va_start(Marker, Parameter) __va_start(Marker, Parameter) +#define va_arg(Marker, TYPE) __va_arg(Marker, TYPE) +#define va_end(Marker) ((void)0) +#endif + +// +// Definitions for global constants used by CRT library routines +// +#define INT_MAX MAX_INT32 /* Maximum (signed) int value */ +#define LONG_MAX 0X7FFFFFFFL /* max value for a long */ +#define LONG_MIN (-LONG_MAX-1) /* min value for a long */ +#define ULONG_MAX 0xFFFFFFFF /* Maximum unsigned long value */ +#define CHAR_BIT 8 /* Number of bits in a char */ + +// Maximum value for an object of type unsigned long long int. +#define ULLONG_MAX 0xFFFFFFFFFFFFFFFFULL // 2^64 - 1 +// Maximum value for an object of type unsigned char. +#define UCHAR_MAX 255 // 2^8 - 1 + +// +// Basic types mapping +// +typedef UINTN size_t; +typedef INTN ssize_t; +typedef INT32 time_t; +typedef UINT8 __uint8_t; +typedef UINT8 sa_family_t; +typedef UINT32 uid_t; +typedef UINT32 gid_t; +typedef INT32 int32_t; +typedef UINT32 uint32_t; +typedef UINT16 uint16_t; +typedef UINT8 uint8_t; +typedef enum {false, true} bool; + +// +// File operations are not required for EFI building, +// so FILE is mapped to VOID * to pass build +// +typedef VOID *FILE; + +/** + This is the Redfish version of CRT snprintf function, this function repl= aces "%s" to + "%a" before invoking AsciiSPrint(). That is becasue "%s" is unicode base= on edk2 + environment however "%s" is ascii code base on snprintf(). + See definitions of AsciiSPrint() for the details. + + @param StartOfBuffer A pointer to the output buffer for the produced = Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specifi= ed by StartOfBuffer. + @param FormatString A Null-terminated ASCII format string. + @param ... Variable argument list whose contents are access= ed based on the + format string specified by FormatString. + + @return The number of ASCII characters in the produced output buffer not= including the + Null-terminator. Zero means no string is produced or the error h= appens. + +**/ +UINTN +EFIAPI +RedfishAsciiSPrint ( + OUT CHAR8 *StartOfBuffer, + IN UINTN BufferSize, + IN CONST CHAR8 *FormatString, + ... + ); + +/** + This is the Redfish version of CRT vsnprintf function, this function rep= laces "%s" to + "%a" before invoking AsciiVSPrint(). That is because "%s" is unicode bas= e on edk2 + environment however "%s" is ascii code base on vsnprintf(). + See definitions of AsciiVSPrint() for the details. + + @param StartOfBuffer A pointer to the output buffer for the produced = Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specifi= ed by StartOfBuffer. + @param FormatString A Null-terminated ASCII format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of ASCII characters in the produced output buffer not= including the + Null-terminator. + +**/ +UINTN +EFIAPI +RedfishAsciiVSPrint ( + OUT CHAR8 *StartOfBuffer, + IN UINTN BufferSize, + IN CONST CHAR8 *FormatString, + IN VA_LIST Marker + ); + +// +// Global variables +// +extern int errno; +extern FILE *stderr; + +// +// Function prototypes of CRT Library routines +// +void *malloc (size_t); +void *realloc (void *, size_t); +void *calloc (size_t Num, size_t Size); +void free (void *); +void *memset (void *, int, size_t); +int memcmp (const void *, const void *, size_t); +int isdigit (int); +int isspace (int); +int tolower (int); +int isupper (int); +int isxdigit (int); +int isalnum (int); +void *memcpy (void *, const void *, size_t); +void *memset (void *, int, size_t); +void *memchr (const void *, int, size_t); +int memcmp (const void *, const void *, size_t); +void *memmove (void *, const void *, size_t); +int strcmp (const char *, const char *); +int strncmp (const char *, const char *, size_t); +char *strcpy (char *, const char *); +size_t strlen (const char *); +char *strcat (char *, const char *); +char *strchr (const char *, int); +int strcasecmp (const char *, const char *); +int strncasecmp (const char *, const char *, size_t); +char *strncpy (char *, size_t, const char *, size_t); +int strncmp (const char *, const char *, size_t); +char *strrchr (const char *, int); +unsigned long strtoul (const char *, char **, int); +char * strstr (const char *s1 , const char *s2); +long strtol (const char *, char **, int); +char *strerror (int); +size_t strspn (const char *, const char *); +char * strdup (const char *str); +char * strpbrk (const char *s1, const char *s2); +unsigned long long strtoull(const char * nptr, char ** endptr, int base); +long long strtoll (const char * nptr, char ** endptr, int base); +long strtol (const char * nptr, char ** endptr, int base); +double strtod (const char * __restrict nptr, char ** __restri= ct endptr); +size_t strcspn (const char *, const char *); +int printf (const char *, ...); +int sscanf (const char *, const char *, ...); +FILE *fopen (const char *, const char *); +size_t fread (void *, size_t, size_t, FILE *); +size_t fwrite (const void *, size_t, size_t, FILE *); +int fclose (FILE *); +int fprintf (FILE *, const char *, ...); +int fgetc (FILE * _File); +uid_t getuid (void); +uid_t geteuid (void); +gid_t getgid (void); +gid_t getegid (void); +void qsort (void *, size_t, size_t, int (*)(const void *, = const void *)); +char *getenv (const char *); +#if defined(__GNUC__) && (__GNUC__ >=3D 2) +void abort (void) __attribute__((__noreturn__)); +#else +void abort (void); +#endif +int toupper (int); +int Digit2Val (int); +time_t time (time_t *); + +// +// Macros that directly map functions to BaseLib, BaseMemoryLib, and Debug= Lib functions +// +#define strcmp AsciiStrCmp +#define memcpy(dest,source,count) CopyMem(dest,source,(UINTN)(coun= t)) +#define memset(dest,ch,count) SetMem(dest,(UINTN)(count),(UINT= 8)(ch)) +#define memchr(buf,ch,count) ScanMem8(buf,(UINTN)(count),(UIN= T8)ch) +#define memcmp(buf1,buf2,count) (int)(CompareMem(buf1,buf2,(UINT= N)(count))) +#define memmove(dest,source,count) CopyMem(dest,source,(UINTN)(coun= t)) +#define strlen(str) (size_t)(AsciiStrnLenS(str,MAX_S= TRING_SIZE)) +#define strcpy(strDest,strSource) AsciiStrCpyS(strDest,(strlen(str= Source)+1),strSource) +#define strncpy(strDest,strSource,count) AsciiStrnCpyS(strDest,(UINTN)cou= nt,strSource,(UINTN)count) +#define strncpys(strDest, DestLen, strSource,count) AsciiStrnCpyS(strDest= ,DestLen,strSource,(UINTN)count) +#define strcat(strDest,strSource) AsciiStrCatS(strDest,(strlen(str= Source)+strlen(strDest)+1),strSource) +#define strchr(str,ch) ScanMem8((VOID *)(str),AsciiStrS= ize(str),(UINT8)ch) +#define strcasecmp(str1,str2) (int)AsciiStriCmp(str1,str2) +#define strstr(s1,s2) AsciiStrStr(s1,s2) +#define snprintf(buf,len,...) RedfishAsciiSPrint(buf,len,__VA_= ARGS__) +#define vsnprintf(buf,len,format,marker) RedfishAsciiVSPrint((buf),(len),= (format),(marker)) +#define assert(expression) ASSERT(expression) +#define offsetof(type,member) OFFSET_OF(type,member) + +#define EOF (-1) + +extern int errno; + +#define ERANGE 34 /* 34 Result too large */ + +#endif diff --git a/RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c b/Redf= ishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c new file mode 100644 index 0000000000..0696341bc0 --- /dev/null +++ b/RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c @@ -0,0 +1,809 @@ +/** @file + CRT wrapper functions for system call,the string operation functions + are remodeled after edk2-libc. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#include +#include +#include +#include +#include + +int errno =3D 0; + +/** + Determine if a particular character is an alphanumeric character + @return Returns 1 if c is an alphanumeric character, otherwise returns = 0. +**/ +int isalnum (int c) +{ + // + // ::=3D [0-9] | [a-z] | [A-Z] + // + return ((('0' <=3D (c)) && ((c) <=3D '9')) || + (('a' <=3D (c)) && ((c) <=3D 'z')) || + (('A' <=3D (c)) && ((c) <=3D 'Z'))); +} + +/** + Determine if a particular character is a digital character + + @return Returns 1 if c is an digital character, otherwise returns 0. +**/ +int isdchar (int c) +{ + // + // [0-9] | [e +-.] + // + return ((('0' <=3D (c)) && ((c) <=3D '9')) || + (c =3D=3D 'e') || (c =3D=3D 'E') || + (c =3D=3D '+') || (c =3D=3D '-') || + (c =3D=3D '.')); +} + +/** + Determine if a particular character is a space character + + @return Returns 1 if c is a space character +**/ +int isspace (int c) +{ + // + // ::=3D [ ] + // + return ((c) =3D=3D ' ') || ((c) =3D=3D '\t') || ((c) =3D=3D '\r') || ((c= ) =3D=3D '\n') || ((c) =3D=3D '\v') || ((c) =3D=3D '\f'); +} + +/** + Allocates memory blocks +*/ +void *malloc (size_t size) +{ + return AllocatePool ((UINTN) size); +} + +/** + De-allocates or frees a memory block +*/ +void free (void *ptr) +{ + // + // In Standard C, free() handles a null pointer argument transparently. = This + // is not true of FreePool() below, so protect it. + // + if (ptr !=3D NULL) { + FreePool (ptr); + } +} + +/** + NetBSD Compatibility Function strdup creates a duplicate copy of a strin= g. + + @return Returns the pointer to duplicated string. +**/ +char * strdup(const char *str) +{ + size_t len; + char *copy; + + len =3D strlen(str) + 1; + if ((copy =3D malloc(len)) =3D=3D NULL) + return (NULL); + memcpy(copy, str, len); + return (copy); +} + +/** The toupper function converts a lowercase letter to a corresponding + uppercase letter. + + @param[in] c The character to be converted. + + @return If the argument is a character for which islower is true and + there are one or more corresponding characters, as specified= by + the current locale, for which isupper is true, the toupper + function returns one of the corresponding characters (always= the + same one for any given locale); otherwise, the argument is + returned unchanged. +**/ +int +toupper( + IN int c + ) +{ + if ( (c >=3D 'a') && (c <=3D 'z') ) { + c =3D c - ('a' - 'A'); + } + return c; +} + +/** + Digit to a value. + + @return Returns the value of digit. +**/ +int +Digit2Val( int c) +{ + if (((c >=3D 'a') && (c <=3D 'z')) || ((c >=3D 'A') && (c <=3D 'Z'))) { = /* If c is one of [A-Za-z]... */ + c =3D toupper(c) - 7; // Adjust so 'A' is ('9' + 1) + } + return c - '0'; // Value returned is between 0 and 35, inclusive. +} + + +/** The strtoll function converts the initial portion of the string pointe= d to + by nptr to long long int representation. + + See the description for strtol for more information. + + @return The strtoll function returns the converted value, if any. If no + conversion could be performed, zero is returned. If the correct + value is outside the range of representable values, LLONG_MIN = or + LLONG_MAX is returned (according to the sign of the value, if = any), + and the value of the macro ERANGE is stored in errno. +**/ +long long +strtoll(const char * nptr, char ** endptr, int base) +{ + const char *pEnd; + long long Result =3D 0; + long long Previous; + int temp; + BOOLEAN Negative =3D FALSE; + + pEnd =3D nptr; + + if((base < 0) || (base =3D=3D 1) || (base > 36)) { + if(endptr !=3D NULL) { + *endptr =3D NULL; + } + return 0; + } + // Skip leading spaces. + while(isspace(*nptr)) ++nptr; + + // Process Subject sequence: optional sign followed by digits. + if(*nptr =3D=3D '+') { + Negative =3D FALSE; + ++nptr; + } + else if(*nptr =3D=3D '-') { + Negative =3D TRUE; + ++nptr; + } + + if(*nptr =3D=3D '0') { /* Might be Octal or Hex */ + if(toupper(nptr[1]) =3D=3D 'X') { /* Looks like Hex */ + if((base =3D=3D 0) || (base =3D=3D 16)) { + nptr +=3D 2; /* Skip the "0X" */ + base =3D 16; /* In case base was 0 */ + } + } + else { /* Looks like Octal */ + if((base =3D=3D 0) || (base =3D=3D 8)) { + ++nptr; /* Skip the leading "0" */ + base =3D 8; /* In case base was 0 */ + } + } + } + if(base =3D=3D 0) { /* If still zero then must be decimal */ + base =3D 10; + } + if(*nptr =3D=3D '0') { + for( ; *nptr =3D=3D '0'; ++nptr); /* Skip any remaining leading zeros= */ + pEnd =3D nptr; + } + + while( isalnum(*nptr) && ((temp =3D Digit2Val(*nptr)) < base)) { + Previous =3D Result; + Result =3D MultS64x64 (Result, base) + (long long int)temp; + if( Result <=3D Previous) { // Detect Overflow + if(Negative) { + Result =3D LLONG_MIN; + } + else { + Result =3D LLONG_MAX; + } + Negative =3D FALSE; + errno =3D ERANGE; + break; + } + pEnd =3D ++nptr; + } + if(Negative) { + Result =3D -Result; + } + + // Save pointer to final sequence + if(endptr !=3D NULL) { + *endptr =3D (char *)pEnd; + } + return Result; +} + +/** The strtol, strtoll, strtoul, and strtoull functions convert the initi= al + portion of the string pointed to by nptr to long int, long long int, + unsigned long int, and unsigned long long int representation, respecti= vely. + First, they decompose the input string into three parts: an initial, + possibly empty, sequence of white-space characters (as specified by the + isspace function), a subject sequence resembling an integer represente= d in + some radix determined by the value of base, and a final string of one = or + more unrecognized characters, including the terminating null character= of + the input string. Then, they attempt to convert the subject sequence t= o an + integer, and return the result. + + If the value of base is zero, the expected form of the subject sequenc= e is + that of an integer constant, optionally preceded + by a plus or minus sign, but not including an integer suffix. If the v= alue + of base is between 2 and 36 (inclusive), the expected form of the subj= ect + sequence is a sequence of letters and digits representing an integer w= ith + the radix specified by base, optionally preceded by a plus or minus si= gn, + but not including an integer suffix. The letters from a (or A) through= z + (or Z) are ascribed the values 10 through 35; only letters and digits = whose + ascribed values are less than that of base are permitted. If the value= of + base is 16, the characters 0x or 0X may optionally precede the sequenc= e of + letters and digits, following the sign if present. + + The subject sequence is defined as the longest initial subsequence of = the + input string, starting with the first non-white-space character, that = is of + the expected form. The subject sequence contains no characters if the = input + string is empty or consists entirely of white space, or if the first + non-white-space character is other than a sign or a permissible letter= or digit. + + If the subject sequence has the expected form and the value of base is + zero, the sequence of characters starting with the first digit is + interpreted as an integer constant. If the subject sequence has the + expected form and the value of base is between 2 and 36, it is used as= the + base for conversion, ascribing to each letter its value as given above= . If + the subject sequence begins with a minus sign, the value resulting fro= m the + conversion is negated (in the return type). A pointer to the final str= ing + is stored in the object pointed to by endptr, provided that endptr is + not a null pointer. + + In other than the "C" locale, additional locale-specific subject seque= nce + forms may be accepted. + + If the subject sequence is empty or does not have the expected form, no + conversion is performed; the value of nptr is stored in the object poi= nted + to by endptr, provided that endptr is not a null pointer. + + @return The strtol, strtoll, strtoul, and strtoull functions return the + converted value, if any. If no conversion could be performed, = zero + is returned. If the correct value is outside the range of + representable values, LONG_MIN, LONG_MAX, LLONG_MIN, LLONG_MAX, + ULONG_MAX, or ULLONG_MAX is returned (according to the return = type + and sign of the value, if any), and the value of the macro ERA= NGE + is stored in errno. +**/ +long +strtol(const char * nptr, char ** endptr, int base) +{ + const char *pEnd; + long Result =3D 0; + long Previous; + int temp; + BOOLEAN Negative =3D FALSE; + + pEnd =3D nptr; + + if((base < 0) || (base =3D=3D 1) || (base > 36)) { + if(endptr !=3D NULL) { + *endptr =3D NULL; + } + return 0; + } + // Skip leading spaces. + while(isspace(*nptr)) ++nptr; + + // Process Subject sequence: optional sign followed by digits. + if(*nptr =3D=3D '+') { + Negative =3D FALSE; + ++nptr; + } + else if(*nptr =3D=3D '-') { + Negative =3D TRUE; + ++nptr; + } + + if(*nptr =3D=3D '0') { /* Might be Octal or Hex */ + if(toupper(nptr[1]) =3D=3D 'X') { /* Looks like Hex */ + if((base =3D=3D 0) || (base =3D=3D 16)) { + nptr +=3D 2; /* Skip the "0X" */ + base =3D 16; /* In case base was 0 */ + } + } + else { /* Looks like Octal */ + if((base =3D=3D 0) || (base =3D=3D 8)) { + ++nptr; /* Skip the leading "0" */ + base =3D 8; /* In case base was 0 */ + } + } + } + if(base =3D=3D 0) { /* If still zero then must be decimal */ + base =3D 10; + } + if(*nptr =3D=3D '0') { + for( ; *nptr =3D=3D '0'; ++nptr); /* Skip any remaining leading zeros= */ + pEnd =3D nptr; + } + + while( isalnum(*nptr) && ((temp =3D Digit2Val(*nptr)) < base)) { + Previous =3D Result; + Result =3D (Result * base) + (long int)temp; + if( Result <=3D Previous) { // Detect Overflow + if(Negative) { + Result =3D LONG_MIN; + } + else { + Result =3D LONG_MAX; + } + Negative =3D FALSE; + errno =3D ERANGE; + break; + } + pEnd =3D ++nptr; + } + if(Negative) { + Result =3D -Result; + } + + // Save pointer to final sequence + if(endptr !=3D NULL) { + *endptr =3D (char *)pEnd; + } + return Result; +} + +/** The strtoull function converts the initial portion of the string point= ed to + by nptr to unsigned long long int representation. + + See the description for strtol for more information. + + @return The strtoull function returns the converted value, if any. If = no + conversion could be performed, zero is returned. If the correct + value is outside the range of representable values, ULLONG_MAX= is + returned and the value of the macro ERANGE is stored in errno. +**/ +unsigned long long +strtoull(const char * nptr, char ** endptr, int base) +{ + const char *pEnd; + unsigned long long Result =3D 0; + unsigned long long Previous; + int temp; + + pEnd =3D nptr; + + if((base < 0) || (base =3D=3D 1) || (base > 36)) { + if(endptr !=3D NULL) { + *endptr =3D NULL; + } + return 0; + } + // Skip leading spaces. + while(isspace(*nptr)) ++nptr; + + // Process Subject sequence: optional + sign followed by digits. + if(*nptr =3D=3D '+') { + ++nptr; + } + + if(*nptr =3D=3D '0') { /* Might be Octal or Hex */ + if(toupper(nptr[1]) =3D=3D 'X') { /* Looks like Hex */ + if((base =3D=3D 0) || (base =3D=3D 16)) { + nptr +=3D 2; /* Skip the "0X" */ + base =3D 16; /* In case base was 0 */ + } + } + else { /* Looks like Octal */ + if((base =3D=3D 0) || (base =3D=3D 8)) { + ++nptr; /* Skip the leading "0" */ + base =3D 8; /* In case base was 0 */ + } + } + } + if(base =3D=3D 0) { /* If still zero then must be decimal */ + base =3D 10; + } + if(*nptr =3D=3D '0') { + for( ; *nptr =3D=3D '0'; ++nptr); /* Skip any remaining leading zeros= */ + pEnd =3D nptr; + } + + while( isalnum(*nptr) && ((temp =3D Digit2Val(*nptr)) < base)) { + Previous =3D Result; + Result =3D DivU64x32 (Result, base) + (unsigned long long)temp; + if( Result < Previous) { // If we overflowed + Result =3D ULLONG_MAX; + errno =3D ERANGE; + break; + } + pEnd =3D ++nptr; + } + + // Save pointer to final sequence + if(endptr !=3D NULL) { + *endptr =3D (char *)pEnd; + } + return Result; +} + +/** + edk2 Jansson port does not support doubles, simply return 0. + + These conversion functions convert the initial portion of the string + pointed to by nptr to double, float, and long double representation, + respectively. + + The strtod(), strtof(), and strtold() functions return the converted + value, if any. + + If endptr is not NULL, a pointer to the character after the last charac- + ter used in the conversion is stored in the location referenced by + endptr. + + If no conversion is performed, zero is returned and the value of nptr is + stored in the location referenced by endptr. + + If the correct value would cause overflow, plus or minus HUGE_VAL, + HUGE_VALF, or HUGE_VALL is returned (according to the sign and type of + the return value), and ERANGE is stored in errno. If the correct value + would cause underflow, zero is returned and ERANGE is stored in errno. + + @return Return 0. +**/ +double +strtod (const char * __restrict nptr, char ** __restrict endptr) { + + DEBUG((DEBUG_INFO, "We don't supprot double type on edk2 yet!")); + ASSERT(FALSE); + return (double)0; +} + +/** + Allocate and zero-initialize array. +**/ +void * +calloc(size_t Num, size_t Size) +{ + void *RetVal; + size_t NumSize; + + NumSize =3D Num * Size; + RetVal =3D NULL; + if (NumSize !=3D 0) { + RetVal =3D malloc(NumSize); + if( RetVal !=3D NULL) { + (VOID)ZeroMem( RetVal, NumSize); + } + } + DEBUG((DEBUG_POOL, "0x%p =3D calloc(%d, %d)\n", RetVal, Num, Size)); + + return RetVal; +} + +// +// The arrays give the cumulative number of days up to the first of the +// month number used as the index (1 -> 12) for regular and leap years. +// The value at index 13 is for the whole year. +// +UINTN CumulativeDays[2][14] =3D { + { + 0, + 0, + 31, + 31 + 28, + 31 + 28 + 31, + 31 + 28 + 31 + 30, + 31 + 28 + 31 + 30 + 31, + 31 + 28 + 31 + 30 + 31 + 30, + 31 + 28 + 31 + 30 + 31 + 30 + 31, + 31 + 28 + 31 + 30 + 31 + 30 + 31 + 31, + 31 + 28 + 31 + 30 + 31 + 30 + 31 + 31 + 30, + 31 + 28 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31, + 31 + 28 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31 + 30, + 31 + 28 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31 + 30 + 31 + }, + { + 0, + 0, + 31, + 31 + 29, + 31 + 29 + 31, + 31 + 29 + 31 + 30, + 31 + 29 + 31 + 30 + 31, + 31 + 29 + 31 + 30 + 31 + 30, + 31 + 29 + 31 + 30 + 31 + 30 + 31, + 31 + 29 + 31 + 30 + 31 + 30 + 31 + 31, + 31 + 29 + 31 + 30 + 31 + 30 + 31 + 31 + 30, + 31 + 29 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31, + 31 + 29 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31 + 30, + 31 + 29 + 31 + 30 + 31 + 30 + 31 + 31 + 30 + 31 + 30 + 31 + } +}; + +#define IsLeap(y) (((y) % 4) =3D=3D 0 && (((y) % 100) !=3D 0 || ((y) % 4= 00) =3D=3D 0)) +#define SECSPERMIN (60) +#define SECSPERHOUR (60 * 60) +#define SECSPERDAY (24 * SECSPERHOUR) + +/** + Get the system time as seconds elapsed since midnight, January 1, 1970. +**/ +time_t time (time_t *timer) +{ + EFI_TIME Time; + time_t CalTime; + UINTN Year; + + // + // Get the current time and date information + // + gRT->GetTime (&Time, NULL); + + // + // Years Handling + // UTime should now be set to 00:00:00 on Jan 1 of the current year. + // + for (Year =3D 1970, CalTime =3D 0; Year !=3D Time.Year; Year++) { + CalTime =3D CalTime + (time_t)(CumulativeDays[IsLeap(Year)][13] * SECS= PERDAY); + } + + // + // Add in number of seconds for current Month, Day, Hour, Minute, Second= s, and TimeZone adjustment + // + CalTime =3D CalTime + + (time_t)((Time.TimeZone !=3D EFI_UNSPECIFIED_TIMEZONE) ? (Time= .TimeZone * 60) : 0) + + (time_t)(CumulativeDays[IsLeap(Time.Year)][Time.Month] * SECSP= ERDAY) + + (time_t)(((Time.Day > 0) ? Time.Day - 1 : 0) * SECSPERDAY) + + (time_t)(Time.Hour * SECSPERHOUR) + + (time_t)(Time.Minute * 60) + + (time_t)Time.Second; + + if (timer !=3D NULL) { + *timer =3D CalTime; + } + + return CalTime; +} + +/** + Performs a quick sort +**/ +void qsort (void *base, size_t num, size_t width, int (*compare)(const voi= d *, const void *)) +{ + + ASSERT (base !=3D NULL); + ASSERT (compare !=3D NULL); + + PerformQuickSort (base, (UINTN)num, (UINTN)width, (SORT_COMPARE)compare); + return; +} + +/** + Get character from stream, we don't support file operastion on edk2 JSON= library. + + @return Returns the character currently pointed by the internal file pos= ition indicator of the specified stream + +**/ +int fgetc(FILE * _File){ + return 0; +} +/** + This function check if this is the formating string specifier. + + @param[in] FormatString A Null-terminated ASCII format string. + @param[in,out] CurrentPosition The starting position at the given stri= ng to check for + "[flags][width][.precision][length]s" s= tring specifier. + @param[in] StrLength Maximum string length. + + @return BOOLEAN TRUE means this is the formating string specifier. Cur= rentPosition is + returned at the position of "s". + FALSE means this is not the formating string specifier= .. CurrentPosition is + returned at the position of failed character. + +**/ +BOOLEAN +CheckFormatingString ( + IN CONST CHAR8 *FormatString, + IN OUT UINTN *CurrentPosition, + IN UINTN StrLength + ) +{ + CHAR8 FormatStringParamater; + + while (*(FormatString + *CurrentPosition) !=3D 's') { + // + // Loop until reach character 's' if the formating string is + // compliant with "[flags][width][.precision][length]" format for + // the string specifier. + // + FormatStringParamater =3D *(FormatString + *CurrentPosition); + if ((FormatStringParamater !=3D '-') && + (FormatStringParamater !=3D '+') && + (FormatStringParamater !=3D '*') && + (FormatStringParamater !=3D '.') && + !(((UINTN)FormatStringParamater >=3D (UINTN)'0') && ((UINTN)Format= StringParamater <=3D (UINTN)'9')) + ) { + return FALSE; + } + (*CurrentPosition)++; + if (*CurrentPosition >=3D StrLength) { + return FALSE; + } + }; + return TRUE; +} + +/** + This function clones *FormatString however replaces "%s" with "%a" in the + returned string. + + @param[in] A Null-terminated ASCII format string. + + @return The new format string. Caller has to free the memory of this str= ing + using FreePool(). + +**/ +CHAR8 * +ReplaceUnicodeToAsciiStrFormat ( + IN CONST CHAR8 *FormatString +) +{ + UINTN FormatStrSize; + UINTN FormatStrIndex; + UINTN FormatStrSpecifier; + BOOLEAN PercentageMark; + CHAR8 *TempFormatBuffer; + BOOLEAN IsFormatString; + + // + // Error checking. + // + if (FormatString =3D=3D NULL) { + return NULL; + } + FormatStrSize =3D AsciiStrSize(FormatString); + if (FormatStrSize =3D=3D 0) { + return NULL; + } + TempFormatBuffer =3D AllocatePool(FormatStrSize); // Allocate memory for= the + // new string. + if (TempFormatBuffer=3D=3D NULL) { + return NULL; + } + // + // Clone *FormatString but replace "%s" wih "%a". + // "%%" is not considered as the format tag. + // + PercentageMark =3D FALSE; + FormatStrIndex =3D 0; + while (FormatStrIndex < FormatStrSize) { + if (PercentageMark =3D=3D TRUE) { + // + // Previous character is "%". + // + PercentageMark =3D FALSE; + if (*(FormatString + FormatStrIndex) !=3D '%') { // Check if this is= double "%". + FormatStrSpecifier =3D FormatStrIndex; + // + // Check if this is the formating string specifier. + // + IsFormatString =3D CheckFormatingString (FormatString, &FormatStrS= pecifier, FormatStrSize); + if ((FormatStrSpecifier - FormatStrIndex) !=3D 0) { + CopyMem((VOID *)(TempFormatBuffer + FormatStrIndex), + (VOID *)(FormatString + FormatStrIndex), + FormatStrSpecifier - FormatStrIndex + ); + } + FormatStrIndex =3D FormatStrSpecifier; + if (IsFormatString =3D=3D TRUE) { + // + // Replace 's' with 'a' which is printed in ASCII + // format on edk2 environment. + // + *(TempFormatBuffer + FormatStrSpecifier) =3D 'a'; + FormatStrIndex ++; + } + continue; + } + goto ContinueCheck; + } + if (*(FormatString + FormatStrIndex) =3D=3D '%') { + // + // This character is "%", set the flag. + // + PercentageMark =3D TRUE; + } +ContinueCheck: + // + // Clone character to the new string and advance FormatStrIndex + // to process next character. + // + *(TempFormatBuffer + FormatStrIndex) =3D *(FormatString + FormatStrInd= ex); + FormatStrIndex++; + }; + return TempFormatBuffer; +} + +/** + This is the Redfish version of CRT vsnprintf function, this function rep= laces "%s" to + "%a" before invoking AsciiVSPrint(). That is because "%s" is unicode bas= e on edk2 + environment however "%s" is ascii code base on vsnprintf(). + See definitions of AsciiVSPrint() for the details. + + @param StartOfBuffer A pointer to the output buffer for the produced = Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specifi= ed by StartOfBuffer. + @param FormatString A Null-terminated ASCII format string. + @param Marker VA_LIST marker for the variable argument list. + + @return The number of ASCII characters in the produced output buffer not= including the + Null-terminator. + +**/ +UINTN +EFIAPI +RedfishAsciiVSPrint ( + OUT CHAR8 *StartOfBuffer, + IN UINTN BufferSize, + IN CONST CHAR8 *FormatString, + IN VA_LIST Marker + ) +{ + CHAR8 *TempFormatBuffer; + UINTN LenStrProduced; + + // + // Looking for "%s" in the format string and replace it + // with "%a" for printing ASCII code characters on edk2 + // environment. + // + TempFormatBuffer =3D ReplaceUnicodeToAsciiStrFormat (FormatString); + if (TempFormatBuffer =3D=3D NULL) { + return 0; + } + LenStrProduced =3D AsciiVSPrint (StartOfBuffer, BufferSize, (CONST CHAR8= *)TempFormatBuffer, Marker); + FreePool (TempFormatBuffer); + return LenStrProduced; +} + +/** + This is the Redfish version of CRT snprintf function, this function repl= aces "%s" to + "%a" before invoking AsciiSPrint(). That is because "%s" is unicode base= on edk2 + environment however "%s" is ascii code base on snprintf(). + See definitions of AsciiSPrint() for the details. + + @param StartOfBuffer A pointer to the output buffer for the produced = Null-terminated + ASCII string. + @param BufferSize The size, in bytes, of the output buffer specifi= ed by StartOfBuffer. + @param FormatString A Null-terminated ASCII format string. + @param ... Variable argument list whose contents are access= ed based on the + format string specified by FormatString. + + @return The number of ASCII characters in the produced output buffer not= including the + Null-terminator. + +**/ +UINTN +EFIAPI +RedfishAsciiSPrint ( + OUT CHAR8 *StartOfBuffer, + IN UINTN BufferSize, + IN CONST CHAR8 *FormatString, + ... + ) +{ + VA_LIST Marker; + UINTN LenStrProduced; + + VA_START(Marker, FormatString); + LenStrProduced =3D RedfishAsciiVSPrint (StartOfBuffer, BufferSize, Forma= tString, Marker); + return LenStrProduced; +} + diff --git a/RedfishPkg/RedfishPkg.ci.yaml b/RedfishPkg/RedfishPkg.ci.yaml index 20c297ad22..e410d1a608 100644 --- a/RedfishPkg/RedfishPkg.ci.yaml +++ b/RedfishPkg/RedfishPkg.ci.yaml @@ -17,6 +17,25 @@ ], ## Both file path and directory path are accepted. "IgnoreFiles": [ + ## Below are files incorporated with open source which are + ## not edk2 coding standard compliant. + ## + ## EDK2 CRT library which is not edk2 coding + ## standard compliant. + ## C runtime library for RedfishPkg modules + "PrivateInclude/Crt/sys", + "PrivateInclude/Crt/assert.h", + "PrivateInclude/Crt/errno.h", + "PrivateInclude/Crt/limits.h", + "PrivateInclude/Crt/math.h", + "PrivateInclude/Crt/stdarg.h", + "PrivateInclude/Crt/stddef.h", + "PrivateInclude/Crt/stdio.h", + "PrivateInclude/Crt/stdlib.h", + "PrivateInclude/Crt/string.h", + "PrivateInclude/Crt/time.h", + "PrivateInclude/Library/RedfishCrtLib.h", + "PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c" ] }, "CompilerPlugin": { --=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 (#70025): https://edk2.groups.io/g/devel/message/70025 Mute This Topic: https://groups.io/mt/79519376/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- From nobody Thu Apr 25 22:13:25 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+70026+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+70026+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090722; cv=none; d=zohomail.com; s=zohoarc; b=E1s1DdVkr0tWfIoSARIlPvpsAsqYVRgQrjAE7dKWdoSNvyGUo4PgZyOqqg0jYrWkZ/N7a33Eub5TejOyo/mleS3YpqvhvPLCUQfuY0HVnutsCZUQhClVfcjz5pm409stjgalBqoPY+T0DzZWBQBtjvnq2U+LSpfUpB6ce2Ps6rs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090722; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=SYSB+oIagtPl08P452i1b1IkUnlYKX5q/PLm+SpC+8c=; b=cQgWf5K8fLOMogxiqPKzxXvi9qZYpsITuThcjw17qMHWY1Bl6WnUCtSLfY1J6dKBcXWJF54dIoRHjA4SiGfAipCf+Q8980DbUUFv99chLmmm/TCjKlzhtrsWtBPJP4UyAaoBaf6tlLhe+8Q/0gGsebmpYqaFbfWlcpnXImHWkNU= 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+70026+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090722185933.2080864121591; Thu, 7 Jan 2021 23:25:22 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id xjIRYY1788612xqgbIQdWmYG; Thu, 07 Jan 2021 23:25:21 -0800 X-Received: from mx0a-002e3701.pphosted.com (mx0a-002e3701.pphosted.com [148.163.147.86]) by mx.groups.io with SMTP id smtpd.web12.821.1610090716125878669 for ; Thu, 07 Jan 2021 23:25:16 -0800 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 1087JaCX028550; Fri, 8 Jan 2021 07:25:15 GMT X-Received: from g4t3427.houston.hpe.com (g4t3427.houston.hpe.com [15.241.140.73]) by mx0b-002e3701.pphosted.com with ESMTP id 35xf6ms7fx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 08 Jan 2021 07:25:15 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3427.houston.hpe.com (Postfix) with ESMTP id B11C966; Fri, 8 Jan 2021 07:25:14 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 9EBF048; Fri, 8 Jan 2021 07:25:13 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Leif Lindholm , Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 4/6] RedfishPkg/library: EDK2 port of jansson library Date: Fri, 8 Jan 2021 14:37:11 +0800 Message-Id: <20210108063713.8853-5-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-Proofpoint-UnRewURL: 0 URL was un-rewritten MIME-Version: 1.0 X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: YzefGzfEuhcNjdvUKX7HU7G7x1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090721; bh=5v3dbmpi2VObB+KSviUK0rqDZEoCKth6TAnqV3WyB5I=; h=Cc:Date:From:Reply-To:Subject:To; b=c3RQph5Kgdrh6VssaBEWAYAjDJEM0NqUnEoyl0WpTU1qj2tuqcux7c8UNtNXZi1hgmA VQb3ZOvOg5yIxYzCAaECna4ShU8Ok8vnOauViQKVAyXmfa8y42V3s7lTiB7ux+EiRGgV8 xViheNAIhc2+xPrSrrniswt1a0/Lsbt3jxE= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" edk2 JsonLib which is the edk2 port of open source jansson library. (https://github.com/akheron/jansson) jansson library is the open source project to manipulate JSON data structure. Signed-off-by: Abner Chang Cc: Leif Lindholm Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Nickle Wang Acked-by: Leif Lindholm --- RedfishPkg/RedfishPkg.dec | 12 + RedfishPkg/Library/JsonLib/JsonLib.inf | 86 ++ RedfishPkg/Include/Library/JsonLib.h | 779 ++++++++++++ RedfishPkg/Library/JsonLib/jansson_config.h | 41 + .../Library/JsonLib/jansson_private_config.h | 19 + RedfishPkg/Library/JsonLib/JsonLib.c | 957 ++++++++++++++ RedfishPkg/Library/JsonLib/load.c | 1111 +++++++++++++++++ RedfishPkg/Library/JsonLib/Readme.rst | 35 + RedfishPkg/RedfishPkg.ci.yaml | 8 +- 9 files changed, 3047 insertions(+), 1 deletion(-) create mode 100644 RedfishPkg/Library/JsonLib/JsonLib.inf create mode 100644 RedfishPkg/Include/Library/JsonLib.h create mode 100644 RedfishPkg/Library/JsonLib/jansson_config.h create mode 100644 RedfishPkg/Library/JsonLib/jansson_private_config.h create mode 100644 RedfishPkg/Library/JsonLib/JsonLib.c create mode 100644 RedfishPkg/Library/JsonLib/load.c create mode 100644 RedfishPkg/Library/JsonLib/Readme.rst diff --git a/RedfishPkg/RedfishPkg.dec b/RedfishPkg/RedfishPkg.dec index 9f8b85778d..2985676b60 100644 --- a/RedfishPkg/RedfishPkg.dec +++ b/RedfishPkg/RedfishPkg.dec @@ -19,6 +19,13 @@ [Includes.Common.Private] PrivateInclude # Private header files for C RTL. PrivateInclude/Crt # Private header files for C RTL. + Library/JsonLib # Private header files for jansson + # configuration files. + # - jansson_config.h + # - jansson_private_config.h + # jansson.h refers to above two configurat= ion + # files for building platform jansson libr= ary. + Library/JsonLib/jansson/src # For referring to jannson.h =20 [LibraryClasses] ## @libraryclass Platform Redfish Host Interface Library @@ -38,6 +45,11 @@ # This library is only intended to be used by UEFI network stack modul= es. RestExLib|Include/Library/RestExLib.h =20 + ## @libraryclass Provides the library functions based on third party + # jansson library to manipulate JSON data structure. + # + JsonLib|Include/Library/JsonLib.h + [LibraryClasses.Common.Private] ## @libraryclass Provides the private C runtime library functions. # CRT library is currently used by edk2 JsonLib (open source diff --git a/RedfishPkg/Library/JsonLib/JsonLib.inf b/RedfishPkg/Library/Js= onLib/JsonLib.inf new file mode 100644 index 0000000000..48b094a78a --- /dev/null +++ b/RedfishPkg/Library/JsonLib/JsonLib.inf @@ -0,0 +1,86 @@ +## @file +# Thirty party Jansson library for JSON operations. +# +# Copyright (c) 2019, Intel Corporation. All rights reserved.
+# (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+# +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x0001001b + BASE_NAME =3D JsonLib + FILE_GUID =3D F5E36815-305A-4C5A-9D75-4F2149E45255 + MODULE_TYPE =3D DXE_DRIVER + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D JsonLib|DXE_DRIVER UEFI_APPLICATION U= EFI_DRIVER + +# +# VALID_ARCHITECTURES =3D IA32 X64 ARM AARCH64 RISCV64 +# + +[Sources] + # + # Below are the source code of third + # party jansson library. + # + jansson/src/dump.c + jansson/src/error.c + jansson/src/hashtable.c + jansson/src/hashtable_seed.c + jansson/src/memory.c + jansson/src/pack_unpack.c + jansson/src/strbuffer.c + jansson/src/strconv.c + jansson/src/utf.c + jansson/src/value.c + jansson/src/version.c + # + # Below are the source of edk2 JsonLib. + # + JsonLib.c + jansson_config.h + jansson_private_config.h + # + # Below is the source code override to fix the build issue. + # Add code in load.c to conditionally use stdin according + # to HAVE_UNISTD_H macro. The PR is submitted to jansson + # open source community. + # https://github.com/akheron/jansson/pull/558 + # + load.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + RedfishPkg/RedfishPkg.dec + +[LibraryClasses] + BaseLib + BaseMemoryLib + Ucs2Utf8Lib + RedfishCrtLib + DebugLib + MemoryAllocationLib + PrintLib + UefiRuntimeServicesTableLib + UefiLib + +[BuildOptions] + # + # Disables the following Visual Studio compiler warnings + # so we do not break the build with /WX option: + # C4090: 'function' : different 'const' qualifiers + # C4244: conversion from type1 to type2, possible loss of data + # C4334: 32-bit shift implicitly converted to 64-bit + # C4204: nonstandard extension used: non-constant aggregate initializer + # + # Define macro HAVE_CONFIG_H to include jansson_private_config.h to buil= d. + # Undefined _WIN32, WIN64, _MSC_VER macros + # On GCC, no error on the unused-function and unused-but-set-variable. + # + MSFT:*_*_X64_CC_FLAGS =3D /wd4204 /wd4244 /wd4090 /wd4334 /DHAVE_CONFIG_= H=3D1 /U_WIN32 /UWIN64 /U_MSC_VER + MSFT:*_*_IA32_CC_FLAGS =3D /wd4204 /wd4244 /wd4090 /DHAVE_CONFIG_H=3D1 /= U_WIN32 /UWIN64 /U_MSC_VER + GCC:*_*_*_CC_FLAGS =3D -Wno-unused-function -Wno-unused-but-set-variable + diff --git a/RedfishPkg/Include/Library/JsonLib.h b/RedfishPkg/Include/Libr= ary/JsonLib.h new file mode 100644 index 0000000000..3c10f67d27 --- /dev/null +++ b/RedfishPkg/Include/Library/JsonLib.h @@ -0,0 +1,779 @@ +/** @file + APIs for JSON operations. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef JSON_LIB_H_ +#define JSON_LIB_H_ + +typedef VOID* EDKII_JSON_VALUE; +typedef VOID* EDKII_JSON_ARRAY; +typedef VOID* EDKII_JSON_OBJECT; + +/// +/// Map to json_int_t in jansson.h +/// +typedef INT64 EDKII_JSON_INT_T; // #JSON_INTEGER_IS_LONG_LONG is set = to 1 + // in jansson_Config.h + +/// +/// Map to the definitions in jansson.h +/// See below URI for the JSON encoding flags reference. +/// https://jansson.readthedocs.io/en/2.13/apiref.html#encoding +/// +#define EDKII_JSON_MAX_INDENT 0x1F +#define EDKII_JSON_INDENT(n) ((n) & EDKII_JSON_MAX_INDENT) + +#define EDKII_JSON_COMPACT 0x20 +#define EDKII_JSON_ENSURE_ASCII 0x40 +#define EDKII_JSON_SORT_KEYS 0x80 +#define EDKII_JSON_PRESERVE_ORDER 0x100 +#define EDKII_JSON_ENCODE_ANY 0x200 +#define EDKII_JSON_ESCAPE_SLASH 0x400 +#define EDKII_JSON_REAL_PRECISION(n) (((n) & 0x1F) << 11) +#define EDKII_JSON_EMBED 0x10000 + +/// +/// Map to the definitions in jansson.h +/// See below URI for the JSON decoding flags reference. +/// https://jansson.readthedocs.io/en/2.13/apiref.html?highlight=3Djson_lo= adb#decoding +/// +#define EDKII_JSON_REJECT_DUPLICATES 0x1 +#define EDKII_JSON_DISABLE_EOF_CHECK 0x2 +#define EDKII_JSON_DECODE_ANY 0x4 +#define EDKII_JSON_DECODE_INT_AS_REAL 0x8 +#define EDKII_JSON_ALLOW_NUL 0x10 + +#define EDKII_JSON_ARRAY_FOREACH(Array, Index, Value) \ + for(Index =3D 0; \ + Index < JsonArrayCount(Array) && (Value =3D JsonArrayGetValue(Array, I= ndex)); \ + Index++) + +/// +/// Map to the json_error_t in jansson.h +/// +#define EDKII_JSON_ERROR_TEXT_LENGTH 160 +#define EDKII_JSON_ERROR_SOURCE_LENGTH 80 +typedef struct { + INTN Line; + INTN Column; + INTN Position; + CHAR8 Source [EDKII_JSON_ERROR_SOURCE_LENGTH]; + CHAR8 Text [EDKII_JSON_ERROR_TEXT_LENGTH]; +} EDKII_JSON_ERROR; + +/// +/// Map to the json_type in jansson.h +/// +typedef enum { + EdkiiJsonTypeObject, + EdkiiJsonTypeArray, + EdkiiJsonTypeString, + EdkiiJsonTypeInteger, + EdkiiJsonTypeReal, + EdkiiJsonTypeTrue, + EdkiiJsonTypeFalse, + EdkiiJsonTypeNull +} EDKII_JSON_TYPE; + +/** + The function is used to initialize a JSON value which contains a new JSO= N array, + or NULL on error. Initially, the array is empty. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @retval The created JSON value which contains a JSON array or NULL = if intial a JSON array + is failed. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitArray ( + VOID + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N object, + or NULL on error. Initially, the object is empty. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @retval The created JSON value which contains a JSON object or NULL= if intial a JSON object + is failed. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitObject ( + VOID + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N string, + or NULL on error. + + The input string must be NULL terminated Ascii format, non-Ascii charact= ers will + be processed as an error. Unicode characters can also be represented by = Ascii string + as the format: \u + 4 hexadecimal digits, like \u3E5A, or \u003F. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] String The Ascii string to initialize to JSON value + + @retval The created JSON value which contains a JSON string or NULL= . Select a + Getter API for a specific encoding format. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitAsciiString ( + IN CONST CHAR8 *String + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N string, + or NULL on error. + + The input must be a NULL terminated UCS2 format Unicode string. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] String The Unicode string to initialize to JSON value + + @retval The created JSON value which contains a JSON string or NULL= . Select a + Getter API for a specific encoding format. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitUnicodeString ( + IN CHAR16 *String + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N integer, + or NULL on error. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] Value The integer to initialize to JSON value + + @retval The created JSON value which contains a JSON number or NULL. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitNumber ( + IN INT64 Value + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N boolean, + or NULL on error. + + Boolean JSON value is kept as static value, and no need to do any cleanu= p work. + + @param[in] Value The boolean value to initialize. + + @retval The created JSON value which contains a JSON boolean or NUL= L. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitBoolean ( + IN BOOLEAN Value + ); + +/** + The function is used to initialize a JSON value which contains a new JSO= N NULL, + or NULL on error. + + NULL JSON value is kept as static value, and no need to do any cleanup w= ork. + + @retval The created NULL JSON value. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitNull ( + VOID + ); + +/** + The function is used to decrease the reference count of a JSON value by = one, and once + this reference count drops to zero, the value is destroyed and it can no= longer be used. + If this destroyed value is object type or array type, reference counts f= or all containing + JSON values will be decreased by 1. Boolean JSON value and NULL JSON val= ue won't be destroyed + since they are static values kept in memory. + + Reference Count Strategy: BaseJsonLib uses this strategy to track whethe= r a value is still + in use or not. When a value is created, it's reference count is set to 1= . If a reference to a + value is kept for use, its reference count is incremented, and when the = value is no longer + needed, the reference count is decremented. When the reference count dro= ps to zero, there are + no references left, and the value can be destroyed. + + The given JSON value maybe NULL and not causing any problem. Just output= the debug message + to inform caller the NULL value is passed in. + + @param[in] Json The JSON value to be freed. json_decref ma= y return without any + changes if Json is NULL. + +**/ +VOID +EFIAPI +JsonValueFree ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to create a fresh copy of a JSON value, and all chi= ld values are deep + copied in a recursive fashion. It should be called when this JSON value = might be modified + in later use, but the original still wants to be used in somewhere else. + + Reference counts of the returned root JSON value and all child values wi= ll be set to 1, and + caller needs to cleanup the root value by calling JsonValueFree(). + + * Note: Since this function performs a copy from bottom to up, too many = calls may cause some + performance issues, user should avoid unnecessary calls to this function= unless it is really + needed. + + @param[in] Json The JSON value to be cloned. + + @retval Return the cloned JSON value, or NULL on error. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueClone ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON value contains a JSO= N array. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON array. + @retval FALSE The JSON value doesn't contain a JSON arra= y. + +**/ +BOOLEAN +EFIAPI +JsonValueIsArray ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON value contains a JSO= N object. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON object. + @retval FALSE The JSON value doesn't contain a JSON obje= ct. + +**/ +BOOLEAN +EFIAPI +JsonValueIsObject ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON Value contains a str= ing, Ascii or + Unicode format is not differentiated. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON string. + @retval FALSE The JSON value doesn't contain a JSON stri= ng. + +**/ +BOOLEAN +EFIAPI +JsonValueIsString ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON value contains a JSO= N number. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value is contains JSON number. + @retval FALSE The JSON value doesn't contain a JSON numb= er. + +**/ +BOOLEAN +EFIAPI +JsonValueIsNumber ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON value contains a JSO= N boolean. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON boolean. + @retval FALSE The JSON value doesn't contain a JSON bool= ean. + +**/ +BOOLEAN +EFIAPI +JsonValueIsBoolean ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to return if the provided JSON value contains a JSO= N NULL. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON NULL. + @retval FALSE The JSON value doesn't contain a JSON NULL. + +**/ +BOOLEAN +EFIAPI +JsonValueIsNull ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated array in an array type J= SON value. + + Any changes to the returned array will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated array in JSON value or NULL. + +**/ +EDKII_JSON_ARRAY +EFIAPI +JsonValueGetArray ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated object in an object type= JSON value. + + Any changes to the returned object will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated object in JSON value or NULL. + +**/ +EDKII_JSON_OBJECT +EFIAPI +JsonValueGetObject ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated Ascii string in a string= type JSON value. + + Any changes to the returned string will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated Ascii string in JSON value or NULL. + +**/ +CONST CHAR8 * +EFIAPI +JsonValueGetAsciiString ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated Unicode string in a stri= ng type JSON value. + + Caller can do any changes to the returned string without any impact to t= he original JSON + value, and caller needs to free the returned string using FreePool(). + + @param[in] Json The provided JSON value. + + @retval Return the associated Unicode string in JSON value or NULL. + +**/ +CHAR16* +EFIAPI +JsonValueGetUnicodeString ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated integer in a number type= JSON value. + + The input JSON value should not be NULL or contain no JSON number, other= wise it will + ASSERT() and return 0. + + @param[in] Json The provided JSON value. + + @retval Return the associated number in JSON value. + +**/ +INT64 +EFIAPI +JsonValueGetNumber ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated boolean in a boolean typ= e JSON value. + + The input JSON value should not be NULL or contain no JSON boolean, othe= rwise it will + ASSERT() and return FALSE. + + @param[in] Json The provided JSON value. + + @retval Return the associated value of JSON boolean. + +**/ +BOOLEAN +EFIAPI +JsonValueGetBoolean ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to retrieve the associated string in a string type = JSON value. + + Any changes to the returned string will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated Ascii string in JSON value or NULL on= errors. + +**/ +CONST CHAR8* +EFIAPI +JsonValueGetString ( + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to get the number of elements in a JSON object, or = 0 if it is NULL or + not a JSON object. + + @param[in] JsonObject The provided JSON object. + + @retval Return the number of elements in this JSON object or 0. + +**/ +UINTN +EFIAPI +JsonObjectSize ( + IN EDKII_JSON_OBJECT JsonObject + ); + +/** + The function is used to enumerate all keys in a JSON object. + + Caller should be responsible to free the returned key array reference us= ing + FreePool(). But contained keys are read only and must not be modified or= freed. + + @param[in] JsonObj The provided JSON object for enumera= tion. + @param[out] KeyCount The count of keys in this JSON objec= t. + + @retval Return an array of the enumerated keys in this JSON object = or NULL if + JsonObj is not an JSON object, key count is zero or on othe= r errors. + +**/ +CHAR8** +JsonObjectGetKeys ( + IN EDKII_JSON_OBJECT JsonObj, + OUT UINTN *KeyCount + ); + +/** + The function is used to get a JSON value corresponding to the input key = from a JSON object. + + It only returns a reference to this value and any changes on this value = will impact the + original JSON object. If that is not expected, please call JsonValueClon= e() to clone it to + use. + + Input key must be a valid NULL terminated UTF8 encoded string. NULL will= be returned when + Key-Value is not found in this JSON object. + + @param[in] JsonObj The provided JSON object. + @param[in] Key The key of the JSON value to be retrieved. + + @retval Return the corresponding JSON value to key, or NULL on erro= r. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonObjectGetValue ( + IN CONST EDKII_JSON_OBJECT JsonObj, + IN CONST CHAR8 *Key + ); + +/** + The function is used to set a JSON value corresponding to the input key = from a JSON object, + and the reference count of this value will be increased by 1. + + Input key must be a valid NULL terminated UTF8 encoded string. If there = already is a value for + this key, this key will be assigned to the new JSON value. The old JSON = value will be removed + from this object and thus its' reference count will be decreased by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonObj The provided JSON object. + @param[in] Key The key of the JSON value to be set. + @param[in] Json The JSON value to set to this JSON o= bject mapped by key. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS The JSON value has been set to this = JSON object. + +**/ +EFI_STATUS +EFIAPI +JsonObjectSetValue ( + IN EDKII_JSON_OBJECT JsonObj, + IN CONST CHAR8 *Key, + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to get the number of elements in a JSON array. Retu= rns or 0 if JsonArray + is NULL or not a JSON array. + + @param[in] JsonArray The provided JSON array. + + @retval Return the number of elements in this JSON array or 0. + +**/ +UINTN +EFIAPI +JsonArrayCount ( + IN EDKII_JSON_ARRAY JsonArray + ); + +/** + The function is used to return the JSON value in the array at position i= ndex. The valid range + for this index is from 0 to the return value of JsonArrayCount() minus 1. + + It only returns a reference to this value and any changes on this value = will impact the + original JSON object. If that is not expected, please call JsonValueClon= e() to clone it to + use. + + If this array is NULL or not a JSON array, or if index is out of range, = NULL will be returned. + + @param[in] JsonArray The provided JSON Array. + + @retval Return the JSON value located in the Index position or + NULL if JsonArray is not an array or no items in the array. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonArrayGetValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN UINTN Index + ); + +/** + The function is used to append a JSON value to the end of the JSON array= , and grow the size of + array by 1. The reference count of this value will be increased by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonArray The provided JSON object. + @param[in] Json The JSON value to append. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS JSON value has been appended to the = end of the JSON array. + +**/ +EFI_STATUS +EFIAPI +JsonArrayAppendValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN EDKII_JSON_VALUE Json + ); + +/** + The function is used to remove a JSON value at position index, shifting = the elements after index + one position towards the start of the array. The reference count of this= value will be decreased + by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonArray The provided JSON array. + @param[in] Index The Index position before removement. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS The JSON array has been removed at p= osition index. + +**/ +EFI_STATUS +EFIAPI +JsonArrayRemoveValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN UINTN Index + ); + +/** + Dump JSON to a buffer. + + @param[in] JsonValue The provided JSON value. + @param[in] Flags The Index position before removement. The v= alue + could be the combination of below flags. + - EDKII_JSON_INDENT(n) + - EDKII_JSON_COMPACT + - EDKII_JSON_ENSURE_ASCII + - EDKII_JSON_SORT_KEYS + - EDKII_JSON_PRESERVE_ORDER + - EDKII_JSON_ENCODE_ANY + - EDKII_JSON_ESCAPE_SLASH + - EDKII_JSON_REAL_PRECISION(n) + - EDKII_JSON_EMBED + See below URI for the JSON encoding flags r= eference. + https://jansson.readthedocs.io/en/2.13/apir= ef.html#encoding + + @retval CHAR8 * Dump fail if NULL returned, otherwise the b= uffer + contain JSON paylaod in ASCII string. The r= eturn + value must be freed by the caller FreePool(= ). +**/ +CHAR8 * +EFIAPI +JsonDumpString ( + IN EDKII_JSON_VALUE JsonValue, + IN UINTN Flags + ); + +/** + Load JSON from a buffer. + + @param[in] Buffer Bufffer to the JSON payload + @param[in] BufferLen Length of the buffer + @param[in] Flags Flag of loading JSON buffer, the value + could be the combination of below flags. + - EDKII_JSON_REJECT_DUPLICATES + - EDKII_JSON_DISABLE_EOF_CHECK + - EDKII_JSON_DECODE_ANY + - EDKII_JSON_DECODE_INT_AS_REAL + - EDKII_JSON_ALLOW_NUL + See below URI for the JSON encoding flags ref= erence. + https://jansson.readthedocs.io/en/2.13/apiref= .html?highlight=3Djson_loadb#decoding + + @param[in,out] Error Pointer EDKII_JSON_ERROR structure + + @retval EDKII_JSON_VALUE NULL means fail to load JSON payload. +**/ +EDKII_JSON_VALUE +EFIAPI +JsonLoadBuffer ( + IN CONST CHAR8 *Buffer, + IN UINTN BufferLen, + IN UINTN Flags, + IN OUT EDKII_JSON_ERROR *Error + ); + +/** + The reference count is used to track whether a value is still in use or = not. + When a value is created, it's reference count is set to 1. + when the value is no longer needed, the reference count is decremented. + When the reference count drops to zero, there are no references left and= the + value can be destroyed. + + This funciton decrement the reference count of EDKII_JSON_VALUE. As soon= as + a call to json_decref() drops the reference count to zero, the value is + destroyed and it can no longer be used. + + @param[in] JsonValue JSON value +**/ +VOID +EFIAPI +JsonDecreaseReference ( + IN EDKII_JSON_VALUE JsonValue + ); + +/** + The reference count is used to track whether a value is still in use or = not. + When a value is created, it's reference count is set to 1. + If a reference to a value is kept (e.g. a value is stored somewhere for = later use), + its reference count is incremented. + + This function increment the reference count of json if it's not NULL. + Returns EDKII_JSON_VALUE. + + @param[in] JsonValue JSON value + @retval EDKII_JSON_VALUE of itself +**/ +EDKII_JSON_VALUE +EFIAPI +JsonIncreaseReference ( + IN EDKII_JSON_VALUE JsonValue + ); +/** + Returns an opaque iterator which can be used to iterate over all key-val= ue pairs + in object, or NULL if object is empty + + @param[in] JsonValue JSON value +**/ +VOID * +EFIAPI +JsonObjectIterator ( + IN EDKII_JSON_VALUE JsonValue + ); + +/** + Extract the associated value from iterator. + + @param[in] Iterator Iterator pointer +**/ +EDKII_JSON_VALUE +EFIAPI +JsonObjectIteratorValue ( + IN VOID *Iterator + ); + +/** + Returns an iterator pointing to the next key-value pair in object after = iter, + or NULL if the whole object has been iterated through. + + @param[in] JsonValue JSON value + @param[in] Iterator Iterator pointer + @retval Iterator pointer +**/ +VOID * +JsonObjectIteratorNext ( + IN EDKII_JSON_VALUE JsonValue, + IN VOID *Iterator + ); + +/** + Returns the json type of this json value + + @param[in] JsonValue JSON value + @retval JSON type returned +**/ +EDKII_JSON_TYPE +EFIAPI +JsonGetType( + IN EDKII_JSON_VALUE JsonValue + ); +#endif diff --git a/RedfishPkg/Library/JsonLib/jansson_config.h b/RedfishPkg/Libra= ry/JsonLib/jansson_config.h new file mode 100644 index 0000000000..c66d3ced9b --- /dev/null +++ b/RedfishPkg/Library/JsonLib/jansson_config.h @@ -0,0 +1,41 @@ +/** @file This is the configuration file for building jansson library. + + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + **/ + +#ifndef JANSSON_CONFIG_H_ +#define JANSSON_CONFIG_H_ + +/// +/// We don't support inline JSON on edk2 +/// +#define JSON_INLINE + +/// +/// We support long long on edk2 +/// +#define JSON_INTEGER_IS_LONG_LONG 1 + +/// +/// We don't support locale on edk2 +/// +#define JSON_HAVE_LOCALECONV 0 + +/// +/// We don't support atomic builtins on edk2 +/// +#define JSON_HAVE_ATOMIC_BUILTINS 0 + +/// +/// We don't support sync builtins on edk2 +/// +#define JSON_HAVE_SYNC_BUILTINS 0 + +/// +/// Mzximum deepth is set to 2048 +/// +#define JSON_PARSER_MAX_DEPTH 2048 + +#endif diff --git a/RedfishPkg/Library/JsonLib/jansson_private_config.h b/RedfishP= kg/Library/JsonLib/jansson_private_config.h new file mode 100644 index 0000000000..268f91ef8a --- /dev/null +++ b/RedfishPkg/Library/JsonLib/jansson_private_config.h @@ -0,0 +1,19 @@ +/** @file + Jansson private configurations for UEFI support. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef JANSSON_PRIVATE_CONFIG_H_ +#define JANSSON_PRIVATE_CONFIG_H_ + +#define HAVE_SYS_TIME_H 1 +#define HAVE_SYS_TYPES_H 1 + +#define INITIAL_HASHTABLE_ORDER 3 + +#endif diff --git a/RedfishPkg/Library/JsonLib/JsonLib.c b/RedfishPkg/Library/Json= Lib/JsonLib.c new file mode 100644 index 0000000000..34ff381aee --- /dev/null +++ b/RedfishPkg/Library/JsonLib/JsonLib.c @@ -0,0 +1,957 @@ +/** @file + APIs for JSON operations. The fuctions provided by this library are the + wrapper to native open source jansson library. See below document for + the API reference. + https://jansson.readthedocs.io/en/2.13/apiref.html + + Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.
+ (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include +#include +#include +#include + +#include "jansson.h" + +/** + The function is used to initialize a JSON value which contains a new JSO= N array, + or NULL on error. Initially, the array is empty. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @retval The created JSON value which contains a JSON array or NULL = if intial a JSON array + is failed. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitArray ( + VOID + ) +{ + return (EDKII_JSON_VALUE)json_array(); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N object, + or NULL on error. Initially, the object is empty. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @retval The created JSON value which contains a JSON object or NULL= if intial a JSON object + is failed. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitObject ( + VOID + ) +{ + return (EDKII_JSON_VALUE)json_object(); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N string, + or NULL on error. + + The input string must be NULL terminated Ascii format, non-Ascii charact= ers will + be processed as an error. Unicode characters can also be represented by = Ascii string + as the format: \u + 4 hexadecimal digits, like \u3E5A, or \u003F. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] String The Ascii string to initialize to JSON value + + @retval The created JSON value which contains a JSON string or NULL= . Select a + Getter API for a specific encoding format. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitAsciiString ( + IN CONST CHAR8 *String + ) +{ + UINTN Index; + + if (String =3D=3D NULL) { + return NULL; + } + + Index =3D 0; + while (*(String + Index) !=3D '\0') { + if (((*(String + Index)) & 0x80) !=3D 0x00) { + return NULL; + } + + Index++; + } + + return (EDKII_JSON_VALUE)json_string (String); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N string, + or NULL on error. + + The input must be a NULL terminated UCS2 format Unicode string. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] String The Unicode string to initialize to JSON value + + @retval The created JSON value which contains a JSON string or NULL= . Select a + Getter API for a specific encoding format. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitUnicodeString ( + IN CHAR16 *String + ) +{ + EFI_STATUS Status; + CHAR8 *Utf8Str; + + if (String =3D=3D NULL) { + return NULL; + } + + Utf8Str =3D NULL; + Status =3D UCS2StrToUTF8 (String, &Utf8Str); + if (EFI_ERROR (Status)) { + return NULL; + } + + return (EDKII_JSON_VALUE)json_string (Utf8Str); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N integer, + or NULL on error. + + The reference count of this value will be set to 1, and caller needs to = cleanup the + value by calling JsonValueFree(). + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] Value The integer to initialize to JSON value + + @retval The created JSON value which contains a JSON number or NULL. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitNumber ( + IN INT64 Value + ) +{ + return (EDKII_JSON_VALUE)json_integer (Value); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N boolean, + or NULL on error. + + Boolean JSON value is kept as static value, and no need to do any cleanu= p work. + + @param[in] Value The boolean value to initialize. + + @retval The created JSON value which contains a JSON boolean or NUL= L. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitBoolean ( + IN BOOLEAN Value + ) +{ + return (EDKII_JSON_VALUE)json_boolean (Value); +} + +/** + The function is used to initialize a JSON value which contains a new JSO= N NULL, + or NULL on error. + + NULL JSON value is kept as static value, and no need to do any cleanup w= ork. + + @retval The created NULL JSON value. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueInitNull ( + VOID + ) +{ + return (EDKII_JSON_VALUE)json_null(); +} + +/** + The function is used to decrease the reference count of a JSON value by = one, and once + this reference count drops to zero, the value is destroyed and it can no= longer be used. + If this destroyed value is object type or array type, reference counts f= or all containing + JSON values will be decreased by 1. Boolean JSON value and NULL JSON val= ue won't be destroyed + since they are static values kept in memory. + + Reference Count Strategy: BaseJsonLib uses this strategy to track whethe= r a value is still + in use or not. When a value is created, it's reference count is set to 1= . If a reference to a + value is kept for use, its reference count is incremented, and when the = value is no longer + needed, the reference count is decremented. When the reference count dro= ps to zero, there are + no references left, and the value can be destroyed. + + The given JSON value maybe NULL and not causing any problem. Just output= the debug message + to inform caller the NULL value is passed in. + + @param[in] Json The JSON value to be freed. json_decref ma= y return without any + changes if Json is NULL. + +**/ +VOID +EFIAPI +JsonValueFree ( + IN EDKII_JSON_VALUE Json + ) +{ + json_decref((json_t *)Json); +} + +/** + The function is used to create a fresh copy of a JSON value, and all chi= ld values are deep + copied in a recursive fashion. It should be called when this JSON value = might be modified + in later use, but the original still wants to be used in somewhere else. + + Reference counts of the returned root JSON value and all child values wi= ll be set to 1, and + caller needs to cleanup the root value by calling JsonValueFree(). + + * Note: Since this function performs a copy from bottom to up, too many = calls may cause some + performance issues, user should avoid unnecessary calls to this function= unless it is really + needed. + + @param[in] Json The JSON value to be cloned. + + @retval Return the cloned JSON value, or NULL on error. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonValueClone ( + IN EDKII_JSON_VALUE Json + ) +{ + return (EDKII_JSON_VALUE)json_deep_copy ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON value contains a JSO= N array. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON array. + @retval FALSE The JSON value doesn't contain a JSON arra= y. + +**/ +BOOLEAN +EFIAPI +JsonValueIsArray ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_array ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON value contains a JSO= N object. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON object. + @retval FALSE The JSON value doesn't contain a JSON obje= ct. + +**/ +BOOLEAN +EFIAPI +JsonValueIsObject ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_object ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON Value contains a str= ing, Ascii or + Unicode format is not differentiated. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON string. + @retval FALSE The JSON value doesn't contain a JSON stri= ng. + +**/ +BOOLEAN +EFIAPI +JsonValueIsString ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_string ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON value contains a JSO= N number. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value is contains JSON number. + @retval FALSE The JSON value doesn't contain a JSON numb= er. + +**/ +BOOLEAN +EFIAPI +JsonValueIsNumber ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_integer ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON value contains a JSO= N boolean. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON boolean. + @retval FALSE The JSON value doesn't contain a JSON bool= ean. + +**/ +BOOLEAN +EFIAPI +JsonValueIsBoolean ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_boolean ((json_t *) Json); +} + +/** + The function is used to return if the provided JSON value contains a JSO= N NULL. + + @param[in] Json The provided JSON value. + + @retval TRUE The JSON value contains a JSON NULL. + @retval FALSE The JSON value doesn't contain a JSON NULL. + +**/ +BOOLEAN +EFIAPI +JsonValueIsNull ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_is_null ((json_t *) Json); +} + +/** + The function is used to retrieve the associated array in an array type J= SON value. + + Any changes to the returned array will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated array in JSON value or NULL. + +**/ +EDKII_JSON_ARRAY +EFIAPI +JsonValueGetArray ( + IN EDKII_JSON_VALUE Json + ) +{ + if (Json =3D=3D NULL || !JsonValueIsArray (Json)) { + return NULL; + } + + return (EDKII_JSON_ARRAY)Json; +} + +/** + The function is used to retrieve the associated object in an object type= JSON value. + + Any changes to the returned object will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated object in JSON value or NULL. + +**/ +EDKII_JSON_OBJECT +EFIAPI +JsonValueGetObject ( + IN EDKII_JSON_VALUE Json + ) +{ + if (Json =3D=3D NULL || !JsonValueIsObject (Json)) { + return NULL; + } + + return (EDKII_JSON_OBJECT)Json; +} + +/** + The function is used to retrieve the associated Ascii string in a string= type JSON value. + + Any changes to the returned string will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated Ascii string in JSON value or NULL. + +**/ +CONST CHAR8 * +EFIAPI +JsonValueGetAsciiString ( + IN EDKII_JSON_VALUE Json + ) +{ + CHAR8 *AsciiStr; + UINTN Index; + + AsciiStr =3D (CHAR8 *) ((json_t *) Json); + if (AsciiStr =3D=3D NULL) { + return NULL; + } + + Index =3D 0; + while (*(AsciiStr + Index) !=3D '\0') { + if (((*(AsciiStr + Index)) & 0x80) !=3D 0x00) { + return NULL; + } + + Index++; + } + + return AsciiStr; +} + +/** + The function is used to retrieve the associated Unicode string in a stri= ng type JSON value. + + Caller can do any changes to the returned string without any impact to t= he original JSON + value, and caller needs to free the returned string using FreePool(). + + @param[in] Json The provided JSON value. + + @retval Return the associated Unicode string in JSON value or NULL. + +**/ +CHAR16* +EFIAPI +JsonValueGetUnicodeString ( + IN EDKII_JSON_VALUE Json + ) +{ + EFI_STATUS Status; + CONST CHAR8 *Utf8Str; + CHAR16 *Ucs2Str; + + Utf8Str =3D json_string_value ((json_t *) Json); + if (Utf8Str =3D=3D NULL) { + return NULL; + } + + Status =3D UTF8StrToUCS2 ((CHAR8*)Utf8Str, &Ucs2Str); + if (EFI_ERROR (Status)) { + return NULL; + } + + return Ucs2Str; +} + +/** + The function is used to retrieve the associated integer in a number type= JSON value. + + The input JSON value should not be NULL or contain no JSON number, other= wise it will + ASSERT() and return 0. + + @param[in] Json The provided JSON value. + + @retval Return the associated number in JSON value. + +**/ +INT64 +EFIAPI +JsonValueGetNumber ( + IN EDKII_JSON_VALUE Json + ) +{ + ASSERT (Json !=3D NULL && JsonValueIsNumber (Json)); + if (Json =3D=3D NULL || !JsonValueIsNumber (Json)) { + return 0; + } + + return json_integer_value ((json_t *) Json); +} + +/** + The function is used to retrieve the associated boolean in a boolean typ= e JSON value. + + The input JSON value should not be NULL or contain no JSON boolean, othe= rwise it will + ASSERT() and return FALSE. + + @param[in] Json The provided JSON value. + + @retval Return the associated value of JSON boolean. + +**/ +BOOLEAN +EFIAPI +JsonValueGetBoolean ( + IN EDKII_JSON_VALUE Json + ) +{ + ASSERT (Json !=3D NULL && JsonValueIsBoolean (Json)); + if (Json =3D=3D NULL || !JsonValueIsBoolean (Json)) { + return FALSE; + } + + return json_is_true ((json_t *) Json); +} + +/** + The function is used to retrieve the associated string in a string type = JSON value. + + Any changes to the returned string will impact the original JSON value. + + @param[in] Json The provided JSON value. + + @retval Return the associated Ascii string in JSON value or NULL on= errors. + +**/ +CONST CHAR8* +EFIAPI +JsonValueGetString ( + IN EDKII_JSON_VALUE Json + ) +{ + return json_string_value ((const json_t *)Json); +} + +/** + The function is used to get the number of elements in a JSON object, or = 0 if it is NULL or + not a JSON object. + + @param[in] JsonObject The provided JSON object. + + @retval Return the number of elements in this JSON object or 0. + +**/ +UINTN +EFIAPI +JsonObjectSize ( + IN EDKII_JSON_OBJECT JsonObject + ) +{ + return json_object_size ((json_t *) JsonObject); +} + +/** + The function is used to enumerate all keys in a JSON object. + + Caller should be responsible to free the returned key array reference us= ing + FreePool(). But contained keys are read only and must not be modified or= freed. + + @param[in] JsonObj The provided JSON object for enumera= tion. + @param[out] KeyCount The count of keys in this JSON objec= t. + + @retval Return an array of the enumerated keys in this JSON object = or NULL if + JsonObj is not an JSON object, key count is zero or on othe= r errors. + +**/ +CHAR8** +JsonObjectGetKeys ( + IN EDKII_JSON_OBJECT JsonObj, + OUT UINTN *KeyCount + ) +{ + + UINTN Index; + CONST CHAR8 **KeyArray; + CONST CHAR8 *Key; + EDKII_JSON_VALUE Value; + + if (JsonObj =3D=3D NULL || KeyCount =3D=3D NULL) { + return NULL; + } + + Index =3D 0; + json_object_foreach(JsonObj, Key, Value) { + Index++; + } + if (Index =3D=3D 0) { + *KeyCount =3D 0; + return NULL; + } + + *KeyCount =3D Index; + KeyArray =3D (CONST CHAR8 **) AllocateZeroPool (*KeyCount * sizeof (CHAR= 8 *)); + if (KeyArray =3D=3D NULL) { + return NULL; + } + + Key =3D NULL; + Value =3D NULL; + Index =3D 0; + json_object_foreach((json_t *) JsonObj, Key, Value) { + KeyArray[Index] =3D Key; + Index++; + } + + return (CHAR8 **)KeyArray; +} + +/** + The function is used to get a JSON value corresponding to the input key = from a JSON object. + + It only returns a reference to this value and any changes on this value = will impact the + original JSON object. If that is not expected, please call JsonValueClon= e() to clone it to + use. + + Input key must be a valid NULL terminated UTF8 encoded string. NULL will= be returned when + Key-Value is not found in this JSON object. + + @param[in] JsonObj The provided JSON object. + @param[in] Key The key of the JSON value to be retrieved. + + @retval Return the corresponding JSON value to key, or NULL on erro= r. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonObjectGetValue ( + IN CONST EDKII_JSON_OBJECT JsonObj, + IN CONST CHAR8 *Key + ) +{ + return (EDKII_JSON_VALUE)json_object_get ((const json_t *)JsonObj, (cons= t char *)Key); +} + +/** + The function is used to set a JSON value corresponding to the input key = from a JSON object, + and the reference count of this value will be increased by 1. + + Input key must be a valid NULL terminated UTF8 encoded string. If there = already is a value for + this key, this key will be assigned to the new JSON value. The old JSON = value will be removed + from this object and thus its' reference count will be decreased by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonObj The provided JSON object. + @param[in] Key The key of the JSON value to be set. + @param[in] Json The JSON value to set to this JSON o= bject mapped by key. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS The JSON value has been set to this = JSON object. + +**/ +EFI_STATUS +EFIAPI +JsonObjectSetValue ( + IN EDKII_JSON_OBJECT JsonObj, + IN CONST CHAR8 *Key, + IN EDKII_JSON_VALUE Json + ) +{ + if (json_object_set ((json_t *) JsonObj, Key, (json_t *) Json) !=3D 0) { + return EFI_ABORTED; + } else { + return EFI_SUCCESS; + } +} + +/** + The function is used to get the number of elements in a JSON array. Retu= rns or 0 if JsonArray + is NULL or not a JSON array. + + @param[in] JsonArray The provided JSON array. + + @retval Return the number of elements in this JSON array or 0. + +**/ +UINTN +EFIAPI +JsonArrayCount ( + IN EDKII_JSON_ARRAY JsonArray + ) +{ + return json_array_size ((json_t *) JsonArray); +} + +/** + The function is used to return the JSON value in the array at position i= ndex. The valid range + for this index is from 0 to the return value of JsonArrayCount() minus 1. + + It only returns a reference to this value and any changes on this value = will impact the + original JSON object. If that is not expected, please call JsonValueClon= e() to clone it to + use. + + If this array is NULL or not a JSON array, or if index is out of range, = NULL will be returned. + + @param[in] JsonArray The provided JSON Array. + + @retval Return the JSON value located in the Index position or + NULL if JsonArray is not an array or no items in the array. + +**/ +EDKII_JSON_VALUE +EFIAPI +JsonArrayGetValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN UINTN Index + ) +{ + return (EDKII_JSON_VALUE)json_array_get ((json_t *) JsonArray, Index); +} + +/** + The function is used to append a JSON value to the end of the JSON array= , and grow the size of + array by 1. The reference count of this value will be increased by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonArray The provided JSON object. + @param[in] Json The JSON value to append. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS JSON value has been appended to the = end of the JSON array. + +**/ +EFI_STATUS +EFIAPI +JsonArrayAppendValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN EDKII_JSON_VALUE Json + ) +{ + if (json_array_append ((json_t *) JsonArray, (json_t *) Json) !=3D 0) { + return EFI_ABORTED; + } else { + return EFI_SUCCESS; + } +} + +/** + The function is used to remove a JSON value at position index, shifting = the elements after index + one position towards the start of the array. The reference count of this= value will be decreased + by 1. + + More details for reference count strategy can refer to the API descripti= on for JsonValueFree(). + + @param[in] JsonArray The provided JSON array. + @param[in] Index The Index position before removement. + + @retval EFI_ABORTED Some error occur and operation abort= ed. + @retval EFI_SUCCESS The JSON array has been removed at p= osition index. + +**/ +EFI_STATUS +EFIAPI +JsonArrayRemoveValue ( + IN EDKII_JSON_ARRAY JsonArray, + IN UINTN Index + ) +{ + if (json_array_remove ((json_t *) JsonArray, Index) !=3D 0) { + return EFI_ABORTED; + } else { + return EFI_SUCCESS; + } +} + +/** + Dump JSON to a buffer. + + @param[in] JsonValue The provided JSON value. + @param[in] Flags The Index position before removement. The v= alue + could be the combination of below flags. + - EDKII_JSON_INDENT(n) + - EDKII_JSON_COMPACT + - EDKII_JSON_ENSURE_ASCII + - EDKII_JSON_SORT_KEYS + - EDKII_JSON_PRESERVE_ORDER + - EDKII_JSON_ENCODE_ANY + - EDKII_JSON_ESCAPE_SLASH + - EDKII_JSON_REAL_PRECISION(n) + - EDKII_JSON_EMBED + See below URI for the JSON encoding flags r= eference. + https://jansson.readthedocs.io/en/2.13/apir= ef.html#encoding + + @retval CHAR8 * Dump fail if NULL returned, otherwise the b= uffer + contain JSON paylaod in ASCII string. The r= eturn + value must be freed by the caller using Fre= ePool(). +**/ +CHAR8 * +EFIAPI +JsonDumpString ( + IN EDKII_JSON_VALUE JsonValue, + IN UINTN Flags + ) +{ + if (JsonValue =3D=3D NULL) { + return NULL; + } + return json_dumps((json_t *)JsonValue, Flags); +} + +/** + Load JSON from a buffer. + + @param[in] Buffer Bufffer to the JSON payload + @param[in] BufferLen Length of the buffer + @param[in] Flags Flag of loading JSON buffer, the value + could be the combination of below flags. + - EDKII_JSON_REJECT_DUPLICATES + - EDKII_JSON_DISABLE_EOF_CHECK + - EDKII_JSON_DECODE_ANY + - EDKII_JSON_DECODE_INT_AS_REAL + - EDKII_JSON_ALLOW_NUL + See below URI for the JSON encoding flags ref= erence. + https://jansson.readthedocs.io/en/2.13/apiref= .html?highlight=3Djson_loadb#decoding + + @param[in,out] Error Pointer EDKII_JSON_ERROR structure + + @retval EDKII_JSON_VALUE NULL means fail to load JSON payload. +**/ +EDKII_JSON_VALUE +EFIAPI +JsonLoadBuffer ( + IN CONST CHAR8 *Buffer, + IN UINTN BufferLen, + IN UINTN Flags, + IN OUT EDKII_JSON_ERROR *Error + ) +{ + return json_loadb(Buffer, BufferLen, Flags, (json_error_t *)Error); +} + +/** + The reference count is used to track whether a value is still in use or = not. + When a value is created, it's reference count is set to 1. + when the value is no longer needed, the reference count is decremented. + When the reference count drops to zero, there are no references left and= the + value can be destroyed. + + This funciton decrement the reference count of EDKII_JSON_VALUE. As soon= as + a call to json_decref() drops the reference count to zero, the value is + destroyed and it can no longer be used. + + @param[in] JsonValue JSON value +**/ +VOID +EFIAPI +JsonDecreaseReference ( + IN EDKII_JSON_VALUE JsonValue + ) +{ + json_decref (JsonValue); +} + +/** + The reference count is used to track whether a value is still in use or = not. + When a value is created, it's reference count is set to 1. + If a reference to a value is kept (e.g. a value is stored somewhere for = later use), + its reference count is incremented. + + This function increment the reference count of json if it's not NULL. + Returns EDKII_JSON_VALUE. + + @param[in] JsonValue JSON value + @retval EDKII_JSON_VALUE of itself +**/ +EDKII_JSON_VALUE +EFIAPI +JsonIncreaseReference ( + IN EDKII_JSON_VALUE JsonValue + ) +{ + return json_incref (JsonValue); +} + +/** + Returns an opaque iterator which can be used to iterate over all key-val= ue pairs + in object, or NULL if object is empty. + + @param[in] JsonValue JSON value + @retval Iterator pointer +**/ +VOID * +EFIAPI +JsonObjectIterator ( + IN EDKII_JSON_VALUE JsonValue + ) +{ + return json_object_iter (JsonValue); +} + +/** + Extract the associated value from iterator. + + @param[in] Iterator Iterator pointer + @retval EDKII_JSON_VALUE +**/ +EDKII_JSON_VALUE +EFIAPI +JsonObjectIteratorValue ( + IN VOID *Iterator + ) +{ + return json_object_iter_value(Iterator); +} + +/** + Returns an iterator pointing to the next key-value pair in object after = iter, + or NULL if the whole object has been iterated through. + + @param[in] JsonValue JSON value + @param[in] Iterator Iterator pointer + @retval Iterator pointer +**/ +VOID * +JsonObjectIteratorNext ( + IN EDKII_JSON_VALUE JsonValue, + IN VOID *Iterator + ) +{ + return json_object_iter_next(JsonValue, Iterator); +} + +/** + Returns the json type of this json value. + + @param[in] JsonValue JSON value + @retval JSON type returned +**/ +EDKII_JSON_TYPE +EFIAPI +JsonGetType ( + IN EDKII_JSON_VALUE JsonValue + ) +{ + return ((json_t *)JsonValue)->type; +} diff --git a/RedfishPkg/Library/JsonLib/load.c b/RedfishPkg/Library/JsonLib= /load.c new file mode 100644 index 0000000000..37e0ba4271 --- /dev/null +++ b/RedfishPkg/Library/JsonLib/load.c @@ -0,0 +1,1111 @@ +/* + * Copyright (c) 2009-2016 Petri Lehtinen + * + * Jansson is free software; you can redistribute it and/or modify + * it under the terms of the MIT license. See LICENSE for details. + + (C) Copyright 2020 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent AND MIT + */ + +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#endif + +#include "jansson_private.h" + +#include +#include +#include +#include +#include +#include +#ifdef HAVE_UNISTD_H +#include +#endif + +#include "jansson.h" +#include "strbuffer.h" +#include "utf.h" + +#define STREAM_STATE_OK 0 +#define STREAM_STATE_EOF -1 +#define STREAM_STATE_ERROR -2 + +#define TOKEN_INVALID -1 +#define TOKEN_EOF 0 +#define TOKEN_STRING 256 +#define TOKEN_INTEGER 257 +#define TOKEN_REAL 258 +#define TOKEN_TRUE 259 +#define TOKEN_FALSE 260 +#define TOKEN_NULL 261 + +/* Locale independent versions of isxxx() functions */ +#define l_isupper(c) ('A' <=3D (c) && (c) <=3D 'Z') +#define l_islower(c) ('a' <=3D (c) && (c) <=3D 'z') +#define l_isalpha(c) (l_isupper(c) || l_islower(c)) +#define l_isdigit(c) ('0' <=3D (c) && (c) <=3D '9') +#define l_isxdigit(c) = \ + (l_isdigit(c) || ('A' <=3D (c) && (c) <=3D 'F') || ('a' <=3D (c) && (c= ) <=3D 'f')) + +/* Read one byte from stream, convert to unsigned char, then int, and + return. return EOF on end of file. This corresponds to the + behaviour of fgetc(). */ +typedef int (*get_func)(void *data); + +typedef struct { + get_func get; + void *data; + char buffer[5]; + size_t buffer_pos; + int state; + int line; + int column, last_column; + size_t position; +} stream_t; + +typedef struct { + stream_t stream; + strbuffer_t saved_text; + size_t flags; + size_t depth; + int token; + union { + struct { + char *val; + size_t len; + } string; + json_int_t integer; + double real; + } value; +} lex_t; + +#define stream_to_lex(stream) container_of(stream, lex_t, stream) + +/*** error reporting ***/ + +static void error_set(json_error_t *error, const lex_t *lex, enum json_err= or_code code, + const char *msg, ...) { + va_list ap; + char msg_text[JSON_ERROR_TEXT_LENGTH]; + char msg_with_context[JSON_ERROR_TEXT_LENGTH]; + + int line =3D -1, col =3D -1; + size_t pos =3D 0; + const char *result =3D msg_text; + + if (!error) + return; + + va_start(ap, msg); + vsnprintf(msg_text, JSON_ERROR_TEXT_LENGTH, msg, ap); + msg_text[JSON_ERROR_TEXT_LENGTH - 1] =3D '\0'; + va_end(ap); + + if (lex) { + const char *saved_text =3D strbuffer_value(&lex->saved_text); + + line =3D lex->stream.line; + col =3D lex->stream.column; + pos =3D lex->stream.position; + + if (saved_text && saved_text[0]) { + if (lex->saved_text.length <=3D 20) { + snprintf(msg_with_context, JSON_ERROR_TEXT_LENGTH, "%s nea= r '%s'", + msg_text, saved_text); + msg_with_context[JSON_ERROR_TEXT_LENGTH - 1] =3D '\0'; + result =3D msg_with_context; + } + } else { + if (code =3D=3D json_error_invalid_syntax) { + /* More specific error code for premature end of file. */ + code =3D json_error_premature_end_of_input; + } + if (lex->stream.state =3D=3D STREAM_STATE_ERROR) { + /* No context for UTF-8 decoding errors */ + result =3D msg_text; + } else { + snprintf(msg_with_context, JSON_ERROR_TEXT_LENGTH, "%s nea= r end of file", + msg_text); + msg_with_context[JSON_ERROR_TEXT_LENGTH - 1] =3D '\0'; + result =3D msg_with_context; + } + } + } + + jsonp_error_set(error, line, col, pos, code, "%s", result); +} + +/*** lexical analyzer ***/ + +static void stream_init(stream_t *stream, get_func get, void *data) { + stream->get =3D get; + stream->data =3D data; + stream->buffer[0] =3D '\0'; + stream->buffer_pos =3D 0; + + stream->state =3D STREAM_STATE_OK; + stream->line =3D 1; + stream->column =3D 0; + stream->position =3D 0; +} + +static int stream_get(stream_t *stream, json_error_t *error) { + int c; + + if (stream->state !=3D STREAM_STATE_OK) + return stream->state; + + if (!stream->buffer[stream->buffer_pos]) { + c =3D stream->get(stream->data); + if (c =3D=3D EOF) { + stream->state =3D STREAM_STATE_EOF; + return STREAM_STATE_EOF; + } + + stream->buffer[0] =3D c; + stream->buffer_pos =3D 0; + + if (0x80 <=3D c && c <=3D 0xFF) { + /* multi-byte UTF-8 sequence */ + size_t i, count; + + count =3D utf8_check_first(c); + if (!count) + goto out; + + assert(count >=3D 2); + + for (i =3D 1; i < count; i++) + stream->buffer[i] =3D stream->get(stream->data); + + if (!utf8_check_full(stream->buffer, count, NULL)) + goto out; + + stream->buffer[count] =3D '\0'; + } else + stream->buffer[1] =3D '\0'; + } + + c =3D stream->buffer[stream->buffer_pos++]; + + stream->position++; + if (c =3D=3D '\n') { + stream->line++; + stream->last_column =3D stream->column; + stream->column =3D 0; + } else if (utf8_check_first(c)) { + /* track the Unicode character column, so increment only if + this is the first character of a UTF-8 sequence */ + stream->column++; + } + + return c; + +out: + stream->state =3D STREAM_STATE_ERROR; + error_set(error, stream_to_lex(stream), json_error_invalid_utf8, + "unable to decode byte 0x%x", c); + return STREAM_STATE_ERROR; +} + +static void stream_unget(stream_t *stream, int c) { + if (c =3D=3D STREAM_STATE_EOF || c =3D=3D STREAM_STATE_ERROR) + return; + + stream->position--; + if (c =3D=3D '\n') { + stream->line--; + stream->column =3D stream->last_column; + } else if (utf8_check_first(c)) + stream->column--; + + assert(stream->buffer_pos > 0); + stream->buffer_pos--; + assert(stream->buffer[stream->buffer_pos] =3D=3D c); +} + +static int lex_get(lex_t *lex, json_error_t *error) { + return stream_get(&lex->stream, error); +} + +static void lex_save(lex_t *lex, int c) { strbuffer_append_byte(&lex->save= d_text, c); } + +static int lex_get_save(lex_t *lex, json_error_t *error) { + int c =3D stream_get(&lex->stream, error); + if (c !=3D STREAM_STATE_EOF && c !=3D STREAM_STATE_ERROR) + lex_save(lex, c); + return c; +} + +static void lex_unget(lex_t *lex, int c) { stream_unget(&lex->stream, c); } + +static void lex_unget_unsave(lex_t *lex, int c) { + if (c !=3D STREAM_STATE_EOF && c !=3D STREAM_STATE_ERROR) { +/* Since we treat warnings as errors, when assertions are turned + * off the "d" variable would be set but never used. Which is + * treated as an error by GCC. + */ +#ifndef NDEBUG + char d; +#endif + stream_unget(&lex->stream, c); +#ifndef NDEBUG + d =3D +#endif + strbuffer_pop(&lex->saved_text); + assert(c =3D=3D d); + } +} + +static void lex_save_cached(lex_t *lex) { + while (lex->stream.buffer[lex->stream.buffer_pos] !=3D '\0') { + lex_save(lex, lex->stream.buffer[lex->stream.buffer_pos]); + lex->stream.buffer_pos++; + lex->stream.position++; + } +} + +static void lex_free_string(lex_t *lex) { + jsonp_free(lex->value.string.val); + lex->value.string.val =3D NULL; + lex->value.string.len =3D 0; +} + +/* assumes that str points to 'u' plus at least 4 valid hex digits */ +static int32_t decode_unicode_escape(const char *str) { + int i; + int32_t value =3D 0; + + assert(str[0] =3D=3D 'u'); + + for (i =3D 1; i <=3D 4; i++) { + char c =3D str[i]; + value <<=3D 4; + if (l_isdigit(c)) + value +=3D c - '0'; + else if (l_islower(c)) + value +=3D c - 'a' + 10; + else if (l_isupper(c)) + value +=3D c - 'A' + 10; + else + return -1; + } + + return value; +} + +static void lex_scan_string(lex_t *lex, json_error_t *error) { + int c; + const char *p; + char *t; + int i; + + lex->value.string.val =3D NULL; + lex->token =3D TOKEN_INVALID; + + c =3D lex_get_save(lex, error); + + while (c !=3D '"') { + if (c =3D=3D STREAM_STATE_ERROR) + goto out; + + else if (c =3D=3D STREAM_STATE_EOF) { + error_set(error, lex, json_error_premature_end_of_input, + "premature end of input"); + goto out; + } + + else if (0 <=3D c && c <=3D 0x1F) { + /* control character */ + lex_unget_unsave(lex, c); + if (c =3D=3D '\n') + error_set(error, lex, json_error_invalid_syntax, "unexpect= ed newline"); + else + error_set(error, lex, json_error_invalid_syntax, "control = character 0x%x", + c); + goto out; + } + + else if (c =3D=3D '\\') { + c =3D lex_get_save(lex, error); + if (c =3D=3D 'u') { + c =3D lex_get_save(lex, error); + for (i =3D 0; i < 4; i++) { + if (!l_isxdigit(c)) { + error_set(error, lex, json_error_invalid_syntax, + "invalid escape"); + goto out; + } + c =3D lex_get_save(lex, error); + } + } else if (c =3D=3D '"' || c =3D=3D '\\' || c =3D=3D '/' || c = =3D=3D 'b' || c =3D=3D 'f' || + c =3D=3D 'n' || c =3D=3D 'r' || c =3D=3D 't') + c =3D lex_get_save(lex, error); + else { + error_set(error, lex, json_error_invalid_syntax, "invalid = escape"); + goto out; + } + } else + c =3D lex_get_save(lex, error); + } + + /* the actual value is at most of the same length as the source + string, because: + - shortcut escapes (e.g. "\t") (length 2) are converted to 1 byte + - a single \uXXXX escape (length 6) is converted to at most 3 byt= es + - two \uXXXX escapes (length 12) forming an UTF-16 surrogate pair + are converted to 4 bytes + */ + t =3D jsonp_malloc(lex->saved_text.length + 1); + if (!t) { + /* this is not very nice, since TOKEN_INVALID is returned */ + goto out; + } + lex->value.string.val =3D t; + + /* + 1 to skip the " */ + p =3D strbuffer_value(&lex->saved_text) + 1; + + while (*p !=3D '"') { + if (*p =3D=3D '\\') { + p++; + if (*p =3D=3D 'u') { + size_t length; + int32_t value; + + value =3D decode_unicode_escape(p); + if (value < 0) { + error_set(error, lex, json_error_invalid_syntax, + "invalid Unicode escape '%.6s'", p - 1); + goto out; + } + p +=3D 5; + + if (0xD800 <=3D value && value <=3D 0xDBFF) { + /* surrogate pair */ + if (*p =3D=3D '\\' && *(p + 1) =3D=3D 'u') { + int32_t value2 =3D decode_unicode_escape(++p); + if (value2 < 0) { + error_set(error, lex, json_error_invalid_synta= x, + "invalid Unicode escape '%.6s'", p -= 1); + goto out; + } + p +=3D 5; + + if (0xDC00 <=3D value2 && value2 <=3D 0xDFFF) { + /* valid second surrogate */ + value =3D + ((value - 0xD800) << 10) + (value2 - 0xDC0= 0) + 0x10000; + } else { + /* invalid second surrogate */ + error_set(error, lex, json_error_invalid_synta= x, + "invalid Unicode '\\u%04X\\u%04X'", = value, value2); + goto out; + } + } else { + /* no second surrogate */ + error_set(error, lex, json_error_invalid_syntax, + "invalid Unicode '\\u%04X'", value); + goto out; + } + } else if (0xDC00 <=3D value && value <=3D 0xDFFF) { + error_set(error, lex, json_error_invalid_syntax, + "invalid Unicode '\\u%04X'", value); + goto out; + } + + if (utf8_encode(value, t, &length)) + assert(0); + t +=3D length; + } else { + switch (*p) { + case '"': + case '\\': + case '/': + *t =3D *p; + break; + case 'b': + *t =3D '\b'; + break; + case 'f': + *t =3D '\f'; + break; + case 'n': + *t =3D '\n'; + break; + case 'r': + *t =3D '\r'; + break; + case 't': + *t =3D '\t'; + break; + default: + assert(0); + } + t++; + p++; + } + } else + *(t++) =3D *(p++); + } + *t =3D '\0'; + lex->value.string.len =3D t - lex->value.string.val; + lex->token =3D TOKEN_STRING; + return; + +out: + lex_free_string(lex); +} + +#ifndef JANSSON_USING_CMAKE /* disabled if using cmake */ +#if JSON_INTEGER_IS_LONG_LONG +#ifdef _MSC_VER /* Microsoft Visual Studio */ +#define json_strtoint _strtoi64 +#else +#define json_strtoint strtoll +#endif +#else +#define json_strtoint strtol +#endif +#endif + +static int lex_scan_number(lex_t *lex, int c, json_error_t *error) { + const char *saved_text; + char *end; + double doubleval; + + lex->token =3D TOKEN_INVALID; + + if (c =3D=3D '-') + c =3D lex_get_save(lex, error); + + if (c =3D=3D '0') { + c =3D lex_get_save(lex, error); + if (l_isdigit(c)) { + lex_unget_unsave(lex, c); + goto out; + } + } else if (l_isdigit(c)) { + do + c =3D lex_get_save(lex, error); + while (l_isdigit(c)); + } else { + lex_unget_unsave(lex, c); + goto out; + } + + if (!(lex->flags & JSON_DECODE_INT_AS_REAL) && c !=3D '.' && c !=3D 'E= ' && c !=3D 'e') { + json_int_t intval; + + lex_unget_unsave(lex, c); + + saved_text =3D strbuffer_value(&lex->saved_text); + + errno =3D 0; + intval =3D json_strtoint(saved_text, &end, 10); + if (errno =3D=3D ERANGE) { + if (intval < 0) + error_set(error, lex, json_error_numeric_overflow, + "too big negative integer"); + else + error_set(error, lex, json_error_numeric_overflow, "too bi= g integer"); + goto out; + } + + assert(end =3D=3D saved_text + lex->saved_text.length); + + lex->token =3D TOKEN_INTEGER; + lex->value.integer =3D intval; + return 0; + } + + if (c =3D=3D '.') { + c =3D lex_get(lex, error); + if (!l_isdigit(c)) { + lex_unget(lex, c); + goto out; + } + lex_save(lex, c); + + do + c =3D lex_get_save(lex, error); + while (l_isdigit(c)); + } + + if (c =3D=3D 'E' || c =3D=3D 'e') { + c =3D lex_get_save(lex, error); + if (c =3D=3D '+' || c =3D=3D '-') + c =3D lex_get_save(lex, error); + + if (!l_isdigit(c)) { + lex_unget_unsave(lex, c); + goto out; + } + + do + c =3D lex_get_save(lex, error); + while (l_isdigit(c)); + } + + lex_unget_unsave(lex, c); + + if (jsonp_strtod(&lex->saved_text, &doubleval)) { + error_set(error, lex, json_error_numeric_overflow, "real number ov= erflow"); + goto out; + } + + lex->token =3D TOKEN_REAL; + lex->value.real =3D doubleval; + return 0; + +out: + return -1; +} + +static int lex_scan(lex_t *lex, json_error_t *error) { + int c; + + strbuffer_clear(&lex->saved_text); + + if (lex->token =3D=3D TOKEN_STRING) + lex_free_string(lex); + + do + c =3D lex_get(lex, error); + while (c =3D=3D ' ' || c =3D=3D '\t' || c =3D=3D '\n' || c =3D=3D '\r'= ); + + if (c =3D=3D STREAM_STATE_EOF) { + lex->token =3D TOKEN_EOF; + goto out; + } + + if (c =3D=3D STREAM_STATE_ERROR) { + lex->token =3D TOKEN_INVALID; + goto out; + } + + lex_save(lex, c); + + if (c =3D=3D '{' || c =3D=3D '}' || c =3D=3D '[' || c =3D=3D ']' || c = =3D=3D ':' || c =3D=3D ',') + lex->token =3D c; + + else if (c =3D=3D '"') + lex_scan_string(lex, error); + + else if (l_isdigit(c) || c =3D=3D '-') { + if (lex_scan_number(lex, c, error)) + goto out; + } + + else if (l_isalpha(c)) { + /* eat up the whole identifier for clearer error messages */ + const char *saved_text; + + do + c =3D lex_get_save(lex, error); + while (l_isalpha(c)); + lex_unget_unsave(lex, c); + + saved_text =3D strbuffer_value(&lex->saved_text); + + if (strcmp(saved_text, "true") =3D=3D 0) + lex->token =3D TOKEN_TRUE; + else if (strcmp(saved_text, "false") =3D=3D 0) + lex->token =3D TOKEN_FALSE; + else if (strcmp(saved_text, "null") =3D=3D 0) + lex->token =3D TOKEN_NULL; + else + lex->token =3D TOKEN_INVALID; + } + + else { + /* save the rest of the input UTF-8 sequence to get an error + message of valid UTF-8 */ + lex_save_cached(lex); + lex->token =3D TOKEN_INVALID; + } + +out: + return lex->token; +} + +static char *lex_steal_string(lex_t *lex, size_t *out_len) { + char *result =3D NULL; + if (lex->token =3D=3D TOKEN_STRING) { + result =3D lex->value.string.val; + *out_len =3D lex->value.string.len; + lex->value.string.val =3D NULL; + lex->value.string.len =3D 0; + } + return result; +} + +static int lex_init(lex_t *lex, get_func get, size_t flags, void *data) { + stream_init(&lex->stream, get, data); + if (strbuffer_init(&lex->saved_text)) + return -1; + + lex->flags =3D flags; + lex->token =3D TOKEN_INVALID; + return 0; +} + +static void lex_close(lex_t *lex) { + if (lex->token =3D=3D TOKEN_STRING) + lex_free_string(lex); + strbuffer_close(&lex->saved_text); +} + +/*** parser ***/ + +static json_t *parse_value(lex_t *lex, size_t flags, json_error_t *error); + +static json_t *parse_object(lex_t *lex, size_t flags, json_error_t *error)= { + json_t *object =3D json_object(); + if (!object) + return NULL; + + lex_scan(lex, error); + if (lex->token =3D=3D '}') + return object; + + while (1) { + char *key; + size_t len; + json_t *value; + + if (lex->token !=3D TOKEN_STRING) { + error_set(error, lex, json_error_invalid_syntax, "string or '}= ' expected"); + goto error; + } + + key =3D lex_steal_string(lex, &len); + if (!key) + return NULL; + if (memchr(key, '\0', len)) { + jsonp_free(key); + error_set(error, lex, json_error_null_byte_in_key, + "NUL byte in object key not supported"); + goto error; + } + + if (flags & JSON_REJECT_DUPLICATES) { + if (json_object_get(object, key)) { + jsonp_free(key); + error_set(error, lex, json_error_duplicate_key, "duplicate= object key"); + goto error; + } + } + + lex_scan(lex, error); + if (lex->token !=3D ':') { + jsonp_free(key); + error_set(error, lex, json_error_invalid_syntax, "':' expected= "); + goto error; + } + + lex_scan(lex, error); + value =3D parse_value(lex, flags, error); + if (!value) { + jsonp_free(key); + goto error; + } + + if (json_object_set_new_nocheck(object, key, value)) { + jsonp_free(key); + goto error; + } + + jsonp_free(key); + + lex_scan(lex, error); + if (lex->token !=3D ',') + break; + + lex_scan(lex, error); + } + + if (lex->token !=3D '}') { + error_set(error, lex, json_error_invalid_syntax, "'}' expected"); + goto error; + } + + return object; + +error: + json_decref(object); + return NULL; +} + +static json_t *parse_array(lex_t *lex, size_t flags, json_error_t *error) { + json_t *array =3D json_array(); + if (!array) + return NULL; + + lex_scan(lex, error); + if (lex->token =3D=3D ']') + return array; + + while (lex->token) { + json_t *elem =3D parse_value(lex, flags, error); + if (!elem) + goto error; + + if (json_array_append_new(array, elem)) { + goto error; + } + + lex_scan(lex, error); + if (lex->token !=3D ',') + break; + + lex_scan(lex, error); + } + + if (lex->token !=3D ']') { + error_set(error, lex, json_error_invalid_syntax, "']' expected"); + goto error; + } + + return array; + +error: + json_decref(array); + return NULL; +} + +static json_t *parse_value(lex_t *lex, size_t flags, json_error_t *error) { + json_t *json; + + lex->depth++; + if (lex->depth > JSON_PARSER_MAX_DEPTH) { + error_set(error, lex, json_error_stack_overflow, "maximum parsing = depth reached"); + return NULL; + } + + switch (lex->token) { + case TOKEN_STRING: { + const char *value =3D lex->value.string.val; + size_t len =3D lex->value.string.len; + + if (!(flags & JSON_ALLOW_NUL)) { + if (memchr(value, '\0', len)) { + error_set(error, lex, json_error_null_character, + "\\u0000 is not allowed without JSON_ALLOW_N= UL"); + return NULL; + } + } + + json =3D jsonp_stringn_nocheck_own(value, len); + lex->value.string.val =3D NULL; + lex->value.string.len =3D 0; + break; + } + + case TOKEN_INTEGER: { + json =3D json_integer(lex->value.integer); + break; + } + + case TOKEN_REAL: { + json =3D json_real(lex->value.real); + break; + } + + case TOKEN_TRUE: + json =3D json_true(); + break; + + case TOKEN_FALSE: + json =3D json_false(); + break; + + case TOKEN_NULL: + json =3D json_null(); + break; + + case '{': + json =3D parse_object(lex, flags, error); + break; + + case '[': + json =3D parse_array(lex, flags, error); + break; + + case TOKEN_INVALID: + error_set(error, lex, json_error_invalid_syntax, "invalid toke= n"); + return NULL; + + default: + error_set(error, lex, json_error_invalid_syntax, "unexpected t= oken"); + return NULL; + } + + if (!json) + return NULL; + + lex->depth--; + return json; +} + +static json_t *parse_json(lex_t *lex, size_t flags, json_error_t *error) { + json_t *result; + + lex->depth =3D 0; + + lex_scan(lex, error); + if (!(flags & JSON_DECODE_ANY)) { + if (lex->token !=3D '[' && lex->token !=3D '{') { + error_set(error, lex, json_error_invalid_syntax, "'[' or '{' e= xpected"); + return NULL; + } + } + + result =3D parse_value(lex, flags, error); + if (!result) + return NULL; + + if (!(flags & JSON_DISABLE_EOF_CHECK)) { + lex_scan(lex, error); + if (lex->token !=3D TOKEN_EOF) { + error_set(error, lex, json_error_end_of_input_expected, + "end of file expected"); + json_decref(result); + return NULL; + } + } + + if (error) { + /* Save the position even though there was no error */ + error->position =3D (int)lex->stream.position; + } + + return result; +} + +typedef struct { + const char *data; + size_t pos; +} string_data_t; + +static int string_get(void *data) { + char c; + string_data_t *stream =3D (string_data_t *)data; + c =3D stream->data[stream->pos]; + if (c =3D=3D '\0') + return EOF; + else { + stream->pos++; + return (unsigned char)c; + } +} + +json_t *json_loads(const char *string, size_t flags, json_error_t *error) { + lex_t lex; + json_t *result; + string_data_t stream_data; + + jsonp_error_init(error, ""); + + if (string =3D=3D NULL) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + stream_data.data =3D string; + stream_data.pos =3D 0; + + if (lex_init(&lex, string_get, flags, (void *)&stream_data)) + return NULL; + + result =3D parse_json(&lex, flags, error); + + lex_close(&lex); + return result; +} + +typedef struct { + const char *data; + size_t len; + size_t pos; +} buffer_data_t; + +static int buffer_get(void *data) { + char c; + buffer_data_t *stream =3D data; + if (stream->pos >=3D stream->len) + return EOF; + + c =3D stream->data[stream->pos]; + stream->pos++; + return (unsigned char)c; +} + +json_t *json_loadb(const char *buffer, size_t buflen, size_t flags, json_e= rror_t *error) { + lex_t lex; + json_t *result; + buffer_data_t stream_data; + + jsonp_error_init(error, ""); + + if (buffer =3D=3D NULL) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + stream_data.data =3D buffer; + stream_data.pos =3D 0; + stream_data.len =3D buflen; + + if (lex_init(&lex, buffer_get, flags, (void *)&stream_data)) + return NULL; + + result =3D parse_json(&lex, flags, error); + + lex_close(&lex); + return result; +} + +json_t *json_loadf(FILE *input, size_t flags, json_error_t *error) { + lex_t lex; + const char *source; + json_t *result; +#ifdef HAVE_UNISTD_H + if (input =3D=3D stdin) + source =3D ""; + else +#endif + source =3D ""; + + jsonp_error_init(error, source); + + if (input =3D=3D NULL) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + if (lex_init(&lex, (get_func)fgetc, flags, input)) + return NULL; + + result =3D parse_json(&lex, flags, error); + + lex_close(&lex); + return result; +} + +static int fd_get_func(int *fd) { +#ifdef HAVE_UNISTD_H + uint8_t c; + if (read(*fd, &c, 1) =3D=3D 1) + return c; +#endif + return EOF; +} + +json_t *json_loadfd(int input, size_t flags, json_error_t *error) { + lex_t lex; + const char *source; + json_t *result; + +#ifdef HAVE_UNISTD_H + if (input =3D=3D STDIN_FILENO) + source =3D ""; + else +#endif + source =3D ""; + + jsonp_error_init(error, source); + + if (input < 0) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + if (lex_init(&lex, (get_func)fd_get_func, flags, &input)) + return NULL; + + result =3D parse_json(&lex, flags, error); + + lex_close(&lex); + return result; +} + +json_t *json_load_file(const char *path, size_t flags, json_error_t *error= ) { + json_t *result; + FILE *fp; + + jsonp_error_init(error, path); + + if (path =3D=3D NULL) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + fp =3D fopen(path, "rb"); + if (!fp) { + error_set(error, NULL, json_error_cannot_open_file, "unable to ope= n %s: %s", path, + strerror(errno)); + return NULL; + } + + result =3D json_loadf(fp, flags, error); + + fclose(fp); + return result; +} + +#define MAX_BUF_LEN 1024 + +typedef struct { + char data[MAX_BUF_LEN]; + size_t len; + size_t pos; + json_load_callback_t callback; + void *arg; +} callback_data_t; + +static int callback_get(void *data) { + char c; + callback_data_t *stream =3D data; + + if (stream->pos >=3D stream->len) { + stream->pos =3D 0; + stream->len =3D stream->callback(stream->data, MAX_BUF_LEN, stream= ->arg); + if (stream->len =3D=3D 0 || stream->len =3D=3D (size_t)-1) + return EOF; + } + + c =3D stream->data[stream->pos]; + stream->pos++; + return (unsigned char)c; +} + +json_t *json_load_callback(json_load_callback_t callback, void *arg, size_= t flags, + json_error_t *error) { + lex_t lex; + json_t *result; + + callback_data_t stream_data; + + memset(&stream_data, 0, sizeof(stream_data)); + stream_data.callback =3D callback; + stream_data.arg =3D arg; + + jsonp_error_init(error, ""); + + if (callback =3D=3D NULL) { + error_set(error, NULL, json_error_invalid_argument, "wrong argumen= ts"); + return NULL; + } + + if (lex_init(&lex, (get_func)callback_get, flags, &stream_data)) + return NULL; + + result =3D parse_json(&lex, flags, error); + + lex_close(&lex); + return result; +} diff --git a/RedfishPkg/Library/JsonLib/Readme.rst b/RedfishPkg/Library/Jso= nLib/Readme.rst new file mode 100644 index 0000000000..1c652591c7 --- /dev/null +++ b/RedfishPkg/Library/JsonLib/Readme.rst @@ -0,0 +1,35 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D + Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D + Jansson is a C library for encoding, decoding and manipulating JSON data. +Its main features and design principles are: + + - Simple and intuitive API and data model + - Comprehensive documentation + - No dependencies on other libraries + - Full Unicode support (UTF-8) + - Extensive test suite + + Jansson is licensed under the MIT license(refer to ReadMe.rst under edk2= ). +It is used in production and its API is stable. It works on numerous +platforms, including numerous Unix like systems and Windows. It's suitable +for use on any system, including desktop, server, and small embedded syste= ms. + + In UEFI/EDKII environment, Redfish project consumes jansson to achieve J= SON +operations. + +* Jansson version on edk2: 2.13.1, API reference is on the below URL, + https://jansson.readthedocs.io/en/2.13/apiref.html + +* EDKII jansson library wrapper: + - JsonLib.h: + This is the denifitions of EDKII JSON APIs which are mapped to + jannson funcitons accordingly. + +*Known issue: + Build fail with jansson/src/load.c, add code in load.c to conditionally + use stdin according to HAVE_UNISTD_H macro. The PR is submitted to + jansson open source community. + https://github.com/akheron/jansson/pull/558 + + diff --git a/RedfishPkg/RedfishPkg.ci.yaml b/RedfishPkg/RedfishPkg.ci.yaml index e410d1a608..fde6fa89bc 100644 --- a/RedfishPkg/RedfishPkg.ci.yaml +++ b/RedfishPkg/RedfishPkg.ci.yaml @@ -35,7 +35,13 @@ "PrivateInclude/Crt/string.h", "PrivateInclude/Crt/time.h", "PrivateInclude/Library/RedfishCrtLib.h", - "PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c" + "PrivateLibrary/RedfishCrtLib/RedfishCrtLib.c", + ## + ## For jansson library open source + ## load.c is overrided from open source. + "Library/JsonLib/load.c", + "Library/JsonLib/jansson_config.h", + "Library/JsonLib/jansson_private_config.h" ] }, "CompilerPlugin": { --=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 (#70026): https://edk2.groups.io/g/devel/message/70026 Mute This Topic: https://groups.io/mt/79519377/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- From nobody Thu Apr 25 22:13:25 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+70027+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+70027+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090723; cv=none; d=zohomail.com; s=zohoarc; b=FbFU48B+Fbjd5G0kZ46w/O6nGMBGyFWa0rpvmewlJAkOYwWkG+kcbHQF0eaewJUDtdd9FvpalD90zOIT1O270gXlQMIDwSd561Vdtbf4J+18UTye1pCQruvxCqHovBmvOssj/30SKJmRd7dpyFnzE7d9/OcYlAprHEWYOk/dlTM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090723; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:Message-ID:Reply-To:References:Sender:Subject:To; bh=PGJsE3or1vJSmuNIVFrivXl+5/+KY39xXXkeUoUDOdU=; b=CQcKx/7rvjMN/+Vip7cQCGq00Sbk+W3CismCQqi/7NKpGXk+RyBTTLSwYUyKw+MZ9O4K35AY0UBssMiZaAnC4/bJO+yVuVpnFlLLIrOm69NcT5YgUqmPp89XT+tsFq1ybwCZMXhLsG3e0wtBmLnn1BvVASOGDb9UNVO3MiSlKBU= 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+70027+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090723646985.1464303954313; Thu, 7 Jan 2021 23:25:23 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id SFAkYY1788612xS0Osqw2BpF; Thu, 07 Jan 2021 23:25:23 -0800 X-Received: from mx0b-002e3701.pphosted.com (mx0b-002e3701.pphosted.com [148.163.143.35]) by mx.groups.io with SMTP id smtpd.web10.822.1610090717794470202 for ; Thu, 07 Jan 2021 23:25:18 -0800 X-Received: from pps.filterd (m0150244.ppops.net [127.0.0.1]) by mx0b-002e3701.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 1087J7PS001298 for ; Fri, 8 Jan 2021 07:25:16 GMT X-Received: from g4t3427.houston.hpe.com (g4t3427.houston.hpe.com [15.241.140.73]) by mx0b-002e3701.pphosted.com with ESMTP id 35xg1x10gp-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 08 Jan 2021 07:25:16 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3427.houston.hpe.com (Postfix) with ESMTP id EB6176A for ; Fri, 8 Jan 2021 07:25:15 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 0B4E14A; Fri, 8 Jan 2021 07:25:14 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 5/6] RedfishPkg: Add EDK2 port of jansson library to build Date: Fri, 8 Jan 2021 14:37:12 +0800 Message-Id: <20210108063713.8853-6-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: V9lLbPRix6tfHKyrNzsosRj8x1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090723; bh=JPqdKxcgJfzJJYsWg0GDkQARu15lEcyj606rvxtY37Q=; h=Cc:Date:From:Reply-To:Subject:To; b=Y54eoOkcp+ZPE1nnbOFwxxLFnpqgowcU+nInwgL/BjxH/KojMT72w/fp6SJVL4jep4Q pNGa476HkRaDA9KEEg9d0KsOHxaUXE6w4OAf9vTUYTw+O3SFSO0J0QteXe4TsM5btTRzU ZOevhKdn6fCdizqwiC337vEQHsCpdkzgsRA= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Add EDK2 port jansson library (JsonLib) to RedfishPkg Signed-off-by: Abner Chang Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Nickle Wang --- RedfishPkg/RedfishLibs.dsc.inc | 1 + RedfishPkg/RedfishPkg.dsc | 1 + 2 files changed, 2 insertions(+) diff --git a/RedfishPkg/RedfishLibs.dsc.inc b/RedfishPkg/RedfishLibs.dsc.inc index 2e54f90dc2..103a596753 100644 --- a/RedfishPkg/RedfishLibs.dsc.inc +++ b/RedfishPkg/RedfishLibs.dsc.inc @@ -15,5 +15,6 @@ Ucs2Utf8Lib|RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf BaseSortLib|MdeModulePkg/Library/BaseSortLib/BaseSortLib.inf RedfishCrtLib|RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf + JsonLib|RedfishPkg/Library/JsonLib/JsonLib.inf !endif =20 diff --git a/RedfishPkg/RedfishPkg.dsc b/RedfishPkg/RedfishPkg.dsc index 420da0f2a9..bffa8f1f89 100644 --- a/RedfishPkg/RedfishPkg.dsc +++ b/RedfishPkg/RedfishPkg.dsc @@ -52,5 +52,6 @@ RedfishPkg/Library/DxeRestExLib/DxeRestExLib.inf RedfishPkg/Library/BaseUcs2Utf8Lib/BaseUcs2Utf8Lib.inf RedfishPkg/PrivateLibrary/RedfishCrtLib/RedfishCrtLib.inf + RedfishPkg/Library/JsonLib/JsonLib.inf =20 !include RedfishPkg/Redfish.dsc.inc --=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 (#70027): https://edk2.groups.io/g/devel/message/70027 Mute This Topic: https://groups.io/mt/79519378/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- From nobody Thu Apr 25 22:13:25 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+70029+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+70029+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=hpe.com ARC-Seal: i=1; a=rsa-sha256; t=1610090719; cv=none; d=zohomail.com; s=zohoarc; b=QSeuj6XrbPMnSY8hpctrKi1HysACe2wkgBNd/kcO8DGIcch158dZY9s1QEqoMGOvf3e6gj9YK0tRPEIAG8Jv55jEMx3+zq06R4Zx9TtSo1EtlYI+Vw+K92NXO3zVGyqiYPZi3df1/EnqseL16cGgPuOWpDHQEM/1aAToDKjshK0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610090719; h=Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:Message-ID:Reply-To:References:Sender:Subject:To; bh=18DenR/AXzOmiQlD0STDrdvZWfG6UP9E058Vm1mpjR8=; b=knsvb62mXSOrqsqnD/HkoBm8nihyrvPFD38vbQe1dDLE/LevsyAI23VCekyZi+htp6UUsxw981LRSuYc5fjyUfZn3P9hWmvDQM+wEZBQwJ5YgZ5jFIIYQ4Rl+H0Oa0mft7YrQLYawO57YsgQ4aIUCTzyX3ROcTUbkT2tz/yWwoo= 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+70029+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1610090719995940.9758315726474; Thu, 7 Jan 2021 23:25:19 -0800 (PST) Return-Path: X-Received: by 127.0.0.2 with SMTP id bn3yYY1788612xl4xgRnD3Gx; Thu, 07 Jan 2021 23:25:19 -0800 X-Received: from mx0b-002e3701.pphosted.com (mx0b-002e3701.pphosted.com [148.163.143.35]) by mx.groups.io with SMTP id smtpd.web09.831.1610090718797527548 for ; Thu, 07 Jan 2021 23:25:19 -0800 X-Received: from pps.filterd (m0134425.ppops.net [127.0.0.1]) by mx0b-002e3701.pphosted.com (8.16.0.43/8.16.0.43) with SMTP id 1087OhN9002134; Fri, 8 Jan 2021 07:25:18 GMT X-Received: from g4t3427.houston.hpe.com (g4t3427.houston.hpe.com [15.241.140.73]) by mx0b-002e3701.pphosted.com with ESMTP id 35xjykg05k-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 08 Jan 2021 07:25:18 +0000 X-Received: from g9t2301.houston.hpecorp.net (g9t2301.houston.hpecorp.net [16.220.97.129]) by g4t3427.houston.hpe.com (Postfix) with ESMTP id 8956E66; Fri, 8 Jan 2021 07:25:17 +0000 (UTC) X-Received: from abner-virtual-machine.asiapacific.hpqcorp.net (abner-virtual-machine.asiapacific.hpqcorp.net [15.119.210.153]) by g9t2301.houston.hpecorp.net (Postfix) with ESMTP id 479C948; Fri, 8 Jan 2021 07:25:16 +0000 (UTC) From: "Abner Chang" To: devel@edk2.groups.io Cc: Sean Brogan , Bret Barkelew , Nickle Wang , Peter O'Hanley Subject: [edk2-devel] [PATCH v13 6/6] .pytool: Add required submodule for JsonLib Date: Fri, 8 Jan 2021 14:37:13 +0800 Message-Id: <20210108063713.8853-7-abner.chang@hpe.com> In-Reply-To: <20210108063713.8853-1-abner.chang@hpe.com> References: <20210108063713.8853-1-abner.chang@hpe.com> X-HPE-SCL: -1 Precedence: Bulk List-Unsubscribe: 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: vJF9TWqfv3w7pEyt3wjDTB1ex1787277AA= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1610090719; bh=mHzLSx8m6CyWOd84nydeUPMQ1vvrGbPubUrICgas/Aw=; h=Cc:Date:From:Reply-To:Subject:To; b=JykT7J2bJYHK9Ytr7gqL8Sf4MTxhBq8RXMjChckowvBCU908ka4svENLxaHGw/oBqH+ R8nSxk5ghob7jxfHqIPfeAvT1zxi5/eVf7SnsdmFRfxtEe75iuiwBl9lLdx17Lsr0QxKE MNfoT0MVCnGwm4zkW3uC3IE0W+/f5FO/zJI= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Open source project jansson is leveraged by edk2 JsonLib. Add jansson to the required submodule in CiSettings.py. Signed-off-by: Abner Chang Cc: Sean Brogan Cc: Bret Barkelew Cc: Nickle Wang Cc: Peter O'Hanley Reviewed-by: Bret Barkelew --- .pytool/CISettings.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.pytool/CISettings.py b/.pytool/CISettings.py index b337d046ae..416de023cc 100644 --- a/.pytool/CISettings.py +++ b/.pytool/CISettings.py @@ -158,6 +158,8 @@ class Settings(CiBuildSettingsManager, UpdateSettingsMa= nager, SetupSettingsManag "MdeModulePkg/Library/BrotliCustomDecompressLib/brotli", False= )) rs.append(RequiredSubmodule( "BaseTools/Source/C/BrotliCompress/brotli", False)) + rs.append(RequiredSubmodule( + "RedfishPkg/Library/JsonLib/jansson", False)) return rs =20 def GetName(self): --=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 (#70029): https://edk2.groups.io/g/devel/message/70029 Mute This Topic: https://groups.io/mt/79519380/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-