Received: by 2002:a25:4158:0:0:0:0:0 with SMTP id o85csp5144177yba; Wed, 8 May 2019 08:32:46 -0700 (PDT) X-Google-Smtp-Source: APXvYqwXkeN9GAtmiVfPOzxMzHBMLiXcX7NZDNiOQz/T2/bJVGygrQ7HWEWJfnxLHW7bBV7Dx90a X-Received: by 2002:a62:56d9:: with SMTP id h86mr40611801pfj.195.1557329566525; Wed, 08 May 2019 08:32:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1557329566; cv=none; d=google.com; s=arc-20160816; b=h2SCSyNsN6fS7sl/rhqbPjC7ycAl/81RGjOzPtE5HhCj1rX8icxMOMSg61sg4/FY9/ C5hVIM4H2sQudt79KQER3o5cYXcS09HqBXFlOBXhCo2+DXimS/KTXD8tyO9Egdtc/TlP mi0dCvzegBFxkdCjcCgG45E757puP+fHXH0BMzw+emH4xcYdXftHCnTvSuhy2ypzvS1J +9E7e5Dw1/OLG+aAPTn0UCHzygnm3qzwZc5Z/vfh+JlfrzuzKvuQ9WaXOoDdjWKDrSWf QnCSBZNDgbRdnJY3rEP1aOV45d1XqvqtZaDeu4eoLxhJHU/yd3wZcGyDXBRqnIrgiY5F d+YA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=24w4jqgdtlrA7O2xMmJS0tVlbeaBr/Rj015fWFSNbZI=; b=pn/RUmdzWwe9XpL5RPrbCXYC7qWqEzcedxykGajAGOsQnbO3isBXMBUGWskr1aHxgU O3Xp7KlamE4RxwcEJbz8Uiabhsk06Yap7XHp87buX30opWYRXQNpiAv1+SpDdCZX+j2u ksRd+/F02qlruAY3knDrw4dfYF1xohV8KkPZ8fw3OUjAI+gahQjtbJHuqOxzNz8drmYi qvzYmNrd3nMl2D3UrWhsTQRGPcP7zffnVqDWyT9W0AXb7QFCWlVRJsEjeE5ZjOUr++2E zr+6o3p5S0/xqnJ7P4TKvfa0vfUvcij4uNjueBLIh69zS3DbryOpgP9aLYmZy767Ih7c vvJQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b="rH/qiAZi"; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id x32si24445030pld.16.2019.05.08.08.32.30; Wed, 08 May 2019 08:32:46 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b="rH/qiAZi"; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728349AbfEHPX6 (ORCPT + 99 others); Wed, 8 May 2019 11:23:58 -0400 Received: from mail-pf1-f193.google.com ([209.85.210.193]:36167 "EHLO mail-pf1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727025AbfEHPX4 (ORCPT ); Wed, 8 May 2019 11:23:56 -0400 Received: by mail-pf1-f193.google.com with SMTP id v80so10673730pfa.3; Wed, 08 May 2019 08:23:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=24w4jqgdtlrA7O2xMmJS0tVlbeaBr/Rj015fWFSNbZI=; b=rH/qiAZi+JW6v0WAgwiNnAU9FVpDQhmGGaVkHmDmoHZMKmEJa0owtTK9gQfUVfg5JL FjCb+zy3YpkbTFDO9UshwWjZZAdBUnURec78lF7byRFp8nUNdk2PxzSXIeT99rRfrvFP at1rxkvcAxbMeZvHasM0Fb1QFCiqE3oEnEie8iDu67b+GLrocM7Y5MJVgdWX6bJXd+pC Kt6MG1HzEXTXsLMNa+c68umSgwxC4XI8XrzzgvEgig4ScCm65MsmFccb65ciBkQGXUq2 4wfg/jRTZa+6/capUnaVs/3JsmTbjmc+YfQUK+k8tx6YW/z3q1gltnHPUJ+ibecnsSjY 4yvw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=24w4jqgdtlrA7O2xMmJS0tVlbeaBr/Rj015fWFSNbZI=; b=qdLx+BGQ8+IIODBQ6wyI99i53y0pnJKMcGdx51+yVLosLVvAdmx0Lq4WHTtMTbCkgR HMNVqiZkO9xUwI2XRVajcdiisAgcwpeib5/O7L7i/Gf7N4QZ9Qzf6OOKTyBi+O0UBUWs P16+F1h5lkEtQomNA7/NdJJyG8LZhod+pmh1j1i8HJsCqAvNdYNtiYQSpJwYUpXoq4WJ gBF4EWBCzDgLXxYEmLMgcfsc0HWfcsaI0cNeRrzGGBwQbLDVITIOlzuL3g59gZeJGQ7p 1QzuX0cNydVtOtuFyuTgd6TD+tQHCiws7WthTh/jrPiE/ICu3xsBHrH/bPyVpp33jN21 Dlgg== X-Gm-Message-State: APjAAAVyshJU5ZsoxmO9kjz65gTgn9IkmGfhFhfFZCwRIKJ/u57+WYXd EOcTIOTQdvGIF91+TwKzQbQ30RE0 X-Received: by 2002:aa7:8493:: with SMTP id u19mr30699550pfn.233.1557329035776; Wed, 08 May 2019 08:23:55 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id o73sm7459360pfi.137.2019.05.08.08.23.50 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Wed, 08 May 2019 08:23:55 -0700 (PDT) From: Changbin Du To: corbet@lwn.net, tglx@linutronix.de, mingo@redhat.com, bp@alien8.de Cc: x86@kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Changbin Du , Mauro Carvalho Chehab Subject: [PATCH v4 18/27] Documentation: x86: convert orc-unwinder.txt to reST Date: Wed, 8 May 2019 23:21:32 +0800 Message-Id: <20190508152141.8740-19-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190508152141.8740-1-changbin.du@gmail.com> References: <20190508152141.8740-1-changbin.du@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du Reviewed-by: Mauro Carvalho Chehab --- Documentation/x86/index.rst | 1 + .../{orc-unwinder.txt => orc-unwinder.rst} | 27 ++++++++++--------- 2 files changed, 16 insertions(+), 12 deletions(-) rename Documentation/x86/{orc-unwinder.txt => orc-unwinder.rst} (93%) diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst index 6e3c887a0c3b..453557097743 100644 --- a/Documentation/x86/index.rst +++ b/Documentation/x86/index.rst @@ -14,6 +14,7 @@ x86-specific Documentation kernel-stacks entry_64 earlyprintk + orc-unwinder zero-page tlb mtrr diff --git a/Documentation/x86/orc-unwinder.txt b/Documentation/x86/orc-unwinder.rst similarity index 93% rename from Documentation/x86/orc-unwinder.txt rename to Documentation/x86/orc-unwinder.rst index cd4b29be29af..d811576c1f3e 100644 --- a/Documentation/x86/orc-unwinder.txt +++ b/Documentation/x86/orc-unwinder.rst @@ -1,8 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============ ORC unwinder ============ Overview --------- +======== The kernel CONFIG_UNWINDER_ORC option enables the ORC unwinder, which is similar in concept to a DWARF unwinder. The difference is that the @@ -23,12 +26,12 @@ correlate instruction addresses with their stack states at run time. ORC vs frame pointers ---------------------- +===================== With frame pointers enabled, GCC adds instrumentation code to every function in the kernel. The kernel's .text size increases by about 3.2%, resulting in a broad kernel-wide slowdown. Measurements by Mel -Gorman [1] have shown a slowdown of 5-10% for some workloads. +Gorman [1]_ have shown a slowdown of 5-10% for some workloads. In contrast, the ORC unwinder has no effect on text size or runtime performance, because the debuginfo is out of band. So if you disable @@ -55,7 +58,7 @@ depending on the kernel config. ORC vs DWARF ------------- +============ ORC debuginfo's advantage over DWARF itself is that it's much simpler. It gets rid of the complex DWARF CFI state machine and also gets rid of @@ -65,7 +68,7 @@ mission critical oops code. The simpler debuginfo format also enables the unwinder to be much faster than DWARF, which is important for perf and lockdep. In a basic -performance test by Jiri Slaby [2], the ORC unwinder was about 20x +performance test by Jiri Slaby [2]_, the ORC unwinder was about 20x faster than an out-of-tree DWARF unwinder. (Note: That measurement was taken before some performance tweaks were added, which doubled performance, so the speedup over DWARF may be closer to 40x.) @@ -85,7 +88,7 @@ still be able to control the format, e.g. no complex state machines. ORC unwind table generation ---------------------------- +=========================== The ORC data is generated by objtool. With the existing compile-time stack metadata validation feature, objtool already follows all code @@ -133,7 +136,7 @@ objtool follows GCC code quite well. Unwinder implementation details -------------------------------- +=============================== Objtool generates the ORC data by integrating with the compile-time stack metadata validation feature, which is described in detail in @@ -154,7 +157,7 @@ subset of the table needs to be searched. Etymology ---------- +========= Orcs, fearsome creatures of medieval folklore, are the Dwarves' natural enemies. Similarly, the ORC unwinder was created in opposition to the @@ -162,7 +165,7 @@ complexity and slowness of DWARF. "Although Orcs rarely consider multiple solutions to a problem, they do excel at getting things done because they are creatures of action, not -thought." [3] Similarly, unlike the esoteric DWARF unwinder, the +thought." [3]_ Similarly, unlike the esoteric DWARF unwinder, the veracious ORC unwinder wastes no time or siloconic effort decoding variable-length zero-extended unsigned-integer byte-coded state-machine-based debug information entries. @@ -174,6 +177,6 @@ brutal, unyielding efficiency. ORC stands for Oops Rewind Capability. -[1] https://lkml.kernel.org/r/20170602104048.jkkzssljsompjdwy@suse.de -[2] https://lkml.kernel.org/r/d2ca5435-6386-29b8-db87-7f227c2b713a@suse.cz -[3] http://dustin.wikidot.com/half-orcs-and-orcs +.. [1] https://lkml.kernel.org/r/20170602104048.jkkzssljsompjdwy@suse.de +.. [2] https://lkml.kernel.org/r/d2ca5435-6386-29b8-db87-7f227c2b713a@suse.cz +.. [3] http://dustin.wikidot.com/half-orcs-and-orcs -- 2.20.1