Refactor some packet-building for readability and safety
[oweals/dinit.git] / src / dinitctl.cc
index fadc2fb055bd3ce99bd7b40e2521266e0a65fe37..f260bf0a9d0aa5d1a4f4708357b010e7845b8f31 100644 (file)
 #include "dinit-client.h"
 #include "load-service.h"
 #include "dinit-util.h"
+#include "mconfig.h"
 
 // dinitctl:  utility to control the Dinit daemon, including starting and stopping of services.
 
-// This utility communicates with the dinit daemon via a unix stream socket (/dev/initctl,
-// or $HOME/.dinitctl).
+// This utility communicates with the dinit daemon via a unix stream socket (as specified in
+// SYSCONTROLSOCKET, or $HOME/.dinitctl).
 
 static constexpr uint16_t min_cp_version = 1;
 static constexpr uint16_t max_cp_version = 1;
@@ -37,7 +38,7 @@ enum class command_t;
 static int issue_load_service(int socknum, const char *service_name, bool find_only = false);
 static int check_load_reply(int socknum, cpbuffer_t &, handle_t *handle_p, service_state_t *state_p);
 static int start_stop_service(int socknum, cpbuffer_t &, const char *service_name, command_t command,
-        bool do_pin, bool wait_for_service, bool verbose);
+        bool do_pin, bool do_force, bool wait_for_service, bool verbose);
 static int unpin_service(int socknum, cpbuffer_t &, const char *service_name, bool verbose);
 static int unload_service(int socknum, cpbuffer_t &, const char *service_name);
 static int list_services(int socknum, cpbuffer_t &);
@@ -62,6 +63,7 @@ enum class command_t {
     START_SERVICE,
     WAKE_SERVICE,
     STOP_SERVICE,
+    RESTART_SERVICE,
     RELEASE_SERVICE,
     UNPIN_SERVICE,
     UNLOAD_SERVICE,
@@ -92,6 +94,7 @@ int main(int argc, char **argv)
     bool sys_dinit = false;  // communicate with system daemon
     bool wait_for_service = true;
     bool do_pin = false;
+    bool do_force = false;
     
     command_t command = command_t::NONE;
         
@@ -113,6 +116,14 @@ int main(int argc, char **argv)
             else if (strcmp(argv[i], "--pin") == 0) {
                 do_pin = true;
             }
+            else if (strcmp(argv[i], "--socket-path") == 0 || strcmp(argv[i], "-p") == 0) {
+                ++i;
+                if (i == argc) {
+                    cerr << "dinitctl: --socket-path/-p should be followed by socket path" << std::endl;
+                    return 1;
+                }
+                control_socket_str = argv[i];
+            }
             else if ((command == command_t::ENABLE_SERVICE || command == command_t::DISABLE_SERVICE)
                     && strcmp(argv[i], "--from") == 0) {
                 ++i;
@@ -122,8 +133,12 @@ int main(int argc, char **argv)
                 }
                 service_name = argv[i];
             }
+            else if ((command == command_t::STOP_SERVICE || command == command_t::RESTART_SERVICE)
+                    && (strcmp(argv[i], "--force") == 0 || strcmp(argv[i], "-f") == 0)) {
+                do_force = true;
+            }
             else {
-                cerr << "dinitctl: unrecognized option: " << argv[i] << " (use --help for help)\n";
+                cerr << "dinitctl: unrecognized/invalid option: " << argv[i] << " (use --help for help)\n";
                 return 1;
             }
         }
@@ -137,6 +152,9 @@ int main(int argc, char **argv)
             else if (strcmp(argv[i], "stop") == 0) {
                 command = command_t::STOP_SERVICE;
             }
+            else if (strcmp(argv[i], "restart") == 0) {
+                command = command_t::RESTART_SERVICE;
+            }
             else if (strcmp(argv[i], "release") == 0) {
                 command = command_t::RELEASE_SERVICE;
             }
