From patchwork Mon May 1 16:54:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Suren Baghdasaryan X-Patchwork-Id: 13227649 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 BCF69C77B7C for ; Mon, 1 May 2023 16:55:41 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5A490900010; Mon, 1 May 2023 12:55:41 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 52BF2900002; Mon, 1 May 2023 12:55:41 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3A60E900010; Mon, 1 May 2023 12:55:41 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 2C7CA900002 for ; Mon, 1 May 2023 12:55:41 -0400 (EDT) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id EBC34120814 for ; Mon, 1 May 2023 16:55:40 +0000 (UTC) X-FDA: 80742287640.19.BA413BB Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) by imf16.hostedemail.com (Postfix) with ESMTP id 33179180020 for ; Mon, 1 May 2023 16:55:39 +0000 (UTC) Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=google.com header.s=20221208 header.b=1K0fFEAK; spf=pass (imf16.hostedemail.com: domain of 3Cu9PZAYKCFEBDAx6uz77z4x.v75416DG-553Etv3.7Az@flex--surenb.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=3Cu9PZAYKCFEBDAx6uz77z4x.v75416DG-553Etv3.7Az@flex--surenb.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1682960139; 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=esQmYNSNwAFEEht8P+eJjy3027KPfc8B0JiLBlMM/Bo=; b=7lzpd/aMtEWnWd5HOMveE7FDL+TYrv4qnndXT1uVaQvsK2dHCwkzSiZI0kyIY/8X5qp6fZ x2SEl5bV7f/o42XZ3ucxi911kukiufk5ZlzbEmEYHkHu0CUEx53E+dOYc1ZD8uOgVeH5Wf /ni5q/OCNyGTBCCu06hPeI82TAgOUsc= ARC-Authentication-Results: i=1; imf16.hostedemail.com; dkim=pass header.d=google.com header.s=20221208 header.b=1K0fFEAK; spf=pass (imf16.hostedemail.com: domain of 3Cu9PZAYKCFEBDAx6uz77z4x.v75416DG-553Etv3.7Az@flex--surenb.bounces.google.com designates 209.85.219.202 as permitted sender) smtp.mailfrom=3Cu9PZAYKCFEBDAx6uz77z4x.v75416DG-553Etv3.7Az@flex--surenb.bounces.google.com; dmarc=pass (policy=reject) header.from=google.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1682960139; a=rsa-sha256; cv=none; b=CIt8qbYsh1maJf6yJw81Qw9IcUyOHqUWwvG1Qp80z5rG37+KOQgMRkQAWTig4Z44ZxjGXs MJPfZ0CDwus/xmS0Z6EiRKA/jU6Gb2C0yUmXW5rNBcLRiZJA03/4exzX205XOHmaiKitTu 5GJlrpfgk9Dtm9bMMTLX2O60AQxT2WI= Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-b9a77926afbso5336380276.3 for ; Mon, 01 May 2023 09:55:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20221208; t=1682960138; x=1685552138; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=esQmYNSNwAFEEht8P+eJjy3027KPfc8B0JiLBlMM/Bo=; b=1K0fFEAK+AaTcTrhRe/8a98Aa8YFb/wagQhTInABD8mCONGKSRgdFrxtZCXhoikIrD 95LbVzIsXi3bINaTtEnZF9G22EF21tdKrkz425iIWjDwgf5ia/D5RPk4ld7MvQ2bZrHL zTPwIsZxtdpBgp2DZGIo7+RgNrWbsBTdHAdG+30Neb5Pvht487JVGA5EbtFhDduMq7HO ShzwvYcyvz3j9I+l3PwqAphCFJcDaU5zq6rGvI+RjzLbAJs5GZMoaQi5lWkbfdI+rVbA ocsPKP0FHdN7fG1jB6JiNezvv7iCPM0MjKja2ICr+xbGSCsCD3+3JKMB5QLLD+jX5DbM FQSg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682960138; x=1685552138; 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=esQmYNSNwAFEEht8P+eJjy3027KPfc8B0JiLBlMM/Bo=; b=lrFJtWVIBnr6ELmNTK06iu0ksvTJa2M3oncFRR4UO4O92RAYsvm78JQmZciTh/T+/k mqmu5LacNEOCjvXVqVdmXdJq3rVSt+02XEume5zQq51lrWqqDZVesEPqj0f59t1j4JjU XJ6c9cQmiv4hDxt1tW5FhUdorn0I2oVlZa98jbAKyK1dQgHnpwRmfeHLF/IxnGv8XZGl ErdK+HLGWhYhZsC7OUEmK3cnjft3U51e8ltcPcV8eOinP0ZDrUgf11m1DnS1700Hsz0D uMsGAXiu8+FCTyyiBIizqT5RnRHHDfz3r07TPoYVuDVlGpPInTYIR+WNvlQNMMYQep7H p2aA== X-Gm-Message-State: AC+VfDyR9KRmQJVG+Jl13TugqcwQO+AHrPZvVtO5dvSL+y+eEBOP3YaZ 8BPwVtLPpjeSh1nEbDBw35Wa0mloiM8= X-Google-Smtp-Source: ACHHUZ5PU+HAQ/Z79Go9ruK3jLDijCoDZh/O68HGN1mUxbgOcPOxNdjm/ucjU0E7fPKkrMRK65Bl/NGds+o= X-Received: from surenb-desktop.mtv.corp.google.com ([2620:15c:211:201:6d24:3efd:facc:7ac4]) (user=surenb job=sendgmr) by 2002:a25:c00b:0:b0:b99:4887:c736 with SMTP id c11-20020a25c00b000000b00b994887c736mr8510714ybf.3.1682960138280; Mon, 01 May 2023 09:55:38 -0700 (PDT) Date: Mon, 1 May 2023 09:54:23 -0700 In-Reply-To: <20230501165450.15352-1-surenb@google.com> Mime-Version: 1.0 References: <20230501165450.15352-1-surenb@google.com> X-Mailer: git-send-email 2.40.1.495.gc816e09b53d-goog Message-ID: <20230501165450.15352-14-surenb@google.com> Subject: [PATCH 13/40] 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, corbet@lwn.net, void@manifault.com, peterz@infradead.org, juri.lelli@redhat.com, ldufour@linux.ibm.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, 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, 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, shakeelb@google.com, songmuchun@bytedance.com, jbaron@akamai.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-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: 33179180020 X-Stat-Signature: ernk74yww164h1fgy1xabymbt6yookn7 X-HE-Tag: 1682960139-846808 X-HE-Meta: U2FsdGVkX1+i6jxaLhiEcDAy2o6I0E4OLaZ6sg02yUrGR51tU1am1t5F50gPbFr7ryYqtUDNv+JkwlC+6V8fvb63ooNKM41b2dXovPK+KlBLZm66QRqBOyqmVgSMLVADEJTTJUWI/k9hQeYU1KnkQinxOhz9Fnwc5hNYQU7Vw72fKXJpQPcxN9R2e+rHoFKPA9KEp7+e2sW1SiEz+xks+8/bCpY3xITuRyt8LVhNYk0hlTG15xArdltqVuL9UOWYGA0n5MWaPjsmBXipWQFZ4hnOBjXEAOFP409cVaYQ9zPq/9BEZvY8tHwN6MGA7il8RMuktzABXNOv7jAytFECliTvQo0xeyclxmLmTWxbi9rRwRqaCRnxwHI8oAmyA+0Fa418MemXGKfUq/h1i2aQodh1T81UXs5aV5LWOujuN0GidbI7sENGdmNkVy51LtMlK5aKl+p+5+pduHEDSqYqV4KaO7aZESzm6aTxmaICAqD6qccqw9m3ujeaeZbRpsf9EtxEaEYQNJOujAgDqbsiTTSgNk6ghzcqXAPhwg4f7dMoJsOG5KlDEHQ0q4MSPASfJONGH37+EjL8R55pZSEREV8JmxNYy8EgX3Y6RH6TEMKjQeYQHyOaUkcgRyd6wSdBipn543LZDBDbTjpeJEdaS6ATpLYrVfHukZZTyCi0d+IOhwsTuW1fqy8e0h19k16jlbqJCKhAJ00io50q/QSoYdmkGowmqhqwubGw6ZNeAd36TKr4bNOUKKil9Xa0rGMNWkPNSUuYAlpPrXoLsanXPNnyCq22G6fdud5QBMAmTo2GAMBsnp3sAB0gotw6slqE2rsgWcztIR3ZSHBT65UmHSjuhagJ52jt8QcKNVIs5hma1CEEhFR0eNgp7umTb40RDW5Ki8pM+Uq/u3/SalK0B/FsfSg5T6zqk+HHGefsS3kLi96uT0w2IJ5tCTDdUpBGxw4IoEWX83HFZcekTKU M477cBLh 8/SVvH0qgtAcnSwJ1m6lbTgO4vdaPZupf1aBLLqFggMXwQj78BnCqnhF9NcAyrycPmRBMoi1FHC1cl7dm/H6qTD/Gjgons1Q8yVDCIQGmnQeueHZQM+Q5pDKT7rseog6TM1/hJchLDssGTevnCBLKMDWJRgwh+f9I7Jlmp1zI54GUck2MF/+3DsqFsFtKVZ3wYucABJ1GsvAaQZPFl7QHahjQTmSk6n9G1b068XHNE9FnTcAbTXWxKzbXZFcBRVg3rLzNdvtrRJfBUkDYQJT895f3ikjH/kG8sJr9N+waHPbipTd0BW8gtha74fyHaT8iTd67tyqp8aUglbx25TyUuEavN2HW68i9hN4iJQ9RHHm4Ho3DSkSSw8amS26vQReHtNJA0A2syvrtH58eqDZO9vDpWjcnxrtJSNNmVzQgCZc6NoM9jxii8WfuO0hLCoL1UsIyMbBiSKkgUT4WOfQzYeQlSZpKGhybjaHZK0tYyj/oJVPVuEj+MnBJ5FThWK2CLgfx+CvKLEdMJ0qibv4MsH0sAfQie/FFDEAfnQ9xsHg2lNLA8g6skWT2FtrsQdlOftD/gUI6NNsdUBuaSSct0piPcd9b/mfMPfsnfqazhL+tctJGzUUAKv6i9cDMI85sE67HDPJ/CJeaasPZpoBc4/g204WBFZltoM3PrijlUAy1Hq4= 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: 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 | 71 ++++++++++++++ lib/Kconfig.debug | 4 + lib/Makefile | 1 + lib/codetag.c | 199 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 275 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..a9d7adecc2a5 --- /dev/null +++ b/include/linux/codetag.h @@ -0,0 +1,71 @@ +/* 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 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_range { + struct codetag *start; + struct codetag *stop; +}; + +struct codetag_module { + struct module *mod; + struct codetag_range range; +}; + +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; +}; + +#define CODE_TAG_INIT { \ + .modname = KBUILD_MODNAME, \ + .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 ce51d4dc6803..5078da7d3ffb 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -957,6 +957,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 293a0858a3f8..28d70ecf2976 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -228,6 +228,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..7708f8388e55 --- /dev/null +++ b/lib/codetag.c @@ -0,0 +1,199 @@ +// 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; +}; + +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) +{ + seq_buf_printf(out, "%s:%u module:%s func:%s", + ct->filename, ct->lineno, + ct->modname, 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; +} + +static void *get_symbol(struct module *mod, const char *prefix, const char *name) +{ + char buf[64]; + int res; + + res = snprintf(buf, sizeof(buf), "%s%s", prefix, name); + if (WARN_ON(res < 1 || res > sizeof(buf))) + return NULL; + + 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; +} + +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; +}