Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / d7f04fd9ef456a6e6871adba6f3c5803f1ee88c6
commitd7f04fd9ef456a6e6871adba6f3c5803f1ee88c6[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Sun May 01 01:11:07 2022 +0000
committerEd Tanous <ed@tanous.net>Wed Jun 15 00:36:40 2022 +0000
tree9fea25b9a9232b8af6d542c61d00785172c2b995
parent3ba0007367777144f474fdf99439ae8c03633486 [diff]
memory: refactor JSON assembling codes

This commit does nothing but a refactoring around the translation codes
that translate data from dbus objects to JSON.

Existing codes assumes that the |AsyncResponse| is always at a specific
DIMM. This doesn't work if we are doing a efficient level=1 expand, as
introduced initially in
https://gerrit.openbmc-project.xyz/c/openbmc/bmcweb/+/52418, where the
|AsyncResponse| now points to the MemoryCollection.

In order to reuse codes in future changes, this commits refactors many
functions to take a JSON pointer, so any attributes added to a specific
DIMM go to the JSON pointer, rather than always to the root.

1. Tested on my mock environment,
```
URI: /redfish/v1/Systems/system/Memory/dimm0
{
    "@odata.id": "/redfish/v1/Systems/system/Memory/dimm0",
    "@odata.type": "#Memory.v1_11_0.Memory",
    "AllowedSpeedsMHz": [],
    "BaseModuleType": "RDIMM",
    "BusWidthBits": 0,
    "CapacityMiB": 1024,
    "DataWidthBits": 0,
    "ErrorCorrection": "NoECC",
    "FirmwareRevision": "0",
    "Id": "dimm0",
    "Name": "DIMM Slot",
    "OperatingSpeedMhz": 0,
    "RankCount": 0,
    "Regions": [
        {
            "MemoryClassification": "Volatile",
            "OffsetMiB": 0,
            "PassphraseEnabled": false,
            "RegionId": "",
            "SizeMiB": 1024
        }
    ],
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "State": "Enabled"
    }
}
```
2. No new Redfish Validator failures on MemoryCollection on real
hardware:
/redfish/v1/Systems/system/Memory (response time:0:00:00.116538)
MemoryCollection Pass
/redfish/v1/Systems/system/Memory/dimm0 (response time:
0:00:00.201940) Memory Pass

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: I61e6c76ca6dd6f129c5d382dcc46a4292a4e1bb7
1 file changed
tree: 9fea25b9a9232b8af6d542c61d00785172c2b995
  1. .github/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. subprojects/
  9. .clang-format
  10. .clang-ignore
  11. .clang-tidy
  12. .dockerignore
  13. .gitignore
  14. .shellcheck
  15. bmcweb.service.in
  16. bmcweb.socket.in
  17. bmcweb_config.h.in
  18. build_x86.sh
  19. build_x86_docker.sh
  20. CLIENTS.md
  21. COMMON_ERRORS.md
  22. DEVELOPING.md
  23. Dockerfile
  24. Dockerfile.base
  25. HEADERS.md
  26. LICENSE
  27. MAINTAINERS
  28. meson.build
  29. meson_options.txt
  30. OEM_SCHEMAS.md
  31. OWNERS
  32. pam-webserver
  33. README.md
  34. Redfish.md
  35. run-ci
  36. setup.cfg
  37. TESTING.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/meson_options.txt and then compiling. For example, meson <builddir> -Dkvm=disabled ... followed by ninja in build directory. The option names become C++ preprocessor symbols that control which code is compiled into the program.

Compile bmcweb with default options:

meson builddir
ninja -C builddir

Compile bmcweb with yocto defaults:

meson builddir -Dbuildtype=minsize -Db_lto=true -Dtests=disabled
ninja -C buildir

If any of the dependencies are not found on the host system during configuration, meson automatically gets them via its wrap dependencies mentioned in bmcweb/subprojects.

Enable/Disable meson wrap feature

meson builddir -Dwrap_mode=nofallback
ninja -C builddir

Enable debug traces

meson builddir -Dbuildtype=debug
ninja -C builddir

Generate test coverage report:

meson builddir -Db_coverage=true -Dtests=enabled
ninja -C builddir test
ninja -C builddir coverage

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.