From patchwork Fri May 26 07:01:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Indu Bhagat X-Patchwork-Id: 99317 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp276639vqr; Fri, 26 May 2023 00:04:16 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4Vm95PIg2kYyQI3f9apwFxF/pNA1sk9HdIqLpPMFsBPZ3KamIqI+LmM6dDF2xdMMVsRXSW X-Received: by 2002:a17:907:9345:b0:956:fbd7:bc5e with SMTP id bv5-20020a170907934500b00956fbd7bc5emr1087688ejc.64.1685084656051; Fri, 26 May 2023 00:04:16 -0700 (PDT) Received: from sourceware.org (server2.sourceware.org. [2620:52:3:1:0:246e:9693:128c]) by mx.google.com with ESMTPS id vm1-20020a170907b68100b00965a751e048si1428749ejc.373.2023.05.26.00.04.15 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 May 2023 00:04:16 -0700 (PDT) Received-SPF: pass (google.com: domain of binutils-bounces+ouuuleilei=gmail.com@sourceware.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) client-ip=2620:52:3:1:0:246e:9693:128c; Authentication-Results: mx.google.com; dkim=pass header.i=@sourceware.org header.s=default header.b=ctadMisp; arc=fail (signature failed); spf=pass (google.com: domain of binutils-bounces+ouuuleilei=gmail.com@sourceware.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) smtp.mailfrom="binutils-bounces+ouuuleilei=gmail.com@sourceware.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 8243A3882651 for ; Fri, 26 May 2023 07:02:53 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 8243A3882651 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1685084573; bh=OCYSpz115hZKTiXTKWbcVD8ZgJZHdDNDx6zLSZQRqk8=; h=To:Cc:Subject:Date:In-Reply-To:References:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From:Reply-To:From; b=ctadMispnFgHhxYP8oEWHnF6HpWoK51JEeiDb0Hqj+4Yb5pilK4459m6m/up6SBdy f1Q4/9H+mVN2KuTjmovUHs/Tssu3/oK/N3rPQr0VzxQSAkzbKdtnpO4rjeKE4GGGim 4hK6gyW1mDe7iUOdrdFzmQRXiIfEjtOzmNMRqKY8= X-Original-To: binutils@sourceware.org Delivered-To: binutils@sourceware.org Received: from mx0b-00069f02.pphosted.com (mx0b-00069f02.pphosted.com [205.220.177.32]) by sourceware.org (Postfix) with ESMTPS id 228533856DE7 for ; Fri, 26 May 2023 07:01:53 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 228533856DE7 Received: from pps.filterd (m0333520.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 34Q6nuTB011064 for ; Fri, 26 May 2023 07:01:52 GMT Received: from iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta01.appoci.oracle.com [130.35.100.223]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3qtquc80s7-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 26 May 2023 07:01:52 +0000 Received: from pps.filterd (iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 34Q5mSCd023798 for ; Fri, 26 May 2023 07:01:52 GMT Received: from nam10-bn7-obe.outbound.protection.outlook.com (mail-bn7nam10lp2101.outbound.protection.outlook.com [104.47.70.101]) by iadpaimrmta01.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 3qqk8y5jkx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 26 May 2023 07:01:51 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nqjc1cGFVBWLtGs3JX95o7hyDp86z6m/A0NFVQwPfZRcmTV1uZUNv/PPlD8cidjC06ARH7PjvsyWHQOguNaDzDAydGbT4xEPKGDcRRspU5IRNJTn85tUAfNc0AueeD67SGy1YoRZw3cdkCn+Q67/SDMliOj9ra1a0w3aU9HOnTqjTVDAPlXulHJ0VQqlgRWfHb3cddrjU1Wz6knbgRnKUapXJvbkBaJWaP5Quwi2aVoSyTpb4zPrLYVEiknzElGlqZ3uKTlSitXDWC4HcO0awe0UBlUwIGFoolgk3FPQcu9r+pUoqtP1Okir6AqHRHKR/0E5e5hWH32EL+nVTvNoRw== 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=OCYSpz115hZKTiXTKWbcVD8ZgJZHdDNDx6zLSZQRqk8=; b=EYNb2RxZP38bU83aCIUnn6YdCh5lECkJNcuYri9Um59jxEi+az6LgY6p9i6yxoK+ruVzzAQrpAC/ESnl2HlXxm6NlxjPnH6s8Vzrl2OxeXd7pOU3ahMSfGloL/Clf+1aOTmzyas46M3rNhWJWuT79kJI9nRCb5fwdZLFg6+zihYVZlV2BjR2Ylbu9WOsMU7EPvCU3luvKvUgJzNMtSPOnzbq/k97Mv8FtExsDdPuPaznUDuqwkWSIPFMKL4U0JkLK8jCGyKRp8TX9OOlxPiZ5YAggMi2bBbleVWbJdc771cqqQA764cafqzdZn5r+bX1umdlmvWndDu4ePSRL86R7A== 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 Received: from MWHPR1001MB2158.namprd10.prod.outlook.com (2603:10b6:301:2d::17) by PH7PR10MB5879.namprd10.prod.outlook.com (2603:10b6:510:130::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6433.17; Fri, 26 May 2023 07:01:49 +0000 Received: from MWHPR1001MB2158.namprd10.prod.outlook.com ([fe80::fdbb:b921:1ef:2d44]) by MWHPR1001MB2158.namprd10.prod.outlook.com ([fe80::fdbb:b921:1ef:2d44%4]) with mapi id 15.20.6411.025; Fri, 26 May 2023 07:01:49 +0000 To: binutils@sourceware.org Cc: Indu Bhagat Subject: [COMMITTED] sframe/doc: minor improvements for readability Date: Fri, 26 May 2023 00:01:32 -0700 Message-Id: <20230526070132.4185600-4-indu.bhagat@oracle.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230526070132.4185600-1-indu.bhagat@oracle.com> References: <20230526070132.4185600-1-indu.bhagat@oracle.com> X-ClientProxiedBy: BYAPR02CA0049.namprd02.prod.outlook.com (2603:10b6:a03:54::26) To MWHPR1001MB2158.namprd10.prod.outlook.com (2603:10b6:301:2d::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: MWHPR1001MB2158:EE_|PH7PR10MB5879:EE_ X-MS-Office365-Filtering-Correlation-Id: e4c05f31-6d77-44b1-2ed9-08db5db713df X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: AWWg74JRrEzfdCtdic9niFL1VIyarUKTFqRpm/pq87E9/bRSmw4keuXJQW/bQWoAla7RXgd626dhu7+1VafHBFRE8YQ5WXhluu6d9qK+H+vxdqoSUMpqEelVVpFzcsLZkEPo1ExLPcMbGyIT6sqDS+MkLNczgELQlDaTw5hWQBqWNDIMB/Tn2BWgaVPEtn//kgoMjxzPjVhC9JN5xxcudAuPfo564vw1Ept9hSD9wsKxxWUwy19qPRx8YRWbyPUhqWwIOo86voLm2eUfdxKhpw9KZ/Jw5zTjjD3gwW/0kMOeOwsJmP8r94MwcNoxSj8HsTvF9gAnXVoRho0yApq8eMJ2M7e+DsIjZCWA4rHvrnf955pBK4sR/Bejfc21fn3YdDgdXveUyh++cadyyYfk9H9FQhhjK4k2dvT96ocBL81x614nGmP+KgU40AppDitQzLrTYvkeR6AW07GHSFJOz2eQ7D1Lu9WLGw4mGP9zzWkF9PRxd2SimUQa1axzgdF5eU0grd1phIQTZQijYujazkmovzMAnp1WqIv/Mk/GePkMGML8uSZr3Z5UQ75Jh6eg 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:(13230028)(376002)(136003)(396003)(39860400002)(366004)(346002)(451199021)(4326008)(316002)(41300700001)(86362001)(6486002)(36756003)(66476007)(5660300002)(8676002)(66946007)(6916009)(66556008)(8936002)(6666004)(44832011)(2906002)(478600001)(186003)(2616005)(38100700002)(83380400001)(107886003)(26005)(6506007)(6512007)(1076003); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: CA0DHZn8UaFP3v7KvSCuvNGA0A87Iboxf3OWeYCYD0pVMDQU5RIf43SVm5YFSEEZXfwm3atWAobmbOWE9NRXs6LOB6FiQSD73yYAVJU79oAPqrkSV+0YpELUNsFRYlmVuZTxmixfVgSx23kuiASQ4xrdvxj1GDVjEBHjeHNkfVZBIbiEwB34Npe47F4ZgFAc0HviubeR5x3tfHh6KM5ZLBIXg6bjDBcsRxaPPgkMfuabUYdLB0E7hq2XlZ6Chkrdo29Kesy7qgs69ZHsgMcIgPMK76EemGdJNFtnEwEwsEBBy9T5fFNBSGUXGluEwOAG4uDgnrVo/FiP7u93mGyE9pDsfhjlSBwPkMReKarJpiKCEmRN12lXqnxKXssV01C8C1XH3m9NSpitySf3fQKwOdw84T5isPXqSyvuXI1HyCqkJYE/nX7QgmL0THOtOyNx8ZnVKrPHSc6B5sgniIBKrbbNrErg/G1cPWnUG29EZOO/mCbNAshX6GMrUIXkTUzhxHahb4hLmYmQntG5JKaDqnlY/ziNhitfl08RN2n3cwanEtnotmv37MarITefHyM3HtZV6A6/jHg7VXC6r3RikJCA7bVg2zR1qtuuP5SmTCOPCBde7qoCljSPguQhDAGCNSBWJUX6KMzB5B9spo712KhnqXVyg2kh52Gs4O1IlKRPtc/0MmgFpxqo+UJEuGYZxp+B4FSI6M99N3lpgiMvp5LrzPmX35wRKGcB2wMkYGKC9RLXILnACHv+R8i5tXkqljmO1JJrN1SNenKBOpLWKyJiesR+6PvaARk2yvXRFUHDf7Bd9NSUCxxl+enQ4XxOECNnM4p15XbYkGN4sXtGfn0RqN6m8/6elJnH/f9OJXb0hIm+XJFLqrL9N/h8Y+RMvlPGFI11utR5UiAC2ntfseADhiKAFcyjr+JcokgHNh4jqK6HgUB2JHQyE7SI5vmzgvJakPOJyzlYoC8QFdrGl+easbPMlTAmm3No7fuyW6CWFc6hKZcfxBlF2EEAWeooiXZR0y2GA6Ufsopijo6jw+s/OArPIW46OrpVf9aFUTZ2Sa4U4XXoenZr+p0o7ZAfzANnDFJxGuHUaeeENgm81Uv1Y+3fn549M7cehrgZbSeedXfSaORHo7/TO1bUKhiTog3FeN9w3m5liJe7tb5k8kSuK8CnDBMr2Ih8orQDqR03Os+m76g66XxgZ5qKC2B+mZbhnYgRLkRSs+/wPRRdF1jmVzkKsBsspNDxIwTWK/aw8qUjGnWblAUU0SJBtthWpRdWkXucM2KmE6mTPzSmBSSVAfY7X/WQvRh+bU9BQVAIKLxyZDLrPicgZi0BjTitVJ3ZMGrcsmC+8mnOro1wZh8s2F4npTHFLlaTLHr01E3dLA/wxOTfj3IF0WUUV9fNVH/7QCESRyvkDsgaApIMwzVcWVJhDZn3AhTvesC7nu+3yg2vVsb3M0vNfR8dhbimKXzBDGdqWh61dM/mJLuG+p3D+NBtDwfEQIY0IUBTo3LSPVU99Ep6kVekbLgu+w7vgjJ5tnj2IbO/ft9qlaqYOkETrYj7IrbeUUwz8ywLP0hOcufIvnhilO3fVLFu3G67 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: Bz1wkhpNGeQmGUeXRJVVyiMzcwrhSuDAYZSCFYLazo0WnUzViAChgIG+GieV9dM1/HnGhXUuyeqddja+cOeyI27sWaYWOHcJwBP+8yFSFzt8/MIjpWfL0/3MFPWj4oDncqAXyBFThLnJKEG1EWAVf3b/VSlka15O1eMhYxfKA0qfM56jO9y5f5FnjlJkZlHBEebieGyebk/t2x+vOE0E+2En6mIpQhptLf/dhgFP3iCyF8njio4v3BWMLTPDGtubeAytift3j2KnIisIUNqj9QE3vO4eDBcfmjHkaHBGQjV/6evHnrs62NSwMgMdN7QUy4M/lsKDGIwIWKJ8AEfFpS0EI+rFWAKVPUvwt+fu7afD1fY01plEv1wNs8pccXlEf7Nyb7ikXI8LnRG35jr7Res3mUZAqhytmIWDt0lX5Acv1JSs2fGEXop+SvU/na371enPMV3DUja6jVWN50SYAd9gauO7m2p9mGAwGtywA46CNj6cEc24BA87StHxDkuHyFFT71XPsbaSKvxZkalmwkJVqLcmZnD0Bvmoh9Hv6ZFSAqtxenFklj0F16gc+nLeaVUZV0w93KivDWqpKRf1e8IuOO/aFwtEOUvcrrj47+id7ryIeizFdGElWjcxrrvfstO9VGZwDiZugA+tt4l/iG9ah3ZhPHtTWmXxMbSuLwKvLmfv8jsDYbrHnyxW+Z7Ue/+8wiE/iQXkEAfiBlbIVMU1CRZ+Hw4RBeIQLAOnaAKD7gmHvFCRIaQM4tN5G47U X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-Network-Message-Id: e4c05f31-6d77-44b1-2ed9-08db5db713df X-MS-Exchange-CrossTenant-AuthSource: MWHPR1001MB2158.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 26 May 2023 07:01:49.8694 (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: SY43AWlVA5hDUpRAAkOL76Ii+gJow1lVfuNXhPb5CoCIUdW0FTKNLC3UGhZCeilbHRS64YZyiGJO6Til50/fsw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR10MB5879 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.957,Hydra:6.0.573,FMLib:17.11.176.26 definitions=2023-05-26_01,2023-05-25_03,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 adultscore=0 phishscore=0 mlxscore=0 mlxlogscore=350 bulkscore=0 malwarescore=0 suspectscore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2304280000 definitions=main-2305260058 X-Proofpoint-ORIG-GUID: XpUfqCgXXkUJYuzme_nxiKrH8umhWoO4 X-Proofpoint-GUID: XpUfqCgXXkUJYuzme_nxiKrH8umhWoO4 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_H5, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: binutils@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Binutils mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Indu Bhagat via Binutils From: Indu Bhagat Reply-To: Indu Bhagat Errors-To: binutils-bounces+ouuuleilei=gmail.com@sourceware.org Sender: "Binutils" X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1766939328227615284?= X-GMAIL-MSGID: =?utf-8?q?1766939328227615284?= libsframe/ * sframe-spec.texi: Cosmetic fixes. --- libsframe/doc/sframe-spec.texi | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/libsframe/doc/sframe-spec.texi b/libsframe/doc/sframe-spec.texi index 6987b6fee13..5155410bdc8 100644 --- a/libsframe/doc/sframe-spec.texi +++ b/libsframe/doc/sframe-spec.texi @@ -46,8 +46,8 @@ Frame Pointer (FP). Return Address (RA). @end itemize -The reason for existence of the SFrame format is to support fast, online -generation of stack traces using simple means. +The reason for existence of the SFrame format is to provide a simple, fast and +low-overhead mechanism to generate stack traces. @menu * Overview:: @@ -81,7 +81,7 @@ The associated API to decode, probe and encode the SFrame section, provided via later. This document is intended to be in sync with the C code in @file{sframe.h}. -Please report descrepancies between the two, if any. +Please report discrepancies between the two, if any. @node SFrame section @chapter SFrame section @@ -234,14 +234,14 @@ of the return address is @code{CFA - 8}. Since this offset is in close vicinity with the CFA in most ABIs, @code{sfh_cfa_fixed_fp_offset} and @code{sfh_cfa_fixed_ra_offset} are limited to signed 8-bit integers. -SFrame format has provisioned for future ABIs/architectures that it may -support. The @code{sframe_header} structure provides an unsigned 8-bit -integral field to denote the size of an auxilliary SFrame header. The -auxilliary SFrame header follows right after the @code{sframe_header} +SFrame format has made some provisions for supporting more ABIs/architectures +in the future. The @code{sframe_header} structure provides an unsigned 8-bit +integral field to denote the size of an auxiliary SFrame header. The +auxiliary SFrame header follows right after the @code{sframe_header} structure. As for the offset calculations, the @emph{end} of SFrame header -must be the end of the auxilliary SFrame header, if the latter is present. +must be the end of the auxiliary SFrame header, if the latter is present. -Tieing it all together: +Putting it all together: @multitable {Offset} {@code{int8_t sfh_cfa_fixed_fp_offset}} {The number of SFrame FREs in the section.} @headitem Offset @tab Name @tab Description @@ -263,7 +263,7 @@ Tieing it all together: @item 0x07 @tab @code{uint8_t sfh_auxhdr_len} -@tab Size in bytes of the auxilliary header that follows the +@tab Size in bytes of the auxiliary header that follows the @code{sframe_header} structure. @item 0x08