idevicediagnostics: Implement multiple commands to make the tool useful

1 files changed, 200 insertions, 35 deletions

diff --git a/tools/idevicediagnostics.c b/tools/idevicediagnostics.c
index e0bcb48..93211c3 100644
--- a/tools/idevicediagnostics.c
+++ b/tools/idevicediagnostics.c
@@ -31,13 +31,24 @@
 #include <libimobiledevice/lockdown.h>
 #include <libimobiledevice/diagnostics_relay.h>
 
+enum cmd_mode {
+        CMD_NONE = 0,
+        CMD_SLEEP,
+        CMD_RESTART,
+        CMD_SHUTDOWN,
+        CMD_DIAGNOSTICS,
+        CMD_MOBILEGESTALT,
+        CMD_IOREGISTRY
+};
+
 static void print_xml(plist_t node)
 {
         char *xml = NULL;
         uint32_t len = 0;
         plist_to_xml(node, &xml, &len);
-        if (xml)
+        if (xml) {
                 puts(xml);
+        }
 }
 
 void print_usage(int argc, char **argv);
@@ -45,12 +56,17 @@ void print_usage(int argc, char **argv);
 int main(int argc, char **argv)
 {
         idevice_t device = NULL;
-        lockdownd_client_t lckd = NULL;
-        diagnostics_relay_client_t diagc = NULL;
+        lockdownd_client_t lockdown_client = NULL;
+        diagnostics_relay_client_t diagnostics_client = NULL;
+        lockdownd_error_t ret = LOCKDOWN_E_UNKNOWN_ERROR;
         uint16_t port = 0;
         int result = -1;
         int i;
         char *udid = NULL;
+        int cmd = CMD_NONE;
+        char* cmd_arg = NULL;
+        plist_t node = NULL;
+        plist_t keys = NULL;
 
         /* parse cmdline args */
         for (i = 1; i < argc; i++) {
@@ -62,14 +78,81 @@ int main(int argc, char **argv)
                         i++;
                         if (!argv[i] || (strlen(argv[i]) != 40)) {
                                 print_usage(argc, argv);
-                                return 0;
+                                result = 0;
+                                goto cleanup;
                         }
                         udid = strdup(argv[i]);
                         continue;
                 }
                 else if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
                         print_usage(argc, argv);
-                        return 0;
+                        result = 0;
+                        goto cleanup;
+                }
+                else if (!strcmp(argv[i], "sleep")) {
+                        cmd = CMD_SLEEP;
+                }
+                else if (!strcmp(argv[i], "restart")) {
+                        cmd = CMD_RESTART;
+                }
+                else if (!strcmp(argv[i], "shutdown")) {
+                        cmd = CMD_SHUTDOWN;
+                }
+                else if (!strcmp(argv[i], "diagnostics")) {
+                        cmd = CMD_DIAGNOSTICS;
+                        /*  read type */
+                        i++;
+                        if (!argv[i] || ((strcmp(argv[i], "All") != 0) && (strcmp(argv[i], "WiFi") != 0) && (strcmp(argv[i], "GasGauge") != 0) && (strcmp(argv[i], "NAND") != 0))) {
+                                if (argv[i] == NULL) {
+                                        cmd_arg = strdup("All");
+                                        continue;
+                                }
+
+                                if (!strncmp(argv[i], "-", 1)) {
+                                        cmd_arg = strdup("All");
+                                        i--;
+                                        continue;
+                                }
+
+                                printf("Unknown TYPE %s\n", argv[i]);
+                                print_usage(argc, argv);
+                                goto cleanup;
+                        }
+
+                        cmd_arg = strdup(argv[i]);
+                        continue;
+                }
+                else if (!strcmp(argv[i], "mobilegestalt")) {
+                        cmd = CMD_MOBILEGESTALT;
+                        /*  read keys */
+                        i++;
+
+                        if (!argv[i] || argv[i] == NULL || (!strncmp(argv[i], "-", 1))) {
+                                printf("Please supply the key to query.\n");
+                                print_usage(argc, argv);
+                                goto cleanup;
+                        }
+
+                        keys = plist_new_array();
+                        while(1) {
+                                if (argv[i] && (strlen(argv[i]) >= 2) && (strncmp(argv[i], "-", 1) != 0)) {
+                                        plist_array_append_item(keys, plist_new_string(argv[i]));
+                                        i++;
+                                } else {
+                                        i--;
+                                        break;
+                                }
+                        }
+                        continue;
+                }
+                else if (!strcmp(argv[i], "ioreg")) {
+                        cmd = CMD_IOREGISTRY;
+                        /*  read plane */
+                        i++;
+                        if (argv[i]) {
+                                cmd_arg = strdup(argv[i]);
+                        }
+                        continue;
                 }
                 else {
                         print_usage(argc, argv);
@@ -77,58 +160,140 @@ int main(int argc, char **argv)
                 }
         }
 
