From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx0a-00069f02.pphosted.com (mx0a-00069f02.pphosted.com [205.220.165.32]) by sourceware.org (Postfix) with ESMTPS id AF2AA385841E for ; Tue, 31 Jan 2023 23:34:56 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org AF2AA385841E Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=oracle.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=oracle.com Received: from pps.filterd (m0246617.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 30VIiMWu005638 for ; Tue, 31 Jan 2023 23:34:55 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : content-transfer-encoding : content-type : mime-version; s=corp-2022-7-12; bh=IHicnACfAIHQ01+/0OZcH+mzwGL2VN3e1VXlIsyjuDY=; b=VAEdpsrjrWv9xR2SsBjKFvQzHRfRUZLnWhtK+ghMosYUucJpa/p/M/cz00d+n7D64iEh 6dX1SyVmB22WT7LNoeCjvUyIrgX2fqZX0d1Y75AZe6PM60I3Gdxhj5UGu7Y9kihreoNF Qe90x1Iqj9eUw7tjGiX0AZrbVt7HPHgCwBgQ+2b7uxlvrS3FpGxI+jy9I20VVJHEmyp+ 8YVcgXJQj+uiUXRQaAZ9+cFDCo3PJA2eCyzHG4cKzDwrLkwof7nU6ClRiFua4/eo04mi wVrToNa/XNpa+TaG7cTtpxJ+SMM1A48nkEkDMIuTBXDexwq2SnDmB0un9pwvmQbsFih5 /Q== Received: from iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta03.appoci.oracle.com [130.35.103.27]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3ncvm1739u-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Tue, 31 Jan 2023 23:34:55 +0000 Received: from pps.filterd (iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (8.17.1.5/8.17.1.5) with ESMTP id 30VMuxKK031594 for ; Tue, 31 Jan 2023 23:34:54 GMT Received: from nam12-mw2-obe.outbound.protection.outlook.com (mail-mw2nam12lp2040.outbound.protection.outlook.com [104.47.66.40]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 3nct5d8rp2-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Tue, 31 Jan 2023 23:34:53 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=hFOq4QaDbVVhD5VAcAZDzBXf1HbpncVTRucO1nEyMo7qwLP7si4f+4p4iB5LzhykE6x9FolNMEEbzqA04qjiv58Oi56mCFcERNmrOy2roLmz+wdIHdkAzft6h9AiwiYt1rCENRfOXw/OBpzXZg0fLpzLoFMjkOjG6yS6wl7kYgv6EbaILUscK6rL0j9KwussoFzuIZpmIJvrFc+5Gak/q9ecRe3MfG1HMzSw8Exbeu0SrGcdSkVv7TYx6UD6wvdMc716rp6OcVeX5fL5oPMJN68b+2vVJqjtDR/4xnkvJl5K40i4zvuPcqxzhR4dz9ejwweRxBmtcUQ23dzxAZCmwg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=IHicnACfAIHQ01+/0OZcH+mzwGL2VN3e1VXlIsyjuDY=; b=EEfRCkcNBDqA44G+WT41VERswrVcfclCpd4M6Xl72mwn35E3o6AXwxfaziI+cgI0gcJTeK32eqDeKZLwQDruCqAha0q4zlcHx8VbRfIQhpCqqD7QGI9SnQMkrv62PjwvxVWaVKguv3P028l+J1vEOKnFWBDfvjf1bkMDwWZXy3Vj+BqpCPHM2IUdDA4N+JhmBkIMBiz3yK4emLkfYTYELtYbRNqQ2/YZFvDrKRCc9WVWlN0ckNSJfFWjTR1pf/2PI7PeC/xgwrh3wECg9pLpvLmo4AjQ9iPp9C8vwq85Oyg2c7JjO8wPsB/E7ilILzrhQaRxYRFygbt3FaFKcaEIqw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oracle.com; dmarc=pass action=none header.from=oracle.com; dkim=pass header.d=oracle.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.onmicrosoft.com; s=selector2-oracle-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=IHicnACfAIHQ01+/0OZcH+mzwGL2VN3e1VXlIsyjuDY=; b=yRRS03G4/rqRHqCRbIThfMY9iDDg5dHbSu08oMDBWPYr/FYqXeQVl3NoyQ2D8RpbSlD2prGUpDZhOlC+6wU9jlhK3m9k7a64KKKFeL1o+dQVROovzyKAcS2qhXdvWsoXf7JBVdXalrnIqHZ3UTvxJEJze7TUI8xFQXaxPj5kq6M= Received: from MWHPR1001MB2158.namprd10.prod.outlook.com (2603:10b6:301:2d::17) by SA2PR10MB4666.namprd10.prod.outlook.com (2603:10b6:806:112::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6064.22; Tue, 31 Jan 2023 23:34:51 +0000 Received: from MWHPR1001MB2158.namprd10.prod.outlook.com ([fe80::14e6:a522:273f:db57]) by MWHPR1001MB2158.namprd10.prod.outlook.com ([fe80::14e6:a522:273f:db57%7]) with mapi id 15.20.6064.022; Tue, 31 Jan 2023 23:34:51 +0000 From: Indu Bhagat To: binutils@sourceware.org Cc: Indu Bhagat Subject: [PATCH 1/5] libsframe/doc: use "stack trace" instead of "unwind" for SFrame Date: Tue, 31 Jan 2023 15:34:25 -0800 Message-Id: <20230131233429.3708328-2-indu.bhagat@oracle.com> X-Mailer: git-send-email 2.39.0 In-Reply-To: <20230131233429.3708328-1-indu.bhagat@oracle.com> References: <20230131233429.3708328-1-indu.bhagat@oracle.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: MW4P220CA0005.NAMP220.PROD.OUTLOOK.COM (2603:10b6:303:115::10) To MWHPR1001MB2158.namprd10.prod.outlook.com (2603:10b6:301:2d::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: MWHPR1001MB2158:EE_|SA2PR10MB4666:EE_ X-MS-Office365-Filtering-Correlation-Id: d43734df-cb67-4668-9982-08db03e3bfc4 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: moF7DL/b8lfl7W/5aGQKP8y56YMBWtp7pQl63DSusfABb+0IebHvKFyDBQoRx/HLfHy422IRN6Mz6d4UsXtTp5qwnuUEjPrel/CGFGSJOLXBV78+vLk9L8cbcNUunRPunygY/0z5uPSg0T/CNdCY/6KGgEOOawfSxd3ghr6UNruFjgbIV7Hhi0oFuJBIYLfY0Z3v+WJNZuHsbgaUsPHUsUuc2KiPvaXPWbxBs8CW9zQVyGeqr+5MFbTHC67/+LbN8z6xQv0zrPvcbnB2n6hw8ajOUovzHF1kWw/FOPnCy3t8lE3t0t6ZmNKeVYop/FjFrnnaqQSh6B4eIGWJJ+6TANVmOCc2cOdXDz7m36uar6uW8lk4eU8YF7vSsRLktjP8X96ge0fdNKhn0SAZBFW6FIQD/Uz/L+v2tJvC0XT7GMQFS7CgzqKrN31xMqj6YGKFuTy7JgN7/6rEeE+XaD7D1Tdilyv9FOCMqx78uTDzNWsdwliSZQCjVFn6VN7ZspL3SUla09dj5t/X8tpdADOk+XNVyHJuXQlo4ub+Q9JH4sOtg39gMZF5aQvhRr9fjx1bvyONpOMilcNSTFlzl5u1SDJdqjQgPc/4wmoHACTPc3Yaupe8axE8PXjcBYNyqSSEm9S2Tx2ZhCYXnFzVcoW3MQ== X-Forefront-Antispam-Report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:MWHPR1001MB2158.namprd10.prod.outlook.com;PTR:;CAT:NONE;SFS:(13230025)(346002)(39860400002)(376002)(136003)(366004)(396003)(451199018)(6916009)(8676002)(4326008)(83380400001)(41300700001)(66476007)(66556008)(66946007)(316002)(8936002)(6512007)(36756003)(186003)(26005)(44832011)(2906002)(5660300002)(6666004)(6506007)(107886003)(478600001)(1076003)(86362001)(2616005)(6486002)(38100700002);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?f4lXnNNd+6YXvchYN7v9PHlkw0Pp6OfqeXfW8t5SaQnTq7CRD9kIwU7wp8ga?= =?us-ascii?Q?tqFY+SgsXLWiNwy+cdV9eGS2Mp5W40ay/q/ynEoJbJOyBbiiJYGRzWTLIxmt?= =?us-ascii?Q?hMAGSnRZP0b2ZrtYUpUsILxEJkamwMiNhtkpWqdIWkOgWku0q16icS+lW5/f?= =?us-ascii?Q?N9clAaolae1jjl6If5pDX6VqEqE6g04SMxNjL0vpJ3TSQBGQ3kmLrzm/HzVz?= =?us-ascii?Q?ECeGnIfRN1D9wtsLtXPrYqj4Uz9Exq1szUYhkDjO34VK0dwH8Y6velqU0rLg?= =?us-ascii?Q?S7eXKI7t8U1fa6XVbRnWN1+LoBI69eYHUNYBVlNteBLzW9XXntVZK/SMIxCN?= =?us-ascii?Q?NfPKsqJ178GhZZWfng3phVIfdGC0BEuUB7XC00MRoxchM9vDJLzsJrPcqhA1?= =?us-ascii?Q?PRNvBNwh+WUeZDTybIFWpxLgtG8KdoU6I47kVP2EoEnN4ol5tg9KrrowFE7r?= =?us-ascii?Q?R3nHP6TaoEBpmnivRpMrZ5MzzYkpFIRifUCB7RgjWXJVohuhKgxjPJj4u9xM?= =?us-ascii?Q?5+zAeXa/A8cBqUMUyel5fINEifuiSIDW32NR95slgiTcxWJo82wxnuwVAbPz?= =?us-ascii?Q?lBnHOmIZyfAoH89fpS/QldoWeg4s9t6xUwoeH7f30n7HXRonKjD3+h0wAT+x?= =?us-ascii?Q?3J8h5VrG3KNMno2uegWbwlbMxfaUAKjy1PEK2HeOrhM0i4W9kginZpDf158n?= =?us-ascii?Q?BGvXKBow+Bwtd2cuQ7TcKoCn7Ks0sQEtTSyTcxyyJrwJkn0u5PzHk6jyJRRz?= =?us-ascii?Q?e5zJI/h9e6qtKgOuO5fgOkbpdA3GbHxx8kZ/3lK7HQwGgQwswyz7cbM00SR4?= =?us-ascii?Q?PBczUe7gYw/CSfrR37TyHl1wj9jUIAW406gVP5Gp8xprrP2If13fudMKB9u7?= =?us-ascii?Q?Fr4X0yTUlqEFmLp4LDhhm2kyw50vyfn7EJmm3yd3y/3msRwzk7y4Ro8DoOKD?= =?us-ascii?Q?iXQhOhI9qLUvLM8VP/syDueh81Bclr2vTmcYYmm+fD0s2Hw/tr8RzAPfWTSs?= =?us-ascii?Q?/YizsnJ6MZtAvwxQkv4xVXQHhg+onjr7RGa6blBG519E8UR7MuZcy4TaYbm8?= =?us-ascii?Q?q16wPfXlkcBfd66d+YcyJNZTwO0SdLcafqgmWoUtRZ/4LROiJb2MWHTijBkG?= =?us-ascii?Q?JY/TFZ9jLCxVC5j1V3y5kbm/i09M76krWfV7JGXhg1LHWQFYXPUlLeyZiIXy?= =?us-ascii?Q?cJ0t/GfZcAgu8hRFUyNiqgbVl9hC6IDmFZbNaHSerYunp80B0tE+Wrze4cbg?= =?us-ascii?Q?iGzEu35XIE/YRGwunaHL2Q6V4wF+2m1drMiDbevgYUBvVR2M7TwdxWSljqLZ?= =?us-ascii?Q?xJjB3Ii/aEvln0CEWn7ZcvId7SVfnGjAUiZI6d96Z0CWuDmu4TRtoDH2Dw1C?= =?us-ascii?Q?8OoHrVITEE2aXYC2SGNiTBUncFAQQahYODbSowAxCnrZk5w85ziK+JOZD/7A?= =?us-ascii?Q?FIhR2KIIsbKUkrm+y183VrrQgBwo5YjDtSHptVstHzj5THxlpeXD4rwaydE8?= =?us-ascii?Q?cRrRTBZ7GKJDDp0PBbmE6qAp0Fhw6u223AFAGO7Qc3Zjsv/v346X6GqpDMWK?= =?us-ascii?Q?eZqz+/ZjX1TK8Su6Z6cyZwpG0IETba3wA13PBySp?= X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: 3pdEYfypDFGbKxSlbKZc2Xr/30+i8rG3tipFBcxbr3avYuj5bt1otWKNgq5NqNFbAR9votcMTjriMEzp6Qv4fk/Ak+PuWgk4qcJPViZSn6F/4BVtONJNepm6nZ8CoumpjV1f1M/5KZiBfFD9u8tTm58DluPOuzdZ5UUMQmbEEqSQMAM6Gm3Q0apGvT7uaTJ1dhhLT3iPAFcUVe12BF3kuuBH2B2Q0udwqipzWK5IoTDCXwzYLDDu8S+QMGKIh0BwZM9wpo8N/RzULeAr5zE8xlQcVTsTsMMJl66rmlGRhQ1V5BFIQXiMjw+lqUQx/rrKkiEoIYqh3uNDnR6Kxt38++PzMwuvOsN4x+zM8zFPSrXdw37wO7o4Wx2xdkUUqvjaZFHpwbMgDIkzV4u/Y3cNKDRDtGLQnvDZM7Ef7dAozbTID/YdkoKtXV8Eso/lYGTZbstodZz80cIZ6Dyjkw3VdwpXQnfUP+rY85oIGdaA76le7PJC+wLygc/7WDGLCL2ZDlDTc8yOUFZSPXnfMMx5shiM8rDGxfLKQvkVUOhlSJb/a1ALLl0gsTIS4VRHeAmstM+ZGLV+7HWJ6On0Y8Obwlw5ocgJBk0lYJQt1s/MS2Ljh4bGqyhyblpLjJtlBTBSC5Ilj+00l/WSQmz6LNjbTcip8nCwB70P5CV8VCBBLmeQ++ihr8XZQd8VzO531BzoIMbK3feBf8HJhzySWyTaduxFs+j8GkI/05OmernSgUlEnS/CcwSO/tqEQgA2G7r6j27Ye6c/GRxQoSLIKP1ShA== X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-Network-Message-Id: d43734df-cb67-4668-9982-08db03e3bfc4 X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2158.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Jan 2023 23:34:51.4411 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: cDn+EDNQDBIHPLomgVmSIi3NqBRs7QJWu0PS9glLNS/ZlSMjp2lO9ikhaduBsLgPZBAA2+MtYILDSD5tfAvfBA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA2PR10MB4666 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.930,Hydra:6.0.562,FMLib:17.11.122.1 definitions=2023-01-31_08,2023-01-31_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 malwarescore=0 suspectscore=0 adultscore=0 mlxscore=0 phishscore=0 mlxlogscore=999 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2301310202 X-Proofpoint-GUID: Hs12Ceeme98OpKNKSXgr2LuXogHW2Sh7 X-Proofpoint-ORIG-GUID: Hs12Ceeme98OpKNKSXgr2LuXogHW2Sh7 X-Spam-Status: No, score=-13.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,GIT_PATCH_0,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: SFrame format is meant for generating stack traces only. libsframe/ * doc/sframe-spec.texi: Use "stack trace" instead of "unwind". --- libsframe/doc/sframe-spec.texi | 37 +++++++++++++++++----------------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi index 175c622f85d..6987b6fee13 100644 --- a/libsframe/doc/sframe-spec.texi +++ b/libsframe/doc/sframe-spec.texi @@ -35,7 +35,7 @@ License''. This manual describes version 1 of the SFrame file format. SFrame stands for Simple Frame format. SFrame format keeps track of the minimal necessary -information needed for stack unwinding: +information needed for generating stack traces: @itemize @minus @item @@ -47,7 +47,7 @@ Return Address (RA). @end itemize The reason for existence of the SFrame format is to support fast, online -backtracing using a simple unwinder. +generation of stack traces using simple means. @menu * Overview:: @@ -62,7 +62,7 @@ backtracing using a simple unwinder. @cindex Overview @tindex PT_GNU_SFRAME -The SFrame unwind information is provided in a loaded section, known as the +The SFrame stack trace information is provided in a loaded section, known as the @code{.sframe} section. When available, the @code{.sframe} section appears in a new segment of its own, PT_GNU_SFRAME. @@ -289,7 +289,7 @@ high-level function description for backtracing. @item 0x18 @tab @code{uint32_t sfh_freoff} @tab The offset in bytes of the SFrame FRE sub-section, the core of the SFrame -section, which describes the unwind information using variable-length array +section, which describes the stack trace information using variable-length array elements. @xref{SFrame Frame Row Entries}. @end multitable @@ -303,8 +303,9 @@ elements. @xref{SFrame Frame Row Entries}. @cindex SFrame ABI/arch identifier SFrame header identifies the ABI/arch of the target system for which the -executable and it's unwind information is intended. There are currently three -identifiable ABI/arch values in the format. +executable and hence, the stack trace information contained in the SFrame +section, is intended. There are currently three identifiable ABI/arch values +in the format. @multitable {SFRAME_ABI_AARCH64_ENDIAN_LITTLE} {Value} {@code{AARCH64 little-endian}} @headitem ABI/arch Identifier @tab Value @tab Description @@ -324,7 +325,7 @@ identifiable ABI/arch values in the format. @end multitable The presence of an explicit identification of ABI/arch in SFrame may allow -unwinders to make certain ABI-specific decisions. +stack trace generators to make certain ABI-specific decisions. @node SFrame Function Descriptor Entries @section SFrame FDE @@ -332,8 +333,8 @@ unwinders to make certain ABI-specific decisions. The SFrame Function Descriptor Entry sub-section is a sorted array of fixed-length SFrame function descriptor entries (SFrame FDEs). Each SFrame FDE -is a packed structure which contains information to describe a function's unwind -information at a high-level. +is a packed structure which contains information to describe a function's stack +trace information at a high-level. @example typedef struct sframe_func_desc_entry @@ -459,7 +460,7 @@ to look up a matching FRE. @subsection The SFrame FRE types A real world application can have functions of size big and small. SFrame -format defines three types of SFrame FRE entries to represent the unwind +format defines three types of SFrame FRE entries to represent the stack trace information for such a variety of function sizes. These representations vary in the number of bits needed to encode the start address offset in the SFrame FRE. @@ -488,21 +489,21 @@ The following constants are defined and used to identify the SFrame FRE types: 32-bit value. @end multitable -A single function must use the same type of FRE throughout. The choice of -which SFrame FRE is used to encode the unwind information of a function, is -stored in the @xref{The SFrame FDE info word}. +A single function must use the same type of SFrame FRE throughout. An +identifier to reflect the chosen SFrame FRE type is stored in the +@xref{The SFrame FDE info word}. @node SFrame Frame Row Entries @section SFrame FRE @cindex SFrame FRE -The SFrame Frame Row Entry sub-section contains the core of the unwind +The SFrame Frame Row Entry sub-section contains the core of the stack trace information. -An SFrame Frame Row Entry is a self-sufficient record containing SFrame unwind -info for a range of contiguous addresses, starting at the specified offset from -the start of the function. Each SFrame Frame Row Entry is followed by S*N -bytes, where: +An SFrame Frame Row Entry is a self-sufficient record containing SFrame stack +trace information for a range of contiguous addresses, starting at the +specified offset from the start of the function. Each SFrame Frame Row Entry +is followed by S*N bytes, where: @itemize @minus @item -- 2.39.0