Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-state-manager / 4ee594663bfb4229332ec46b8bcaa7bdce947f6c
commit4ee594663bfb4229332ec46b8bcaa7bdce947f6c[log] [tgz]
authorAndrew Geissler <geissonator@yahoo.com>Thu Apr 28 16:58:26 2022 -0400
committerAndrew Geissler <andrew@geissonator.com>Mon May 09 17:59:48 2022 +0000
tree38981e4f7242042d2ed21b2f948ad33c13c077dc
parent80db4752d278247ad69ed45bb81f8113eb730e00 [diff]
bmc-reboot: put into NotReady state

When a reboot of the BMC has been requested, there is a period of time
where certain services, like the BMC webserver, are still running. This
can be confusing to external clients that do not know the BMC reboot is
occurring and who are still expecting the BMC interfaces (like Redfish)
to continue working. Provide at least a cookie crumb to external clients
by switching the BMC state to NotReady when a BMC reboot is initiated.

This allows client a method to read the BMC state via the redfish
managers API and know the state of the BMC.

Tested:
- Verified when I initiated a reboot of the BMC via the
  RequestedBMCTransition property that the BMC state was set to
  NotReady

Apr 28 20:12:53 witherspoon phosphor-bmc-state-manager[337]: Setting the RequestedBMCTransition field to xyz.openbmc_project.State.BMC.Transition.Reboot
Apr 28 20:12:53 witherspoon phosphor-bmc-state-manager[337]: Setting the BMCState field to xyz.openbmc_project.State.BMC.BMCState.NotReady
... <BMC rebooted>
Apr 28 20:15:27 witherspoon phosphor-bmc-state-manager[349]: Setting the BMCState field to BMC_NOTREADY
Apr 28 20:15:27 witherspoon phosphor-bmc-state-manager[349]: Setting the BMCState field to xyz.openbmc_project.State.BMC.BMCState.NotReady
Apr 28 20:15:27 witherspoon phosphor-bmc-state-manager[349]: Setting the RebootCause field to xyz.openbmc_project.State.BMC.RebootCause.Unknown
Apr 28 20:15:57 witherspoon phosphor-bmc-state-manager[349]: BMC_READY
Apr 28 20:15:57 witherspoon phosphor-bmc-state-manager[349]: Setting the BMCState field to xyz.openbmc_project.State.BMC.BMCState.Ready

Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I97b1191769390e7774fb1d3714e8b3f742838f6a
1 file changed
tree: 38981e4f7242042d2ed21b2f948ad33c13c077dc
  1. data/
  2. host_condition_gpio/
  3. service_files/
  4. subprojects/
  5. target_files/
  6. test/
  7. .clang-format
  8. .gitignore
  9. .shellcheck
  10. bmc_state_manager.cpp
  11. bmc_state_manager.hpp
  12. bmc_state_manager_main.cpp
  13. chassis_check_power_status.cpp
  14. chassis_state_manager.cpp
  15. chassis_state_manager.hpp
  16. chassis_state_manager_main.cpp
  17. discover_system_state.cpp
  18. host_check.cpp
  19. host_check.hpp
  20. host_reset_recovery.cpp
  21. host_state_manager.cpp
  22. host_state_manager.hpp
  23. host_state_manager_main.cpp
  24. hypervisor_state_manager.cpp
  25. hypervisor_state_manager.hpp
  26. hypervisor_state_manager_main.cpp
  27. LICENSE
  28. MAINTAINERS
  29. meson.build
  30. meson_options.txt
  31. obmcutil
  32. OWNERS
  33. README.md
  34. scheduled_host_transition.cpp
  35. scheduled_host_transition.hpp
  36. scheduled_host_transition_main.cpp
  37. secure_boot_check.cpp
  38. settings.cpp
  39. settings.hpp
  40. systemd_service_parser.cpp
  41. systemd_service_parser.hpp
  42. systemd_target_monitor.cpp
  43. systemd_target_parser.cpp
  44. systemd_target_parser.hpp
  45. systemd_target_signal.cpp
  46. systemd_target_signal.hpp
  47. utils.cpp
  48. utils.hpp
README.md

Phosphor State Manager Documentation

This repository contains the software responsible for tracking and controlling the state of different objects within OpenBMC. This currently includes the BMC, Chassis, and Host. The most critical feature of phosphor-state-manager software is its support for requests to power on and off the system by the user.

This software also enforces any restore policy (i.e. auto power on system after a system power event or bmc reset) and ensures its states are updated correctly in situations where the BMC is rebooted and the chassis or host are in on/running states.

