soc/apple/rtkit-crashlog.c

0001 // SPDX-License-Identifier: GPL-2.0-only OR MIT
0002 /*
0003  * Apple RTKit IPC library
0004  * Copyright (C) The Asahi Linux Contributors
0005  */
0006 #include "rtkit-internal.h"
0007
0008 #define FOURCC(a, b, c, d) \
0009     (((u32)(a) << 24) | ((u32)(b) << 16) | ((u32)(c) << 8) | ((u32)(d)))
0010
0011 #define APPLE_RTKIT_CRASHLOG_HEADER FOURCC('C', 'L', 'H', 'E')
0012 #define APPLE_RTKIT_CRASHLOG_STR FOURCC('C', 's', 't', 'r')
0013 #define APPLE_RTKIT_CRASHLOG_VERSION FOURCC('C', 'v', 'e', 'r')
0014 #define APPLE_RTKIT_CRASHLOG_MBOX FOURCC('C', 'm', 'b', 'x')
0015 #define APPLE_RTKIT_CRASHLOG_TIME FOURCC('C', 't', 'i', 'm')
0016
0017 struct apple_rtkit_crashlog_header {
0018     u32 fourcc;
0019     u32 version;
0020     u32 size;
0021     u32 flags;
0022     u8 _unk[16];
0023 };
0024 static_assert(sizeof(struct apple_rtkit_crashlog_header) == 0x20);
0025
0026 struct apple_rtkit_crashlog_mbox_entry {
0027     u64 msg0;
0028     u64 msg1;
0029     u32 timestamp;
0030     u8 _unk[4];
0031 };
0032 static_assert(sizeof(struct apple_rtkit_crashlog_mbox_entry) == 0x18);
0033
0034 static void apple_rtkit_crashlog_dump_str(struct apple_rtkit *rtk, u8 *bfr,
0035                       size_t size)
0036 {
0037     u32 idx;
0038     u8 *ptr, *end;
0039
0040     memcpy(&idx, bfr, 4);
0041
0042     ptr = bfr + 4;
0043     end = bfr + size;
0044     while (ptr < end) {
0045         u8 *newline = memchr(ptr, '\n', end - ptr);
0046
0047         if (newline) {
0048             u8 tmp = *newline;
0049             *newline = '\0';
0050             dev_warn(rtk->dev, "RTKit: Message (id=%x): %s\n", idx,
0051                  ptr);
0052             *newline = tmp;
0053             ptr = newline + 1;
0054         } else {
0055             dev_warn(rtk->dev, "RTKit: Message (id=%x): %s", idx,
0056                  ptr);
0057             break;
0058         }
0059     }
0060 }
0061
0062 static void apple_rtkit_crashlog_dump_version(struct apple_rtkit *rtk, u8 *bfr,
0063                           size_t size)
0064 {
0065     dev_warn(rtk->dev, "RTKit: Version: %s", bfr + 16);
0066 }
0067
0068 static void apple_rtkit_crashlog_dump_time(struct apple_rtkit *rtk, u8 *bfr,
0069                        size_t size)
0070 {
0071     u64 crash_time;
0072
0073     memcpy(&crash_time, bfr, 8);
0074     dev_warn(rtk->dev, "RTKit: Crash time: %lld", crash_time);
0075 }
0076
0077 static void apple_rtkit_crashlog_dump_mailbox(struct apple_rtkit *rtk, u8 *bfr,
0078                           size_t size)
0079 {
0080     u32 type, index, i;
0081     size_t n_messages;
0082     struct apple_rtkit_crashlog_mbox_entry entry;
0083
0084     memcpy(&type, bfr + 16, 4);
0085     memcpy(&index, bfr + 24, 4);
0086     n_messages = (size - 28) / sizeof(entry);
0087
0088     dev_warn(rtk->dev, "RTKit: Mailbox history (type = %d, index = %d)",
0089          type, index);
0090     for (i = 0; i < n_messages; ++i) {
0091         memcpy(&entry, bfr + 28 + i * sizeof(entry), sizeof(entry));
0092         dev_warn(rtk->dev, "RTKit:  #%03d@%08x: %016llx %016llx", i,
0093              entry.timestamp, entry.msg0, entry.msg1);
0094     }
0095 }
0096
0097 void apple_rtkit_crashlog_dump(struct apple_rtkit *rtk, u8 *bfr, size_t size)
0098 {
0099     size_t offset;
0100     u32 section_fourcc, section_size;
0101     struct apple_rtkit_crashlog_header header;
0102
0103     memcpy(&header, bfr, sizeof(header));
0104     if (header.fourcc != APPLE_RTKIT_CRASHLOG_HEADER) {
0105         dev_warn(rtk->dev, "RTKit: Expected crashlog header but got %x",
0106              header.fourcc);
0107         return;
0108     }
0109
0110     if (header.size > size) {
0111         dev_warn(rtk->dev, "RTKit: Crashlog size (%x) is too large",
0112              header.size);
0113         return;
0114     }
0115
0116     size = header.size;
0117     offset = sizeof(header);
0118
0119     while (offset < size) {
0120         memcpy(&section_fourcc, bfr + offset, 4);
0121         memcpy(&section_size, bfr + offset + 12, 4);
0122
0123         switch (section_fourcc) {
0124         case APPLE_RTKIT_CRASHLOG_HEADER:
0125             dev_dbg(rtk->dev, "RTKit: End of crashlog reached");
0126             return;
0127         case APPLE_RTKIT_CRASHLOG_STR:
0128             apple_rtkit_crashlog_dump_str(rtk, bfr + offset + 16,
0129                               section_size);
0130             break;
0131         case APPLE_RTKIT_CRASHLOG_VERSION:
0132             apple_rtkit_crashlog_dump_version(
0133                 rtk, bfr + offset + 16, section_size);
0134             break;
0135         case APPLE_RTKIT_CRASHLOG_MBOX:
0136             apple_rtkit_crashlog_dump_mailbox(
0137                 rtk, bfr + offset + 16, section_size);
0138             break;
0139         case APPLE_RTKIT_CRASHLOG_TIME:
0140             apple_rtkit_crashlog_dump_time(rtk, bfr + offset + 16,
0141                                section_size);
0142             break;
0143         default:
0144             dev_warn(rtk->dev,
0145                  "RTKit: Unknown crashlog section: %x",
0146                  section_fourcc);
0147         }
0148
0149         offset += section_size;
0150     }
0151
0152     dev_warn(rtk->dev,
0153          "RTKit: End of crashlog reached but no footer present");
0154 }