public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: "devel@edk2.groups.io" <devel@edk2.groups.io>,
	"abner.chang@hpe.com" <abner.chang@hpe.com>,
	"Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>,
	Bret Barkelew <Bret.Barkelew@microsoft.com>,
	"Wang, Jian J" <jian.j.wang@intel.com>,
	"Wu, Hao A" <hao.a.wu@intel.com>, Andrew Fish <afish@apple.com>,
	Laszlo Ersek <lersek@redhat.com>,
	Leif Lindholm <leif@nuviainc.com>,
	Nickle Wang <nickle.wang@hpe.com>,
	Peter O'Hanley <peter.ohanley@hpe.com>
Subject: Re: [edk2-devel] [PATCH v3 0/4] jansson edk2 port
Date: Wed, 2 Dec 2020 17:37:43 +0000	[thread overview]
Message-ID: <BL0PR11MB32368600F6E090ECD9238DF0D2F30@BL0PR11MB3236.namprd11.prod.outlook.com> (raw)
In-Reply-To: <20201202071557.4688-1-abner.chang@hpe.com>

Hi Abner,

Can you provide a summary of the testing that is performed by the jansson project
and what additional testing has been implemented for the EDK II wrapper?

Since this is a generic lib that may be asked to parse JSON content from 
untrusted sources, we want to make sure it has proper testing.

