README_zh.md · 王洋/developtools_bytrace

# bytrace组件<a name="ZH-CN_TOPIC_0000001102209942"></a>

-   [简介](#section152771918494)
-   [架构图](#section6808195518497)
-   [目录](#section1610792125019)
-   [说明](#section18684185975017)
-   [相关仓](#section1849151125618)

## 简介<a name="section152771918494"></a>

bytrace是开发人员用于追踪进程轨迹、查看性能的一种工具，主要对内核ftrace进行了封装和扩展，来支持用户态的打点。该工具主要分为两部分，API和命令行：

1.  bytrace向应用开发人员暴露了打点的API，开发应用过程中可以在关键代码处调用对应API进行打点；
2.  命令行部分通过使能对应的label，来获取打点信息。通过该工具可以打开想要查看的用户态和内核label（通过命令行“bytrace -l”，查看支持的所有label），然后通过命令行进行抓取trace信息到指定文件中，下文有具体使用指导。

## 架构图<a name="section6808195518497"></a>

![](figures/architecture_zh.png)

## 目录<a name="section1610792125019"></a>

```
/developtools/bytrace
├── bin           # bytrace组件代码目录 
│   └── include   # 头文件目录
│   └── src       # 源文件目录
│   └── test      # 测试用例目录
├── interfaces    # 对外接口存放目录
│   └── innerkits # 对内部子系统暴露的头文件存放目录
│   └── kits      # 对外部暴露的头文件存放目录
├── script        # 脚本目录
```

## 说明<a name="section18684185975017"></a>

使用说明

bytrace当前支持如下命令：

**表 1**  命令行列表

<a name="table16802195914247"></a>
<table><thead align="left"><tr id="row14804759142412"><th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.1"><a name="p1280465972411"></a><a name="p1280465972411"></a>Option
</th>
<th class="cellrowborder" valign="top" width="50%" id="mcps1.2.3.1.2"><a name="p380414595249"></a><a name="p380414595249"></a>Description
</th>
</tr>
</thead>
<tbody><tr id="row1714512123414"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1915412133419"></a><a name="p1915412133419"></a>-h，--help
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p6156126341"></a><a name="p6156126341"></a>查看option帮助
</td>
</tr>
<tr id="row13804135982416"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p18051959152410"></a><a name="p18051959152410"></a>-b <a name="i35979186184"></a><a name="i35979186184"></a>n，--buffer_size <a name="i144491624181811"></a><a name="i144491624181811"></a>n
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p0805165932419"></a><a name="p0805165932419"></a>指定<a name="i134241333181817"></a><a name="i134241333181817"></a>n(KB)内存大小用于存取trace日志，默认2048KB
</td>
</tr>
<tr id="row580519592245"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p880510591241"></a><a name="p880510591241"></a>-t <a name="i8668143912203"></a><a name="i8668143912203"></a>n，--time <a name="i841433614202"></a><a name="i841433614202"></a>n
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p1480517591245"></a><a name="p1480517591245"></a>用来指定trace运行的时间（单位：s），取决于需要分析过程的时间
</td>
</tr>
<tr id="row4806175913247"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p980655912242"></a><a name="p980655912242"></a>--trace_clock <a name="i19464452217"></a><a name="i19464452217"></a>clock
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p11806959142416"></a><a name="p11806959142416"></a>trace输出的时钟类型，一般设备支持boot、global、mono、uptime、perf等，默认为boot
</td>
</tr>
<tr id="row1280635917242"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p180715591244"></a><a name="p180715591244"></a>--trace_begin
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p480795916243"></a><a name="p480795916243"></a>启动抓trace
</td>
</tr>
<tr id="row1580717599245"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p38073598242"></a><a name="p38073598242"></a>--trace_dump
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p148077595245"></a><a name="p148077595245"></a>将数据输出到指定位置（默认控制台）
</td>
</tr>
<tr id="row180811592242"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p11808165922419"></a><a name="p11808165922419"></a>--trace_finish
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p18809559182420"></a><a name="p18809559182420"></a>停止抓trace，并将数据输出到指定位置（默认控制台）
</td>
</tr>
<tr id="row2809185972420"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p2080925922418"></a><a name="p2080925922418"></a>-l，--list_categories
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p38091159142414"></a><a name="p38091159142414"></a>输出手机能支持的trace模块
</td>
</tr>
<tr id="row1880912598248"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p1681014595244"></a><a name="p1681014595244"></a>--overwrite
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p12810165914248"></a><a name="p12810165914248"></a>当缓冲区满的时候，将丢弃最新的信息。（默认丢弃最老的日志）
</td>
</tr>
<tr id="row1181015992414"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p168101859152415"></a><a name="p168101859152415"></a>-o <a name="i1367232742113"></a><a name="i1367232742113"></a>filename，--output <a name="i4305133012219"></a><a name="i4305133012219"></a>filename
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p9810559132410"></a><a name="p9810559132410"></a>指定输出的目标文件名称
</td>
</tr>
<tr id="row8810155982415"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.1 "><a name="p381145912410"></a><a name="p381145912410"></a>-z
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.2.3.1.2 "><a name="p1281117592249"></a><a name="p1281117592249"></a>抓取trace后进行压缩
</td>
</tr>
</tbody>
</table>

以下是常用bytrace命令示例，供开发者参考：

-   查询支持的label。

```
    bytrace -l
    ```

或者

```
    bytrace --list_categories
    ```

-   设置4M缓存，抓取10秒，抓取label为ability的trace信息。

```
    bytrace -b 4096 -t 10 --overwrite ability > /data/mytrace.ftrace
    ```

-   设置trace的输出时钟为mono。

```
    bytrace --trace_clock mono  -b 4096 -t 10 --overwrite ability > /data/mytrace.ftrace
    ```

-   抓取trace后进行压缩。

```
    bytrace -z  -b 4096 -t 10 --overwrite ability > /data/mytrace.ftrace
    ```

## 相关仓<a name="section1849151125618"></a>

研发工具链子系统

**developtools\_bytrace\_standard**

王洋/developtools_bytrace

简介

发行版

贡献者

近期动态

王洋/developtools_bytrace .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

王洋/developtools_bytrace