1 /*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include <cutils/trace.h>
18 #include <errno.h>
19 #include <fcntl.h>
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <string.h>
23
24 #include "private/bionic_lock.h"
25 #include "private/bionic_systrace.h"
26 #include "private/libc_logging.h"
27
28 #define _REALLY_INCLUDE_SYS__SYSTEM_PROPERTIES_H_
29 #include <sys/_system_properties.h>
30
31 #define WRITE_OFFSET 32
32
33 constexpr char SYSTRACE_PROPERTY_NAME[] = "debug.atrace.tags.enableflags";
34
35 static Lock g_lock;
36 static const prop_info* g_pinfo;
37 static uint32_t g_property_serial = -1;
38 static uint32_t g_property_area_serial = -1;
39 static uint64_t g_tags;
40 static int g_trace_marker_fd = -1;
41
should_trace()42 static bool should_trace() {
43 bool result = false;
44 g_lock.lock();
45 // debug.atrace.tags.enableflags is set to a safe non-tracing value during property
46 // space initialization, so it should only be null in two cases, if there are
47 // insufficient permissions for this process to access the property, in which
48 // case an audit will be logged, and during boot before the property server has
49 // been started, in which case we store the global property_area serial to prevent
50 // the costly find operation until we see a changed property_area.
51 if (g_pinfo == nullptr && g_property_area_serial != __system_property_area_serial()) {
52 g_property_area_serial = __system_property_area_serial();
53 g_pinfo = __system_property_find(SYSTRACE_PROPERTY_NAME);
54 }
55
56 if (g_pinfo) {
57 // Find out which tags have been enabled on the command line and set
58 // the value of tags accordingly. If the value of the property changes,
59 // the serial will also change, so the costly system_property_read function
60 // can be avoided by calling the much cheaper system_property_serial
61 // first. The values within pinfo may change, but its location is guaranteed
62 // not to move.
63 uint32_t cur_serial = __system_property_serial(g_pinfo);
64 if (cur_serial != g_property_serial) {
65 __system_property_read_callback(g_pinfo,
66 [] (void*, const char*, const char* value, uint32_t serial) {
67 g_property_serial = serial;
68 g_tags = strtoull(value, nullptr, 0);
69 }, nullptr);
70 }
71 result = ((g_tags & ATRACE_TAG_BIONIC) != 0);
72 }
73 g_lock.unlock();
74 return result;
75 }
76
get_trace_marker_fd()77 static int get_trace_marker_fd() {
78 g_lock.lock();
79 if (g_trace_marker_fd == -1) {
80 g_trace_marker_fd = open("/sys/kernel/debug/tracing/trace_marker", O_CLOEXEC | O_WRONLY);
81 }
82 g_lock.unlock();
83 return g_trace_marker_fd;
84 }
85
bionic_trace_begin(const char * message)86 void bionic_trace_begin(const char* message) {
87 if (!should_trace()) {
88 return;
89 }
90
91 int trace_marker_fd = get_trace_marker_fd();
92 if (trace_marker_fd == -1) {
93 return;
94 }
95
96 // If bionic tracing has been enabled, then write the message to the
97 // kernel trace_marker.
98 int length = strlen(message);
99 char buf[length + WRITE_OFFSET];
100 size_t len = snprintf(buf, length + WRITE_OFFSET, "B|%d|%s", getpid(), message);
101
102 // Tracing may stop just after checking property and before writing the message.
103 // So the write is acceptable to fail. See b/20666100.
104 TEMP_FAILURE_RETRY(write(trace_marker_fd, buf, len));
105 }
106
bionic_trace_end()107 void bionic_trace_end() {
108 if (!should_trace()) {
109 return;
110 }
111
112 int trace_marker_fd = get_trace_marker_fd();
113 if (trace_marker_fd == -1) {
114 return;
115 }
116
117 TEMP_FAILURE_RETRY(write(trace_marker_fd, "E", 1));
118 }
119
ScopedTrace(const char * message)120 ScopedTrace::ScopedTrace(const char* message) : called_end_(false) {
121 bionic_trace_begin(message);
122 }
123
~ScopedTrace()124 ScopedTrace::~ScopedTrace() {
125 End();
126 }
127
End()128 void ScopedTrace::End() {
129 if (!called_end_) {
130 bionic_trace_end();
131 called_end_ = true;
132 }
133 }
134