@@ -244,49 +262,56 @@ int main(int argc, char **argv)
           "    dinitctl [options] wake [options] <service-name>\n"
           "    dinitctl [options] release [options] <service-name>\n"
           "    dinitctl [options] unpin <service-name>\n"
-          "    dinitctl unload <service-name>\n"
-          "    dinitctl list\n"
-          "    dinitctl shutdown\n"
-          "    dinitctl add-dep <type> <from-service> <to-service>\n"
-          "    dinitctl rm-dep <type> <from-service> <to-service>\n"
-          "    dinitctl enable [--from <from-service>] <to-service>\n"
-          "    dinitctl disable [--from <from-service>] <to-service>\n"
+          "    dinitctl [options] unload <service-name>\n"
+          "    dinitctl [options] list\n"
+          "    dinitctl [options] shutdown\n"
+          "    dinitctl [options] add-dep <type> <from-service> <to-service>\n"
+          "    dinitctl [options] rm-dep <type> <from-service> <to-service>\n"
+          "    dinitctl [options] enable [--from <from-service>] <to-service>\n"
+          "    dinitctl [options] disable [--from <from-service>] <to-service>\n"
           "\n"
           "Note: An activated service continues running when its dependents stop.\n"
           "\n"
           "General options:\n"
+          "  --help           : show this help\n"
           "  -s, --system     : control system daemon instead of user daemon\n"
           "  --quiet          : suppress output (except errors)\n"
+          "  --socket-path <path>, -p <path>\n"
+          "                   : specify socket for communication with daemon\n"
           "\n"
           "Command options:\n"
-          "  --help           : show this help\n"
           "  --no-wait        : don't wait for service startup/shutdown to complete\n"
-          "  --pin            : pin the service in the requested state\n";
+          "  --pin            : pin the service in the requested state\n"
+          "  --force          : force stop even if dependents will be affected\n";
         return 1;
     }
     
     signal(SIGPIPE, SIG_IGN);
     
-    control_socket_path = "/dev/dinitctl";
-    
     // Locate control socket
