Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 22ff08b9 authored by Mike Ma's avatar Mike Ma
Browse files

Persisted log parser for incident reporting 

Add persisted log section (section 1116) in incident report. Since
persisted logs are only stored in /data/misc/logd in plain text
format with interleaving log buffers, incidentd must use a dedicated
parser to parse them into protobuf, and it is more efficient to store
all buffers in a single section.

Implementation details: incidentd invokes incident-helper-cmd, who
reads all persisted log files in /data/misc/logd dir matching
logcat.* pattern, parses them line by line into TextLogEntry, and
passes the data back to incidentd through stdout in protobuf wire
format.

Command to invoke persisted log directly:
$ incident-helper-cmd run persisted_logs

Bug: 146086597
Test: adb shell incident -p EXPLICIT 1116 | \
      .out/soong/host/linux-x86/bin/aprotoc --decode_raw
Change-Id: I163cc47f1b34a58b404d7b7485ff47d8893e3bdd
parent a4d4f94e

cmds/incident_helper/Android.bp

+25 −0
Original line number Diff line number Diff line 
// Copyright (C) 2017 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.



java_binary {

    name: "incident-helper-cmd",

    wrapper: "incident_helper_cmd",

    srcs: [

        "java/**/*.java",

    ],

    proto: {

        plugin: "javastream",

    },

}



cc_defaults {

    name: "incident_helper_defaults",

cmds/incident_helper/incident_helper_cmd

0 → 100644
+6 −0
Original line number Diff line number Diff line 
#!/system/bin/sh

# Script to start "incident_helper_cmd" on the device

#

base=/system

export CLASSPATH=$base/framework/incident-helper-cmd.jar

exec app_process $base/bin com.android.commands.incident.IncidentHelper "$@"

cmds/incident_helper/java/com/android/commands/incident/ExecutionException.java

0 → 100644
+40 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2020 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 com.android.commands.incident;



/**

 * Thrown when there is an error executing a section.

 */

public class ExecutionException extends Exception {

    /**

     * Constructs a ExecutionException.

     *

     * @param msg the message

     */

    public ExecutionException(String msg) {

        super(msg);

    }



    /**

     * Constructs a ExecutionException from another exception.

     *

     * @param e the exception

     */

    public ExecutionException(Exception e) {

        super(e);

    }

}

cmds/incident_helper/java/com/android/commands/incident/IncidentHelper.java

0 → 100644
+124 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2020 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 com.android.commands.incident;



import android.util.Log;



import com.android.commands.incident.sections.PersistLogSection;



import java.io.PrintStream;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.List;

import java.util.ListIterator;



/**

 * Helper command runner for incidentd to run customized command to gather data for a non-standard

 * section.

 */

public class IncidentHelper {

    private static final String TAG = "IncidentHelper";

    private static boolean sLog = false;

    private final List<String> mArgs;

    private ListIterator<String> mArgsIterator;



    private IncidentHelper(String[] args) {

        mArgs = Collections.unmodifiableList(Arrays.asList(args));

        mArgsIterator = mArgs.listIterator();

    }



    private static void showUsage(PrintStream out) {

        out.println("This command is not designed to be run manually.");

        out.println("Usage:");

        out.println("  run [sectionName]");

    }



    private void run(String[] args) throws ExecutionException {

        Section section = null;

        List<String> sectionArgs = new ArrayList<>();

        while (mArgsIterator.hasNext()) {

            String arg = mArgsIterator.next();

            if ("-l".equals(arg)) {

                sLog = true;

                Log.i(TAG, "Args: [" + String.join(",", args) + "]");

            } else if ("run".equals(arg)) {

                section = getSection(nextArgRequired());

                mArgsIterator.forEachRemaining(sectionArgs::add);

                break;

            } else {

                log(Log.WARN, TAG, "Error: Unknown argument: " + arg);

                return;

            }

        }

        section.run(System.in, System.out, sectionArgs);

    }



    private static Section getSection(String name) throws IllegalArgumentException {

        if ("persisted_logs".equals(name)) {

            return new PersistLogSection();

        }

        throw new IllegalArgumentException("Section not found: " + name);

    }



    private String nextArgRequired() {

        if (!mArgsIterator.hasNext()) {

            throw new IllegalArgumentException(

                    "Arg required after \"" + mArgs.get(mArgsIterator.previousIndex()) + "\"");

        }

        return mArgsIterator.next();

    }



    /**

     * Print the given message to stderr, also log it if asked to (set by -l cmd arg).

     */

    public static void log(int priority, String tag, String msg) {

        System.err.println(tag + ": " + msg);

        if (sLog) {

            Log.println(priority, tag, msg);

        }

    }



    /**

     * Command-line entry point.

     *

     * @param args The command-line arguments

     */

    public static void main(String[] args) {

        if (args.length == 0) {

            showUsage(System.err);

            System.exit(0);

        }

        IncidentHelper incidentHelper = new IncidentHelper(args);

        try {

            incidentHelper.run(args);

        } catch (IllegalArgumentException e) {

            showUsage(System.err);

            System.err.println();

            e.printStackTrace(System.err);

            if (sLog) {

                Log.e(TAG, "Error: ", e);

            }

        } catch (Exception e) {

            e.printStackTrace(System.err);

            if (sLog) {

                Log.e(TAG, "Error: ", e);

            }

            System.exit(1);

        }

    }

}

cmds/incident_helper/java/com/android/commands/incident/Section.java

0 → 100644
+29 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2020 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 com.android.commands.incident;



import java.io.InputStream;

import java.io.OutputStream;

import java.util.List;



/** Section interface used by {@link IncidentHelper}. */

public interface Section {

    /**

     * Writes protobuf wire format to out, optionally reads data from in, with supplied args.

     */

    void run(InputStream in, OutputStream out, List<String> args) throws ExecutionException;

}