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

Commit 58d72e22 authored by Nandana Dutt's avatar Nandana Dutt
Browse files

Add a bugreport mode 

ActivityManager sets a system property to encapsulate a bunch of
commandline arguments to dumpstate. Provide an enumerated alternative so
it can be used in the new binder service.

Bug: 117177665
Test: adb shell /data/nativetest64/dumpstate_test/dumpstate_test
Change-Id: I24cdc2e750e3a00e49d7053a05ddae05d6348bc4
parent c435db5d

cmds/dumpstate/dumpstate.cpp

+107 −13
Original line number Diff line number Diff line
@@ -1934,37 +1934,95 @@ static void SendBugreportFinishedBroadcast() { 
    }

}



// TODO: Move away from system properties when we have options passed via binder calls.

/* Sets runtime options from the system properties and then clears those properties. */

static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {

    options->extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");

    if (!options->extra_options.empty()) {

        // Framework uses a system property to override some command-line args.

        // Currently, it contains the type of the requested bugreport.

        if (options->extra_options == "bugreportplus") {

static inline const char* ModeToString(Dumpstate::BugreportMode mode) {

    switch (mode) {

        case Dumpstate::BugreportMode::BUGREPORT_FULL:

            return "BUGREPORT_FULL";

        case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:

            return "BUGREPORT_INTERACTIVE";

        case Dumpstate::BugreportMode::BUGREPORT_REMOTE:

            return "BUGREPORT_REMOTE";

        case Dumpstate::BugreportMode::BUGREPORT_WEAR:

            return "BUGREPORT_WEAR";

        case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:

            return "BUGREPORT_TELEPHONY";

        case Dumpstate::BugreportMode::BUGREPORT_WIFI:

            return "BUGREPORT_WIFI";

    }

}



static void SetOptionsFromMode(Dumpstate::BugreportMode mode, Dumpstate::DumpOptions* options) {

    switch (mode) {

        case Dumpstate::BugreportMode::BUGREPORT_FULL:

            options->do_broadcast = true;

            options->do_fb = true;

            break;

        case Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE:

            // Currently, the dumpstate binder is only used by Shell to update progress.

            options->do_start_service = true;

            options->do_progress_updates = true;

            options->do_fb = false;

        } else if (options->extra_options == "bugreportremote") {

            options->do_broadcast = true;

            break;

        case Dumpstate::BugreportMode::BUGREPORT_REMOTE:

            options->do_vibrate = false;

            options->is_remote_mode = true;

            options->do_fb = false;

        } else if (options->extra_options == "bugreportwear") {

            options->do_broadcast = true;

            break;

        case Dumpstate::BugreportMode::BUGREPORT_WEAR:

            options->do_start_service = true;

            options->do_progress_updates = true;

            options->do_zip_file = true;

        } else if (options->extra_options == "bugreporttelephony") {

            options->do_fb = true;

            options->do_broadcast = true;

            break;

        case Dumpstate::BugreportMode::BUGREPORT_TELEPHONY:

            options->telephony_only = true;

        } else if (options->extra_options == "bugreportwifi") {

            options->do_fb = true;

            options->do_broadcast = true;

            break;

        case Dumpstate::BugreportMode::BUGREPORT_WIFI:

            options->wifi_only = true;

            options->do_zip_file = true;

            options->do_fb = true;

            options->do_broadcast = true;

            break;

    }

}



static Dumpstate::BugreportMode getBugreportModeFromProperty() {

    // If the system property is not set, it's assumed to be a full bugreport.

    Dumpstate::BugreportMode mode = Dumpstate::BugreportMode::BUGREPORT_FULL;



    std::string extra_options = android::base::GetProperty(PROPERTY_EXTRA_OPTIONS, "");

    if (!extra_options.empty()) {

        // Framework uses a system property to override some command-line args.

        // Currently, it contains the type of the requested bugreport.

        if (extra_options == "bugreportplus") {

            mode = Dumpstate::BugreportMode::BUGREPORT_INTERACTIVE;

        } else if (extra_options == "bugreportremote") {

            mode = Dumpstate::BugreportMode::BUGREPORT_REMOTE;

        } else if (extra_options == "bugreportwear") {

            mode = Dumpstate::BugreportMode::BUGREPORT_WEAR;

        } else if (extra_options == "bugreporttelephony") {

            mode = Dumpstate::BugreportMode::BUGREPORT_TELEPHONY;

        } else if (extra_options == "bugreportwifi") {

            mode = Dumpstate::BugreportMode::BUGREPORT_WIFI;

        } else {

            MYLOGE("Unknown extra option: %s\n", options->extra_options.c_str());

            MYLOGE("Unknown extra option: %s\n", extra_options.c_str());

        }

        // Reset the property

        android::base::SetProperty(PROPERTY_EXTRA_OPTIONS, "");

    }

    return mode;

}



// TODO: Move away from system properties when we have options passed via binder calls.

/* Sets runtime options from the system properties and then clears those properties. */

static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) {

    Dumpstate::BugreportMode mode = getBugreportModeFromProperty();

    SetOptionsFromMode(mode, options);



    options->notification_title = android::base::GetProperty(PROPERTY_EXTRA_TITLE, "");

    if (!options->notification_title.empty()) {
@@ -1982,6 +2040,40 @@ static void SetOptionsFromProperties(Dumpstate::DumpOptions* options) { 
    }

}



static void LogDumpOptions(const Dumpstate::DumpOptions& options) {

    MYLOGI("do_zip_file: %d\n", options.do_zip_file);

    MYLOGI("do_add_date: %d\n", options.do_add_date);

    MYLOGI("do_vibrate: %d\n", options.do_vibrate);

    MYLOGI("use_socket: %d\n", options.use_socket);

    MYLOGI("use_control_socket: %d\n", options.use_control_socket);

    MYLOGI("do_fb: %d\n", options.do_fb);

    MYLOGI("do_broadcast: %d\n", options.do_broadcast);

    MYLOGI("is_remote_mode: %d\n", options.is_remote_mode);

    MYLOGI("show_header_only: %d\n", options.show_header_only);

    MYLOGI("do_start_service: %d\n", options.do_start_service);

    MYLOGI("telephony_only: %d\n", options.telephony_only);

    MYLOGI("wifi_only: %d\n", options.wifi_only);

    MYLOGI("do_progress_updates: %d\n", options.do_progress_updates);

    MYLOGI("use_outfile: %s\n", options.use_outfile.c_str());

    MYLOGI("extra_options: %s\n", options.extra_options.c_str());

    MYLOGI("args: %s\n", options.args.c_str());

    MYLOGI("notification_title: %s\n", options.notification_title.c_str());

    MYLOGI("notification_description: %s\n", options.notification_description.c_str());

}



void Dumpstate::DumpOptions::Initialize(BugreportMode bugreport_mode) {

    // In the new API world, date is always added; output is always a zip file.

    // TODO(111441001): remove these options once they are obsolete.

    do_add_date = true;

    do_zip_file = true;



    // STOPSHIP b/111441001: Remove hardcoded output file path; accept fd.

    use_outfile = "/data/user_de/0/com.android.shell/files/bugreports/bugreport";



    extra_options = ModeToString(bugreport_mode);

    SetOptionsFromMode(bugreport_mode, this);

}



Dumpstate::RunStatus Dumpstate::DumpOptions::Initialize(int argc, char* argv[]) {

    RunStatus status = RunStatus::OK;

    int c;
@@ -2048,6 +2140,8 @@ bool Dumpstate::DumpOptions::ValidateOptions() const { 


Dumpstate::RunStatus Dumpstate::RunWithOptions(std::unique_ptr<DumpOptions> options) {

    if (!options->ValidateOptions()) {

        MYLOGE("Invalid options specified\n");

        LogDumpOptions(*options);

        return RunStatus::INVALID_INPUT;

    }

    options_ = std::move(options);

cmds/dumpstate/dumpstate.h

+18 −0
Original line number Diff line number Diff line
@@ -42,6 +42,9 @@ 
// TODO: and then remove explicitly android::os::dumpstate:: prefixes

namespace android {

namespace os {



struct DumpstateOptions;



namespace dumpstate {



class DumpstateTest;
@@ -185,6 +188,17 @@ class Dumpstate { 
  public:

    enum RunStatus { OK, HELP, INVALID_INPUT, ERROR };



    // TODO(117177665): should enumerate constants in the AIDL file.

    // The mode under which the bugreport should be run. Each mode encapsulates a few options.

    enum BugreportMode {

        BUGREPORT_FULL,

        BUGREPORT_INTERACTIVE,

        BUGREPORT_REMOTE,

        BUGREPORT_WEAR,

        BUGREPORT_TELEPHONY,

        BUGREPORT_WIFI

    };



    static android::os::dumpstate::CommandOptions DEFAULT_DUMPSYS;



    static Dumpstate& GetInstance();
@@ -317,6 +331,7 @@ class Dumpstate { 
        // Whether progress updates should be published.

        bool do_progress_updates = false;

        std::string use_outfile;

        // TODO: rename to MODE.

        // Extra options passed as system property.

        std::string extra_options;

        // Command-line arguments as string
@@ -328,6 +343,9 @@ class Dumpstate { 
        /* Initializes options from commandline arguments and system properties. */

        RunStatus Initialize(int argc, char* argv[]);



        /* Initializes options from the requested mode. */

        void Initialize(BugreportMode bugreport_mode);



        /* Returns true if the options set so far are consistent. */

        bool ValidateOptions() const;

    };

cmds/dumpstate/tests/dumpstate_test.cpp

+6 −5
Original line number Diff line number Diff line
@@ -159,10 +159,11 @@ TEST_F(DumpOptionsTest, InitializeNone) { 
    };

    // clang-format on



    Dumpstate::DumpOptions options;

    Dumpstate::RunStatus status = options_.Initialize(ARRAY_SIZE(argv), argv);



    EXPECT_EQ(status, Dumpstate::RunStatus::OK);



    // These correspond to bugreport_mode = full, because that's the default.

    EXPECT_FALSE(options_.do_add_date);

    EXPECT_FALSE(options_.do_zip_file);

    EXPECT_EQ("", options_.use_outfile);
@@ -170,10 +171,10 @@ TEST_F(DumpOptionsTest, InitializeNone) { 
    EXPECT_FALSE(options_.use_control_socket);

    EXPECT_FALSE(options_.show_header_only);

    EXPECT_TRUE(options_.do_vibrate);

    EXPECT_FALSE(options_.do_fb);

    EXPECT_TRUE(options_.do_fb);

    EXPECT_FALSE(options_.do_progress_updates);

    EXPECT_FALSE(options_.is_remote_mode);

    EXPECT_FALSE(options_.do_broadcast);

    EXPECT_TRUE(options_.do_broadcast);

}



TEST_F(DumpOptionsTest, InitializePartial1) {
@@ -202,10 +203,10 @@ TEST_F(DumpOptionsTest, InitializePartial1) { 
    // Other options retain default values

    EXPECT_FALSE(options_.show_header_only);

    EXPECT_TRUE(options_.do_vibrate);

    EXPECT_FALSE(options_.do_fb);

    EXPECT_TRUE(options_.do_fb);

    EXPECT_FALSE(options_.do_progress_updates);

    EXPECT_FALSE(options_.is_remote_mode);

    EXPECT_FALSE(options_.do_broadcast);

    EXPECT_TRUE(options_.do_broadcast);

}



TEST_F(DumpOptionsTest, InitializePartial2) {