debug-trigger: Do what we can to debug unresponsive systems
debug-trigger is a small daemon which translates an external signal that
the system is unresponsive into a system crash for debug data
collection.
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Ic04f1a95aaf651d56b75f5261d8a6f76d34477a7
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8dada3e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/MAINTAINERS b/MAINTAINERS
new file mode 100644
index 0000000..44a84f8
--- /dev/null
+++ b/MAINTAINERS
@@ -0,0 +1,45 @@
+How to use this list:
+ Find the most specific section entry (described below) that matches where
+ your change lives and add the reviewers (R) and maintainers (M) as
+ reviewers. You can use the same method to track down who knows a particular
+ code base best.
+
+ Your change/query may span multiple entries; that is okay.
+
+ If you do not find an entry that describes your request at all, someone
+ forgot to update this list; please at least file an issue or send an email
+ to a maintainer, but preferably you should just update this document.
+
+Description of section entries:
+
+ Section entries are structured according to the following scheme:
+
+ X: NAME <EMAIL_USERNAME@DOMAIN> <DISCORD_USERNAME!>
+ X: ...
+ .
+ .
+ .
+
+ Where REPO_NAME is the name of the repository within the OpenBMC GitHub
+ organization; FILE_PATH is a file path within the repository, possibly with
+ wildcards; X is a tag of one of the following types:
+
+ M: Denotes maintainer; has fields NAME <EMAIL_USERNAME@DOMAIN> <DISCORD_USERNAME!>;
+ if omitted from an entry, assume one of the maintainers from the
+ MAINTAINERS entry.
+ R: Denotes reviewer; has fields NAME <EMAIL_USERNAME@DOMAIN> <DISCORD_USERNAME!>;
+ these people are to be added as reviewers for a change matching the repo
+ path.
+ F: Denotes forked from an external repository; has fields URL.
+
+ Line comments are to be denoted "# SOME COMMENT" (typical shell style
+ comment); it is important to follow the correct syntax and semantics as we
+ may want to use automated tools with this file in the future.
+
+ A change cannot be added to an OpenBMC repository without a MAINTAINER's
+ approval; thus, a MAINTAINER should always be listed as a reviewer.
+
+START OF MAINTAINERS LIST
+-------------------------
+
+M: Andrew Jeffery <andrew@aj.id.au> <arj!>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d5d38c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# BMC Debug Trigger #
+
+`debug-trigger` listens for an external signal that the BMC is in some way
+unresponsive. When the signal is received it triggers a crash to collect debug
+data and reboots the system in the hope that it will recover.
+
+## Trigger sources ##
+
+`debug-trigger` implements a simple protocol over an LPC KCS device as its
+trigger source.
+
+## Debug actions ##
+
+`debug-trigger` implements a single action once the trigger event is received,
+which is to crash the kernel via `/proc/sysrq-trigger`. For systems with kdump
+configured this results in collection of system state as context for why the
+system was externally unresponsive.
diff --git a/main.c b/main.c
new file mode 100644
index 0000000..d55b706
--- /dev/null
+++ b/main.c
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2021 IBM Corp.
+
+#include <err.h>
+#include <fcntl.h>
+#include <getopt.h>
+#include <libgen.h>
+#include <limits.h>
+#include <linux/reboot.h>
+#include <stdlib.h>
+#include <string.h>
+#include <sys/reboot.h>
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+static int process(int source, int sink)
+{
+ ssize_t ingress;
+ char command;
+
+ while ((ingress = read(source, &command, sizeof(command))) == sizeof(command)) {
+ static const char action = 'c';
+ ssize_t rc;
+
+ switch (command) {
+ case 'D': /* Debug */
+ sync();
+
+ if ((rc = write(sink, &action, sizeof(action))) == sizeof(action))
+ continue;
+
+ if (rc == -1) {
+ warn("Failed to execute command 0x%02x (%c)",
+ command, command);
+ } else {
+ warnx("Failed to execute command 0x%02x (%c): %zd",
+ command, command, rc);
+ }
+ break;
+ case 'R':
+ sync();
+
+ if ((rc = reboot(LINUX_REBOOT_CMD_RESTART))) {
+ if (rc == -1)
+ warn("Failed to reboot BMC");
+ else
+ warnx("Failed to reboot BMC: %zd", rc);
+ }
+ break;
+ default:
+ warnx("Unexpected command: 0x%02x (%c)", command, command);
+ }
+ }
+
+ if (ingress == -1)
+ warn("Failed to read from source");
+
+ return ingress;
+}
+
+int main(int argc, char * const argv[])
+{
+ char devnode[PATH_MAX];
+ char *devid;
+ int source;
+ int sink;
+
+ while (1) {
+ static struct option long_options[] = {
+ {0, 0, 0, 0},
+ };
+ int c;
+
+ c = getopt_long(argc, argv, "", long_options, NULL);
+ if (c == -1)
+ break;
+ }
+
+ source = 0;
+ sink = 1;
+
+ if (optind < argc) {
+ char devpath[PATH_MAX];
+
+ strncpy(devpath, argv[optind], sizeof(devpath));
+ devpath[PATH_MAX - 1] = '\0';
+ devid = basename(devpath);
+
+ strncpy(devnode, "/dev/", sizeof(devnode));
+ strncat(devnode, devid, sizeof(devnode));
+ devnode[PATH_MAX - 1] = '\0';
+
+ if ((source = open(devnode, O_RDONLY)) == -1)
+ err(EXIT_FAILURE, "Failed to open %s", devnode);
+
+ optind++;
+ }
+
+ if (optind < argc) {
+ if ((sink = open(argv[optind], O_WRONLY)) == -1)
+ err(EXIT_FAILURE, "Failed to open %s", argv[optind]);
+
+ optind++;
+ }
+
+ if (optind < argc)
+ err(EXIT_FAILURE, "Found %d unexpected arguments", argc - optind);
+
+ if (process(source, sink) < 0)
+ errx(EXIT_FAILURE, "Failure while processing command stream");
+
+ return 0;
+}
diff --git a/meson.build b/meson.build
new file mode 100644
index 0000000..e60bd8b
--- /dev/null
+++ b/meson.build
@@ -0,0 +1,29 @@
+project('debug-trigger', 'c', license: 'Apache-2.0', version: '0.1')
+executable('debug-trigger', 'main.c', install: true)
+
+if get_option('systemd')
+ systemd = dependency('systemd')
+ unitdir = systemd.get_pkgconfig_variable('systemdsystemunitdir')
+ configure_file(input: 'systemd/system/debug-trigger@.service',
+ output: 'debug-trigger@.service',
+ copy: true,
+ install_dir: unitdir)
+endif
+
+udev = dependency('udev')
+udevdir = udev.get_pkgconfig_variable('udevdir')
+udevrules = [
+ 'p10bmc-debug-trigger-kcs1',
+ 'p10bmc-debug-trigger-kcs2',
+ 'p10bmc-debug-trigger-kcs3',
+ 'p10bmc-debug-trigger-kcs4',
+]
+
+foreach rule : udevrules
+ if get_option(rule)
+ src = 'udev/rules.d/' + rule + '.rules'
+ dst = rule + '.rules'
+ rulesdir = udevdir + '/rules.d'
+ configure_file(input: src, output: dst, copy: true, install_dir: rulesdir)
+ endif
+endforeach
diff --git a/meson/arm-linux-gneabi-gcc.ini b/meson/arm-linux-gneabi-gcc.ini
new file mode 100644
index 0000000..d9e733d
--- /dev/null
+++ b/meson/arm-linux-gneabi-gcc.ini
@@ -0,0 +1,9 @@
+[constants]
+arch = 'arm-linux-gnueabi'
+
+[binaries]
+c = arch + '-gcc'
+cpp = arch + '-g++'
+ld = arch + '-ld'
+strip = arch + '-strip'
+pkgconfig = arch + '-pkg-config'
diff --git a/meson/arm-linux-gneabihf-gcc.ini b/meson/arm-linux-gneabihf-gcc.ini
new file mode 100644
index 0000000..a1b4232
--- /dev/null
+++ b/meson/arm-linux-gneabihf-gcc.ini
@@ -0,0 +1,9 @@
+[constants]
+arch = 'arm-linux-gnueabihf'
+
+[binaries]
+c = arch + '-gcc'
+cpp = arch + '-g++'
+ld = arch + '-ld'
+strip = arch + '-strip'
+pkgconfig = arch + '-pkg-config'
diff --git a/meson_options.txt b/meson_options.txt
new file mode 100644
index 0000000..6793077
--- /dev/null
+++ b/meson_options.txt
@@ -0,0 +1,5 @@
+option('systemd', type: 'boolean', value: true)
+option('p10bmc-debug-trigger-kcs1', type: 'boolean', value: false)
+option('p10bmc-debug-trigger-kcs2', type: 'boolean', value: false)
+option('p10bmc-debug-trigger-kcs3', type: 'boolean', value: false)
+option('p10bmc-debug-trigger-kcs4', type: 'boolean', value: false)
diff --git a/systemd/system/debug-trigger@.service b/systemd/system/debug-trigger@.service
new file mode 100644
index 0000000..b9ec40e
--- /dev/null
+++ b/systemd/system/debug-trigger@.service
@@ -0,0 +1,6 @@
+[Unit]
+Description=BMC Debug Trigger
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/debug-trigger /%I /proc/sysrq-trigger
diff --git a/udev/rules.d/p10bmc-debug-trigger-kcs1.rules b/udev/rules.d/p10bmc-debug-trigger-kcs1.rules
new file mode 100644
index 0000000..1a8e89d
--- /dev/null
+++ b/udev/rules.d/p10bmc-debug-trigger-kcs1.rules
@@ -0,0 +1,2 @@
+ACTION=="add", DEVPATH=="*/1e789024.kcs/*", SUBSYSTEM=="serio", RUN{program}+="/bin/sh -c 'echo -n serio_raw > /sys%p/drvctl'"
+ACTION=="add", DEVPATH=="*/1e789024.kcs/*", SUBSYSTEMS=="serio", SUBSYSTEM=="misc", TAG+="systemd", ENV{SYSTEMD_WANTS}+="debug-trigger@"
diff --git a/udev/rules.d/p10bmc-debug-trigger-kcs2.rules b/udev/rules.d/p10bmc-debug-trigger-kcs2.rules
new file mode 100644
index 0000000..b0eedf8
--- /dev/null
+++ b/udev/rules.d/p10bmc-debug-trigger-kcs2.rules
@@ -0,0 +1,2 @@
+ACTION=="add", DEVPATH=="*/1e789028.kcs/*", SUBSYSTEM=="serio", RUN{program}+="/bin/sh -c 'echo -n serio_raw > /sys%p/drvctl'"
+ACTION=="add", DEVPATH=="*/1e789028.kcs/*", SUBSYSTEMS=="serio", SUBSYSTEM=="misc", TAG+="systemd", ENV{SYSTEMD_WANTS}+="debug-trigger@"
diff --git a/udev/rules.d/p10bmc-debug-trigger-kcs3.rules b/udev/rules.d/p10bmc-debug-trigger-kcs3.rules
new file mode 100644
index 0000000..7f203ba
--- /dev/null
+++ b/udev/rules.d/p10bmc-debug-trigger-kcs3.rules
@@ -0,0 +1,2 @@
+ACTION=="add", DEVPATH=="*/1e78902c.kcs/*", SUBSYSTEM=="serio", RUN{program}+="/bin/sh -c 'echo -n serio_raw > /sys%p/drvctl'"
+ACTION=="add", DEVPATH=="*/1e78902c.kcs/*", SUBSYSTEMS=="serio", SUBSYSTEM=="misc", TAG+="systemd", ENV{SYSTEMD_WANTS}+="debug-trigger@"
diff --git a/udev/rules.d/p10bmc-debug-trigger-kcs4.rules b/udev/rules.d/p10bmc-debug-trigger-kcs4.rules
new file mode 100644
index 0000000..248a0dd
--- /dev/null
+++ b/udev/rules.d/p10bmc-debug-trigger-kcs4.rules
@@ -0,0 +1,2 @@
+ACTION=="add", DEVPATH=="*/1e789114.kcs/*", SUBSYSTEM=="serio", RUN{program}+="/bin/sh -c 'echo -n serio_raw > /sys%p/drvctl'"
+ACTION=="add", DEVPATH=="*/1e789114.kcs/*", SUBSYSTEMS=="serio", SUBSYSTEM=="misc", TAG+="systemd", ENV{SYSTEMD_WANTS}+="debug-trigger@"