From nobody Fri Dec 19 17:44:10 2025 Received: from mail-pj1-f74.google.com (mail-pj1-f74.google.com [209.85.216.74]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DC7391DB951 for ; Mon, 27 Jan 2025 21:33:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738013618; cv=none; b=QPyVN7s+CNea3Y+9i8dVLQzv7DZEXzqeO5iHs/ULAOx6XNHYuiH6meq5ahRYmDDKcwkde4NIE1m0XLkrtUhlfp0E+c2h4lwud1OqSQuQF0T4wuEvLLp0GQobHW/saonhkTGFzCwsgGLnaX9M6V2E7QFkOYs6oDz5PmfNiGduBVE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738013618; c=relaxed/simple; bh=4qOdPw6hOBZxSpET+wd7E8BTc7x5s3vFgcr6W7+jzvI=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=IquGMoqntJ3L36dv4wmHA0BNie7PZAIiNW6EvqCtPodqGxEbo41v6YNR6lB6caPZi/BiKeq6yaT8xoJ+du1GlwfP7NyZkB9JjUp7dcJWWEvBAplSzmOx7u0Iq2mycAn2vVfT7Qn7uYHizypE1f2eyHnTq0Bo7hFUCHepIVCWOIU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--wnliu.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=DZWUlv6T; arc=none smtp.client-ip=209.85.216.74 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--wnliu.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="DZWUlv6T" Received: by mail-pj1-f74.google.com with SMTP id 98e67ed59e1d1-2efa74481fdso9895165a91.1 for ; Mon, 27 Jan 2025 13:33:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1738013615; x=1738618415; darn=vger.kernel.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=vFxyJQizGcViiMZLcjGdqbFKo+O4vKLRWZRU/ldO2O0=; b=DZWUlv6TF2/2MW26VDsxa2TuwozQBrHsJsnW0UNCq1LyxFFgSg5KtccP6o7vPy+nvF k2rKskMz1gU51W7T5QnBUg4Sk8opHXU9bEcWp84fHBkMnGYfnZ7aelo+sRMvMFEQF3BH STCXSRCyV/5JnNsTKgKNX1xUll7weXlqfIorS+gLE9RakrQ9XLU55VSyclKsyBSOOrQZ 3qNSrBVEzbaSwzhgvGwp7Bpimcv8US/57mN/iq0QiUyNjZaRV3cDr8qa4O4CiprSIXdM 1M9vWoOb+ycLScelHwJkK5fNjacrtd13rk6mty6UO4zix1ELbUqtfzSaaZqtyRsgfiWD yw+Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738013615; x=1738618415; 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=vFxyJQizGcViiMZLcjGdqbFKo+O4vKLRWZRU/ldO2O0=; b=RaVF3DY5ZdKIkYcXauwCU2+hvObF+uI3/rauN+4AWCWc2BsIS0LdZ9xlc7Y0Wb5Cgi tQGM50Eslj1cnB7ggmEUiXeIcw5ujgeXtJT73b+HRfcRGPxEtEpJbpOE1UcII63OjxJc Kc6krYqPA2xKS+wv7LQh8Z/qgcAUf3F8Sli1U0QU4C9ZSXJFnVuqUOhWAr7pZd9w4rHD VmCh4Ou9o2SsO7GoJrkNLEoTx3gwPqF/zTPsPBDk+gSsgGGIh+iTWnbJT2TI51IZ5m6V X8tFsi/LaRcGZ4bJXdPmlmqI9SpdqSiu/Y/Fanmfyi2CaHXnL0rvyuwdxRog3IfFASXq F3TQ== X-Forwarded-Encrypted: i=1; AJvYcCVguFPtPE+LWArVpSkpVpdzqzldWasvRXDRafYQpCiBH1Skke1uXJnOvZ/ySMdcV0keWXFrXutuB5acZxQ=@vger.kernel.org X-Gm-Message-State: AOJu0Yy0lK0a2ypgepKMza0wS8beR9FoW7BqTGc+L3HcckKsVeKcavar WSSrRHoN/Fgu+c0jpJ/iu4v7GG0HBL9yXX5mDPj1i5nH+iKAGW1F9HPiszwQHXtbjL3P/6gJqg= = X-Google-Smtp-Source: AGHT+IHHPT3SHafekGNUGDZsLxe9xIeZEZ7pS5XFwvuSD16m5Qqb3+3tw3GkG+JemAl3HyjyegOXze/WMg== X-Received: from pjbpa16.prod.google.com ([2002:a17:90b:2650:b0:2da:ac73:93e0]) (user=wnliu job=prod-delivery.src-stubby-dispatcher) by 2002:a17:90b:2751:b0:2ee:f440:53ed with SMTP id 98e67ed59e1d1-2f782d9a1d5mr60272909a91.31.1738013614965; Mon, 27 Jan 2025 13:33:34 -0800 (PST) Date: Mon, 27 Jan 2025 21:33:06 +0000 In-Reply-To: <20250127213310.2496133-1-wnliu@google.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250127213310.2496133-1-wnliu@google.com> X-Mailer: git-send-email 2.48.1.262.g85cc9f2d1e-goog Message-ID: <20250127213310.2496133-5-wnliu@google.com> Subject: [PATCH 4/8] unwind: Implement generic sframe unwinder library From: Weinan Liu To: Josh Poimboeuf , Steven Rostedt , Indu Bhagat , Peter Zijlstra Cc: Mark Rutland , roman.gushchin@linux.dev, Will Deacon , Ian Rogers , linux-toolchains@vger.kernel.org, linux-kernel@vger.kernel.org, live-patching@vger.kernel.org, joe.lawrence@redhat.com, linux-arm-kernel@lists.infradead.org, Weinan Liu Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" This change introduces a kernel space unwinder using sframe table for architectures without ORC unwinder support. The implementation is adapted from Josh's userspace sframe unwinder proposal[1] according to the sframe v2 spec[2]. [1] https://lore.kernel.org/lkml/42c0a99236af65c09c8182e260af7bcf5aa1e158.1= 730150953.git.jpoimboe@kernel.org/ [2] https://sourceware.org/binutils/docs/sframe-spec.html Signed-off-by: Weinan Liu Reviewed-by: Prasanna Kumar T S M . --- include/linux/sframe_lookup.h | 43 ++++++++ kernel/Makefile | 1 + kernel/sframe_lookup.c | 196 ++++++++++++++++++++++++++++++++++ 3 files changed, 240 insertions(+) create mode 100644 include/linux/sframe_lookup.h create mode 100644 kernel/sframe_lookup.c diff --git a/include/linux/sframe_lookup.h b/include/linux/sframe_lookup.h new file mode 100644 index 000000000000..1c26cf1f38d4 --- /dev/null +++ b/include/linux/sframe_lookup.h @@ -0,0 +1,43 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +#ifndef _LINUX_SFRAME_LOOKUP_H +#define _LINUX_SFRAME_LOOKUP_H + +/** + * struct sframe_ip_entry - sframe unwind info for given ip + * @cfa_offset: Offset for the Canonical Frame Address(CFA) from Frame + * Pointer(FP) or Stack Pointer(SP) + * @ra_offset: Offset for the Return Address from CFA. + * @fp_offset: Offset for the Frame Pointer (FP) from CFA. + * @use_fp: Use FP to get next CFA or not + */ +struct sframe_ip_entry { + int32_t cfa_offset; + int32_t ra_offset; + int32_t fp_offset; + bool use_fp; +}; + +/** + * struct sframe_table - sframe struct of a table + * @sfhdr_p: Pointer to sframe header + * @fde_p: Pointer to the first of sframe frame description entry(FDE). + * @fre_p: Pointer to the first of sframe frame row entry(FRE). + */ +struct sframe_table { + struct sframe_header *sfhdr_p; + struct sframe_fde *fde_p; + char *fre_p; +}; + +#ifdef CONFIG_SFRAME_UNWINDER +void init_sframe_table(void); +int sframe_find_pc(unsigned long pc, struct sframe_ip_entry *entry); +#else +static inline void init_sframe_table(void) {} +static inline int sframe_find_pc(unsigned long pc, struct sframe_ip_entry = *entry) +{ + return -EINVAL; +} +#endif + +#endif /* _LINUX_SFRAME_LOOKUP_H */ diff --git a/kernel/Makefile b/kernel/Makefile index 87866b037fbe..705c9277e5cd 100644 --- a/kernel/Makefile +++ b/kernel/Makefile @@ -131,6 +131,7 @@ obj-$(CONFIG_WATCH_QUEUE) +=3D watch_queue.o =20 obj-$(CONFIG_RESOURCE_KUNIT_TEST) +=3D resource_kunit.o obj-$(CONFIG_SYSCTL_KUNIT_TEST) +=3D sysctl-test.o +obj-$(CONFIG_SFRAME_UNWINDER) +=3D sframe_lookup.o =20 CFLAGS_stackleak.o +=3D $(DISABLE_STACKLEAK_PLUGIN) obj-$(CONFIG_GCC_PLUGIN_STACKLEAK) +=3D stackleak.o diff --git a/kernel/sframe_lookup.c b/kernel/sframe_lookup.c new file mode 100644 index 000000000000..846f1da95d89 --- /dev/null +++ b/kernel/sframe_lookup.c @@ -0,0 +1,196 @@ +// SPDX-License-Identifier: GPL-2.0-only +#include +#include +#include +#include +#include "sframe.h" + +#define pr_fmt(fmt) "sframe: " fmt + +extern char __start_sframe_header[]; +extern char __stop_sframe_header[]; + +static bool sframe_init __ro_after_init; +static struct sframe_table sftbl; + +#define SFRAME_READ_TYPE(in, out, type) \ +({ \ + type __tmp; \ + memcpy(&__tmp, in, sizeof(__tmp)); \ + in +=3D sizeof(__tmp); \ + out =3D __tmp; \ +}) + +#define SFRAME_READ_ROW_ADDR(in_addr, out_addr, type) \ +({ \ + switch (type) { \ + case SFRAME_FRE_TYPE_ADDR1: \ + SFRAME_READ_TYPE(in_addr, out_addr, u8); \ + break; \ + case SFRAME_FRE_TYPE_ADDR2: \ + SFRAME_READ_TYPE(in_addr, out_addr, u16); \ + break; \ + case SFRAME_FRE_TYPE_ADDR4: \ + SFRAME_READ_TYPE(in_addr, out_addr, u32); \ + break; \ + default: \ + break; \ + } \ +}) + +#define SFRAME_READ_ROW_OFFSETS(in_addr, out_addr, size) \ +({ \ + switch (size) { \ + case 1: \ + SFRAME_READ_TYPE(in_addr, out_addr, s8); \ + break; \ + case 2: \ + SFRAME_READ_TYPE(in_addr, out_addr, s16); \ + break; \ + case 4: \ + SFRAME_READ_TYPE(in_addr, out_addr, s32); \ + break; \ + default: \ + break; \ + } \ +}) + +static struct sframe_fde *find_fde(const struct sframe_table *tbl, unsigne= d long pc) +{ + int l, r, m, f; + int32_t ip; + struct sframe_fde *fdep; + + if (!tbl || !tbl->sfhdr_p || !tbl->fde_p) + return NULL; + + ip =3D (pc - (unsigned long)tbl->sfhdr_p); + + /* Do a binary range search to find the rightmost FDE start_addr < ip */ + l =3D m =3D f =3D 0; + r =3D tbl->sfhdr_p->num_fdes; + while (l < r) { + m =3D l + ((r - l) / 2); + fdep =3D tbl->fde_p + m; + if (fdep->start_addr > ip) + r =3D m; + else + l =3D m + 1; + } + /* use l - 1 because l will be the first item fdep->start_addr > ip */ + f =3D l - 1; + if (f >=3D tbl->sfhdr_p->num_fdes || f < 0) + return NULL; + fdep =3D tbl->fde_p + f; + if (ip < fdep->start_addr || ip >=3D fdep->start_addr + fdep->size) + return NULL; + + return fdep; +} + +static int find_fre(const struct sframe_table *tbl, unsigned long pc, + const struct sframe_fde *fdep, struct sframe_ip_entry *entry) +{ + int i, offset_size, offset_count; + char *fres, *offsets_loc; + int32_t ip_off; + uint32_t next_row_ip_off; + uint8_t fre_info, fde_type =3D SFRAME_FUNC_FDE_TYPE(fdep->info), + fre_type =3D SFRAME_FUNC_FRE_TYPE(fdep->info); + + fres =3D tbl->fre_p + fdep->fres_off; + + /* Whether PCs in the FREs should be treated as masks or not */ + if (fde_type =3D=3D SFRAME_FDE_TYPE_PCMASK) + ip_off =3D pc % fdep->rep_size; + else + ip_off =3D (int32_t)(pc - (unsigned long)tbl->sfhdr_p) - fdep->start_add= r; + + if (ip_off < 0 || ip_off >=3D fdep->size) + return -EINVAL; + + /* + * FRE structure starts by address of the entry with variants length. Use + * two pointers to track current head(fres) and the address of last + * offset(offsets_loc) + */ + for (i =3D 0; i < fdep->fres_num; i++) { + SFRAME_READ_ROW_ADDR(fres, next_row_ip_off, fre_type); + if (ip_off < next_row_ip_off) + break; + SFRAME_READ_TYPE(fres, fre_info, u8); + offsets_loc =3D fres; + /* + * jump to the start of next fre + * fres +=3D fre_offets_cnt*offset_size + */ + fres +=3D SFRAME_FRE_OFFSET_COUNT(fre_info) << SFRAME_FRE_OFFSET_SIZE(fr= e_info); + } + + offset_size =3D 1 << SFRAME_FRE_OFFSET_SIZE(fre_info); + offset_count =3D SFRAME_FRE_OFFSET_COUNT(fre_info); + + if (offset_count > 0) { + SFRAME_READ_ROW_OFFSETS(offsets_loc, entry->cfa_offset, offset_size); + offset_count--; + } + if (offset_count > 0 && !entry->ra_offset) { + SFRAME_READ_ROW_OFFSETS(offsets_loc, entry->ra_offset, offset_size); + offset_count--; + } + if (offset_count > 0 && !entry->fp_offset) { + SFRAME_READ_ROW_OFFSETS(offsets_loc, entry->fp_offset, offset_size); + offset_count--; + } + if (offset_count) + return -EINVAL; + + entry->use_fp =3D SFRAME_FRE_CFA_BASE_REG_ID(fre_info) =3D=3D SFRAME_BASE= _REG_FP; + + return 0; +} + +int sframe_find_pc(unsigned long pc, struct sframe_ip_entry *entry) +{ + struct sframe_fde *fdep; + struct sframe_table *sftbl_p =3D &sftbl; + int err; + + if (!sframe_init) + return -EINVAL; + + memset(entry, 0, sizeof(*entry)); + entry->ra_offset =3D sftbl_p->sfhdr_p->cfa_fixed_ra_offset; + entry->fp_offset =3D sftbl_p->sfhdr_p->cfa_fixed_fp_offset; + + fdep =3D find_fde(sftbl_p, pc); + if (!fdep) + return -EINVAL; + err =3D find_fre(sftbl_p, pc, fdep, entry); + if (err) + return err; + + return 0; +} + +void __init init_sframe_table(void) +{ + size_t sframe_size =3D (void *)__stop_sframe_header - (void *)__start_sfr= ame_header; + void *sframe_buf =3D __start_sframe_header; + + if (sframe_size <=3D 0) + return; + sftbl.sfhdr_p =3D sframe_buf; + if (!sftbl.sfhdr_p || sftbl.sfhdr_p->preamble.magic !=3D SFRAME_MAGIC || + sftbl.sfhdr_p->preamble.version !=3D SFRAME_VERSION_2 || + !(sftbl.sfhdr_p->preamble.flags & SFRAME_F_FDE_SORTED)) { + pr_warn("WARNING: Unable to read sframe header. Disabling unwinder.\n"); + return; + } + + sftbl.fde_p =3D (struct sframe_fde *)(__start_sframe_header + SFRAME_HDR_= SIZE(*sftbl.sfhdr_p) + + sftbl.sfhdr_p->fdes_off); + sftbl.fre_p =3D __start_sframe_header + SFRAME_HDR_SIZE(*sftbl.sfhdr_p) + + sftbl.sfhdr_p->fres_off; + sframe_init =3D true; +} --=20 2.48.1.262.g85cc9f2d1e-goog