Mike

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Abner Chang
> Sent: Tuesday, December 1, 2020 11:16 PM
> To: devel@edk2.groups.io
> Cc: Sean Brogan <sean.brogan@microsoft.com>; Bret Barkelew <Bret.Barkelew@microsoft.com>; Wang, Jian J
> <jian.j.wang@intel.com>; Wu, Hao A <hao.a.wu@intel.com>; Andrew Fish <afish@apple.com>; Laszlo Ersek <lersek@redhat.com>;
> Leif Lindholm <leif@nuviainc.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Nickle Wang <nickle.wang@hpe.com>;
> Peter O'Hanley <peter.ohanley@hpe.com>
> Subject: [edk2-devel] [PATCH v3 0/4] jansson edk2 port
> 
> In v3, Add jansson library as the required submoudle in
>        CiSettings.py for CI test.
> In v2, JsonLib is moved to under RedfishPkg.
> 
> edk2 JSON library is based on jansson open source
> (https://github.com/akheron/jansson) and wrapped as an edk2
> library. edk2 JsonLib will be used by edk2 Redfish feature
> drivers (not contributed yet) and the edk2 port of libredfish
> library (not contributed yet) based on DMTF GitHub
> (https://github.com/DMTF/libredfish).
> 
> Jansson is licensed under the MIT license(refer to ReadMe.rst under edk2).
> It is used in production and its API is stable. In UEFI/EDKII environment,
> Redfish project consumes jansson to achieve JSON operations.
> 
> * Jansson version on edk2: 2.13.1
> 
> * EDKII jansson library wrapper:
>    - JsonLib.h:
>      This is the denifitions of EDKII JSON APIs which are mapped to
>      jannson funcitons accordingly.
> 
>    - JanssonJsonLibMapping.h:
>      This is the wrapper file to map funcitons and definitions used in
>      native jannson applications to edk2 JsonLib. This avoids the
>      modifications on native jannson applications to be built under
>      edk2 environment.
> 
> *Known issue:
>   Build fail with jansson/src/load.c, overrride and 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
> 
> Signed-off-by: Abner Chang <abner.chang@hpe.com>
> 
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif@nuviainc.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Nickle Wang <nickle.wang@hpe.com>
> Cc: Peter O'Hanley <peter.ohanley@hpe.com>
> 
> Abner Chang (4):
>   edk2: jansson submodule for edk2 JSON library
>   RedfishPkg/library: EDK2 port of jansson library
>   RedfishPkg: Add EDK2 port of jansson library to build
>   .pytool: Add required submodule for JsonLib
> 
>  .gitmodules                                   |    3 +
>  .pytool/CISettings.py                         |    2 +
>  ReadMe.rst                                    |    1 +
>  .../Include/Library/JanssonJsonLibMapping.h   |   63 +
>  RedfishPkg/Include/Library/JsonLib.h          |  767 ++++++++++++
>  .../Library/JsonLib/JanssonCrtLibSupport.c    |  705 +++++++++++
>  .../Library/JsonLib/JanssonCrtLibSupport.h    |  196 +++
>  RedfishPkg/Library/JsonLib/JsonLib.c          |  960 ++++++++++++++
>  RedfishPkg/Library/JsonLib/JsonLib.inf        |  103 ++
>  RedfishPkg/Library/JsonLib/JsonUtilities.c    |  417 +++++++
>  RedfishPkg/Library/JsonLib/JsonUtilities.h    |   69 +
>  RedfishPkg/Library/JsonLib/Readme.txt         |   40 +
>  RedfishPkg/Library/JsonLib/assert.h           |   16 +
>  RedfishPkg/Library/JsonLib/errno.h            |   16 +
>  RedfishPkg/Library/JsonLib/jansson            |    1 +
>  RedfishPkg/Library/JsonLib/jansson_config.h   |   60 +
>  .../Library/JsonLib/jansson_private_config.h  |   19 +
>  RedfishPkg/Library/JsonLib/limits.h           |   16 +
>  RedfishPkg/Library/JsonLib/load.c             | 1111 +++++++++++++++++
>  RedfishPkg/Library/JsonLib/math.h             |   16 +
>  RedfishPkg/Library/JsonLib/stdarg.h           |   15 +
>  RedfishPkg/Library/JsonLib/stddef.h           |   16 +
>  RedfishPkg/Library/JsonLib/stdio.h            |   15 +
>  RedfishPkg/Library/JsonLib/stdlib.h           |   16 +
>  RedfishPkg/Library/JsonLib/string.h           |   16 +
>  RedfishPkg/Library/JsonLib/sys/time.h         |   15 +
>  RedfishPkg/Library/JsonLib/sys/types.h        |   15 +
>  RedfishPkg/Library/JsonLib/time.h             |   15 +
>  RedfishPkg/RedfishLibs.dsc.inc                |    1 +
>  RedfishPkg/RedfishPkg.ci.yaml                 |   33 +-
>  RedfishPkg/RedfishPkg.dec                     |    5 +
>  RedfishPkg/RedfishPkg.dsc                     |    1 +
>  32 files changed, 4743 insertions(+), 1 deletion(-)
>  create mode 100644 RedfishPkg/Include/Library/JanssonJsonLibMapping.h
>  create mode 100644 RedfishPkg/Include/Library/JsonLib.h
>  create mode 100644 RedfishPkg/Library/JsonLib/JanssonCrtLibSupport.c
>  create mode 100644 RedfishPkg/Library/JsonLib/JanssonCrtLibSupport.h
>  create mode 100644 RedfishPkg/Library/JsonLib/JsonLib.c
>  create mode 100644 RedfishPkg/Library/JsonLib/JsonLib.inf
>  create mode 100644 RedfishPkg/Library/JsonLib/JsonUtilities.c
>  create mode 100644 RedfishPkg/Library/JsonLib/JsonUtilities.h
>  create mode 100644 RedfishPkg/Library/JsonLib/Readme.txt
>  create mode 100644 RedfishPkg/Library/JsonLib/assert.h
>  create mode 100644 RedfishPkg/Library/JsonLib/errno.h
>  create mode 160000 RedfishPkg/Library/JsonLib/jansson
>  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/limits.h
>  create mode 100644 RedfishPkg/Library/JsonLib/load.c
>  create mode 100644 RedfishPkg/Library/JsonLib/math.h
>  create mode 100644 RedfishPkg/Library/JsonLib/stdarg.h
>  create mode 100644 RedfishPkg/Library/JsonLib/stddef.h
>  create mode 100644 RedfishPkg/Library/JsonLib/stdio.h
>  create mode 100644 RedfishPkg/Library/JsonLib/stdlib.h
>  create mode 100644 RedfishPkg/Library/JsonLib/string.h
>  create mode 100644 RedfishPkg/Library/JsonLib/sys/time.h
>  create mode 100644 RedfishPkg/Library/JsonLib/sys/types.h
>  create mode 100644 RedfishPkg/Library/JsonLib/time.h
> 
> --
> 2.17.1
> 
> 
> 
> 
> 


  parent reply	other threads:[~2020-12-02 17:37 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-02  7:15 [PATCH v3 0/4] jansson edk2 port Abner Chang
2020-12-02  7:15 ` [PATCH v3 1/4] edk2: jansson submodule for edk2 JSON library Abner Chang
2020-12-02  7:15 ` [PATCH v3 2/4] RedfishPkg/library: EDK2 port of jansson library Abner Chang
2020-12-02 10:03   ` 回复: [edk2-devel] " gaoliming
2020-12-03  3:25     ` Abner Chang
2020-12-02 13:47   ` Leif Lindholm
2020-12-03 15:13     ` Abner Chang
2020-12-03 17:06       ` Leif Lindholm
2020-12-04  6:20         ` Abner Chang
2020-12-02  7:15 ` [PATCH v3 3/4] RedfishPkg: Add EDK2 port of jansson library to build Abner Chang
2020-12-02  7:15 ` [PATCH v3 4/4] .pytool: Add required submodule for JsonLib Abner Chang
2020-12-02 17:37 ` Michael D Kinney [this message]
2020-12-03  3:40   ` [edk2-devel] [PATCH v3 0/4] jansson edk2 port Abner Chang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=BL0PR11MB32368600F6E090ECD9238DF0D2F30@BL0PR11MB3236.namprd11.prod.outlook.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox