docs/designs/dump-manager.md

20 - **System Dump**: A dump of the Host's main memory and processor registers.
22 - **Memory Preserving Reboot(MPR)**: A method of reboot with preserving the
24 - **PLDM**: An interface and data model to access low-level platform inventory,
26   [ReadMore](https://github.com/openbmc/docs/blob/master/designs/pldm-stack.md)
27 - **Machine Check Exception**: A severe error inside a processor core that
29 - **BMCWeb**: An embedded webserver for OpenBMC.
46 A dump collected when there is a failure in the BMC with various debug
80 to help to debug the failure.
84 …es - Users are examples, not a mandatory part of implementation](https://user-images.githubusercon…
88 - Create a dump: Initiate the creation of the dump, based on an error condition
90 - List the dumps: List all dumps present in the BMC.
91 - Get a dump: Offload the dump to an external entity.
92 - Notify: Notify the dump manager that a new dump is created.
93 - Delete the dump.
94 - Mark a dump as offloaded to an external entity.
95 - Set the dump policies like disabling a type of dump or dump overwriting
106 - Collected by BMC and stored on BMC.
107 - Collected and stored on an attached entity but offloaded through BMC.
109 This proposal focuses on re-using the existing
110 [phosphor-debug-collector](https://github.com/openbmc/phosphor-debug-collector),
113 ![phosphor-debug-collector](https://user-images.githubusercontent.com/16666879/72070844-7b56c980-33…
115 ### Brief design points of existing phosphor-debug-collector
117 - A create interface which assumes the type is BMC dump and returns an ID to the
118   caller for the user-initiated dumps.
119 - An external request of dump is considered as a user-initiated BMC dump and
121 - The dreport create dump file in the dump path provided by the dump manager
123 - A watch process is forked by the dump manager to catch the signal for the file
125 - The watch process calls an internal dbus interface to create the dump entry
127 - The path of dump is based on the predefined base path and the id of the dump.
128 - When the request comes for offload, the file is downloaded from the dump base
130 - Deleting a dump by deleting the entry and internal file also will be deleted.
131 - There are system generated dumps based on error log or core dump, which works
132   similar to user-initiated dumps with the following difference.
133 - No external create D-Bus interface is needed, but a monitor application will
136 - Once the event occurred, the monitor will call an internal D-Bus interface
138 - The dump manager calls dreport with a dump type got from the monitor and write
141 ### Updates proposed to the existing phosphor-debug-collector
143 - External D-Bus interface needs to specify the type of the dump since a user
145 - Create will be returning an id which can be mapped to the actual dump once it
147 - A Notify interface is provided for notifying the creation of a dump outside
149 - The InitiateOffload function will be implemented to download the dump.
150 - Status of the dump, whether offloaded or not, will be added to the dump entry.
154 - Dump Manager DBus object provides interfaces for creating and managing dump
156 - Interfaces
157   - **Create**: The interface to create a dump, called by clients to initiate
158     user-initiated dump.
159     - AdditionalData: The additional data, if any, for initiating the dump. The
162       either a string or a 64 bit number. The enum-format string is required to
169   - **Notify**: Notify the dump manager that a new dump is created.
170     - ID: ID of the dump, if not 0 this will be the external id of the dump
171     - Type: Type of dump that was created.
172     - Size: Size of the dump
176     -  **InitiateOffload**: Initiate the offload of the dump.
177         - OffloadUri: The URI where the dump should be offloaded.
183 - ID: Id of the dump
184 - Timestamp: Dump creation timestamp
185 - Size: Total size of the dump
186 - OffloadComplete: Set to true when offload is completed
187 - OffloadURI: The URI for offloading the dump, set while initiating the offload.
195 - No Additional properties
199 - External Source ID: ID provided by the Host, this id will be used for all
207 - Create: Initiate methods to create the dump in Host.
208 - Generating the dump in Host
209 - Host notifies the creation of dump through PLDM to BMC.
210 - PLDM call Notify to create the dump entry
211 - InitiateOffload: Dump manager request Host to start offload
212 - The Host sends the dump through PLDM, and PLDM on BMC sends it out.
216 - Offloading Host dumps through Host instead of BMC, but considered BMC option
217   due to following reasons - The BMC is considered the "management path" of most
219   offload location. - BMC provides one common point for all dumps generated in
224 - The existing BMC dump interface needs to be re-used. The current interface is
227 - Modifying the BMC dump infrastructure to support additional dumps.
228 - openpower-proc-control will be updated to call memory preserving chip-ops and
230 - Additional system state to indicate the system is collecting debug data While
235 - Unit tests to make sure the dump manager interfaces are working.
236 - Following integration tests will be executed to make sure the dump manager is
237   working as expected. - Test creating host dumps and offloading it. - Test
238   deleting host dumps - Create/List/Offload/Delete BMC dumps to make sure
240 - Automated tests for dump Create/List/Offload/Delete to avoid regression.