summaryrefslogtreecommitdiff
path: root/lldb/docs
diff options
context:
space:
mode:
authorWalter Erquinigo <wallace@fb.com>2022-06-14 15:53:59 -0700
committerWalter Erquinigo <wallace@fb.com>2022-06-16 11:42:22 -0700
commit6a5355e8a159bd9c058d4fbba2a87e0465fe0dc7 (patch)
treecc9193e1fdc61643f6c19a013d4fbfa124086287 /lldb/docs
parent67c24051450116c2c633e8a2740c08cf904e1605 (diff)
downloadllvm-6a5355e8a159bd9c058d4fbba2a87e0465fe0dc7.tar.gz
[trace][intelpt] Support system-wide tracing [20] - Rename some fields in the schema
As discusses offline with @jj10305, we are updating some naming used throughout the code, specially in the json schema - traceBuffer -> iptTrace - core -> cpu Differential Revision: https://reviews.llvm.org/D127817
Diffstat (limited to 'lldb/docs')
-rw-r--r--lldb/docs/lldb-gdb-remote.txt31
-rw-r--r--lldb/docs/use/intel_pt.rst2
2 files changed, 14 insertions, 19 deletions
diff --git a/lldb/docs/lldb-gdb-remote.txt b/lldb/docs/lldb-gdb-remote.txt
index 4a06964c30ca..4f0cfa4585b0 100644
--- a/lldb/docs/lldb-gdb-remote.txt
+++ b/lldb/docs/lldb-gdb-remote.txt
@@ -308,13 +308,14 @@ read packet: {"name":<name>, "description":<description>}/E<error code>;AAAAAAAA
// might result in less data available for less frequent threads. See
// "perCoreTracing" below for more information.
//
-// Each actual trace buffer, either from "process tracing" or "thread tracing",
-// is stored in an in-memory circular buffer, which keeps the most recent data.
+// Each actual intel pt trace buffer, either from "process tracing" or "thread
+// tracing", is stored in an in-memory circular buffer, which keeps the most
+// recent data.
//
// Additional params in the input schema:
// {
-// "traceBufferSize": <decimal integer>,
-// Size in bytes used by each individual per-thread or per-core trace
+// "iptTraceSize": <decimal integer>,
+// Size in bytes used by each individual per-thread or per-cpu trace
// buffer. It must be a power of 2 greater than or equal to 4096 (2^12)
// bytes.
//
@@ -369,7 +370,7 @@ read packet: {"name":<name>, "description":<description>}/E<error code>;AAAAAAAA
// /* process tracing only */
// "processBufferSizeLimit": <decimal integer>,
// Maximum total buffer size per process in bytes.
-// This limit applies to the sum of the sizes of all thread or core
+// This limit applies to the sum of the sizes of all thread or cpu core
// buffers for the current process, excluding the ones started with
// "thread tracing".
//
@@ -482,7 +483,7 @@ read packet: OK/E<error code>;AAAAAAAAA
// Size in bytes of this thread data.
// },
// ],
-// "cores"?: [
+// "cpus"?: [
// "id": <decimal integer>,
// Identifier for this CPU logical core.
// "binaryData": [
@@ -507,15 +508,15 @@ read packet: OK/E<error code>;AAAAAAAAA
//
// INTEL PT
//
-// If per-core process tracing is enabled, "tracedThreads" will contain all
+// If per-cpu process tracing is enabled, "tracedThreads" will contain all
// the threads of the process without any trace buffers. Besides that, the
-// "cores" field will also be returned with per core trace buffers.
-// A side effect of per-core tracing is that all the threads of unrelated
+// "cpus" field will also be returned with per cpu core trace buffers.
+// A side effect of per-cpu tracing is that all the threads of unrelated
// processes will also be traced, thus polluting the tracing data.
//
// Binary data kinds:
-// - traceBuffer: trace buffer for a thread or a core.
-// - perfContextSwitchTrace: context switch trace for a core generated by
+// - iptTrace: trace buffer for a thread or a cpu.
+// - perfContextSwitchTrace: context switch trace for a cpu generated by
// perf_event_open.
// - procfsCpuInfo: contents of the /proc/cpuinfo file.
//
@@ -558,17 +559,11 @@ read packet: {...object}/E<error code>;AAAAAAAAA
// Tracing technology name, e.g. intel-pt, arm-etm.
// "kind": <string>,
// Identifier for the data.
-// "coreId": <Optional decimal>,
+// "cpuId": <Optional decimal>,
// Core id in decimal if the data belongs to a CPU core.
// "tid"?: <Optional decimal>,
// Tid in decimal if the data belongs to a thread.
// }
-//
-// INTEL PT
-//
-// Binary data kinds:
-// - traceBuffer: trace buffer for a thread or a core.
-// - procfsCpuInfo: contents of the /proc/cpuinfo file.
//----------------------------------------------------------------------
send packet: jLLDBTraceGetBinaryData:{"type":<type>,"kind":<query>,"tid":<tid>,"offset":<offset>,"size":<size>}]
diff --git a/lldb/docs/use/intel_pt.rst b/lldb/docs/use/intel_pt.rst
index ae6f72011ace..3d615e30f99e 100644
--- a/lldb/docs/use/intel_pt.rst
+++ b/lldb/docs/use/intel_pt.rst
@@ -196,7 +196,7 @@ For example
"threads": [
{
"tid": 815455,
- "traceBuffer": "trace.file" # raw thread-specific trace from the AUX buffer
+ "iptTrace": "trace.file" # raw thread-specific trace from the AUX buffer
}
],
"modules": [ # this are all the shared libraries + the main executable