From patchwork Thu Mar 21 16:36:32 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Suren Baghdasaryan X-Patchwork-Id: 13599168 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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 84065C6FD1F for ; Thu, 21 Mar 2024 16:37:46 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id AC95E6B00A1; Thu, 21 Mar 2024 12:37:38 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id A79786B00A3; Thu, 21 Mar 2024 12:37:38 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6D50F6B00A2; Thu, 21 Mar 2024 12:37:38 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 47CB46B00A1 for ; Thu, 21 Mar 2024 12:37:38 -0400 (EDT) Received: from smtpin11.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 2268E141296 for ; Thu, 21 Mar 2024 16:37:38 +0000 (UTC) X-FDA: 81921602196.11.ECA71A9 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) by imf16.hostedemail.com (Postfix) with ESMTP id BB57418001D for ; Thu, 21 Mar 2024 16:37:32 +0000 (UTC) Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=WGfJJ5uH; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf16.hostedemail.com: domain of 3S2L8ZQYKCDgmolYhVaiiafY.Wigfchor-ggepUWe.ila@flex--surenb.bounces.google.com designates 209.85.128.201 as permitted sender) smtp.mailfrom=3S2L8ZQYKCDgmolYhVaiiafY.Wigfchor-ggepUWe.ila@flex--surenb.bounces.google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1711039052; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=hrfC4K8F/Q+T2mI4qsQQV2fR1wUsQY/g8GL2B+37hNg=; b=IkWgXEacJpuNHrZMFBD35hMFegTS03hA1J8+gPsa1ZPmG/aEpXu/8H/9npJ7PIj/zEETJr 3yraIkN7pthuys8FzoL0nYgBUuKX+zNH8UWF8tzNGFLIvq5W5gHeDjpfagmmERU8NEX5ja COFDnTeIK2JxSIfNAj1YGtQQL7skHQ8= ARC-Authentication-Results: i=1; imf16.hostedemail.com; dkim=pass header.d=google.com header.s=20230601 header.b=WGfJJ5uH; dmarc=pass (policy=reject) header.from=google.com; spf=pass (imf16.hostedemail.com: domain of 3S2L8ZQYKCDgmolYhVaiiafY.Wigfchor-ggepUWe.ila@flex--surenb.bounces.google.com designates 209.85.128.201 as permitted sender) smtp.mailfrom=3S2L8ZQYKCDgmolYhVaiiafY.Wigfchor-ggepUWe.ila@flex--surenb.bounces.google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1711039052; a=rsa-sha256; cv=none; b=DpXfEoZPQthhdqfyVbBjQhXAMTKuf3A6tWaurMcXECnL4Rqdsnkwh20AJiyNjKjOASxvvY M6sRxmCpG3+9zRileXRNEcLMuNnNO4MUgWrRECRuM9F80fNPVyKsBm2k7TyM5WseSrkU1c zsHPxzSla9Sfh0yL7XGIGg5BFemNQ9Q= Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-60ccc3cfa39so16712997b3.2 for ; Thu, 21 Mar 2024 09:37:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1711039052; x=1711643852; darn=kvack.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=hrfC4K8F/Q+T2mI4qsQQV2fR1wUsQY/g8GL2B+37hNg=; b=WGfJJ5uHmHX1LUdRAj35iCrQhEvpIcd+MU0JhS8oAwG16Wl+J6SxrpKs08ylUojGd4 wy/gzYd2mUYPCv9+eGHY1FUE/9+jrvUpYyLJnuAHSaLn1hpM2hctU47vH579uEURCWrP X8wsxwXF5tYPtu0jqnDw2+QcgagK5pYd0kiyE1V+O3WxViRq2e4Inyv8NA24QTcKjIRj 49cQYjrxvQ2k0r9/a2HuDuFCtlaXtdCwh5g3PkH2LtEBgsCwOQGkFqqSItpKSz5le4lU WKFz03MpJKWXaRUpV2IMw3LPoNQehPmMoGFn+EJV/TVKEw8E3M8EPg1B5zxIljR5twBf zC1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711039052; x=1711643852; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=hrfC4K8F/Q+T2mI4qsQQV2fR1wUsQY/g8GL2B+37hNg=; b=hHaOmTLzfaz1AVBSqJN2rFLfqF12pKHqj+OC19YcTtafKI6T9bV5eXE21B+3uAuh2K 7FfJfJ49B5mwKhTsfLEOKm2L6wxHEMyScfGw8JkSSqnAgFN3L5Y93GbKetzr5VXJB/4Y bXbFbFcmXk2DiMh4TSiTvWaK65RI8gQbAjYEk1LYkm1j1A1qX+qh77RpYhIzrOgXZHBm ySLUMTLjPBNMqqIr0YCsgIn1TMUIQwAfI9bgdCA1nfalxSHUGWiNBAxUMUJdDJJPL/39 EF7kvsnAYSvra2bbiu838bqqRZZHAHxCKY8XnbPdq6tXQOPNI7BkBAA/rg4M4GnmNKPo l33w== X-Forwarded-Encrypted: i=1; AJvYcCW/32ffyU7Xq0r8Yeq3qtSYvytQJVpgRL8sBn0SqUnXoLRmU9r/FZ5EuZoIpU2HX7T25kUHVprOxg+36AzuQUAry8M= X-Gm-Message-State: AOJu0Yzc473sj1jF7BTCWcufBoGAeDkWsxNnEiKIxp5tQcZyK27TI3ZO /eief6EfMCS7bKRSjrZbditn178N3rt1+Qv8+LvWw3fbrNzQWYUq7EdF1kwAbrN/X27UnmlXMnt 0Ag== X-Google-Smtp-Source: AGHT+IFpSBGDOLAV/U358k2FNkIx88WUMnUVEq4fGBmj4tsKZJRhDdGZxZQUSD8tkAfYC1BnErXB1YJ5fBs= X-Received: from surenb-desktop.mtv.corp.google.com ([2620:15c:211:201:a489:6433:be5d:e639]) (user=surenb job=sendgmr) by 2002:a0d:ca91:0:b0:610:fc58:5b83 with SMTP id m139-20020a0dca91000000b00610fc585b83mr1060972ywd.8.1711039051683; Thu, 21 Mar 2024 09:37:31 -0700 (PDT) Date: Thu, 21 Mar 2024 09:36:32 -0700 In-Reply-To: <20240321163705.3067592-1-surenb@google.com> Mime-Version: 1.0 References: <20240321163705.3067592-1-surenb@google.com> X-Mailer: git-send-email 2.44.0.291.gc1ea87d7ee-goog Message-ID: <20240321163705.3067592-11-surenb@google.com> Subject: [PATCH v6 10/37] lib: code tagging framework From: Suren Baghdasaryan To: akpm@linux-foundation.org Cc: kent.overstreet@linux.dev, mhocko@suse.com, vbabka@suse.cz, hannes@cmpxchg.org, roman.gushchin@linux.dev, mgorman@suse.de, dave@stgolabs.net, willy@infradead.org, liam.howlett@oracle.com, penguin-kernel@i-love.sakura.ne.jp, corbet@lwn.net, void@manifault.com, peterz@infradead.org, juri.lelli@redhat.com, catalin.marinas@arm.com, will@kernel.org, arnd@arndb.de, tglx@linutronix.de, mingo@redhat.com, dave.hansen@linux.intel.com, x86@kernel.org, peterx@redhat.com, david@redhat.com, axboe@kernel.dk, mcgrof@kernel.org, masahiroy@kernel.org, nathan@kernel.org, dennis@kernel.org, jhubbard@nvidia.com, tj@kernel.org, muchun.song@linux.dev, rppt@kernel.org, paulmck@kernel.org, pasha.tatashin@soleen.com, yosryahmed@google.com, yuzhao@google.com, dhowells@redhat.com, hughd@google.com, andreyknvl@gmail.com, keescook@chromium.org, ndesaulniers@google.com, vvvvvv@google.com, gregkh@linuxfoundation.org, ebiggers@google.com, ytcoode@gmail.com, vincent.guittot@linaro.org, dietmar.eggemann@arm.com, rostedt@goodmis.org, bsegall@google.com, bristot@redhat.com, vschneid@redhat.com, cl@linux.com, penberg@kernel.org, iamjoonsoo.kim@lge.com, 42.hyeyoo@gmail.com, glider@google.com, elver@google.com, dvyukov@google.com, songmuchun@bytedance.com, jbaron@akamai.com, aliceryhl@google.com, rientjes@google.com, minchan@google.com, kaleshsingh@google.com, surenb@google.com, kernel-team@android.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, iommu@lists.linux.dev, linux-arch@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, linux-modules@vger.kernel.org, kasan-dev@googlegroups.com, cgroups@vger.kernel.org X-Rspam-User: X-Stat-Signature: sitf5zzrqce3p7d1w64csjsx777cb6ca X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: BB57418001D X-HE-Tag: 1711039052-205432 X-HE-Meta: U2FsdGVkX1/0bizppJPgxZ2g7gA0ZR7rtaj0q9sA/e9Z/vLIHA4RdUNvdq1i4ytzOq8xpJL+ox/8DVwmmFUTviUs8zJP6Ziu4ozJu7V45phJML6E83M/eCKQLyHnT31YQt5mevnz2ooPLGEgwhzjG8oyKz6Vj+yqglACxGPrq4g0J0BKSXzbroyuJYsVL+w+DUPaKSG1yKJFed9TlbH4+BNSEMT3W/PDjjs5az8VGfamF/TKliMthhPFJYOf5brk6ZqBuUJHFX6053pzeEnU3x4Gx8HHx8GA3HMer7DjWiSorm9RxQGR2mtDnbaxkHfHVDRADbCgT8fnA54a5/7kUGUofzn3MuvL1PmWYxcChd3B9eqddQmnh9LOQ5i5Bn0GpWK/QF4eSpD+AIY16CaQH+i3iJqnOocxE5TujA8/+3FLRxipuE2TvUpyKlJomd194L14n0kBDAji4K4Zi+zQCnRXq54BmUbqfM18M9EGYXKmpImvZ333HdxkfeKzkTHM9+A43vF4/EZxewFwiQ/IFyP6rtw4Gv7qn9bNvikPugw8t9WfxGmL9QWoF1kxLMN/9ZErm6F6HBNS2yyM4J+FlS3t9AiP8OMaUroXKWWX/p8n0bWErZnO5iZ4NxiPZyZCirpoLgw0OGGI7eV2h2gzK4haGNFLquVMVIVkSK5tAIKJ8U8wuu2oA5CTtWLZ1ZNFHx3DJ2LJFkqnT3XR2JuPmpli5uQHSd7En2nsrgrkDer2cxvKmqrY7gBogNweHuDbrVu0iiu4mHnwEpMIXIGIlVyeP1Fxb2cE7oygAP8XHC7BkHsuFKQSB6MJhyPjLhHIoXP4t7Wrm6rlMOELevNSmpSyh1qHDkrLr53sDWQkZNFs26TBulQ494NXeERHLzXr1Q6Ed+Fv/N6OIhSLhngbziWebQVGra6O7TYforj7R1wC/vbGmMM4rIVH+4uaTQca3Y+JwMpkZS4gpnqJW3S x6v29K71 D9YDM8UE68kJc/vlH7CeKATqfvBXHmkt0QCcniAj48hY0oe+6ybR2Hc6BbYhgdfDTmu8O8vFRdYvi+BQadukD8CYIkIemHN79iRSKjoHsh4qb40xduCOV8bC231/r94+ysq/vk4iuVbaHAMZZAmSoUGHtbKgSuQBvvR8fBTu+CUhuQd/BnVmkAhH71mRYhXVS/i1XOGoZwQxj9sKS+HTPvA+pDHq+FptZ6oFnBVeE+QeSbMI5jI8uGoQU846kNtL4Ipca8I43xWfHA1c87td6+hDnx+iHJKH0LOQTQCEXfpaz740jsCzXKAaDGC2v/11GuRN3vCV8wB1dRjDAtoZoXMTF4R4zFNCdCLpSgDXqTQ/AUtju5WaKF1Mh9m7cIlsHvx3IAb2JGeUt2WhXWTHJXHrnl6RyZcAvJoTC X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Add basic infrastructure to support code tagging which stores tag common information consisting of the module name, function, file name and line number. Provide functions to register a new code tag type and navigate between code tags. Co-developed-by: Kent Overstreet Signed-off-by: Kent Overstreet Signed-off-by: Suren Baghdasaryan --- include/linux/codetag.h | 68 +++++++++++++ lib/Kconfig.debug | 4 + lib/Makefile | 1 + lib/codetag.c | 219 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 292 insertions(+) create mode 100644 include/linux/codetag.h create mode 100644 lib/codetag.c diff --git a/include/linux/codetag.h b/include/linux/codetag.h new file mode 100644 index 000000000000..7734269cdb63 --- /dev/null +++ b/include/linux/codetag.h @@ -0,0 +1,68 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * code tagging framework + */ +#ifndef _LINUX_CODETAG_H +#define _LINUX_CODETAG_H + +#include + +struct codetag_iterator; +struct codetag_type; +struct codetag_module; +struct seq_buf; +struct module; + +/* + * An instance of this structure is created in a special ELF section at every + * code location being tagged. At runtime, the special section is treated as + * an array of these. + */ +struct codetag { + unsigned int flags; /* used in later patches */ + unsigned int lineno; + const char *modname; + const char *function; + const char *filename; +} __aligned(8); + +union codetag_ref { + struct codetag *ct; +}; + +struct codetag_type_desc { + const char *section; + size_t tag_size; +}; + +struct codetag_iterator { + struct codetag_type *cttype; + struct codetag_module *cmod; + unsigned long mod_id; + struct codetag *ct; +}; + +#ifdef MODULE +#define CT_MODULE_NAME KBUILD_MODNAME +#else +#define CT_MODULE_NAME NULL +#endif + +#define CODE_TAG_INIT { \ + .modname = CT_MODULE_NAME, \ + .function = __func__, \ + .filename = __FILE__, \ + .lineno = __LINE__, \ + .flags = 0, \ +} + +void codetag_lock_module_list(struct codetag_type *cttype, bool lock); +struct codetag_iterator codetag_get_ct_iter(struct codetag_type *cttype); +struct codetag *codetag_next_ct(struct codetag_iterator *iter); + +void codetag_to_text(struct seq_buf *out, struct codetag *ct); + +struct codetag_type * +codetag_register_type(const struct codetag_type_desc *desc); + +#endif /* _LINUX_CODETAG_H */ diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index 733ee2ac0138..d2dbdd45fd9a 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -968,6 +968,10 @@ config DEBUG_STACKOVERFLOW If in doubt, say "N". +config CODE_TAGGING + bool + select KALLSYMS + source "lib/Kconfig.kasan" source "lib/Kconfig.kfence" source "lib/Kconfig.kmsan" diff --git a/lib/Makefile b/lib/Makefile index ffc6b2341b45..910335da8f13 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -233,6 +233,7 @@ obj-$(CONFIG_OF_RECONFIG_NOTIFIER_ERROR_INJECT) += \ of-reconfig-notifier-error-inject.o obj-$(CONFIG_FUNCTION_ERROR_INJECTION) += error-inject.o +obj-$(CONFIG_CODE_TAGGING) += codetag.o lib-$(CONFIG_GENERIC_BUG) += bug.o obj-$(CONFIG_HAVE_ARCH_TRACEHOOK) += syscall.o diff --git a/lib/codetag.c b/lib/codetag.c new file mode 100644 index 000000000000..8b5b89ad508d --- /dev/null +++ b/lib/codetag.c @@ -0,0 +1,219 @@ +// SPDX-License-Identifier: GPL-2.0-only +#include +#include +#include +#include +#include +#include + +struct codetag_type { + struct list_head link; + unsigned int count; + struct idr mod_idr; + struct rw_semaphore mod_lock; /* protects mod_idr */ + struct codetag_type_desc desc; +}; + +struct codetag_range { + struct codetag *start; + struct codetag *stop; +}; + +struct codetag_module { + struct module *mod; + struct codetag_range range; +}; + +static DEFINE_MUTEX(codetag_lock); +static LIST_HEAD(codetag_types); + +void codetag_lock_module_list(struct codetag_type *cttype, bool lock) +{ + if (lock) + down_read(&cttype->mod_lock); + else + up_read(&cttype->mod_lock); +} + +struct codetag_iterator codetag_get_ct_iter(struct codetag_type *cttype) +{ + struct codetag_iterator iter = { + .cttype = cttype, + .cmod = NULL, + .mod_id = 0, + .ct = NULL, + }; + + return iter; +} + +static inline struct codetag *get_first_module_ct(struct codetag_module *cmod) +{ + return cmod->range.start < cmod->range.stop ? cmod->range.start : NULL; +} + +static inline +struct codetag *get_next_module_ct(struct codetag_iterator *iter) +{ + struct codetag *res = (struct codetag *) + ((char *)iter->ct + iter->cttype->desc.tag_size); + + return res < iter->cmod->range.stop ? res : NULL; +} + +struct codetag *codetag_next_ct(struct codetag_iterator *iter) +{ + struct codetag_type *cttype = iter->cttype; + struct codetag_module *cmod; + struct codetag *ct; + + lockdep_assert_held(&cttype->mod_lock); + + if (unlikely(idr_is_empty(&cttype->mod_idr))) + return NULL; + + ct = NULL; + while (true) { + cmod = idr_find(&cttype->mod_idr, iter->mod_id); + + /* If module was removed move to the next one */ + if (!cmod) + cmod = idr_get_next_ul(&cttype->mod_idr, + &iter->mod_id); + + /* Exit if no more modules */ + if (!cmod) + break; + + if (cmod != iter->cmod) { + iter->cmod = cmod; + ct = get_first_module_ct(cmod); + } else + ct = get_next_module_ct(iter); + + if (ct) + break; + + iter->mod_id++; + } + + iter->ct = ct; + return ct; +} + +void codetag_to_text(struct seq_buf *out, struct codetag *ct) +{ + if (ct->modname) + seq_buf_printf(out, "%s:%u [%s] func:%s", + ct->filename, ct->lineno, + ct->modname, ct->function); + else + seq_buf_printf(out, "%s:%u func:%s", + ct->filename, ct->lineno, ct->function); +} + +static inline size_t range_size(const struct codetag_type *cttype, + const struct codetag_range *range) +{ + return ((char *)range->stop - (char *)range->start) / + cttype->desc.tag_size; +} + +#ifdef CONFIG_MODULES +static void *get_symbol(struct module *mod, const char *prefix, const char *name) +{ + DECLARE_SEQ_BUF(sb, KSYM_NAME_LEN); + const char *buf; + + seq_buf_printf(&sb, "%s%s", prefix, name); + if (seq_buf_has_overflowed(&sb)) + return NULL; + + buf = seq_buf_str(&sb); + return mod ? + (void *)find_kallsyms_symbol_value(mod, buf) : + (void *)kallsyms_lookup_name(buf); +} + +static struct codetag_range get_section_range(struct module *mod, + const char *section) +{ + return (struct codetag_range) { + get_symbol(mod, "__start_", section), + get_symbol(mod, "__stop_", section), + }; +} + +static int codetag_module_init(struct codetag_type *cttype, struct module *mod) +{ + struct codetag_range range; + struct codetag_module *cmod; + int err; + + range = get_section_range(mod, cttype->desc.section); + if (!range.start || !range.stop) { + pr_warn("Failed to load code tags of type %s from the module %s\n", + cttype->desc.section, + mod ? mod->name : "(built-in)"); + return -EINVAL; + } + + /* Ignore empty ranges */ + if (range.start == range.stop) + return 0; + + BUG_ON(range.start > range.stop); + + cmod = kmalloc(sizeof(*cmod), GFP_KERNEL); + if (unlikely(!cmod)) + return -ENOMEM; + + cmod->mod = mod; + cmod->range = range; + + down_write(&cttype->mod_lock); + err = idr_alloc(&cttype->mod_idr, cmod, 0, 0, GFP_KERNEL); + if (err >= 0) + cttype->count += range_size(cttype, &range); + up_write(&cttype->mod_lock); + + if (err < 0) { + kfree(cmod); + return err; + } + + return 0; +} + +#else /* CONFIG_MODULES */ +static int codetag_module_init(struct codetag_type *cttype, struct module *mod) { return 0; } +#endif /* CONFIG_MODULES */ + +struct codetag_type * +codetag_register_type(const struct codetag_type_desc *desc) +{ + struct codetag_type *cttype; + int err; + + BUG_ON(desc->tag_size <= 0); + + cttype = kzalloc(sizeof(*cttype), GFP_KERNEL); + if (unlikely(!cttype)) + return ERR_PTR(-ENOMEM); + + cttype->desc = *desc; + idr_init(&cttype->mod_idr); + init_rwsem(&cttype->mod_lock); + + err = codetag_module_init(cttype, NULL); + if (unlikely(err)) { + kfree(cttype); + return ERR_PTR(err); + } + + mutex_lock(&codetag_lock); + list_add_tail(&cttype->link, &codetag_types); + mutex_unlock(&codetag_lock); + + return cttype; +}