-    if (! sys_dinit) {
-        char * userhome = getenv("HOME");
-        if (userhome == nullptr) {
-            struct passwd * pwuid_p = getpwuid(getuid());
-            if (pwuid_p != nullptr) {
-                userhome = pwuid_p->pw_dir;
+    if (! control_socket_str.empty()) {
+        control_socket_path = control_socket_str.c_str();
+    }
+    else {
+        control_socket_path = SYSCONTROLSOCKET; // default to system
+        if (! sys_dinit) {
+            char * userhome = getenv("HOME");
+            if (userhome == nullptr) {
+                struct passwd * pwuid_p = getpwuid(getuid());
+                if (pwuid_p != nullptr) {
+                    userhome = pwuid_p->pw_dir;
+                }
+            }
+
+            if (userhome != nullptr) {
+                control_socket_str = userhome;
+                control_socket_str += "/.dinitctl";
+                control_socket_path = control_socket_str.c_str();
+            }
+            else {
+                cerr << "Cannot locate user home directory (set HOME or check /etc/passwd file)" << endl;
+                return 1;
             }
-        }
-        
-        if (userhome != nullptr) {
-            control_socket_str = userhome;
-            control_socket_str += "/.dinitctl";
-            control_socket_path = control_socket_str.c_str();
-        }
-        else {
-            cerr << "Cannot locate user home directory (set HOME or check /etc/passwd file)" << endl;
-            return 1;
         }
     }
     
@@ -343,7 +368,7 @@ int main(int argc, char **argv)
                     command == command_t::ENABLE_SERVICE);
         }
         else {
-            return start_stop_service(socknum, rbuffer, service_name, command, do_pin,
+            return start_stop_service(socknum, rbuffer, service_name, command, do_pin, do_force,
                     wait_for_service, verbose);
         }
     }
@@ -418,9 +443,57 @@ static bool load_service(int socknum, cpbuffer_t &rbuffer, const char *name, han
     return true;
 }
 
+// Get the service name for a given handle, by querying the daemon.
+static std::string get_service_name(int socknum, cpbuffer_t &rbuffer, handle_t handle)
+{
+    auto m = membuf()
+            .append((char) DINIT_CP_QUERYSERVICENAME)
+            .append((char) 0)
+            .append(handle);
+    write_all_x(socknum, m);
+
+    wait_for_reply(rbuffer, socknum);
+
+    if (rbuffer[0] != DINIT_RP_SERVICENAME) {
+        throw cp_read_exception{0};
+    }
+
+    // 1 byte reserved
+    // uint16_t size
+    fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint16_t));
+    uint16_t namesize;
+    rbuffer.extract(&namesize, 2, sizeof(uint16_t));
+    rbuffer.consume(2 + sizeof(uint16_t));
+
+    std::string name;
+
+    do {
+        if (rbuffer.get_length() == 0) {
+            rbuffer.fill(socknum);
+        }
+
+        size_t to_extract = std::min(size_t(rbuffer.get_length()), namesize - name.length());
+        size_t contiguous_len = rbuffer.get_contiguous_length(rbuffer.get_ptr(0));
+        if (contiguous_len <= to_extract) {
+            name.append(rbuffer.get_ptr(0), contiguous_len);
+            rbuffer.consume(contiguous_len);
+            name.append(rbuffer.get_ptr(0), to_extract - contiguous_len);
+            rbuffer.consume(to_extract - contiguous_len);
+        }
+        else {
+            name.append(rbuffer.get_ptr(0), to_extract);
+            rbuffer.consume(to_extract);
+            break;
+        }
+
+    } while (name.length() < namesize);
+
+    return name;
+}
+
 // Start/stop a service
 static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *service_name,
