First checkin of incident reporting.
There are a few major pieces here:
incidentd
---------
This daemon (started by init) runs and accepts incoming requests to take
incident reports. When prompted, it calls into various system services
and fills in an IncidentProto data structure, and then writes the report
into dropbox.
The next steps for incidentd:
- Security review of SELinux policies. These will be a subset of
the dumpstate permissions. Until this is done, incidentd is
not started at boot time.
incident
--------
This shell command calls into incidentd, and can initiate an incident
report and either capture the output or leave for dropbox.
incident_report
---------------
This host side tool can call adb shell with the correct parameters
and also format the incident report as text. This formatting code
was left of the device on purpose. Right now it's pretty small, but
as the number of fields increases, the metadata and code to do the
formatting will start to grow.
The incident_report command also contains a workaround to let it
work before incidentd is turned on by default. Right now, it is
implemented to call adb shell dumpsys <service> --proto directly,
whereas in the future it will go through the full incidentd flow.
incident_section_gen
--------------------
A build-time tool that generates a stripped down set of information
about the fields that are available.
libincident
-----------
This library contains the code to connect to incidentd, and the
meta proto definitions that are used by the framework protos.
The basics are here now, but they are not fully fleshed out yet.
The privacy.proto file contains annotations that can go in the
proto file that we will later use to filter which fields are
uploaded, and which are used by local sources. For example, a
device in a test lab is safe to upload much much more information
than a real user. These will share the same mechanism, but the
user's output will be filtered according to these annotations.
frameworks/core/proto
---------------------
These .proto files contain the definitions of the system's
output. There is one master android.os.IncidentProto file that
is the top level of an incident report, but some other services
(notification, fingerprint, batterystats, etc) will have others
that are used directly by the logging mechanism.
Other files which are shared by several of the services also go
here, such as ComponentName, Locale, Configuration, etc. There
will be many more.
There is also a first iplementation of a dump method handling
--proto in the fingerprint service.
IncidentManager
---------------
The java API to trigger an incident report.
Test: Not written yet
Change-Id: I59568b115ac7fcf73af70c946c95752bf33ae67f
diff --git a/libs/incident/Android.mk b/libs/incident/Android.mk
new file mode 100644
index 0000000..439e86d
--- /dev/null
+++ b/libs/incident/Android.mk
@@ -0,0 +1,41 @@
+# Copyright (C) 2016 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.
+
+LOCAL_PATH:= $(call my-dir)
+include $(CLEAR_VARS)
+
+LOCAL_MODULE := libincident
+
+LOCAL_CFLAGS := \
+ -Wall -Werror -Wno-missing-field-initializers -Wno-unused-variable -Wunused-parameter
+
+LOCAL_SHARED_LIBRARIES := \
+ libbinder \
+ liblog \
+ libutils
+
+LOCAL_AIDL_INCLUDES := $(LOCAL_PATH)/../../core/java
+LOCAL_C_INCLUDES := \
+ $(LOCAL_PATH)/include
+
+LOCAL_SRC_FILES := \
+ ../../core/java/android/os/IIncidentManager.aidl \
+ ../../core/java/android/os/IIncidentReportCompletedListener.aidl \
+ ../../core/java/android/os/IIncidentReportStatusListener.aidl \
+ src/IncidentReportArgs.cpp
+
+LOCAL_EXPORT_C_INCLUDE_DIRS := $(LOCAL_PATH)/include
+
+include $(BUILD_SHARED_LIBRARY)
+
diff --git a/libs/incident/include/android/os/IncidentReportArgs.h b/libs/incident/include/android/os/IncidentReportArgs.h
new file mode 100644
index 0000000..956ef6c
--- /dev/null
+++ b/libs/incident/include/android/os/IncidentReportArgs.h
@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2016, 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.
+ */
+
+#ifndef ANDROID_OS_DUMPSTATE_ARGS_H_
+#define ANDROID_OS_DUMPSTATE_ARGS_H_
+
+#include <binder/Parcel.h>
+#include <binder/Parcelable.h>
+#include <utils/String16.h>
+
+#include <set>
+#include <vector>
+
+namespace android {
+namespace os {
+
+using namespace std;
+
+class IncidentReportArgs : public Parcelable {
+public:
+ IncidentReportArgs();
+ explicit IncidentReportArgs(const IncidentReportArgs& that);
+ virtual ~IncidentReportArgs();
+
+ virtual status_t writeToParcel(Parcel* out) const;
+ virtual status_t readFromParcel(const Parcel* in);
+
+ void setAll(bool all);
+ void addSection(int section);
+ void addHeader(const vector<int8_t>& header);
+
+ inline bool all() const { return mAll; };
+ bool containsSection(int section) const;
+
+ inline const set<int>& sections() const { return mSections; }
+ inline const vector<vector<int8_t>>& headers() const { return mHeaders; }
+
+ void merge(const IncidentReportArgs& that);
+
+private:
+ set<int> mSections;
+ vector<vector<int8_t>> mHeaders;
+ bool mAll;
+};
+
+}
+}
+
+#endif // ANDROID_OS_DUMPSTATE_ARGS_H_
diff --git a/libs/incident/proto/android/privacy.proto b/libs/incident/proto/android/privacy.proto
new file mode 100644
index 0000000..ae5af0e
--- /dev/null
+++ b/libs/incident/proto/android/privacy.proto
@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2016 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.
+ */
+
+syntax = "proto2";
+
+option java_package = "android";
+option java_multiple_files = true;
+
+import "google/protobuf/descriptor.proto";
+
+package android;
+
+// TODO: It's better to track this by semantic types and set policy for those.
+// Do this for now to bootstrap the tools.
+enum Destination {
+ // Fields or messages annotated with DEST_LOCAL must never be
+ // extracted from the device automatically. They can be accessed
+ // by tools on the developer's workstation, and if they are sent
+ // to another device that must be by the user, with a PII warning. (TBD)
+ DEST_LOCAL = 0;
+
+ // Fields or messages annotated with DEST_EXPLICIT can be sent
+ // off the device with an explicit user action.
+ DEST_EXPLICIT = 1;
+
+ // Fields or messages annotated with DEST_LOCAL can be sent by
+ // automatic means, without per-sending user consent. The user
+ // still must have previously accepted a consent to share this
+ // information.
+ DEST_AUTOMATIC = 2;
+
+ // There is no more permissive option than DEST_AUTOMATIC.
+}
+
+message PrivacyFlags {
+ optional Destination dest = 1 [
+ default = DEST_LOCAL
+ ];
+}
+
+extend google.protobuf.FieldOptions {
+ // Flags for automatically filtering statistics
+ optional PrivacyFlags privacy = 102672883;
+}
diff --git a/libs/incident/src/IncidentReportArgs.cpp b/libs/incident/src/IncidentReportArgs.cpp
new file mode 100644
index 0000000..f604909
--- /dev/null
+++ b/libs/incident/src/IncidentReportArgs.cpp
@@ -0,0 +1,172 @@
+/**
+ * Copyright (c) 2016, 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.
+ */
+
+#define LOG_TAG "dumpstate"
+
+#include <android/os/IncidentReportArgs.h>
+
+#include <cutils/log.h>
+
+namespace android {
+namespace os {
+
+IncidentReportArgs::IncidentReportArgs()
+ :mSections(),
+ mAll(false)
+{
+}
+
+IncidentReportArgs::IncidentReportArgs(const IncidentReportArgs& that)
+ :mSections(that.mSections),
+ mHeaders(that.mHeaders),
+ mAll(that.mAll)
+{
+}
+
+IncidentReportArgs::~IncidentReportArgs()
+{
+}
+
+status_t
+IncidentReportArgs::writeToParcel(Parcel* out) const
+{
+ status_t err;
+
+ err = out->writeInt32(mAll);
+ if (err != NO_ERROR) {
+ return err;
+ }
+
+ err = out->writeInt32(mSections.size());
+ if (err != NO_ERROR) {
+ return err;
+ }
+
+ for (set<int>::const_iterator it=mSections.begin(); it!=mSections.end(); it++) {
+ err = out->writeInt32(*it);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ }
+
+ err = out->writeInt32(mHeaders.size());
+ if (err != NO_ERROR) {
+ return err;
+ }
+
+ for (vector<vector<int8_t>>::const_iterator it = mHeaders.begin(); it != mHeaders.end(); it++) {
+ err = out->writeByteVector(*it);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ }
+
+ return NO_ERROR;
+}
+
+status_t
+IncidentReportArgs::readFromParcel(const Parcel* in)
+{
+ status_t err;
+
+ int32_t all;
+ err = in->readInt32(&all);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ if (all != 0) {
+ mAll = all;
+ }
+
+ mSections.clear();
+ int32_t sectionCount;
+ err = in->readInt32(§ionCount);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ for (int i=0; i<sectionCount; i++) {
+ int32_t section;
+ err = in->readInt32(§ion);
+ if (err != NO_ERROR) {
+ return err;
+ }
+
+ mSections.insert(section);
+ }
+
+ int32_t headerCount;
+ err = in->readInt32(&headerCount);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ mHeaders.resize(headerCount);
+ for (int i=0; i<headerCount; i++) {
+ err = in->readByteVector(&mHeaders[i]);
+ if (err != NO_ERROR) {
+ return err;
+ }
+ }
+
+ return OK;
+}
+
+void
+IncidentReportArgs::setAll(bool all)
+{
+ mAll = all;
+ if (all) {
+ mSections.clear();
+ }
+}
+
+void
+IncidentReportArgs::addSection(int section)
+{
+ if (!mAll) {
+ mSections.insert(section);
+ }
+}
+
+void
+IncidentReportArgs::addHeader(const vector<int8_t>& header)
+{
+ mHeaders.push_back(header);
+}
+
+bool
+IncidentReportArgs::containsSection(int section) const
+{
+ return mAll || mSections.find(section) != mSections.end();
+}
+
+void
+IncidentReportArgs::merge(const IncidentReportArgs& that)
+{
+ if (mAll) {
+ return;
+ } else if (that.mAll) {
+ mAll = true;
+ mSections.clear();
+ } else {
+ for (set<int>::const_iterator it=that.mSections.begin();
+ it!=that.mSections.end(); it++) {
+ mSections.insert(*it);
+ }
+ }
+}
+
+}
+}