This repository also provides a command line tool, obmcutil, which provides basic command line support to query and control phosphor-state-manager applications running within an OpenBMC system. This tool itself runs within an OpenBMC system and utilizes D-Bus APIs. These D-Bus APIs are used for development and debug and are not intended for end users.

As with all OpenBMC applications, interfaces and properties within phosphor-state-manager are D-Bus interfaces. These interfaces are then used by external interface protocols, such as Redfish and IPMI, to report and control state to/by the end user.

State Tracking and Control

phosphor-state-manager makes extensive use of systemd. There is a writeup here with an overview of systemd and its use by OpenBMC.

phosphor-state-manager follows some basics design guidelines in its implementation and use of systemd:

  • Keep the different objects as independent as possible (host, chassis, bmc)
  • Use systemd targets for everything and keep the code within phosphor-state-manager minimal
  • Ensure it can support required external interfaces, but don't necessarily create 1x1 mappings otherwise every external interface will end up with its own special chassis or host state request
  • If something like a hard power off can be done by just turning off the chassis, don't provide a command in the host to do the same thing

phosphor-state-manager implements states and state requests as defined in phosphor-dbus-interfaces for each object it supports.

  • bmc: The BMC has very minimal states. It is Ready once all services within the default.target have executed. The only state change request you can make of the BMC is for it to reboot itself.
    • CurrentBMCState: NotReady, Ready
    • RequestedBMCTransition: Reboot
  • chassis: The chassis represents the physical hardware in which the system is contained. It usually has the power supplies, fans, and other hardware associated with it. It can be either On or Off.
    • CurrentPowerState: On, Off
    • RequestedPowerTransition: On, Off
  • host: The host represents the software running on the system. In most cases this is an operating system of some sort. The host can be Off, Running, Quiesced(error condition), or in DiagnosticMode(collecting diagnostic data for a failure)
    • CurrentHostState: Off, Running, Quiesced, DiagnosticMode
    • RequestedHostTransition: Off, On, Reboot, GracefulWarmReboot, ForceWarmReboot

As noted above, phosphor-state-manager provides a command line tool, obmcutil, which takes a state parameter. This will use D-Bus commands to retrieve the above states and present them to the user. It also provides other commands which will send the appropriate D-Bus commands to the above properties to power on/off the chassis and host (see obmcutil --help within an OpenBMC system).

The above objects also implement other D-Bus objects like power on hours, boot progress, reboot attempts, and operating system status. These D-Bus objects are also defined out in the phosphor-dbus-interfaces repository.

Restore Policy on Power Events

The RestorePolicy defines the behavior the user wants when the BMC is reset. If the chassis or host is on/running then this service will not run. If they are off then the RestorePolicy will be read and executed by phosphor-state-manager code.

BMC Reset with Host and/or Chassis On

In situations where the BMC is reset and the chassis and host are on and running, its critical that the BMC software do two things:

  • Never impact the state of the system (causing a power off of a running system is very bad)
  • Ensure the BMC, Chassis, and Host states accurately represent the state of the system.

Note that some of this logic is provided via service files in system-specific meta layers. That is because the logic to determine if the chassis is on or if the host is running can vary from system to system. The requirement to create the files defined below and ensure the common targets go active is a must for anyone wishing to enable this feature.

phosphor-state-manager discovers state vs. trying to cache and save states. This ensure it's always getting the most accurate state information. It discovers the chassis state by checking the pgood value from the power application. If it determines that power is on then it will do the following:

  • Create a file called /run/openbmc/chassis@0-on
    • The presence of this file tells the services to alter their behavior because the chassis is already powered on
  • Start the obmc-chassis-poweron@0.target
    • The majority of services in this target will "fake start" due to the file being present. They will report to systemd that they started and ran successfully but they actually do nothing. This is what you would want in this case. Power is already on so you don't want to run the services to turn power on. You do want to get the obmc-chassis-poweron@0.target in the Active state though so that the chassis object within phosphor-state-manager will correctly report that the chassis is On
  • Start a service to check if the host is on

The chassis@0-on file is removed once the obmc-chassis-poweron@0.target becomes active (i.e. all service have been successfully started which are wanted or required by this target).

The logic to check if the host is on sends a command to the host, and if a response is received then similar logic to chassis is done:

  • Create a file called /run/openbmc/host@0-on
  • Start the obmc-host-start@0.target
    • Similar to above, most services will not run due to the file being created and their service files implementing a "ConditionPathExists=!/run/openbmc/host@0-request"

The host@0-on file is removed once the obmc-host-start@0.target and obmc-host-startmin@0.target become active (i.e. all service have been successfully started which are wanted or required by these targets).

Building the Code

To build this package, do the following steps:

    1. meson build
    2. ninja -C build

To clean the repository again run `rm -rf build`.