OK, likely I should have split this commit in many more, to ease reviews and improve bisectability. But since I didn't, I'll at least try to summarize here what was changed by this big commit, starting with the more complex additions to the trivial ones: - Added a log submission system; for now, it doesn't submit logs to anywhere since we don't have such API well-defined. But it saves the logs locally in a tar.zst, using timestamps to define the moment of log collection and clears the old files. The naming of the log compressed tarball makes use of the Deck serial number and Steam most recent logged account (thanks @TonyP for that idea). - Still on the log submission topic: we try first pstore logs, and if we have none of them, we check kdump logs. In case we have a vmcore, we save it locally (after renaming), but for now we consider that this kind of file won't be submitted. - Since we now have makedumpfile in Holo (thanks @xexaxo), I've removed this binary from here and made this package dependent on makedumpfile. Also, adjusted the respective scripts. - Added some error messages through logger, in case we fail to load pstore/kdump or fail in the log submission script. - Changed systemd service to just do the pstore/kdump loading and call the submit_report.sh script, which is then "disowned" in order we finish as fast as possible the systemd service; boot delays due to this service wouldn't be nice. - Increased the "crashkernel" memory recommended in the documentation, since I've noticed the most recent version of the kernel requires a bit more - let's play safe! - Changed timestamps to use UTC tz - this is due kdump collection happening so early, that timezone is not set, so let's stick with UTC in all cases. - Checked scripts with shellcheck[0] and improved the README. [0] Accepted most suggestions, but some are polemic, and may introduce issues, so the scripts are not fully passing shellcheck and I don't expect them to be in the future, it's just a minor style improvement and failsafe for multiple shells. Signed-off-by: Guilherme G. Piccoli <gpiccoli@igalia.com>
41 lines
1.5 KiB
Bash
41 lines
1.5 KiB
Bash
#!/bin/sh
|
|
#
|
|
# SPDX-License-Identifier: LGPL-2.1+
|
|
#
|
|
# Copyright (c) 2021 Valve
|
|
#
|
|
# Configuration settings for SteamOS kdump. After _any_ change in this
|
|
# file, it's required to create the kdump minimal initramfs by running:
|
|
# /usr/lib/kdump/kdump_load.sh initrd
|
|
#
|
|
|
|
# Mount-related options - the DEVNODE must exist and be available during the
|
|
# kdump script execution. The KDUMP_FOLDER will be create if doesn't exist.
|
|
# The KDUMP_MNT is just a temporary file that will carry the mounted folder
|
|
# path across boot-time scripts.
|
|
|
|
MOUNT_DEVNODE="nvme0n1p8"
|
|
KDUMP_FOLDER="/.steamos/offload/var/kdump"
|
|
KDUMP_MNT="/tmp/kdump.mnt"
|
|
|
|
# Dump controlling settings - for now we don't have network/iscsi dumps, only
|
|
# local storage dumps. If FULL_COREDUMP is !=0, we collect a full compressed
|
|
# vmcore, which might require a lot of disk space. The *_CMD settings refer
|
|
# to tunnings on makedumpfile - we rely on zstd compression and maximum page
|
|
# exclusion for the full vmcore, mimic'ing Debian kdump.
|
|
|
|
FULL_COREDUMP=0
|
|
MAKEDUMPFILE_COREDUMP_CMD="-z -d 31"
|
|
MAKEDUMPFILE_DMESG_CMD="--dump-dmesg"
|
|
|
|
# Pstore-RAM setting - if enabled, Kdump won't be loaded, instead the Pstore
|
|
# RAM backend will be configured. In order to have success, this operation
|
|
# relies in having an available RAM buffer on /proc/iomem with at least 5MiB
|
|
# in size.
|
|
USE_PSTORE_RAM=1
|
|
|
|
# This is a log submission setting, based on Steam config files, and
|
|
# *should not* be changed, or else the log sending mechanism will be
|
|
# impaired.
|
|
LOGINVDF="/home/doorstop/.local/share/Steam/config/loginusers.vdf"
|