From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A3905C4332F for ; Wed, 13 Dec 2023 10:13:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:List-Subscribe:List-Help: List-Post:List-Archive:List-Unsubscribe:List-Id:Message-ID:Date:Subject:Cc:To :From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=aEDBoMQmoTtZUGIWpS7LTsfKjtdTHb3LGs9GceXbLrQ=; b=Op1tZLzSaqldP+ 4r5XkB0wDhIdufLGJk5XFkIgVcZBdD4t0ABRUB53tm1HGZgqbOU0Hp2oAepgTnW9LA/0Ejxzwqj22 CpY8f9iZI2HviPCdrxwSKXqMtw3nJ4cOVRSzYQusnaQAeInTwta9mPz8I2SnqGYkYQu0i34hUqLKG KZuVN/9zoZeJp8IQUJeN3Ct3730HC4R+54GbT4x8LqFjmmHw/DJsiJZC+8fUYRq1k8Z/vZe0BrtWS Cej7tSweazSW/EB8dljz4Leiw0ueVPYvRm0efil6YLhjnbE2aMQ+9373J+YJV88luXg54MNG6WKD7 +hk0wlQUl1XLh7cJvagg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1rDMFR-00EDkx-2L; Wed, 13 Dec 2023 10:13:49 +0000 Received: from mail-io1-xd64.google.com ([2607:f8b0:4864:20::d64]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1rDMFN-00EDkQ-15 for kexec@lists.infradead.org; Wed, 13 Dec 2023 10:13:47 +0000 Received: by mail-io1-xd64.google.com with SMTP id ca18e2360f4ac-7b7282c8941so182629739f.3 for ; Wed, 13 Dec 2023 02:13:42 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1702462422; x=1703067222; h=content-transfer-encoding:message-id:date:subject:cc:to:from :dkim-signature:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=mfHO7/DdmjzYYBTMj3UnheV4NSJDAvB7m+4EE8eUvPg=; b=eWrz9KSXNdl0ABWF4mQWc20er5PrCZlnyUtUYIJOGvjrZq0YxIBruO4Gxi6JDIo1QS 6U27eETTbV9CPb5o2koJucpPRx+MX0/c5yzCx7Qxss363KFcJc+zHpB+fdRPncaSeF93 DMa172AlsNF+NBkeySwFwsCe7si0lbW36/yDAg6YoyDsMYeT6IOxm8PRgT4lmcGfJBXw mJ5HTFssDtCWzZ+pmYqSJykZlWfmI7OTO8nZabSymfh0sv2MnUa15Et3JVnNVybFtwB0 rkFl8h/XYFgEngM8h24M3d4/Txo3rXVblPMajQ4xbi30KcNcSgcL9JZDN+gXWwlqKzGw nhPw== X-Gm-Message-State: AOJu0YwDemYw8ZVYEMekuDzd99XudjTBuZa/w+7+YZyVpOe0IL8SciwG ThEd+bTeZcnVe2sXk/5dRPbSyuMcoyOTT1rcNxbDCIIfQOJBkiGQIGFw X-Google-Smtp-Source: AGHT+IEbMrc6W2YIKGlWLXH3AkCA0cyuWSnbenuIXPz/XkIF0FQZbyi1vybfGRZQHYRFaFwKIXiVwwJbzMms X-Received: by 2002:a92:c563:0:b0:35d:39eb:d367 with SMTP id b3-20020a92c563000000b0035d39ebd367mr12695241ilj.7.1702462422224; Wed, 13 Dec 2023 02:13:42 -0800 (PST) Received: from smtp.aristanetworks.com ([74.123.28.25]) by smtp-relay.gmail.com with ESMTPS id o3-20020a92c683000000b0035f72e8362dsm39990ilg.27.2023.12.13.02.13.42 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 13 Dec 2023 02:13:42 -0800 (PST) X-Relaying-Domain: arista.com Received: from us113.sjc.aristanetworks.com (us113.sjc.aristanetworks.com [10.242.240.8]) by smtp.aristanetworks.com (Postfix) with ESMTP id 6CEBE4136D7; Wed, 13 Dec 2023 02:13:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=arista.com; s=Arista-A; t=1702462421; bh=mfHO7/DdmjzYYBTMj3UnheV4NSJDAvB7m+4EE8eUvPg=; h=From:To:Cc:Subject:Date:From; b=izBALzlhAGKVuumqp4LDMSkcSQIIm8n/dgXWku2NoVPwdlETo5cEFQUEGUMSrCfPP kz/4U0Lac+fzSD93KwSf5Fz4IhDZVVMTgga4nNFrXiVSUhT0tuHQmagu1rlHKOZ85O h+a2dSXl6Qt9cp12fgjj8hwqWwHg/E5gzk2IlwqK0qgOxaxSRkq8T2n9UkcOUfrqUG vxN5Gnzgx8rsOQwXojViLsjkVurdd+ImUxACkAA50OMsnFw6Az+KnxDQhrQhKMKBhF 5vYzraJU91f6Y7EXDQ2PJf75tOI5ZQQRO7+aQCsd7D8khRL4xn4BxVA0COtUOuchsL 718sB4CaXw4yQ== Received: by us113.sjc.aristanetworks.com (Postfix, from userid 10383) id 5C3DFB840A25; Wed, 13 Dec 2023 02:13:41 -0800 (PST) From: Edward Chron To: kexec@lists.infradead.org Cc: k-hagio-ab@nec.com, colona@arista.com, echron@arista.com Subject: [PATCH] makedumpfile add dmesg PRINTK_CALLER id support Date: Wed, 13 Dec 2023 02:13:34 -0800 Message-ID: <20231213101334.25072-1-echron@arista.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20231213_021345_518760_89ED1671 X-CRM114-Status: GOOD ( 29.78 ) X-BeenThere: kexec@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "kexec" Errors-To: kexec-bounces+kexec=archiver.kernel.org@lists.infradead.org Submission to Project: makedumpfile Component: dmesg Files: printk.c makedumpfile.c makedumpfile.h Code level patch applied against: 1.7.4++ - latest code pulled from https://github.com/makedumpfile/makedumpfile makedumpfile Issue #13 https://github.com/makedumpfile/makedumpfile/issues/13 Add support so that dmesg entries include the optional Linux Kernel debug CONFIG option PRINTK_CALLER which adds an optional dmesg field that contains the Thread Id or CPU Id that is issuing the printk to add the message to the kernel ring buffer. If enabled, this CONFIG option makes debugging simpler as dmesg entries for a specific thread or CPU can be recognized. The dmesg command supports printing the PRINTK_CALLER field. The old syslog format (dmesg -S) and recently support was added for dmesg using /dev/kmsg interface. The additional field provided by PRINTK_CALLER is only present if it was configured for the Linux kernel on the running system. The PRINTK_CALLER is a debug option and not configured by default so the dmesg output will only change for those kernels where the option was configured when the kernel was built. For users who went to the trouble to configure PRINTK_CALLER and have the extra field available for debugging, having dmesg print the field is very helpful and so it would be very useful to add makedumpfile support for it. Size of the PRINTK_CALLER field is determined by the maximum number tasks that can be run on the system which is limited by the value of /proc/sys/kernel/pid_max as pid values are from 0 to value - 1. This value determines the number of id digits needed by the caller id. The PRINTK_CALLER field is printed as T for a Task Id or C for a CPU Id for a printk in CPU context. The values are left space padded and enclosed in parentheses such as: [ T123] or [ C16] For dmesg command the PRINTK_CALLER field when present is the last field before the dmesg text so it makes sense to use the same format. Signed-off-by: Ivan Delalande Signed-off-by: Edward Chron --- makedumpfile.c | 35 ++++++++++++++++++++++++++++++++++- makedumpfile.h | 22 ++++++++++++++++++++++ printk.c | 29 ++++++++++++++++++++++++++++- 3 files changed, 84 insertions(+), 2 deletions(-) diff --git a/makedumpfile.c b/makedumpfile.c index a6ec9d4..5172ee2 100644 --- a/makedumpfile.c +++ b/makedumpfile.c @@ -2118,6 +2118,7 @@ module_end: SIZE_INIT(printk_info, "printk_info"); OFFSET_INIT(printk_info.ts_nsec, "printk_info", "ts_nsec"); OFFSET_INIT(printk_info.text_len, "printk_info", "text_len"); + OFFSET_INIT(printk_info.caller_id, "printk_info", "caller_id"); OFFSET_INIT(atomic_long_t.counter, "atomic_long_t", "counter"); @@ -2133,6 +2134,7 @@ module_end: OFFSET_INIT(printk_log.ts_nsec, "printk_log", "ts_nsec"); OFFSET_INIT(printk_log.len, "printk_log", "len"); OFFSET_INIT(printk_log.text_len, "printk_log", "text_len"); + OFFSET_INIT(printk_info.caller_id, "printk_log", "caller_id"); } else { info->flag_use_printk_ringbuffer = FALSE; info->flag_use_printk_log = FALSE; @@ -2462,6 +2464,7 @@ write_vmcoreinfo_data(void) WRITE_MEMBER_OFFSET("printk_info.ts_nsec", printk_info.ts_nsec); WRITE_MEMBER_OFFSET("printk_info.text_len", printk_info.text_len); + WRITE_MEMBER_OFFSET("printk_info.caller_id", printk_info.caller_id); WRITE_MEMBER_OFFSET("atomic_long_t.counter", atomic_long_t.counter); @@ -2470,6 +2473,7 @@ write_vmcoreinfo_data(void) WRITE_MEMBER_OFFSET("printk_log.ts_nsec", printk_log.ts_nsec); WRITE_MEMBER_OFFSET("printk_log.len", printk_log.len); WRITE_MEMBER_OFFSET("printk_log.text_len", printk_log.text_len); + WRITE_MEMBER_OFFSET("printk_log.caller_id", printk_log.caller_id); } else { /* Compatibility with pre-3.11-rc4 */ WRITE_MEMBER_OFFSET("log.ts_nsec", printk_log.ts_nsec); @@ -2921,6 +2925,7 @@ read_vmcoreinfo(void) READ_STRUCTURE_SIZE("printk_info", printk_info); READ_MEMBER_OFFSET("printk_info.ts_nsec", printk_info.ts_nsec); READ_MEMBER_OFFSET("printk_info.text_len", printk_info.text_len); + READ_MEMBER_OFFSET("printk_info.caller_id", printk_info.caller_id); READ_MEMBER_OFFSET("atomic_long_t.counter", atomic_long_t.counter); @@ -2932,6 +2937,7 @@ read_vmcoreinfo(void) READ_MEMBER_OFFSET("printk_log.ts_nsec", printk_log.ts_nsec); READ_MEMBER_OFFSET("printk_log.len", printk_log.len); READ_MEMBER_OFFSET("printk_log.text_len", printk_log.text_len); + READ_MEMBER_OFFSET("printk_log.caller_id", printk_log.caller_id); } else { info->flag_use_printk_ringbuffer = FALSE; info->flag_use_printk_log = FALSE; @@ -5603,7 +5609,34 @@ dump_log_entry(char *logptr, int fp, const char *file_name) msg = logptr + SIZE(printk_log); bufp = buf; - bufp += sprintf(buf, "[%5lld.%06ld] ", nanos, rem/1000); + bufp += sprintf(buf, "[%5lld.%06ld]", nanos, rem/1000); + + if (OFFSET(printk_log.caller_id) > 0) { + ssize_t numspaces; + unsigned int pkc; + char idtype; + int digits; + + /* Get id type, isolate id value in pkc for print */ + pkc = UINT(logptr + OFFSET(printk_log.caller_id)); + idtype = (pkc & 0x80000000) ? 'C' : 'T'; + pkc &= ~0x80000000; + /* Determine size of padding space if needed */ + digits = snprintf(NULL, 0, "%u", pkc); + numspaces = CALLER_ID_SIZE - digits; + if (numspaces > 0) { + char spc[16]; + + memset(spc, 0, sizeof(spc)); + memset(spc, ' ', numspaces); + bufp += sprintf(bufp, "[%s%c%u] ", spc, idtype, pkc); + } else { + bufp += sprintf(bufp, "[%c%u] ", idtype, pkc); + } + } else { + bufp = stpcpy(bufp, " "); + } + indent_len = strlen(buf); /* How much buffer space is needed in the worst case */ diff --git a/makedumpfile.h b/makedumpfile.h index f1619c5..0a7acb5 100644 --- a/makedumpfile.h +++ b/makedumpfile.h @@ -2116,10 +2116,16 @@ struct offset_table { long p_memsz; } elf64_phdr; + /* The caller_id was added by the Linux-5.1 Kernel to hold + * the Thread id or CPU id of the caller adding a printk + * dmesg to the ring buffer. As such older versions of the + * kernel can ignore this field as it won't be filled in. + */ struct printk_log_s { long ts_nsec; long len; long text_len; + long caller_id; } printk_log; /* @@ -2671,6 +2677,22 @@ struct elf_prstatus { #endif +/* + * Minimum size of the id portion of the PRINTK_CALLER dmesg field if it is + * configured in the Linux Kernel. The size is used to pad with spaces the + * PRINTK_CALLER field in each dmesg. For 32 bit kernels the maximum number + * of PIDs supported was 2^15 so pid values 0 to 32,767 while 64 bit systems + * support the value specified in /proc/sys/kernel/pid_max which is capped at + * PID_MAX_LIMIT. We can use 7 digits as that accomodates both 32 bit and + * current 64 bit systems as PID_MAX_LIMIT is currently 2^22 so that will + * fit in 7 digits and the id will add an additional byte for the id type of + * either thread 'T' or CPU 'C', where the Thread ids will have much larger + * values, so the CPU ids will easily be accomodated. When systems exceed + * 7 digits that won't break anything, but print statements needing more + * then 7 digits will not precisely align. + */ +#define CALLER_ID_SIZE 7 + /* * Below are options which getopt_long can recognize. From OPT_START options are * non-printable, just used for implementation. diff --git a/printk.c b/printk.c index 61e0b26..5ebda45 100644 --- a/printk.c +++ b/printk.c @@ -113,7 +113,34 @@ dump_record(struct prb_map *m, unsigned long id) rem = (ulonglong)ts_nsec % (ulonglong)1000000000; bufp = buf; - bufp += sprintf(buf, "[%5lld.%06ld] ", nanos, rem/1000); + bufp += sprintf(buf, "[%5lld.%06ld]", nanos, rem/1000); + + if (OFFSET(printk_info.caller_id) > 0) { + ssize_t numspaces; + unsigned int pkc; + char idtype; + int digits; + + /* Get id type, isolate id value in pkc for print */ + pkc = UINT(inf + OFFSET(printk_info.caller_id)); + idtype = (pkc & 0x80000000) ? 'C' : 'T'; + pkc &= ~0x80000000; + /* Determine size of padding space if needed */ + digits = snprintf(NULL, 0, "%u", pkc); + numspaces = CALLER_ID_SIZE - digits; + if (numspaces > 0) { + char spc[16]; + + memset(spc, 0, sizeof(spc)); + memset(spc, ' ', numspaces); + bufp += sprintf(bufp, "[%s%c%u] ", spc, idtype, pkc); + } else { + bufp += sprintf(bufp, "[%c%u] ", idtype, pkc); + } + } else { + bufp = stpcpy(bufp, " "); + } + indent_len = strlen(buf); /* How much buffer space is needed in the worst case */ -- 2.43.0 _______________________________________________ kexec mailing list kexec@lists.infradead.org http://lists.infradead.org/mailman/listinfo/kexec