+        /* verify options */
+        if (cmd == CMD_NONE) {
+                print_usage(argc, argv);
+                goto cleanup;
+        }
+
         if (IDEVICE_E_SUCCESS != idevice_new(&device, udid)) {
                 printf("No device found, is it plugged in?\n");
-                if (udid) {
-                        free(udid);
-                }
-                return -1;
+                goto cleanup;
         }
+
         if (udid) {
                 free(udid);
         }
 
-        if (LOCKDOWN_E_SUCCESS != lockdownd_client_new_with_handshake(device, &lckd, NULL)) {
+        if (LOCKDOWN_E_SUCCESS != lockdownd_client_new_with_handshake(device, &lockdown_client, NULL)) {
                 idevice_free(device);
-                printf("Exiting.\n");
-                return -1;
+                printf("Unable to connect to lockdownd.\n");
+                goto cleanup;
         }
 
-        lockdownd_start_service(lckd, "com.apple.mobile.diagnostics_relay", &port);
-        lockdownd_client_free(lckd);
-        if (port > 0) {
-                if (diagnostics_relay_client_new(device, port, &diagc) != DIAGNOSTICS_RELAY_E_SUCCESS) {
+        /*  attempt to use newer diagnostics service available on iOS 5 and later */
+        ret = lockdownd_start_service(lockdown_client, "com.apple.mobile.diagnostics_relay", &port);
+        if (ret != LOCKDOWN_E_SUCCESS) {
+                /*  attempt to use older diagnostics service */
+                ret = lockdownd_start_service(lockdown_client, "com.apple.iosdiagnostics.relay", &port);
+        }
+
+        lockdownd_client_free(lockdown_client);
+
+        if ((ret == LOCKDOWN_E_SUCCESS) && (port > 0)) {
+                if (diagnostics_relay_client_new(device, port, &diagnostics_client) != DIAGNOSTICS_RELAY_E_SUCCESS) {
                         printf("Could not connect to diagnostics_relay!\n");
                         result = -1;
                 } else {
-                        plist_t node = NULL;
-                        if (diagnostics_relay_request_diagnostics(diagc, DIAGNOSTICS_RELAY_REQUEST_TYPE_ALL, &node) != DIAGNOSTICS_RELAY_E_SUCCESS) {
-                                printf("Unable to retrieve diagnostics");
+                        switch (cmd) {
+                                case CMD_SLEEP:
+                                        if (diagnostics_relay_sleep(diagnostics_client) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                printf("Putting device into deep sleep mode.\n");
+                                                result = EXIT_SUCCESS;
+                                        } else {
+                                                printf("Failed to put device into deep sleep mode.\n");
+                                        }
+                                break;
+                                case CMD_RESTART:
+                                        if (diagnostics_relay_restart(diagnostics_client, 0) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                printf("Restarting device.\n");
+                                                result = EXIT_SUCCESS;
+                                        } else {
+                                                printf("Failed to restart device.\n");
+                                        }
+                                break;
+                                case CMD_SHUTDOWN:
+                                        if (diagnostics_relay_shutdown(diagnostics_client, 0) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                printf("Shutting down device.\n");
+                                                result = EXIT_SUCCESS;
+                                        } else {
+                                                printf("Failed to shutdown device.\n");
+                                        }
+                                break;
+                                case CMD_MOBILEGESTALT:
+                                        if (diagnostics_relay_query_mobilegestalt(diagnostics_client, keys, &node) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                if (node) {
+                                                        print_xml(node);
+                                                        result = EXIT_SUCCESS;
+                                                }
+                                        } else {
+                                                printf("Unable to query mobilegestalt keys.\n");
+                                        }
+                                break;
+                                case CMD_IOREGISTRY:
+                                        if (diagnostics_relay_query_ioregistry_plane(diagnostics_client, cmd_arg == NULL ? "": cmd_arg, &node) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                if (node) {
+                                                        print_xml(node);
+                                                        result = EXIT_SUCCESS;
+                                                }
+                                        } else {
+                                                printf("Unable to retrieve IORegistry from device.\n");
+                                        }
+                                        break;
+                                case CMD_DIAGNOSTICS:
+                                default:
+                                        if (diagnostics_relay_request_diagnostics(diagnostics_client, cmd_arg, &node) == DIAGNOSTICS_RELAY_E_SUCCESS) {
+                                                if (node) {
+                                                        print_xml(node);
+                                                        result = EXIT_SUCCESS;
+                                                }
+                                        } else {
+                                                printf("Unable to retrieve diagnostics from device.\n");
+                                        }
+                                        break;
                         }
-                        if (node) {
-                                print_xml(node);
-                                plist_free(node);
-                        }
-                        diagnostics_relay_goodbye(diagc);
-                        diagnostics_relay_client_free(diagc);
+
+                        diagnostics_relay_goodbye(diagnostics_client);
+                        diagnostics_relay_client_free(diagnostics_client);
                 }
         } else {
                 printf("Could not start diagnostics service!\n");
         }
+
         idevice_free(device);
-        
+
+cleanup:
+        if (udid) {
+                free(udid);
+        }
+        if (node) {
+                plist_free(node);
+        }
+        if (keys) {
+                plist_free(keys);
+        }
+        if (cmd_arg) {
+                free(cmd_arg);
+        }
         return result;
 }
 
 void print_usage(int argc, char **argv)
 {
-        char *name = NULL;
-
-        name = strrchr(argv[0], '/');
-        printf("Usage: %s [OPTIONS]\n", (name ? name + 1: argv[0]));
-        printf("Retrieves diagnostics information from a device.\n\n");
-        printf("  -d, --debug\t\tenable communication debugging\n");
-        printf("  -u, --udid UDID\ttarget specific device by its 40-digit device UDID\n");
-        printf("  -h, --help\t\tprints usage information\n");
-        printf("\n");
+        char *name = NULL;
+        name = strrchr(argv[0], '/');
+        printf("Usage: %s COMMAND [OPTIONS]\n", (name ? name + 1: argv[0]));
+        printf("Use diagnostics interface of a device running iOS 4 or later.\n\n");
+        printf(" Where COMMAND is one of:\n");
+        printf("  diagnostics [TYPE]\t\tprint diagnostics information from device by TYPE (All, WiFi, GasGauge, NAND)\n");
+        printf("  mobilegestalt KEY [...]\tprint mobilegestalt keys passed as arguments seperated by a space.\n");
+        printf("  ioreg [PLANE]\t\t\tprint IORegistry of device, optionally by PLANE (IODeviceTree, IOPower, IOService) (iOS 5+ only)\n");
+        printf("  shutdown\t\t\tshutdown device\n");
+        printf("  restart\t\t\trestart device\n");
+        printf("  sleep\t\t\t\tput device into sleep mode (disconnects from host)\n\n");
+        printf(" The following OPTIONS are accepted:\n");
+        printf("  -d, --debug\t\tenable communication debugging\n");
+        printf("  -u, --udid UDID\ttarget specific device by its 40-digit device UDID\n");
+        printf("  -h, --help\t\tprints usage information\n");
+        printf("\n");
 }