-        command_t command, bool do_pin, bool wait_for_service, bool verbose)
+        command_t command, bool do_pin, bool do_force, bool wait_for_service, bool verbose)
 {
     using namespace std;
 
@@ -437,6 +510,7 @@ static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *serv
     int pcommand = 0;
     switch (command) {
         case command_t::STOP_SERVICE:
+        case command_t::RESTART_SERVICE:  // stop, and then start
             pcommand = DINIT_CP_STOPSERVICE;
             break;
         case command_t::RELEASE_SERVICE:
@@ -455,14 +529,21 @@ static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *serv
     // We'll do this regardless of the current service state / target state, since issuing
     // start/stop also sets or clears the "explicitly started" flag on the service.
     {
-        char buf[2 + sizeof(handle)];
-        buf[0] = pcommand;
-        buf[1] = do_pin ? 1 : 0;
-        memcpy(buf + 2, &handle, sizeof(handle));
-        write_all_x(socknum, buf, 2 + sizeof(handle));
-        
+        char flags = (do_pin ? 1 : 0) | ((pcommand == DINIT_CP_STOPSERVICE && !do_force) ? 2 : 0);
+        if (command == command_t::RESTART_SERVICE) {
+            flags |= 4;
+        }
+
+        auto m = membuf()
+                .append((char) pcommand)
+                .append(flags)
+                .append(handle);
+        write_all_x(socknum, m);
+
         wait_for_reply(rbuffer, socknum);
-        if (rbuffer[0] == DINIT_RP_ALREADYSS) {
+        auto reply_pkt_h = rbuffer[0];
+        rbuffer.consume(1); // consume header
+        if (reply_pkt_h == DINIT_RP_ALREADYSS) {
             bool already = (state == wanted_state);
             if (verbose) {
                 cout << "Service " << (already ? "(already) " : "")
@@ -470,11 +551,35 @@ static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *serv
             }
             return 0; // success!
         }
-        if (rbuffer[0] != DINIT_RP_ACK) {
-            cerr << "dinitctl: Protocol error." << endl;
+        if (reply_pkt_h == DINIT_RP_DEPENDENTS && pcommand == DINIT_CP_STOPSERVICE) {
+            cerr << "dinitctl: Cannot stop service due to the following dependents:\n"
+                    "(Only direct dependents are listed. Exercise caution before using '--force' !!)\n";
+            // size_t number, N * handle_t handles
+            size_t number;
+            rbuffer.fill_to(socknum, sizeof(number));
+            rbuffer.extract(&number, 0, sizeof(number));
+            rbuffer.consume(sizeof(number));
+            std::vector<handle_t> handles;
+            handles.reserve(number);
+            for (size_t i = 0; i < number; i++) {
+                handle_t handle;
+                rbuffer.fill_to(socknum, sizeof(handle_t));
+                rbuffer.extract(&handle, 0, sizeof(handle));
+                handles.push_back(handle);
+                rbuffer.consume(sizeof(handle));
+            }
+            // Print the directly affected dependents:
+            cerr << " ";
+            for (handle_t handle : handles) {
+                cerr << " " << get_service_name(socknum, rbuffer, handle);
+            }
+            cerr << "\n";
+            return 1;
+        }
+        if (reply_pkt_h != DINIT_RP_ACK && reply_pkt_h != DINIT_RP_ALREADYSS) {
+            cerr << "dinitctl: protocol error." << endl;
             return 1;
         }
-        rbuffer.consume(1);
     }
 
     if (! wait_for_service) {
@@ -605,10 +710,10 @@ static int unpin_service(int socknum, cpbuffer_t &rbuffer, const char *service_n
     
     // Issue UNPIN command.
     {
-        char buf[1 + sizeof(handle)];
-        buf[0] = DINIT_CP_UNPINSERVICE;
-        memcpy(buf + 1, &handle, sizeof(handle));
-        write_all_x(socknum, buf, 2 + sizeof(handle));
+        auto m = membuf()
+                .append<char>(DINIT_CP_UNPINSERVICE)
+                .append(handle);
+        write_all_x(socknum, m);
         
         wait_for_reply(rbuffer, socknum);
         if (rbuffer[0] != DINIT_RP_ACK) {
@@ -647,10 +752,10 @@ static int unload_service(int socknum, cpbuffer_t &rbuffer, const char *service_
 
     // Issue UNLOAD command.
     {
-        char buf[1 + sizeof(handle)];
-        buf[0] = DINIT_CP_UNLOADSERVICE;
-        memcpy(buf + 1, &handle, sizeof(handle));
-        write_all_x(socknum, buf, 2 + sizeof(handle));
+        auto m = membuf()
+                .append<char>(DINIT_CP_UNLOADSERVICE)
+                .append(handle);
+        write_all_x(socknum, m);
 
         wait_for_reply(rbuffer, socknum);
         if (rbuffer[0] == DINIT_RP_NAK) {
@@ -757,7 +862,7 @@ static int list_services(int socknum, cpbuffer_t &rbuffer)
                 cout << " (exit status: " << WEXITSTATUS(exit_status) << ")";
             }
             else if (WIFSIGNALED(exit_status)) {
-                cout << " (signal: " << WSTOPSIG(exit_status) << ")";
+                cout << " (signal: " << WTERMSIG(exit_status) << ")";
             }
         }
 
@@ -787,7 +892,6 @@ static int add_remove_dependency(int socknum, cpbuffer_t &rbuffer, bool add,
 {
     using namespace std;
 
-
     handle_t from_handle;
     handle_t to_handle;
 
@@ -796,11 +900,12 @@ static int add_remove_dependency(int socknum, cpbuffer_t &rbuffer, bool add,
         return 1;
     }
 
-    constexpr int pktsize = 2 + sizeof(handle_t) * 2;
-    char cmdbuf[pktsize] = { add ? (char)DINIT_CP_ADD_DEP : (char)DINIT_CP_REM_DEP, (char)dep_type};
-    memcpy(cmdbuf + 2, &from_handle, sizeof(from_handle));
-    memcpy(cmdbuf + 2 + sizeof(from_handle), &to_handle, sizeof(to_handle));
-    write_all_x(socknum, cmdbuf, pktsize);
+    auto m = membuf()
+            .append<char>(add ? (char)DINIT_CP_ADD_DEP : (char)DINIT_CP_REM_DEP)
+            .append(dep_type)
+            .append(from_handle)
+            .append(to_handle);
+    write_all_x(socknum, m);
 
     wait_for_reply(rbuffer, socknum);
 
@@ -822,14 +927,10 @@ static int shutdown_dinit(int socknum, cpbuffer_t &rbuffer)
     // TODO support no-wait option.
     using namespace std;
 
-    // Build buffer;
-    constexpr int bufsize = 2;
-    char buf[bufsize];
-
-    buf[0] = DINIT_CP_SHUTDOWN;
-    buf[1] = static_cast<char>(shutdown_type_t::HALT);
-
-    write_all_x(socknum, buf, bufsize);
+    auto m = membuf()
+            .append<char>(DINIT_CP_SHUTDOWN)
+            .append(static_cast<char>(shutdown_type_t::HALT));
+    write_all_x(socknum, m);
 
     wait_for_reply(rbuffer, socknum);
 
@@ -838,19 +939,15 @@ static int shutdown_dinit(int socknum, cpbuffer_t &rbuffer)
         return 1;
     }
 
-    // Now wait for rollback complete:
+    // Now wait for rollback complete, by waiting for the connection to close:
     try {
         while (true) {
             wait_for_info(rbuffer, socknum);
-            if (rbuffer[0] == DINIT_ROLLBACK_COMPLETED) {
-                break;
-            }
+            rbuffer.consume(rbuffer[1]);
         }
     }
     catch (cp_read_exception &exc) {
-        // Dinit can terminate before replying: let's assume that happened.
-        // TODO: better check, possibly ensure that dinit actually sends rollback complete before
-        // termination.
+        // Assume that the connection closed.
     }
 
     return 0;
@@ -859,7 +956,8 @@ static int shutdown_dinit(int socknum, cpbuffer_t &rbuffer)
 // exception for cancelling a service operation
 class service_op_cancel { };
 
-static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *from, const char *to, bool enable)
+static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *from, const char *to,
+        bool enable)
 {
     using namespace std;
 
@@ -927,7 +1025,7 @@ static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *
     string service_file_path;
 
     for (std::string path : paths) {
-        string test_path = combine_paths(dinit_cwd + '/' + path, from);
+        string test_path = combine_paths(combine_paths(dinit_cwd, path.c_str()), from);
 
         service_file.open(test_path.c_str(), ios::in);
         if (service_file) {
@@ -1028,14 +1126,16 @@ static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *
     // create link
     if (enable) {
         if (symlink((string("../") + to).c_str(), dep_link_path.c_str()) == -1) {
-            cerr << "dinitctl: Could not create symlink at " << dep_link_path << ": " << strerror(errno) << "\n"
-                    "dinitctl: Note: service was activated, but will not be enabled on restart." << endl;
+            cerr << "dinitctl: Could not create symlink at " << dep_link_path << ": " << strerror(errno)
+                    << "\n" "dinitctl: Note: service was activated, but will not be enabled on restart."
+                    << endl;
             return 1;
         }
     }
     else {
         if (unlink(dep_link_path.c_str()) == -1) {
-            cerr << "dinitctl: Could not unlink dependency entry " << dep_link_path << ": " << strerror(errno) << "\n"
+            cerr << "dinitctl: Could not unlink dependency entry " << dep_link_path << ": "
+                    << strerror(errno) << "\n"
                     "dinitctl: Note: service was disabled, but will be re-enabled on restart." << endl;
             return 1;
         }