Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report crashed firmware version in crash report #367

Merged
merged 1 commit into from
Feb 2, 2025
Merged

Report crashed firmware version in crash report #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions main/kernel/CrashManager.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,43 @@

#include <ArduinoJson.h>

#include <kernel/NvsStore.hpp>
#include <kernel/Strings.hpp>

namespace farmhub::kernel {

class CrashManager {
public:
static void reportPreviousCrashIfAny(JsonObject& json) {
static void handleCrashReport(JsonObject& json) {
NvsStore nvs("crash-report");
reportPreviousCrashIfAny(json, nvs);
nvs.set("version", farmhubVersion);
}

private:
static void reportPreviousCrashIfAny(JsonObject& json, NvsStore& nvs) {
if (!hasCoreDump()) {
return;
}

std::string crashedFirmwareVersion;
if (!nvs.get<std::string>("version", crashedFirmwareVersion)) {
crashedFirmwareVersion = "unknown";
}

esp_core_dump_summary_t summary {};
esp_err_t err = esp_core_dump_get_summary(&summary);
if (err != ESP_OK) {
LOGE("Failed to get core dump summary: %s", esp_err_to_name(err));
} else {
auto crashJson = json["crash"].to<JsonObject>();
crashJson["firmware-version"] = crashedFirmwareVersion;
reportPreviousCrash(crashJson, summary);
}

ESP_ERROR_CHECK_WITHOUT_ABORT(esp_core_dump_image_erase());
}

private:
static bool hasCoreDump() {
esp_err_t err = esp_core_dump_image_check();
switch (err) {
Expand Down Expand Up @@ -58,8 +71,8 @@ class CrashManager {
LOGW("Core dump found: task: %s, cause: %ld",
summary.exc_task, excCause);

json["version"] = summary.core_dump_version;
json["sha256"] = std::string((const char*) summary.app_elf_sha256);
json["dump-version"] = summary.core_dump_version;
json["elf-sha256"] = std::string((const char*) summary.app_elf_sha256);
json["task"] = std::string(summary.exc_task);
json["cause"] = excCause;

Expand Down
2 changes: 1 addition & 1 deletion main/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ extern "C" void app_main() {
json["peripherals"].to<JsonArray>().set(peripheralsInitJson);
json["sleepWhenIdle"] = powerManager->sleepWhenIdle;

CrashManager::reportPreviousCrashIfAny(json);
CrashManager::handleCrashReport(json);
},
Retention::NoRetain, QoS::AtLeastOnce, 5s);

Expand Down
Loading