blob: 6fdc8e8eb961cd9c1e62cda46b1064da9aa139bb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.service.tracing;
import static android.annotation.SystemApi.Client.PRIVILEGED_APPS;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.app.Service;
import android.content.Intent;
import android.os.Handler;
import android.os.IBinder;
import android.os.Looper;
import android.os.Message;
import android.os.Messenger;
import android.os.ParcelFileDescriptor;
import android.os.Process;
import android.tracing.TraceReportParams;
import android.util.Log;
import java.io.IOException;
import java.util.UUID;
/**
* Service to be sub-classed and exposed by (privileged) apps which want to report
* system traces.
* <p>
* Subclasses should implement the onReportTrace method to handle traces reported
* to them.
* </p>
* <pre>
* public class SampleReportService extends TraceReportService {
* public void onReportTrace(TraceParams args) {
* // --- Implementation goes here ---
* }
* }
* </pre>
* <p>
* The service declaration in the application manifest must specify
* BIND_TRACE_REPORT_SERVICE in the permission attribute.
* </p>
* <pre>
* <application>
* <service android:name=".SampleReportService"
* android:permission="android.permission.BIND_TRACE_REPORT_SERVICE">
* </service>
* </application>
* </pre>
*
* Moreover, the package containing this service must hold the DUMP and PACKAGE_USAGE_STATS
* permissions.
*
* @hide
*/
@SystemApi(client = PRIVILEGED_APPS)
public class TraceReportService extends Service {
private static final String TAG = "TraceReportService";
private Messenger mMessenger = null;
/**
* Public to allow this to be used by TracingServiceProxy in system_server.
*
* @hide
*/
public static final int MSG_REPORT_TRACE = 1;
/**
* Contains information about the trace which is being reported.
*
* @hide
*/
@SystemApi(client = PRIVILEGED_APPS)
public static final class TraceParams {
private final ParcelFileDescriptor mFd;
private final UUID mUuid;
private TraceParams(TraceReportParams params) {
mFd = params.fd;
mUuid = new UUID(params.uuidMsb, params.uuidLsb);
}
/**
* Returns the ParcelFileDescriptor for the collected trace.
*/
@NonNull
public ParcelFileDescriptor getFd() {
return mFd;
}
/**
* Returns the UUID of the trace; this is exactly the UUID created by the tracing system
* (i.e. Perfetto) and is also present inside the trace file.
*/
@NonNull
public UUID getUuid() {
return mUuid;
}
}
/**
* Called when a trace is reported and sent to this class.
*
* Note: the trace file descriptor should not be persisted beyond the lifetime of this
* function as it is owned by the framework and will be closed immediately after this function
* returns: if future use of the fd is needed, it should be duped.
*/
public void onReportTrace(@NonNull TraceParams args) {
}
/**
* Handles binder calls from system_server.
*/
private boolean onMessage(@NonNull Message msg) {
if (msg.what == MSG_REPORT_TRACE) {
if (!(msg.obj instanceof TraceReportParams)) {
Log.e(TAG, "Received invalid type for report trace message.");
return false;
}
TraceParams params = new TraceParams((TraceReportParams) msg.obj);
try {
onReportTrace(params);
} finally {
try {
params.getFd().close();
} catch (IOException ignored) {
}
}
return true;
}
return false;
}
/**
* Returns an IBinder for handling binder calls from system_server.
*
* @hide
*/
@Nullable
@Override
public final IBinder onBind(@NonNull Intent intent) {
if (mMessenger == null) {
mMessenger = new Messenger(new Handler(Looper.getMainLooper(), this::onMessage));
}
return mMessenger.getBinder();
}
}
|
