1d9f0492fSopenharmony_ci/*
2d9f0492fSopenharmony_ci * Copyright (C) 2023 Huawei Device Co., Ltd.
3d9f0492fSopenharmony_ci * Licensed under the Apache License, Version 2.0 (the "License");
4d9f0492fSopenharmony_ci * you may not use this file except in compliance with the License.
5d9f0492fSopenharmony_ci * You may obtain a copy of the License at
6d9f0492fSopenharmony_ci *
7d9f0492fSopenharmony_ci *     http://www.apache.org/licenses/LICENSE-2.0
8d9f0492fSopenharmony_ci *
9d9f0492fSopenharmony_ci * Unless required by applicable law or agreed to in writing, software
10d9f0492fSopenharmony_ci * distributed under the License is distributed on an "AS IS" BASIS,
11d9f0492fSopenharmony_ci * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12d9f0492fSopenharmony_ci * See the License for the specific language governing permissions and
13d9f0492fSopenharmony_ci * limitations under the License.
14d9f0492fSopenharmony_ci */
15d9f0492fSopenharmony_ci#include <errno.h>
16d9f0492fSopenharmony_ci#include <inttypes.h>
17d9f0492fSopenharmony_ci#include <limits.h>
18d9f0492fSopenharmony_ci#include <fcntl.h>
19d9f0492fSopenharmony_ci#include <pthread.h>
20d9f0492fSopenharmony_ci#include <stdio.h>
21d9f0492fSopenharmony_ci#include <stdlib.h>
22d9f0492fSopenharmony_ci#include <stdbool.h>
23d9f0492fSopenharmony_ci#include <string.h>
24d9f0492fSopenharmony_ci#include <unistd.h>
25d9f0492fSopenharmony_ci#include <zlib.h>
26d9f0492fSopenharmony_ci
27d9f0492fSopenharmony_ci#include <sys/stat.h>
28d9f0492fSopenharmony_ci#include <sys/types.h>
29d9f0492fSopenharmony_ci
30d9f0492fSopenharmony_ci#include "cJSON.h"
31d9f0492fSopenharmony_ci#include "init_module_engine.h"
32d9f0492fSopenharmony_ci#include "init_param.h"
33d9f0492fSopenharmony_ci#include "init_utils.h"
34d9f0492fSopenharmony_ci#include "plugin_adapter.h"
35d9f0492fSopenharmony_ci#include "securec.h"
36d9f0492fSopenharmony_ci
37d9f0492fSopenharmony_ci#define MAX_SYS_FILES 11
38d9f0492fSopenharmony_ci#define CHUNK_SIZE 65536
39d9f0492fSopenharmony_ci#define BLOCK_SIZE 4096
40d9f0492fSopenharmony_ci#define WAIT_MILLISECONDS 10
41d9f0492fSopenharmony_ci#define BUFFER_SIZE_KB 10240  // 10M
42d9f0492fSopenharmony_ci
43d9f0492fSopenharmony_ci#define TRACE_CFG_KERNEL "KERNEL"
44d9f0492fSopenharmony_ci#define TRACE_CFG_USER "USER"
45d9f0492fSopenharmony_ci#define TRACE_TAG_PARAMETER "debug.hitrace.tags.enableflags"
46d9f0492fSopenharmony_ci#define TRACE_DEBUG_FS_PATH "/sys/kernel/debug/tracing/"
47d9f0492fSopenharmony_ci#define TRACE_FS_PATH "/sys/kernel/tracing/"
48d9f0492fSopenharmony_ci#define TRACE_CFG_PATH STARTUP_INIT_UT_PATH"/system/etc/init_trace.cfg"
49d9f0492fSopenharmony_ci#define TRACE_OUTPUT_PATH "/data/service/el0/startup/init/init_trace.log"
50d9f0492fSopenharmony_ci#define TRACE_OUTPUT_PATH_ZIP "/data/service/el0/startup/init/init_trace.zip"
51d9f0492fSopenharmony_ci
52d9f0492fSopenharmony_ci#define TRACE_CMD "ohos.servicectrl.init_trace"
53d9f0492fSopenharmony_ci
54d9f0492fSopenharmony_ci// various operating paths of ftrace
55d9f0492fSopenharmony_ci#define TRACING_ON_PATH "tracing_on"
56d9f0492fSopenharmony_ci#define TRACE_PATH "trace"
57d9f0492fSopenharmony_ci#define TRACE_MARKER_PATH "trace_marker"
58d9f0492fSopenharmony_ci#define TRACE_CURRENT_TRACER "current_tracer"
59d9f0492fSopenharmony_ci#define TRACE_BUFFER_SIZE_KB "buffer_size_kb"
60d9f0492fSopenharmony_ci#define TRACE_CLOCK "trace_clock"
61d9f0492fSopenharmony_ci#define TRACE_DEF_CLOCK "boot"
62d9f0492fSopenharmony_ci
63d9f0492fSopenharmony_citypedef enum {
64d9f0492fSopenharmony_ci    TRACE_STATE_IDLE,
65d9f0492fSopenharmony_ci    TRACE_STATE_STARTED,
66d9f0492fSopenharmony_ci    TRACE_STATE_STOPED,
67d9f0492fSopenharmony_ci    TRACE_STATE_INTERRUPT
68d9f0492fSopenharmony_ci} TraceState;
69d9f0492fSopenharmony_ci
70d9f0492fSopenharmony_citypedef struct {
71d9f0492fSopenharmony_ci    char *traceRootPath;
72d9f0492fSopenharmony_ci    char buffer[PATH_MAX];
73d9f0492fSopenharmony_ci    cJSON *jsonRootNode;
74d9f0492fSopenharmony_ci    TraceState traceState;
75d9f0492fSopenharmony_ci    uint32_t compress : 1;
76d9f0492fSopenharmony_ci} TraceWorkspace;
77d9f0492fSopenharmony_ci
78d9f0492fSopenharmony_cistatic TraceWorkspace g_traceWorkspace = {NULL, {0}, NULL, 0, 0};
79d9f0492fSopenharmony_cistatic TraceWorkspace *GetTraceWorkspace(void)
80d9f0492fSopenharmony_ci{
81d9f0492fSopenharmony_ci    return &g_traceWorkspace;
82d9f0492fSopenharmony_ci}
83d9f0492fSopenharmony_ci
84d9f0492fSopenharmony_cistatic char *ReadFile(const char *path)
85d9f0492fSopenharmony_ci{
86d9f0492fSopenharmony_ci    struct stat fileStat = {0};
87d9f0492fSopenharmony_ci    if (stat(path, &fileStat) != 0 || fileStat.st_size <= 0) {
88d9f0492fSopenharmony_ci        PLUGIN_LOGE("Invalid file %s or buffer %zu", path, fileStat.st_size);
89d9f0492fSopenharmony_ci        return NULL;
90d9f0492fSopenharmony_ci    }
91d9f0492fSopenharmony_ci    char realPath[PATH_MAX] = "";
92d9f0492fSopenharmony_ci    realpath(path, realPath);
93d9f0492fSopenharmony_ci    FILE *fd = fopen(realPath, "r");
94d9f0492fSopenharmony_ci    PLUGIN_CHECK(fd != NULL, return NULL, "Failed to fopen path %s", path);
95d9f0492fSopenharmony_ci    char *buffer = NULL;
96d9f0492fSopenharmony_ci    do {
97d9f0492fSopenharmony_ci        buffer = (char*)calloc((size_t)(fileStat.st_size + 1), sizeof(char));
98d9f0492fSopenharmony_ci        PLUGIN_CHECK(buffer != NULL, break, "Failed to alloc memory for path %s", path);
99d9f0492fSopenharmony_ci        if (fread(buffer, fileStat.st_size, 1, fd) != 1) {
100d9f0492fSopenharmony_ci            PLUGIN_LOGE("Failed to read file %s errno:%d", path, errno);
101d9f0492fSopenharmony_ci            free(buffer);
102d9f0492fSopenharmony_ci            buffer = NULL;
103d9f0492fSopenharmony_ci        } else {
104d9f0492fSopenharmony_ci            buffer[fileStat.st_size] = '\0';
105d9f0492fSopenharmony_ci        }
106d9f0492fSopenharmony_ci    } while (0);
107d9f0492fSopenharmony_ci    (void)fclose(fd);
108d9f0492fSopenharmony_ci    return buffer;
109d9f0492fSopenharmony_ci}
110d9f0492fSopenharmony_ci
111d9f0492fSopenharmony_cistatic int InitTraceWorkspace(TraceWorkspace *workspace)
112d9f0492fSopenharmony_ci{
113d9f0492fSopenharmony_ci    workspace->traceRootPath = NULL;
114d9f0492fSopenharmony_ci    workspace->traceState = TRACE_STATE_IDLE;
115d9f0492fSopenharmony_ci    workspace->compress = 0;
116d9f0492fSopenharmony_ci    char *fileBuf = ReadFile(TRACE_CFG_PATH);
117d9f0492fSopenharmony_ci    PLUGIN_CHECK(fileBuf != NULL, return -1, "Failed to read file content %s", TRACE_CFG_PATH);
118d9f0492fSopenharmony_ci    workspace->jsonRootNode = cJSON_Parse(fileBuf);
119d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace->jsonRootNode != NULL, free(fileBuf);
120d9f0492fSopenharmony_ci        return -1, "Failed to parse json file %s", TRACE_CFG_PATH);
121d9f0492fSopenharmony_ci    workspace->compress = cJSON_IsTrue(cJSON_GetObjectItem(workspace->jsonRootNode, "compress")) ? 1 : 0;
122d9f0492fSopenharmony_ci    PLUGIN_LOGI("InitTraceWorkspace compress :%d", workspace->compress);
123d9f0492fSopenharmony_ci    free(fileBuf);
124d9f0492fSopenharmony_ci    return 0;
125d9f0492fSopenharmony_ci}
126d9f0492fSopenharmony_ci
127d9f0492fSopenharmony_cistatic void DestroyTraceWorkspace(TraceWorkspace *workspace)
128d9f0492fSopenharmony_ci{
129d9f0492fSopenharmony_ci    if (workspace->traceRootPath) {
130d9f0492fSopenharmony_ci        free(workspace->traceRootPath);
131d9f0492fSopenharmony_ci        workspace->traceRootPath = NULL;
132d9f0492fSopenharmony_ci    }
133d9f0492fSopenharmony_ci    if (workspace->jsonRootNode) {
134d9f0492fSopenharmony_ci        cJSON_Delete(workspace->jsonRootNode);
135d9f0492fSopenharmony_ci        workspace->jsonRootNode = NULL;
136d9f0492fSopenharmony_ci    }
137d9f0492fSopenharmony_ci    workspace->traceState = TRACE_STATE_IDLE;
138d9f0492fSopenharmony_ci}
139d9f0492fSopenharmony_ci
140d9f0492fSopenharmony_cistatic bool IsTraceMountedInner(TraceWorkspace *workspace, const char *fsPath)
141d9f0492fSopenharmony_ci{
142d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer),
143d9f0492fSopenharmony_ci        "%s%s", fsPath, TRACE_MARKER_PATH);
144d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format path %s", fsPath);
145d9f0492fSopenharmony_ci    if (access(workspace->buffer, F_OK) != -1) {
146d9f0492fSopenharmony_ci        workspace->traceRootPath = strdup(fsPath);
147d9f0492fSopenharmony_ci        PLUGIN_CHECK(workspace->traceRootPath != NULL, return false, "Failed to dup fsPath");
148d9f0492fSopenharmony_ci        return true;
149d9f0492fSopenharmony_ci    }
150d9f0492fSopenharmony_ci    return false;
151d9f0492fSopenharmony_ci}
152d9f0492fSopenharmony_ci
153d9f0492fSopenharmony_cistatic bool IsTraceMounted(TraceWorkspace *workspace)
154d9f0492fSopenharmony_ci{
155d9f0492fSopenharmony_ci    return IsTraceMountedInner(workspace, TRACE_DEBUG_FS_PATH) ||
156d9f0492fSopenharmony_ci        IsTraceMountedInner(workspace, TRACE_FS_PATH);
157d9f0492fSopenharmony_ci}
158d9f0492fSopenharmony_ci
159d9f0492fSopenharmony_cistatic bool IsWritableFile(const char *filename)
160d9f0492fSopenharmony_ci{
161d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
162d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
163d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer),
164d9f0492fSopenharmony_ci        "%s%s", workspace->traceRootPath, filename);
165d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format path %s", filename);
166d9f0492fSopenharmony_ci    return access(workspace->buffer, W_OK) != -1;
167d9f0492fSopenharmony_ci}
168d9f0492fSopenharmony_ci
169d9f0492fSopenharmony_cistatic bool WriteStrToFile(const char *filename, const char *str)
170d9f0492fSopenharmony_ci{
171d9f0492fSopenharmony_ci    PLUGIN_LOGV("WriteStrToFile filename %s %s", filename, str);
172d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
173d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
174d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer),
175d9f0492fSopenharmony_ci        "%s%s", workspace->traceRootPath, filename);
176d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format path %s", filename);
177d9f0492fSopenharmony_ci    char realPath[PATH_MAX] = "";
178d9f0492fSopenharmony_ci    realpath(workspace->buffer, realPath);
179d9f0492fSopenharmony_ci    FILE *outfile = fopen(realPath, "w");
180d9f0492fSopenharmony_ci    PLUGIN_CHECK(outfile != NULL, return false, "Failed to open file %s.", workspace->buffer);
181d9f0492fSopenharmony_ci    (void)fprintf(outfile, "%s", str);
182d9f0492fSopenharmony_ci    (void)fflush(outfile);
183d9f0492fSopenharmony_ci    (void)fclose(outfile);
184d9f0492fSopenharmony_ci    return true;
185d9f0492fSopenharmony_ci}
186d9f0492fSopenharmony_ci
187d9f0492fSopenharmony_cistatic bool SetTraceEnabled(const char *path, bool enabled)
188d9f0492fSopenharmony_ci{
189d9f0492fSopenharmony_ci    return WriteStrToFile(path, enabled ? "1" : "0");
190d9f0492fSopenharmony_ci}
191d9f0492fSopenharmony_ci
192d9f0492fSopenharmony_cistatic bool SetBufferSize(int bufferSize)
193d9f0492fSopenharmony_ci{
194d9f0492fSopenharmony_ci    if (!WriteStrToFile(TRACE_CURRENT_TRACER, "nop")) {
195d9f0492fSopenharmony_ci        PLUGIN_LOGE("%s", "Error: write \"nop\" to %s\n", TRACE_CURRENT_TRACER);
196d9f0492fSopenharmony_ci    }
197d9f0492fSopenharmony_ci    char buffer[20] = {0}; // 20 max int number
198d9f0492fSopenharmony_ci    int len = sprintf_s((char *)buffer, sizeof(buffer), "%d", bufferSize);
199d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format int %d", bufferSize);
200d9f0492fSopenharmony_ci    PLUGIN_LOGE("SetBufferSize path %s %s", TRACE_BUFFER_SIZE_KB, buffer);
201d9f0492fSopenharmony_ci    return WriteStrToFile(TRACE_BUFFER_SIZE_KB, buffer);
202d9f0492fSopenharmony_ci}
203d9f0492fSopenharmony_ci
204d9f0492fSopenharmony_cistatic bool SetClock(const char *timeClock)
205d9f0492fSopenharmony_ci{
206d9f0492fSopenharmony_ci    return WriteStrToFile(TRACE_CLOCK, timeClock);
207d9f0492fSopenharmony_ci}
208d9f0492fSopenharmony_ci
209d9f0492fSopenharmony_cistatic bool SetOverWriteEnable(bool enabled)
210d9f0492fSopenharmony_ci{
211d9f0492fSopenharmony_ci    return SetTraceEnabled("options/overwrite", enabled);
212d9f0492fSopenharmony_ci}
213d9f0492fSopenharmony_ci
214d9f0492fSopenharmony_cistatic bool SetTgidEnable(bool enabled)
215d9f0492fSopenharmony_ci{
216d9f0492fSopenharmony_ci    return SetTraceEnabled("options/record-tgid", enabled);
217d9f0492fSopenharmony_ci}
218d9f0492fSopenharmony_ci
219d9f0492fSopenharmony_cistatic bool SetTraceTagsEnabled(uint64_t tags)
220d9f0492fSopenharmony_ci{
221d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
222d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
223d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer), "%" PRIu64 "", tags);
224d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format tags %" PRId64 "", tags);
225d9f0492fSopenharmony_ci    return SystemWriteParam(TRACE_TAG_PARAMETER, workspace->buffer) == 0;
226d9f0492fSopenharmony_ci}
227d9f0492fSopenharmony_ci
228d9f0492fSopenharmony_cistatic bool RefreshServices()
229d9f0492fSopenharmony_ci{
230d9f0492fSopenharmony_ci    return true;
231d9f0492fSopenharmony_ci}
232d9f0492fSopenharmony_ci
233d9f0492fSopenharmony_cistatic cJSON *GetArrayItem(const cJSON *fileRoot, int *arrSize, const char *arrName)
234d9f0492fSopenharmony_ci{
235d9f0492fSopenharmony_ci    cJSON *arrItem = cJSON_GetObjectItemCaseSensitive(fileRoot, arrName);
236d9f0492fSopenharmony_ci    PLUGIN_CHECK(cJSON_IsArray(arrItem), return NULL);
237d9f0492fSopenharmony_ci    *arrSize = cJSON_GetArraySize(arrItem);
238d9f0492fSopenharmony_ci    return *arrSize > 0 ? arrItem : NULL;
239d9f0492fSopenharmony_ci}
240d9f0492fSopenharmony_ci
241d9f0492fSopenharmony_cistatic bool SetUserSpaceSettings(void)
242d9f0492fSopenharmony_ci{
243d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
244d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
245d9f0492fSopenharmony_ci    int size = 0;
246d9f0492fSopenharmony_ci    cJSON *userItem = GetArrayItem(workspace->jsonRootNode, &size, TRACE_CFG_USER);
247d9f0492fSopenharmony_ci    PLUGIN_CHECK(userItem != NULL, return false, "Failed to get user info");
248d9f0492fSopenharmony_ci
249d9f0492fSopenharmony_ci    PLUGIN_LOGI("SetUserSpaceSettings: %d", size);
250d9f0492fSopenharmony_ci    uint64_t enabledTags = 0;
251d9f0492fSopenharmony_ci    for (int i = 0; i < size; i++) {
252d9f0492fSopenharmony_ci        cJSON *item = cJSON_GetArrayItem(userItem, i);
253d9f0492fSopenharmony_ci        PLUGIN_LOGI("Tag name = %s ", cJSON_GetStringValue(cJSON_GetObjectItem(item, "name")));
254d9f0492fSopenharmony_ci        int tag = cJSON_GetNumberValue(cJSON_GetObjectItem(item, "tag"));
255d9f0492fSopenharmony_ci        enabledTags |= 1ULL << tag;
256d9f0492fSopenharmony_ci    }
257d9f0492fSopenharmony_ci    PLUGIN_LOGI("User enabledTags: %" PRId64 "", enabledTags);
258d9f0492fSopenharmony_ci    return SetTraceTagsEnabled(enabledTags) && RefreshServices();
259d9f0492fSopenharmony_ci}
260d9f0492fSopenharmony_ci
261d9f0492fSopenharmony_cistatic bool ClearUserSpaceSettings(void)
262d9f0492fSopenharmony_ci{
263d9f0492fSopenharmony_ci    return SetTraceTagsEnabled(0) && RefreshServices();
264d9f0492fSopenharmony_ci}
265d9f0492fSopenharmony_ci
266d9f0492fSopenharmony_cistatic bool SetKernelTraceEnabled(const TraceWorkspace *workspace, bool enabled)
267d9f0492fSopenharmony_ci{
268d9f0492fSopenharmony_ci    bool result = true;
269d9f0492fSopenharmony_ci    PLUGIN_LOGI("SetKernelTraceEnabled %s", enabled ? "enable" : "disable");
270d9f0492fSopenharmony_ci    int size = 0;
271d9f0492fSopenharmony_ci    cJSON *kernelItem = GetArrayItem(workspace->jsonRootNode, &size, TRACE_CFG_KERNEL);
272d9f0492fSopenharmony_ci    PLUGIN_CHECK(kernelItem != NULL, return false, "Failed to get user info");
273d9f0492fSopenharmony_ci    for (int i = 0; i < size; i++) {
274d9f0492fSopenharmony_ci        cJSON *tagJson = cJSON_GetArrayItem(kernelItem, i);
275d9f0492fSopenharmony_ci        const char *name = cJSON_GetStringValue(cJSON_GetObjectItem(tagJson, "name"));
276d9f0492fSopenharmony_ci        int pathCount = 0;
277d9f0492fSopenharmony_ci        cJSON *paths = GetArrayItem(tagJson, &pathCount, "sys-files");
278d9f0492fSopenharmony_ci        if (paths == NULL) {
279d9f0492fSopenharmony_ci            continue;
280d9f0492fSopenharmony_ci        }
281d9f0492fSopenharmony_ci        PLUGIN_LOGV("Kernel tag name: %s sys-files %d", name, pathCount);
282d9f0492fSopenharmony_ci        for (int j = 0; j < pathCount; j++) {
283d9f0492fSopenharmony_ci            char *path = cJSON_GetStringValue(cJSON_GetArrayItem(paths, j));
284d9f0492fSopenharmony_ci            PLUGIN_CHECK(path != NULL, continue);
285d9f0492fSopenharmony_ci            if (!IsWritableFile(path)) {
286d9f0492fSopenharmony_ci                PLUGIN_LOGW("Path %s is not writable for %s", path, name);
287d9f0492fSopenharmony_ci                continue;
288d9f0492fSopenharmony_ci            }
289d9f0492fSopenharmony_ci            result = result && SetTraceEnabled(path, enabled);
290d9f0492fSopenharmony_ci        }
291d9f0492fSopenharmony_ci    }
292d9f0492fSopenharmony_ci    return result;
293d9f0492fSopenharmony_ci}
294d9f0492fSopenharmony_ci
295d9f0492fSopenharmony_cistatic bool DisableAllTraceEvents(void)
296d9f0492fSopenharmony_ci{
297d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
298d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
299d9f0492fSopenharmony_ci    return SetKernelTraceEnabled(workspace, false);
300d9f0492fSopenharmony_ci}
301d9f0492fSopenharmony_ci
302d9f0492fSopenharmony_cistatic bool SetKernelSpaceSettings(void)
303d9f0492fSopenharmony_ci{
304d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
305d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
306d9f0492fSopenharmony_ci    bool ret = SetBufferSize(BUFFER_SIZE_KB);
307d9f0492fSopenharmony_ci    PLUGIN_CHECK(ret, return false, "Failed to set buffer");
308d9f0492fSopenharmony_ci    ret = SetClock(TRACE_DEF_CLOCK);
309d9f0492fSopenharmony_ci    PLUGIN_CHECK(ret, return false, "Failed to set clock");
310d9f0492fSopenharmony_ci    ret = SetOverWriteEnable(true);
311d9f0492fSopenharmony_ci    PLUGIN_CHECK(ret, return false, "Failed to set write enable");
312d9f0492fSopenharmony_ci    ret = SetTgidEnable(true);
313d9f0492fSopenharmony_ci    PLUGIN_CHECK(ret, return false, "Failed to set tgid enable");
314d9f0492fSopenharmony_ci    ret = SetKernelTraceEnabled(workspace, false);
315d9f0492fSopenharmony_ci    PLUGIN_CHECK(ret, return false, "Pre-clear kernel tracers failed");
316d9f0492fSopenharmony_ci    return SetKernelTraceEnabled(workspace, true);
317d9f0492fSopenharmony_ci}
318d9f0492fSopenharmony_ci
319d9f0492fSopenharmony_cistatic bool ClearKernelSpaceSettings(void)
320d9f0492fSopenharmony_ci{
321d9f0492fSopenharmony_ci    return DisableAllTraceEvents() && SetOverWriteEnable(true) && SetBufferSize(1) && SetClock("boot");
322d9f0492fSopenharmony_ci}
323d9f0492fSopenharmony_ci
324d9f0492fSopenharmony_cistatic bool ClearTrace(void)
325d9f0492fSopenharmony_ci{
326d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
327d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
328d9f0492fSopenharmony_ci
329d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer),
330d9f0492fSopenharmony_ci        "%s%s", workspace->traceRootPath, TRACE_PATH);
331d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format path %s", TRACE_PATH);
332d9f0492fSopenharmony_ci    char realPath[PATH_MAX] = "";
333d9f0492fSopenharmony_ci    realpath(workspace->buffer, realPath);
334d9f0492fSopenharmony_ci    // clear old trace file
335d9f0492fSopenharmony_ci    int fd = open(realPath, O_RDWR);
336d9f0492fSopenharmony_ci    PLUGIN_CHECK(fd >= 0, return false, "Failed to open file %s errno %d", workspace->buffer, errno);
337d9f0492fSopenharmony_ci    (void)ftruncate(fd, 0);
338d9f0492fSopenharmony_ci    close(fd);
339d9f0492fSopenharmony_ci    return true;
340d9f0492fSopenharmony_ci}
341d9f0492fSopenharmony_ci
342d9f0492fSopenharmony_cistatic void DumpCompressedTrace(int traceFd, int outFd)
343d9f0492fSopenharmony_ci{
344d9f0492fSopenharmony_ci    int flush = Z_NO_FLUSH;
345d9f0492fSopenharmony_ci    uint8_t *inBuffer = calloc(1, CHUNK_SIZE);
346d9f0492fSopenharmony_ci    PLUGIN_CHECK(inBuffer != NULL, return, "Error: couldn't allocate buffers\n");
347d9f0492fSopenharmony_ci    uint8_t *outBuffer = malloc(CHUNK_SIZE);
348d9f0492fSopenharmony_ci    PLUGIN_CHECK(outBuffer != NULL, free(inBuffer);
349d9f0492fSopenharmony_ci        return, "Error: couldn't allocate buffers\n");
350d9f0492fSopenharmony_ci
351d9f0492fSopenharmony_ci    z_stream zs = {};
352d9f0492fSopenharmony_ci    int ret = 0;
353d9f0492fSopenharmony_ci    deflateInit2(&zs, Z_DEFAULT_COMPRESSION, Z_DEFLATED, MAX_WBITS + 16, 8, Z_DEFAULT_STRATEGY); // 16 8 bit
354d9f0492fSopenharmony_ci    do {
355d9f0492fSopenharmony_ci        // read data
356d9f0492fSopenharmony_ci        zs.avail_in = (uInt)TEMP_FAILURE_RETRY(read(traceFd, inBuffer, CHUNK_SIZE));
357d9f0492fSopenharmony_ci        PLUGIN_CHECK(zs.avail_in >= 0, break, "Error: reading trace, errno: %d\n", errno);
358d9f0492fSopenharmony_ci        flush = zs.avail_in == 0 ? Z_FINISH : Z_NO_FLUSH;
359d9f0492fSopenharmony_ci        zs.next_in = inBuffer;
360d9f0492fSopenharmony_ci        do {
361d9f0492fSopenharmony_ci            zs.next_out = outBuffer;
362d9f0492fSopenharmony_ci            zs.avail_out = CHUNK_SIZE;
363d9f0492fSopenharmony_ci            ret = deflate(&zs, flush);
364d9f0492fSopenharmony_ci            PLUGIN_CHECK(ret != Z_STREAM_ERROR, break, "Error: deflate trace, errno: %d\n", errno);
365d9f0492fSopenharmony_ci            size_t have = CHUNK_SIZE - zs.avail_out;
366d9f0492fSopenharmony_ci            size_t bytesWritten = (size_t)TEMP_FAILURE_RETRY(write(outFd, outBuffer, have));
367d9f0492fSopenharmony_ci            PLUGIN_CHECK(bytesWritten >= have, flush = Z_FINISH; break,
368d9f0492fSopenharmony_ci                "Error: writing deflated trace, errno: %d\n", errno);
369d9f0492fSopenharmony_ci        } while (zs.avail_out == 0);
370d9f0492fSopenharmony_ci    } while (flush != Z_FINISH);
371d9f0492fSopenharmony_ci
372d9f0492fSopenharmony_ci    ret = deflateEnd(&zs);
373d9f0492fSopenharmony_ci    PLUGIN_ONLY_LOG(ret == Z_OK, "error cleaning up zlib: %d\n", ret);
374d9f0492fSopenharmony_ci    free(inBuffer);
375d9f0492fSopenharmony_ci    free(outBuffer);
376d9f0492fSopenharmony_ci}
377d9f0492fSopenharmony_ci
378d9f0492fSopenharmony_cistatic void DumpTrace(const TraceWorkspace *workspace, int outFd, const char *path)
379d9f0492fSopenharmony_ci{
380d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer), "%s%s", workspace->traceRootPath, path);
381d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return, "Failed to format path %s", path);
382d9f0492fSopenharmony_ci    char realPath[PATH_MAX] = "";
383d9f0492fSopenharmony_ci    realpath(workspace->buffer, realPath);
384d9f0492fSopenharmony_ci    int traceFd = open(realPath, O_RDWR);
385d9f0492fSopenharmony_ci    PLUGIN_CHECK(traceFd >= 0, return, "Failed to open file %s errno %d", workspace->buffer, errno);
386d9f0492fSopenharmony_ci
387d9f0492fSopenharmony_ci    ssize_t bytesWritten;
388d9f0492fSopenharmony_ci    ssize_t bytesRead;
389d9f0492fSopenharmony_ci    if (workspace->compress) {
390d9f0492fSopenharmony_ci        DumpCompressedTrace(traceFd, outFd);
391d9f0492fSopenharmony_ci    } else {
392d9f0492fSopenharmony_ci        char buffer[BLOCK_SIZE];
393d9f0492fSopenharmony_ci        do {
394d9f0492fSopenharmony_ci            bytesRead = TEMP_FAILURE_RETRY(read(traceFd, buffer, BLOCK_SIZE));
395d9f0492fSopenharmony_ci            if ((bytesRead == 0) || (bytesRead == -1)) {
396d9f0492fSopenharmony_ci                break;
397d9f0492fSopenharmony_ci            }
398d9f0492fSopenharmony_ci            bytesWritten = TEMP_FAILURE_RETRY(write(outFd, buffer, bytesRead));
399d9f0492fSopenharmony_ci        } while (bytesWritten > 0);
400d9f0492fSopenharmony_ci    }
401d9f0492fSopenharmony_ci    close(traceFd);
402d9f0492fSopenharmony_ci}
403d9f0492fSopenharmony_ci
404d9f0492fSopenharmony_cistatic bool MarkOthersClockSync(void)
405d9f0492fSopenharmony_ci{
406d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
407d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return false, "Failed to get trace workspace");
408d9f0492fSopenharmony_ci    int len = sprintf_s((char *)workspace->buffer, sizeof(workspace->buffer), "%s%s",
409d9f0492fSopenharmony_ci        workspace->traceRootPath, TRACE_MARKER_PATH);
410d9f0492fSopenharmony_ci    PLUGIN_CHECK(len > 0, return false, "Failed to format path %s", TRACE_MARKER_PATH);
411d9f0492fSopenharmony_ci
412d9f0492fSopenharmony_ci    struct timespec mts = {0, 0};
413d9f0492fSopenharmony_ci    struct timespec rts = {0, 0};
414d9f0492fSopenharmony_ci    if (clock_gettime(CLOCK_REALTIME, &rts) == -1) {
415d9f0492fSopenharmony_ci        PLUGIN_LOGE("Error: get realtime, errno: %d", errno);
416d9f0492fSopenharmony_ci        return false;
417d9f0492fSopenharmony_ci    } else if (clock_gettime(CLOCK_MONOTONIC, &mts) == -1) {
418d9f0492fSopenharmony_ci        PLUGIN_LOGE("Error: get monotonic, errno: %d\n", errno);
419d9f0492fSopenharmony_ci        return false;
420d9f0492fSopenharmony_ci    }
421d9f0492fSopenharmony_ci    const unsigned int nanoSeconds = 1000000000;  // seconds converted to nanoseconds
422d9f0492fSopenharmony_ci    const unsigned int nanoToMill = 1000000;      // millisecond converted to nanoseconds
423d9f0492fSopenharmony_ci    const float nanoToSecond = 1000000000.0f;     // consistent with the ftrace timestamp format
424d9f0492fSopenharmony_ci
425d9f0492fSopenharmony_ci    PLUGIN_LOGE("MarkOthersClockSync %s", workspace->buffer);
426d9f0492fSopenharmony_ci    char realPath[PATH_MAX] = { 0 };
427d9f0492fSopenharmony_ci    realpath(workspace->buffer, realPath);
428d9f0492fSopenharmony_ci    FILE *file = fopen(realPath, "wt+");
429d9f0492fSopenharmony_ci    PLUGIN_CHECK(file != NULL, return false, "Error: opening %s, errno: %d", TRACE_MARKER_PATH, errno);
430d9f0492fSopenharmony_ci    do {
431d9f0492fSopenharmony_ci        int64_t realtime = ((int64_t)rts.tv_sec * nanoSeconds + rts.tv_nsec) / nanoToMill;
432d9f0492fSopenharmony_ci        float parentTs = (float)((((float)mts.tv_sec) * nanoSeconds + mts.tv_nsec) / nanoToSecond);
433d9f0492fSopenharmony_ci        int ret = fprintf(file, "trace_event_clock_sync: realtime_ts=%" PRId64 "\n", realtime);
434d9f0492fSopenharmony_ci        PLUGIN_CHECK(ret > 0, break, "Warning: writing clock sync marker, errno: %d", errno);
435d9f0492fSopenharmony_ci        ret = fprintf(file, "trace_event_clock_sync: parent_ts=%f\n", parentTs);
436d9f0492fSopenharmony_ci        PLUGIN_CHECK(ret > 0, break, "Warning: writing clock sync marker, errno: %d", errno);
437d9f0492fSopenharmony_ci    } while (0);
438d9f0492fSopenharmony_ci    (void)fclose(file);
439d9f0492fSopenharmony_ci    return true;
440d9f0492fSopenharmony_ci}
441d9f0492fSopenharmony_ci
442d9f0492fSopenharmony_cistatic int InitStartTrace(void)
443d9f0492fSopenharmony_ci{
444d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
445d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return 0, "Failed to get trace workspace");
446d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace->traceState == TRACE_STATE_IDLE, return 0,
447d9f0492fSopenharmony_ci        "Invalid state for trace %d", workspace->traceState);
448d9f0492fSopenharmony_ci
449d9f0492fSopenharmony_ci    InitTraceWorkspace(workspace);
450d9f0492fSopenharmony_ci    PLUGIN_CHECK(IsTraceMounted(workspace), return -1);
451d9f0492fSopenharmony_ci
452d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace->traceRootPath != NULL && workspace->jsonRootNode != NULL,
453d9f0492fSopenharmony_ci        return -1, "No trace root path or config");
454d9f0492fSopenharmony_ci
455d9f0492fSopenharmony_ci    // load json init_trace.cfg
456d9f0492fSopenharmony_ci    if (!SetKernelSpaceSettings() || !SetTraceEnabled(TRACING_ON_PATH, true)) {
457d9f0492fSopenharmony_ci        PLUGIN_LOGE("Failed to enable kernel space setting");
458d9f0492fSopenharmony_ci        ClearKernelSpaceSettings();
459d9f0492fSopenharmony_ci        return -1;
460d9f0492fSopenharmony_ci    }
461d9f0492fSopenharmony_ci    ClearTrace();
462d9f0492fSopenharmony_ci    PLUGIN_LOGI("capturing trace...");
463d9f0492fSopenharmony_ci    if (!SetUserSpaceSettings()) {
464d9f0492fSopenharmony_ci        PLUGIN_LOGE("Failed to enable user space setting");
465d9f0492fSopenharmony_ci        ClearKernelSpaceSettings();
466d9f0492fSopenharmony_ci        ClearUserSpaceSettings();
467d9f0492fSopenharmony_ci        return -1;
468d9f0492fSopenharmony_ci    }
469d9f0492fSopenharmony_ci    workspace->traceState = TRACE_STATE_STARTED;
470d9f0492fSopenharmony_ci    return 0;
471d9f0492fSopenharmony_ci}
472d9f0492fSopenharmony_ci
473d9f0492fSopenharmony_cistatic int InitStopTrace(void)
474d9f0492fSopenharmony_ci{
475d9f0492fSopenharmony_ci    PLUGIN_LOGI("Stop trace now ...");
476d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
477d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return 0, "Failed to get trace workspace");
478d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace->traceState == TRACE_STATE_STARTED, return 0, "Invalid state for trace %d",
479d9f0492fSopenharmony_ci        workspace->traceState);
480d9f0492fSopenharmony_ci    workspace->traceState = TRACE_STATE_STOPED;
481d9f0492fSopenharmony_ci
482d9f0492fSopenharmony_ci    MarkOthersClockSync();
483d9f0492fSopenharmony_ci    // clear user tags first and sleep a little to let apps already be notified.
484d9f0492fSopenharmony_ci    ClearUserSpaceSettings();
485d9f0492fSopenharmony_ci    usleep(WAIT_MILLISECONDS);
486d9f0492fSopenharmony_ci    SetTraceEnabled(TRACING_ON_PATH, false);
487d9f0492fSopenharmony_ci
488d9f0492fSopenharmony_ci    const char *path = workspace->compress ? TRACE_OUTPUT_PATH_ZIP : TRACE_OUTPUT_PATH;
489d9f0492fSopenharmony_ci    int outFd = open(path, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
490d9f0492fSopenharmony_ci    if (outFd >= 0) {
491d9f0492fSopenharmony_ci        DumpTrace(workspace, outFd, TRACE_PATH);
492d9f0492fSopenharmony_ci        close(outFd);
493d9f0492fSopenharmony_ci    } else {
494d9f0492fSopenharmony_ci        PLUGIN_LOGE("Failed to open file '%s', err=%d", path, errno);
495d9f0492fSopenharmony_ci    }
496d9f0492fSopenharmony_ci
497d9f0492fSopenharmony_ci    ClearTrace();
498d9f0492fSopenharmony_ci    // clear kernel setting including clock type after dump(MUST) and tracing_on is off.
499d9f0492fSopenharmony_ci    ClearKernelSpaceSettings();
500d9f0492fSopenharmony_ci    // init hitrace config
501d9f0492fSopenharmony_ci    DoJobNow("init-hitrace");
502d9f0492fSopenharmony_ci    DestroyTraceWorkspace(workspace);
503d9f0492fSopenharmony_ci    return 0;
504d9f0492fSopenharmony_ci}
505d9f0492fSopenharmony_ci
506d9f0492fSopenharmony_cistatic int InitInterruptTrace(void)
507d9f0492fSopenharmony_ci{
508d9f0492fSopenharmony_ci    PLUGIN_LOGI("Interrupt trace now ...");
509d9f0492fSopenharmony_ci    TraceWorkspace *workspace = GetTraceWorkspace();
510d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace != NULL, return 0, "Failed to get trace workspace");
511d9f0492fSopenharmony_ci    PLUGIN_CHECK(workspace->traceState == TRACE_STATE_STARTED, return 0,
512d9f0492fSopenharmony_ci        "Invalid state for trace %d", workspace->traceState);
513d9f0492fSopenharmony_ci
514d9f0492fSopenharmony_ci    workspace->traceState = TRACE_STATE_INTERRUPT;
515d9f0492fSopenharmony_ci    MarkOthersClockSync();
516d9f0492fSopenharmony_ci    // clear user tags first and sleep a little to let apps already be notified.
517d9f0492fSopenharmony_ci    ClearUserSpaceSettings();
518d9f0492fSopenharmony_ci    SetTraceEnabled(TRACING_ON_PATH, false);
519d9f0492fSopenharmony_ci    ClearTrace();
520d9f0492fSopenharmony_ci    // clear kernel setting including clock type after dump(MUST) and tracing_on is off.
521d9f0492fSopenharmony_ci    ClearKernelSpaceSettings();
522d9f0492fSopenharmony_ci    // init hitrace config
523d9f0492fSopenharmony_ci    DoJobNow("init-hitrace");
524d9f0492fSopenharmony_ci    DestroyTraceWorkspace(workspace);
525d9f0492fSopenharmony_ci    return 0;
526d9f0492fSopenharmony_ci}
527d9f0492fSopenharmony_ci
528d9f0492fSopenharmony_cistatic int DoInitTraceCmd(int id, const char *name, int argc, const char **argv)
529d9f0492fSopenharmony_ci{
530d9f0492fSopenharmony_ci    PLUGIN_CHECK(argc >= 1, return -1, "Invalid parameter");
531d9f0492fSopenharmony_ci    PLUGIN_LOGI("DoInitTraceCmd argc %d cmd %s", argc, argv[0]);
532d9f0492fSopenharmony_ci    if (strcmp(argv[0], "start") == 0) {
533d9f0492fSopenharmony_ci        return InitStartTrace();
534d9f0492fSopenharmony_ci    } else if (strcmp(argv[0], "stop") == 0) {
535d9f0492fSopenharmony_ci        return InitStopTrace();
536d9f0492fSopenharmony_ci    } else if (strcmp(argv[0], "1") == 0) {
537d9f0492fSopenharmony_ci        return InitInterruptTrace();
538d9f0492fSopenharmony_ci    }
539d9f0492fSopenharmony_ci    return 0;
540d9f0492fSopenharmony_ci}
541d9f0492fSopenharmony_ci
542d9f0492fSopenharmony_cistatic int g_executorId = -1;
543d9f0492fSopenharmony_cistatic int InitTraceInit(void)
544d9f0492fSopenharmony_ci{
545d9f0492fSopenharmony_ci    if (g_executorId == -1) {
546d9f0492fSopenharmony_ci        g_executorId = AddCmdExecutor("init_trace", DoInitTraceCmd);
547d9f0492fSopenharmony_ci        PLUGIN_LOGI("InitTraceInit executorId %d", g_executorId);
548d9f0492fSopenharmony_ci    }
549d9f0492fSopenharmony_ci    return 0;
550d9f0492fSopenharmony_ci}
551d9f0492fSopenharmony_ci
552d9f0492fSopenharmony_cistatic void InitTraceExit(void)
553d9f0492fSopenharmony_ci{
554d9f0492fSopenharmony_ci    PLUGIN_LOGI("InitTraceExit executorId %d", g_executorId);
555d9f0492fSopenharmony_ci    if (g_executorId != -1) {
556d9f0492fSopenharmony_ci        RemoveCmdExecutor("init_trace", g_executorId);
557d9f0492fSopenharmony_ci    }
558d9f0492fSopenharmony_ci}
559d9f0492fSopenharmony_ci
560d9f0492fSopenharmony_ciMODULE_CONSTRUCTOR(void)
561d9f0492fSopenharmony_ci{
562d9f0492fSopenharmony_ci    PLUGIN_LOGI("Start trace now ...");
563d9f0492fSopenharmony_ci    InitTraceInit();
564d9f0492fSopenharmony_ci}
565d9f0492fSopenharmony_ci
566d9f0492fSopenharmony_ciMODULE_DESTRUCTOR(void)
567d9f0492fSopenharmony_ci{
568d9f0492fSopenharmony_ci    InitTraceExit();
569d9f0492fSopenharmony_ci}
570