src/dinitctl.cc

   1 #include <cstdio>
   2 #include <cstddef>
   3 #include <cstring>
   4 #include <string>
   5 #include <iostream>
   6 #include <fstream>
   7 #include <system_error>
   8 #include <memory>
   9 #include <algorithm>
  10
  11 #include <sys/types.h>
  12 #include <sys/stat.h>
  13 #include <sys/wait.h>
  14 #include <sys/socket.h>
  15 #include <sys/un.h>
  16 #include <unistd.h>
  17 #include <signal.h>
  18 #include <pwd.h>
  19
  20 #include "control-cmds.h"
  21 #include "service-constants.h"
  22 #include "cpbuffer.h"
  23 #include "dinit-client.h"
  24 #include "load-service.h"
  25 #include "dinit-util.h"
  26 #include "mconfig.h"
  27
  28 // dinitctl:  utility to control the Dinit daemon, including starting and stopping of services.
  29
  30 // This utility communicates with the dinit daemon via a unix stream socket (as specified in
  31 // SYSCONTROLSOCKET, or $HOME/.dinitctl).
  32
  33 static constexpr uint16_t min_cp_version = 1;
  34 static constexpr uint16_t max_cp_version = 1;
  35
  36 enum class command_t;
  37
  38 static int issue_load_service(int socknum, const char *service_name, bool find_only = false);
  39 static int check_load_reply(int socknum, cpbuffer_t &, handle_t *handle_p, service_state_t *state_p);
  40 static int start_stop_service(int socknum, cpbuffer_t &, const char *service_name, command_t command,
  41         bool do_pin, bool do_force, bool wait_for_service, bool verbose);
  42 static int unpin_service(int socknum, cpbuffer_t &, const char *service_name, bool verbose);
  43 static int unload_service(int socknum, cpbuffer_t &, const char *service_name);
  44 static int list_services(int socknum, cpbuffer_t &);
  45 static int shutdown_dinit(int soclknum, cpbuffer_t &);
  46 static int add_remove_dependency(int socknum, cpbuffer_t &rbuffer, bool add, const char *service_from,
  47         const char *service_to, dependency_type dep_type);
  48 static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *from, const char *to,
  49         bool enable);
  50
  51 static const char * describeState(bool stopped)
  52 {
  53     return stopped ? "stopped" : "started";
  54 }
  55
  56 static const char * describeVerb(bool stop)
  57 {
  58     return stop ? "stop" : "start";
  59 }
  60
  61 enum class command_t {
  62     NONE,
  63     START_SERVICE,
  64     WAKE_SERVICE,
  65     STOP_SERVICE,
  66     RESTART_SERVICE,
  67     RELEASE_SERVICE,
  68     UNPIN_SERVICE,
  69     UNLOAD_SERVICE,
  70     LIST_SERVICES,
  71     SHUTDOWN,
  72     ADD_DEPENDENCY,
  73     RM_DEPENDENCY,
  74     ENABLE_SERVICE,
  75     DISABLE_SERVICE
  76 };
  77
  78
  79 // Entry point.
  80 int main(int argc, char **argv)
  81 {
  82     using namespace std;
  83
  84     bool show_help = argc < 2;
  85     const char *service_name = nullptr;
  86     const char *to_service_name = nullptr;
  87     dependency_type dep_type;
  88     bool dep_type_set = false;
  89
  90     std::string control_socket_str;
  91     const char * control_socket_path = nullptr;
  92
  93     bool verbose = true;
  94     bool sys_dinit = false;  // communicate with system daemon
  95     bool wait_for_service = true;
  96     bool do_pin = false;
  97     bool do_force = false;
  98
  99     command_t command = command_t::NONE;
 100
 101     for (int i = 1; i < argc; i++) {
 102         if (argv[i][0] == '-') {
 103             if (strcmp(argv[i], "--help") == 0) {
 104                 show_help = true;
 105                 break;
 106             }
 107             else if (strcmp(argv[i], "--no-wait") == 0) {
 108                 wait_for_service = false;
 109             }
 110             else if (strcmp(argv[i], "--quiet") == 0) {
 111                 verbose = false;
 112             }
 113             else if (strcmp(argv[i], "--system") == 0 || strcmp(argv[i], "-s") == 0) {
 114                 sys_dinit = true;
 115             }
 116             else if (strcmp(argv[i], "--pin") == 0) {
 117                 do_pin = true;
 118             }
 119             else if (strcmp(argv[i], "--socket-path") == 0 || strcmp(argv[i], "-p") == 0) {
 120                 ++i;
 121                 if (i == argc) {
 122                     cerr << "dinitctl: --socket-path/-p should be followed by socket path" << std::endl;
 123                     return 1;
 124                 }
 125                 control_socket_str = argv[i];
 126             }
 127             else if ((command == command_t::ENABLE_SERVICE || command == command_t::DISABLE_SERVICE)
 128                     && strcmp(argv[i], "--from") == 0) {
 129                 ++i;
 130                 if (i == argc) {
 131                     cerr << "dinitctl: --from should be followed by a service name" << std::endl;
 132                     return 1;
 133                 }
 134                 service_name = argv[i];
 135             }
 136             else if ((command == command_t::STOP_SERVICE || command == command_t::RESTART_SERVICE)
 137                     && (strcmp(argv[i], "--force") == 0 || strcmp(argv[i], "-f") == 0)) {
 138                 do_force = true;
 139             }
 140             else {
 141                 cerr << "dinitctl: unrecognized/invalid option: " << argv[i] << " (use --help for help)\n";
 142                 return 1;
 143             }
 144         }
 145         else if (command == command_t::NONE) {
 146             if (strcmp(argv[i], "start") == 0) {
 147                 command = command_t::START_SERVICE;
 148             }
 149             else if (strcmp(argv[i], "wake") == 0) {
 150                 command = command_t::WAKE_SERVICE;
 151             }
 152             else if (strcmp(argv[i], "stop") == 0) {
 153                 command = command_t::STOP_SERVICE;
 154             }
 155             else if (strcmp(argv[i], "restart") == 0) {
 156                 command = command_t::RESTART_SERVICE;
 157             }
 158             else if (strcmp(argv[i], "release") == 0) {
 159                 command = command_t::RELEASE_SERVICE;
 160             }
 161             else if (strcmp(argv[i], "unpin") == 0) {
 162                 command = command_t::UNPIN_SERVICE;
 163             }
 164             else if (strcmp(argv[i], "unload") == 0) {
 165                 command = command_t::UNLOAD_SERVICE;
 166             }
 167             else if (strcmp(argv[i], "list") == 0) {
 168                 command = command_t::LIST_SERVICES;
 169             }
 170             else if (strcmp(argv[i], "shutdown") == 0) {
 171                 command = command_t::SHUTDOWN;
 172             }
 173             else if (strcmp(argv[i], "add-dep") == 0) {
 174                 command = command_t::ADD_DEPENDENCY;
 175             }
 176             else if (strcmp(argv[i], "rm-dep") == 0) {
 177                 command = command_t::RM_DEPENDENCY;
 178             }
 179             else if (strcmp(argv[i], "enable") == 0) {
 180                 command = command_t::ENABLE_SERVICE;
 181             }
 182             else if (strcmp(argv[i], "disable") == 0) {
 183                 command = command_t::DISABLE_SERVICE;
 184             }
 185             else {
 186                 cerr << "dinitctl: unrecognized command: " << argv[i] << " (use --help for help)\n";
 187                 return 1;
 188             }
 189         }
 190         else {
 191             // service name / other non-option
 192             if (command == command_t::ADD_DEPENDENCY || command == command_t::RM_DEPENDENCY) {
 193                 if (! dep_type_set) {
 194                     if (strcmp(argv[i], "regular") == 0) {
 195                         dep_type = dependency_type::REGULAR;
 196                     }
 197                     else if (strcmp(argv[i], "milestone") == 0) {
 198                         dep_type = dependency_type::MILESTONE;
 199                     }
 200                     else if (strcmp(argv[i], "waits-for") == 0) {
 201                         dep_type = dependency_type::WAITS_FOR;
 202                     }
 203                     else {
 204                         show_help = true;
 205                         break;
 206                     }
 207                     dep_type_set = true;
 208                 }
 209                 else if (service_name == nullptr) {
 210                     service_name = argv[i];
 211                 }
 212                 else if (to_service_name == nullptr) {
 213                     to_service_name = argv[i];
 214                 }
 215                 else {
 216                     show_help = true;
 217                     break;
 218                 }
 219             }
 220             else if (command == command_t::ENABLE_SERVICE || command == command_t::DISABLE_SERVICE) {
 221                 if (to_service_name != nullptr) {
 222                     show_help = true;
 223                     break;
 224                 }
 225                 to_service_name = argv[i];
 226             }
 227             else {
 228                 if (service_name != nullptr) {
 229                     show_help = true;
 230                     break;
 231                 }
 232                 service_name = argv[i];
 233                 // TODO support multiple services
 234             }
 235         }
 236     }
 237
 238     bool no_service_cmd = (command == command_t::LIST_SERVICES || command == command_t::SHUTDOWN);
 239
 240     if (command == command_t::ENABLE_SERVICE || command == command_t::DISABLE_SERVICE) {
 241         show_help |= (to_service_name == nullptr);
 242     }
 243     else if ((service_name == nullptr && ! no_service_cmd) || command == command_t::NONE) {
 244         show_help = true;
 245     }
 246
 247     if (service_name != nullptr && no_service_cmd) {
 248         show_help = true;
 249     }
 250
 251     if ((command == command_t::ADD_DEPENDENCY || command == command_t::RM_DEPENDENCY)
 252             && (! dep_type_set || service_name == nullptr || to_service_name == nullptr)) {
 253         show_help = true;
 254     }
 255
 256     if (show_help) {
 257         cout << "dinitctl:   control Dinit services\n"
 258           "\n"
 259           "Usage:\n"
 260           "    dinitctl [options] start [options] <service-name>\n"
 261           "    dinitctl [options] stop [options] <service-name>\n"
 262           "    dinitctl [options] wake [options] <service-name>\n"
 263           "    dinitctl [options] release [options] <service-name>\n"
 264           "    dinitctl [options] unpin <service-name>\n"
 265           "    dinitctl [options] unload <service-name>\n"
 266           "    dinitctl [options] list\n"
 267           "    dinitctl [options] shutdown\n"
 268           "    dinitctl [options] add-dep <type> <from-service> <to-service>\n"
 269           "    dinitctl [options] rm-dep <type> <from-service> <to-service>\n"
 270           "    dinitctl [options] enable [--from <from-service>] <to-service>\n"
 271           "    dinitctl [options] disable [--from <from-service>] <to-service>\n"
 272           "\n"
 273           "Note: An activated service continues running when its dependents stop.\n"
 274           "\n"
 275           "General options:\n"
 276           "  --help           : show this help\n"
 277           "  -s, --system     : control system daemon instead of user daemon\n"
 278           "  --quiet          : suppress output (except errors)\n"
 279           "  --socket-path <path>, -p <path>\n"
 280           "                   : specify socket for communication with daemon\n"
 281           "\n"
 282           "Command options:\n"
 283           "  --no-wait        : don't wait for service startup/shutdown to complete\n"
 284           "  --pin            : pin the service in the requested state\n"
 285           "  --force          : force stop even if dependents will be affected\n";
 286         return 1;
 287     }
 288
 289     signal(SIGPIPE, SIG_IGN);
 290
 291     // Locate control socket
 292     if (! control_socket_str.empty()) {
 293         control_socket_path = control_socket_str.c_str();
 294     }
 295     else {
 296         control_socket_path = SYSCONTROLSOCKET; // default to system
 297         if (! sys_dinit) {
 298             char * userhome = getenv("HOME");
 299             if (userhome == nullptr) {
 300                 struct passwd * pwuid_p = getpwuid(getuid());
 301                 if (pwuid_p != nullptr) {
 302                     userhome = pwuid_p->pw_dir;
 303                 }
 304             }
 305
 306             if (userhome != nullptr) {
 307                 control_socket_str = userhome;
 308                 control_socket_str += "/.dinitctl";
 309                 control_socket_path = control_socket_str.c_str();
 310             }
 311             else {
 312                 cerr << "Cannot locate user home directory (set HOME or check /etc/passwd file)" << endl;
 313                 return 1;
 314             }
 315         }
 316     }
 317
 318     int socknum = socket(AF_UNIX, SOCK_STREAM, 0);
 319     if (socknum == -1) {
 320         perror("dinitctl: socket");
 321         return 1;
 322     }
 323
 324     struct sockaddr_un * name;
 325     uint sockaddr_size = offsetof(struct sockaddr_un, sun_path) + strlen(control_socket_path) + 1;
 326     name = (struct sockaddr_un *) malloc(sockaddr_size);
 327     if (name == nullptr) {
 328         cerr << "dinitctl: Out of memory" << endl;
 329         return 1;
 330     }
 331
 332     name->sun_family = AF_UNIX;
 333     strcpy(name->sun_path, control_socket_path);
 334
 335     int connr = connect(socknum, (struct sockaddr *) name, sockaddr_size);
 336     if (connr == -1) {
 337         perror("dinitctl: connect");
 338         return 1;
 339     }
 340
 341     try {
 342         // Start by querying protocol version:
 343         cpbuffer_t rbuffer;
 344         check_protocol_version(min_cp_version, max_cp_version, rbuffer, socknum);
 345
 346         if (command == command_t::UNPIN_SERVICE) {
 347             return unpin_service(socknum, rbuffer, service_name, verbose);
 348         }
 349         else if (command == command_t::UNLOAD_SERVICE) {
 350             return unload_service(socknum, rbuffer, service_name);
 351         }
 352         else if (command == command_t::LIST_SERVICES) {
 353             return list_services(socknum, rbuffer);
 354         }
 355         else if (command == command_t::SHUTDOWN) {
 356             return shutdown_dinit(socknum, rbuffer);
 357         }
 358         else if (command == command_t::ADD_DEPENDENCY || command == command_t::RM_DEPENDENCY) {
 359             return add_remove_dependency(socknum, rbuffer, command == command_t::ADD_DEPENDENCY,
 360                     service_name, to_service_name, dep_type);
 361         }
 362         else if (command == command_t::ENABLE_SERVICE || command == command_t::DISABLE_SERVICE) {
 363             // If only one service specified, assume that we enable for 'boot' service:
 364             if (service_name == nullptr) {
 365                 service_name = "boot";
 366             }
 367             return enable_disable_service(socknum, rbuffer, service_name, to_service_name,
 368                     command == command_t::ENABLE_SERVICE);
 369         }
 370         else {
 371             return start_stop_service(socknum, rbuffer, service_name, command, do_pin, do_force,
 372                     wait_for_service, verbose);
 373         }
 374     }
 375     catch (cp_old_client_exception &e) {
 376         std::cerr << "dinitctl: too old (server reports newer protocol version)" << std::endl;
 377         return 1;
 378     }
 379     catch (cp_old_server_exception &e) {
 380         std::cerr << "dinitctl: server too old or protocol error" << std::endl;
 381         return 1;
 382     }
 383     catch (cp_read_exception &e) {
 384         cerr << "dinitctl: control socket read failure or protocol error" << endl;
 385         return 1;
 386     }
 387     catch (cp_write_exception &e) {
 388         cerr << "dinitctl: control socket write error: " << std::strerror(e.errcode) << endl;
 389         return 1;
 390     }
 391 }
 392
 393 // Extract/read a string of specified length from the buffer/socket. The string is consumed
 394 // from the buffer.
 395 static std::string read_string(int socknum, cpbuffer_t &rbuffer, uint32_t length)
 396 {
 397     int rb_len = rbuffer.get_length();
 398     if (uint32_t(rb_len) >= length) {
 399         std::string r = rbuffer.extract_string(0, length);
 400         rbuffer.consume(length);
 401         return r;
 402     }
 403
 404     std::string r = rbuffer.extract_string(0, rb_len);
 405     uint32_t rlen = length - rb_len;
 406     uint32_t clen;
 407     do {
 408         rbuffer.reset();
 409         rbuffer.fill(socknum);
 410         char *bptr = rbuffer.get_ptr(0);
 411         clen = rbuffer.get_length();
 412         clen = std::min(clen, rlen);
 413         r.append(bptr, clen);
 414         rlen -= clen;
 415     } while (rlen > 0);
 416
 417     rbuffer.consume(clen);
 418
 419     return r;
 420 }
 421
 422 // Load a service: issue load command, wait for reply. Return true on success, display error message
 423 // and return false on failure.
 424 //      socknum  - the socket fd to communicate via
 425 //      rbuffer  - the buffer for communication
 426 //      name     - the name of the service to load
 427 //      handle   - where to store the handle of the loaded service
 428 //      state    - where to store the state of the loaded service (may be null).
 429 static bool load_service(int socknum, cpbuffer_t &rbuffer, const char *name, handle_t *handle,
 430         service_state_t *state)
 431 {
 432     // Load 'to' service:
 433     if (issue_load_service(socknum, name)) {
 434         return false;
 435     }
 436
 437     wait_for_reply(rbuffer, socknum);
 438
 439     if (check_load_reply(socknum, rbuffer, handle, state) != 0) {
 440         return false;
 441     }
 442
 443     return true;
 444 }
 445
 446 // Get the service name for a given handle, by querying the daemon.
 447 static std::string get_service_name(int socknum, cpbuffer_t &rbuffer, handle_t handle)
 448 {
 449     char buf[2 + sizeof(handle)];
 450     buf[0] = DINIT_CP_QUERYSERVICENAME;
 451     buf[1] = 0;
 452     memcpy(buf + 2, &handle, sizeof(handle));
 453
 454     write_all_x(socknum, buf, sizeof(buf));
 455
 456     wait_for_reply(rbuffer, socknum);
 457
 458     if (rbuffer[0] != DINIT_RP_SERVICENAME) {
 459         throw cp_read_exception{0};
 460     }
 461
 462     // 1 byte reserved
 463     // uint16_t size
 464     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint16_t));
 465     uint16_t namesize;
 466     rbuffer.extract(&namesize, 2, sizeof(uint16_t));
 467     rbuffer.consume(2 + sizeof(uint16_t));
 468
 469     std::string name;
 470
 471     do {
 472         if (rbuffer.get_length() == 0) {
 473             rbuffer.fill(socknum);
 474         }
 475
 476         size_t to_extract = std::min(size_t(rbuffer.get_length()), namesize - name.length());
 477         size_t contiguous_len = rbuffer.get_contiguous_length(rbuffer.get_ptr(0));
 478         if (contiguous_len <= to_extract) {
 479             name.append(rbuffer.get_ptr(0), contiguous_len);
 480             rbuffer.consume(contiguous_len);
 481             name.append(rbuffer.get_ptr(0), to_extract - contiguous_len);
 482             rbuffer.consume(to_extract - contiguous_len);
 483         }
 484         else {
 485             name.append(rbuffer.get_ptr(0), to_extract);
 486             rbuffer.consume(to_extract);
 487             break;
 488         }
 489
 490     } while (name.length() < namesize);
 491
 492     return name;
 493 }
 494
 495 // Start/stop a service
 496 static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *service_name,
 497         command_t command, bool do_pin, bool do_force, bool wait_for_service, bool verbose)
 498 {
 499     using namespace std;
 500
 501     bool do_stop = (command == command_t::STOP_SERVICE || command == command_t::RELEASE_SERVICE);
 502
 503     service_state_t state;
 504     handle_t handle;
 505
 506     if (! load_service(socknum, rbuffer, service_name, &handle, &state)) {
 507         return 1;
 508     }
 509
 510     service_state_t wanted_state = do_stop ? service_state_t::STOPPED : service_state_t::STARTED;
 511     int pcommand = 0;
 512     switch (command) {
 513         case command_t::STOP_SERVICE:
 514         case command_t::RESTART_SERVICE:  // stop, and then start
 515             pcommand = DINIT_CP_STOPSERVICE;
 516             break;
 517         case command_t::RELEASE_SERVICE:
 518             pcommand = DINIT_CP_RELEASESERVICE;
 519             break;
 520         case command_t::START_SERVICE:
 521             pcommand = DINIT_CP_STARTSERVICE;
 522             break;
 523         case command_t::WAKE_SERVICE:
 524             pcommand = DINIT_CP_WAKESERVICE;
 525             break;
 526         default: ;
 527     }
 528
 529     // Need to issue STOPSERVICE/STARTSERVICE
 530     // We'll do this regardless of the current service state / target state, since issuing
 531     // start/stop also sets or clears the "explicitly started" flag on the service.
 532     {
 533         char buf[2 + sizeof(handle)];
 534         buf[0] = pcommand;
 535         buf[1] = (do_pin ? 1 : 0) | ((pcommand == DINIT_CP_STOPSERVICE && !do_force) ? 2 : 0);
 536         if (command == command_t::RESTART_SERVICE) {
 537             buf[1] |= 4;
 538         }
 539         memcpy(buf + 2, &handle, sizeof(handle));
 540         write_all_x(socknum, buf, 2 + sizeof(handle));
 541
 542         wait_for_reply(rbuffer, socknum);
 543         auto reply_pkt_h = rbuffer[0];
 544         rbuffer.consume(1); // consume header
 545         if (reply_pkt_h == DINIT_RP_ALREADYSS) {
 546             bool already = (state == wanted_state);
 547             if (verbose) {
 548                 cout << "Service " << (already ? "(already) " : "")
 549                         << describeState(do_stop) << "." << endl;
 550             }
 551             return 0; // success!
 552         }
 553         if (reply_pkt_h == DINIT_RP_DEPENDENTS && pcommand == DINIT_CP_STOPSERVICE) {
 554             cerr << "dinitctl: Cannot stop service due to the following dependents:\n"
 555                     "(Only direct dependents are listed. Exercise caution before using '--force' !!)\n";
 556             // size_t number, N * handle_t handles
 557             size_t number;
 558             rbuffer.fill_to(socknum, sizeof(number));
 559             rbuffer.extract(&number, 0, sizeof(number));
 560             rbuffer.consume(sizeof(number));
 561             std::vector<handle_t> handles;
 562             handles.reserve(number);
 563             for (size_t i = 0; i < number; i++) {
 564                 handle_t handle;
 565                 rbuffer.fill_to(socknum, sizeof(handle_t));
 566                 rbuffer.extract(&handle, 0, sizeof(handle));
 567                 handles.push_back(handle);
 568                 rbuffer.consume(sizeof(handle));
 569             }
 570             // Print the directly affected dependents:
 571             cerr << " ";
 572             for (handle_t handle : handles) {
 573                 cerr << " " << get_service_name(socknum, rbuffer, handle);
 574             }
 575             cerr << "\n";
 576             return 1;
 577         }
 578         if (reply_pkt_h != DINIT_RP_ACK && reply_pkt_h != DINIT_RP_ALREADYSS) {
 579             cerr << "dinitctl: protocol error." << endl;
 580             return 1;
 581         }
 582     }
 583
 584     if (! wait_for_service) {
 585         if (verbose) {
 586             cout << "Issued " << describeVerb(do_stop) << " command successfully." << endl;
 587         }
 588         return 0;
 589     }
 590
 591     service_event_t completionEvent;
 592     service_event_t cancelledEvent;
 593
 594     if (do_stop) {
 595         completionEvent = service_event_t::STOPPED;
 596         cancelledEvent = service_event_t::STOPCANCELLED;
 597     }
 598     else {
 599         completionEvent = service_event_t::STARTED;
 600         cancelledEvent = service_event_t::STARTCANCELLED;
 601     }
 602
 603     // Wait until service started:
 604     int r = rbuffer.fill_to(socknum, 2);
 605     while (r > 0) {
 606         if (rbuffer[0] >= 100) {
 607             int pktlen = (unsigned char) rbuffer[1];
 608             fill_buffer_to(rbuffer, socknum, pktlen);
 609
 610             if (rbuffer[0] == DINIT_IP_SERVICEEVENT) {
 611                 handle_t ev_handle;
 612                 rbuffer.extract((char *) &ev_handle, 2, sizeof(ev_handle));
 613                 service_event_t event = static_cast<service_event_t>(rbuffer[2 + sizeof(ev_handle)]);
 614                 if (ev_handle == handle) {
 615                     if (event == completionEvent) {
 616                         if (verbose) {
 617                             cout << "Service " << describeState(do_stop) << "." << endl;
 618                         }
 619                         return 0;
 620                     }
 621                     else if (event == cancelledEvent) {
 622                         if (verbose) {
 623                             cout << "Service " << describeVerb(do_stop) << " cancelled." << endl;
 624                         }
 625                         return 1;
 626                     }
 627                     else if (! do_stop && event == service_event_t::FAILEDSTART) {
 628                         if (verbose) {
 629                             cout << "Service failed to start." << endl;
 630                         }
 631                         return 1;
 632                     }
 633                 }
 634             }
 635
 636             rbuffer.consume(pktlen);
 637             r = rbuffer.fill_to(socknum, 2);
 638         }
 639         else {
 640             // Not an information packet?
 641             cerr << "dinitctl: protocol error" << endl;
 642             return 1;
 643         }
 644     }
 645
 646     if (r == -1) {
 647         perror("dinitctl: read");
 648     }
 649     else {
 650         cerr << "protocol error (connection closed by server)" << endl;
 651     }
 652     return 1;
 653 }
 654
 655 // Issue a "load service" command (DINIT_CP_LOADSERVICE), without waiting for
 656 // a response. Returns 1 on failure (with error logged), 0 on success.
 657 static int issue_load_service(int socknum, const char *service_name, bool find_only)
 658 {
 659     // Build buffer;
 660     uint16_t sname_len = strlen(service_name);
 661     int bufsize = 3 + sname_len;
 662
 663     std::unique_ptr<char[]> ubuf(new char[bufsize]);
 664     auto buf = ubuf.get();
 665
 666     buf[0] = find_only ? DINIT_CP_FINDSERVICE : DINIT_CP_LOADSERVICE;
 667     memcpy(buf + 1, &sname_len, 2);
 668     memcpy(buf + 3, service_name, sname_len);
 669
 670     write_all_x(socknum, buf, bufsize);
 671
 672     return 0;
 673 }
 674
 675 // Check that a "load service" reply was received, and that the requested service was found.
 676 //   state_p may be null.
 677 static int check_load_reply(int socknum, cpbuffer_t &rbuffer, handle_t *handle_p, service_state_t *state_p)
 678 {
 679     using namespace std;
 680
 681     if (rbuffer[0] == DINIT_RP_SERVICERECORD) {
 682         fill_buffer_to(rbuffer, socknum, 2 + sizeof(*handle_p));
 683         rbuffer.extract((char *) handle_p, 2, sizeof(*handle_p));
 684         if (state_p) *state_p = static_cast<service_state_t>(rbuffer[1]);
 685         //target_state = static_cast<service_state_t>(rbuffer[2 + sizeof(handle)]);
 686         rbuffer.consume(3 + sizeof(*handle_p));
 687         return 0;
 688     }
 689     else if (rbuffer[0] == DINIT_RP_NOSERVICE) {
 690         cerr << "dinitctl: failed to find/load service." << endl;
 691         return 1;
 692     }
 693     else {
 694         cerr << "dinitctl: protocol error." << endl;
 695         return 1;
 696     }
 697 }
 698
 699 static int unpin_service(int socknum, cpbuffer_t &rbuffer, const char *service_name, bool verbose)
 700 {
 701     using namespace std;
 702
 703     handle_t handle;
 704
 705     // Build buffer;
 706     if (! load_service(socknum, rbuffer, service_name, &handle, nullptr)) {
 707         return 1;
 708     }
 709
 710     // Issue UNPIN command.
 711     {
 712         char buf[1 + sizeof(handle)];
 713         buf[0] = DINIT_CP_UNPINSERVICE;
 714         memcpy(buf + 1, &handle, sizeof(handle));
 715         write_all_x(socknum, buf, sizeof(buf));
 716
 717         wait_for_reply(rbuffer, socknum);
 718         if (rbuffer[0] != DINIT_RP_ACK) {
 719             cerr << "dinitctl: protocol error." << endl;
 720             return 1;
 721         }
 722         rbuffer.consume(1);
 723     }
 724
 725     if (verbose) {
 726         cout << "Service unpinned." << endl;
 727     }
 728     return 0;
 729 }
 730
 731 static int unload_service(int socknum, cpbuffer_t &rbuffer, const char *service_name)
 732 {
 733     using namespace std;
 734
 735     if (issue_load_service(socknum, service_name, true) == 1) {
 736         return 1;
 737     }
 738
 739     wait_for_reply(rbuffer, socknum);
 740
 741     handle_t handle;
 742
 743     if (rbuffer[0] == DINIT_RP_NOSERVICE) {
 744         cerr << "dinitctl: service not loaded." << endl;
 745         return 1;
 746     }
 747
 748     if (check_load_reply(socknum, rbuffer, &handle, nullptr) != 0) {
 749         return 1;
 750     }
 751
 752     // Issue UNLOAD command.
 753     {
 754         char buf[1 + sizeof(handle)];
 755         buf[0] = DINIT_CP_UNLOADSERVICE;
 756         memcpy(buf + 1, &handle, sizeof(handle));
 757         write_all_x(socknum, buf, 2 + sizeof(handle));
 758
 759         wait_for_reply(rbuffer, socknum);
 760         if (rbuffer[0] == DINIT_RP_NAK) {
 761             cerr << "dinitctl: Could not unload service; service not stopped, or is a dependency of "
 762                     "other service." << endl;
 763             return 1;
 764         }
 765         if (rbuffer[0] != DINIT_RP_ACK) {
 766             cerr << "dinitctl: Protocol error." << endl;
 767             return 1;
 768         }
 769         rbuffer.consume(1);
 770     }
 771
 772     cout << "Service unloaded." << endl;
 773     return 0;
 774 }
 775
 776 static int list_services(int socknum, cpbuffer_t &rbuffer)
 777 {
 778     using namespace std;
 779
 780     char cmdbuf[] = { (char)DINIT_CP_LISTSERVICES };
 781     write_all_x(socknum, cmdbuf, 1);
 782
 783     wait_for_reply(rbuffer, socknum);
 784     while (rbuffer[0] == DINIT_RP_SVCINFO) {
 785         int hdrsize = 8 + std::max(sizeof(int), sizeof(pid_t));
 786         fill_buffer_to(rbuffer, socknum, hdrsize);
 787         int nameLen = rbuffer[1];
 788         service_state_t current = static_cast<service_state_t>(rbuffer[2]);
 789         service_state_t target = static_cast<service_state_t>(rbuffer[3]);
 790
 791         int console_flags = rbuffer[4];
 792         bool has_console = (console_flags & 2) != 0;
 793         bool waiting_console = (console_flags & 1) != 0;
 794         bool was_skipped = (console_flags & 4) != 0;
 795
 796         stopped_reason_t stop_reason = static_cast<stopped_reason_t>(rbuffer[5]);
 797
 798         pid_t service_pid;
 799         int exit_status;
 800         if (current != service_state_t::STOPPED) {
 801             rbuffer.extract((char *)&service_pid, 8, sizeof(service_pid));
 802         }
 803         else {
 804                 rbuffer.extract((char *)&exit_status, 8, sizeof(exit_status));
 805         }
 806
 807         fill_buffer_to(rbuffer, socknum, nameLen + hdrsize);
 808
 809         char *name_ptr = rbuffer.get_ptr(hdrsize);
 810         int clength = std::min(rbuffer.get_contiguous_length(name_ptr), nameLen);
 811
 812         string name = string(name_ptr, clength);
 813         name.append(rbuffer.get_buf_base(), nameLen - clength);
 814
 815         cout << "[";
 816
 817         cout << (target  == service_state_t::STARTED ? "{" : " ");
 818         if (current == service_state_t::STARTED) {
 819             cout << (was_skipped ? "s" : "+");
 820         }
 821         else {
 822             cout << " ";
 823         }
 824         cout << (target  == service_state_t::STARTED ? "}" : " ");
 825
 826         if (current == service_state_t::STARTING) {
 827             cout << "<<";
 828         }
 829         else if (current == service_state_t::STOPPING) {
 830             cout << ">>";
 831         }
 832         else {
 833             cout << "  ";
 834         }
 835
 836         cout << (target  == service_state_t::STOPPED ? "{" : " ");
 837         if (current == service_state_t::STOPPED) {
 838             bool did_fail = false;
 839             if (stop_reason == stopped_reason_t::TERMINATED) {
 840                 if (!WIFEXITED(exit_status) || WEXITSTATUS(exit_status) != 0) {
 841                     did_fail = true;
 842                 }
 843             }
 844             else did_fail = (stop_reason != stopped_reason_t::NORMAL);
 845
 846             cout << (did_fail ? "X" : "-");
 847         }
 848         else {
 849                 cout << " ";
 850         }
 851         cout << (target == service_state_t::STOPPED ? "}" : " ");
 852
 853         cout << "] " << name;
 854
 855         if (current != service_state_t::STOPPED && service_pid != -1) {
 856                 cout << " (pid: " << service_pid << ")";
 857         }
 858
 859         if (current == service_state_t::STOPPED && stop_reason == stopped_reason_t::TERMINATED) {
 860             if (WIFEXITED(exit_status)) {
 861                 cout << " (exit status: " << WEXITSTATUS(exit_status) << ")";
 862             }
 863             else if (WIFSIGNALED(exit_status)) {
 864                 cout << " (signal: " << WTERMSIG(exit_status) << ")";
 865             }
 866         }
 867
 868         if (has_console) {
 869                 cout << " (has console)";
 870         }
 871         else if (waiting_console) {
 872                 cout << " (waiting for console)";
 873         }
 874
 875         cout << endl;
 876
 877         rbuffer.consume(hdrsize + nameLen);
 878         wait_for_reply(rbuffer, socknum);
 879     }
 880
 881     if (rbuffer[0] != DINIT_RP_LISTDONE) {
 882         cerr << "dinitctl: Control socket protocol error" << endl;
 883         return 1;
 884     }
 885
 886     return 0;
 887 }
 888
 889 static int add_remove_dependency(int socknum, cpbuffer_t &rbuffer, bool add,
 890         const char *service_from, const char *service_to, dependency_type dep_type)
 891 {
 892     using namespace std;
 893
 894
 895     handle_t from_handle;
 896     handle_t to_handle;
 897
 898     if (! load_service(socknum, rbuffer, service_from, &from_handle, nullptr)
 899             || ! load_service(socknum, rbuffer, service_to, &to_handle, nullptr)) {
 900         return 1;
 901     }
 902
 903     constexpr int pktsize = 2 + sizeof(handle_t) * 2;
 904     char cmdbuf[pktsize] = { add ? (char)DINIT_CP_ADD_DEP : (char)DINIT_CP_REM_DEP, (char)dep_type};
 905     memcpy(cmdbuf + 2, &from_handle, sizeof(from_handle));
 906     memcpy(cmdbuf + 2 + sizeof(from_handle), &to_handle, sizeof(to_handle));
 907     write_all_x(socknum, cmdbuf, pktsize);
 908
 909     wait_for_reply(rbuffer, socknum);
 910
 911     // check reply
 912     if (rbuffer[0] == DINIT_RP_NAK) {
 913         cerr << "dinitctl: Could not add dependency: circular dependency or wrong state" << endl;
 914         return 1;
 915     }
 916     if (rbuffer[0] != DINIT_RP_ACK) {
 917         cerr << "dinitctl: Control socket protocol error" << endl;
 918         return 1;
 919     }
 920
 921     return 0;
 922 }
 923
 924 static int shutdown_dinit(int socknum, cpbuffer_t &rbuffer)
 925 {
 926     // TODO support no-wait option.
 927     using namespace std;
 928
 929     // Build buffer;
 930     constexpr int bufsize = 2;
 931     char buf[bufsize];
 932
 933     buf[0] = DINIT_CP_SHUTDOWN;
 934     buf[1] = static_cast<char>(shutdown_type_t::HALT);
 935
 936     write_all_x(socknum, buf, bufsize);
 937
 938     wait_for_reply(rbuffer, socknum);
 939
 940     if (rbuffer[0] != DINIT_RP_ACK) {
 941         cerr << "dinitctl: Control socket protocol error" << endl;
 942         return 1;
 943     }
 944
 945     // Now wait for rollback complete, by waiting for the connection to close:
 946     try {
 947         while (true) {
 948             wait_for_info(rbuffer, socknum);
 949             rbuffer.consume(rbuffer[1]);
 950         }
 951     }
 952     catch (cp_read_exception &exc) {
 953         // Assume that the connection closed.
 954     }
 955
 956     return 0;
 957 }
 958
 959 // exception for cancelling a service operation
 960 class service_op_cancel { };
 961
 962 static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *from, const char *to,
 963         bool enable)
 964 {
 965     using namespace std;
 966
 967     service_state_t from_state = service_state_t::STARTED;
 968     handle_t from_handle;
 969
 970     handle_t to_handle;
 971
 972     if (! load_service(socknum, rbuffer, from, &from_handle, &from_state)
 973             || ! load_service(socknum, rbuffer, to, &to_handle, nullptr)) {
 974         return 1;
 975     }
 976
 977     // Get service load path
 978     char buf[1] = { DINIT_CP_QUERY_LOAD_MECH };
 979     write_all_x(socknum, buf, 1);
 980
 981     wait_for_reply(rbuffer, socknum);
 982
 983     if (rbuffer[0] != DINIT_RP_LOADER_MECH) {
 984         cerr << "dinitctl: Control socket protocol error" << endl;
 985         return 1;
 986     }
 987
 988     // Packet type, load mechanism type, packet size:
 989     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint32_t));
 990
 991     if (rbuffer[1] != SSET_TYPE_DIRLOAD) {
 992         cerr << "dinitctl: unknown configuration, unable to load service descriptions" << endl;
 993         return 1;
 994     }
 995
 996     vector<string> paths;
 997
 998     uint32_t pktsize;
 999     rbuffer.extract(&pktsize, 2, sizeof(uint32_t));
1000
1001     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint32_t) * 3); // path entries, cwd length
1002
1003     uint32_t path_entries;  // number of service directories
1004     rbuffer.extract(&path_entries, 2 + sizeof(uint32_t), sizeof(uint32_t));
1005
1006     uint32_t cwd_len;
1007     rbuffer.extract(&cwd_len, 2 + sizeof(uint32_t) * 2, sizeof(uint32_t));
1008     rbuffer.consume(2 + sizeof(uint32_t) * 3);
1009     pktsize -= 2 + sizeof(uint32_t) * 3;
1010
1011     // Read current working directory of daemon:
1012     std::string dinit_cwd = read_string(socknum, rbuffer, cwd_len);
1013
1014     // dinit daemon base directory against which service paths are resolved is in dinit_cwd
1015
1016     for (int i = 0; i < (int)path_entries; i++) {
1017         uint32_t plen;
1018         fill_buffer_to(rbuffer, socknum, sizeof(uint32_t));
1019         rbuffer.extract(&plen, 0, sizeof(uint32_t));
1020         rbuffer.consume(sizeof(uint32_t));
1021         paths.push_back(read_string(socknum, rbuffer, plen));
1022     }
1023
1024     // all service directories are now in the 'paths' vector
1025     // Load/read service description for 'from' service:
1026
1027     ifstream service_file;
1028     string service_file_path;
1029
1030     for (std::string path : paths) {
1031         string test_path = combine_paths(combine_paths(dinit_cwd, path.c_str()), from);
1032
1033         service_file.open(test_path.c_str(), ios::in);
1034         if (service_file) {
1035             service_file_path = test_path;
1036             break;
1037         }
1038     }
1039
1040     if (! service_file) {
1041         cerr << "dinitctl: could not locate service file for service '" << from << "'" << endl;
1042         return 1;
1043     }
1044
1045     // We now need to read the service file, identify the waits-for.d directory (bail out if more than one),
1046     // make sure the service is not listed as a dependency individually.
1047
1048     string waits_for_d;
1049
1050     try {
1051         process_service_file(from, service_file, [&](string &line, string &setting,
1052                 dinit_load::string_iterator i, dinit_load::string_iterator end) -> void {
1053             if (setting == "waits-for" || setting == "depends-on" || setting == "depends-ms") {
1054                 string dname = dinit_load::read_setting_value(i, end);
1055                 if (dname == to) {
1056                     // There is already a dependency
1057                     cerr << "dinitctl: there is a fixed dependency to service '" << to
1058                             << "' in the service description of '" << from << "'." << endl;
1059                     throw service_op_cancel();
1060                 }
1061             }
1062             else if (setting == "waits-for.d") {
1063                 string dname = dinit_load::read_setting_value(i, end);
1064                 if (! waits_for_d.empty()) {
1065                     cerr << "dinitctl: service '" << from << "' has multiple waits-for.d directories "
1066                             << "specified in service description" << endl;
1067                     throw service_op_cancel();
1068                 }
1069                 waits_for_d = std::move(dname);
1070             }
1071         });
1072     }
1073     catch (const service_op_cancel &cexc) {
1074         return 1;
1075     }
1076
1077     // If the from service has no waits-for.d specified, we can't continue
1078     if (waits_for_d.empty()) {
1079         cerr << "dinitctl: service '" << from << "' has no waits-for.d directory specified" << endl;
1080         return 1;
1081     }
1082
1083     // The waits-for.d path is relative to the service file path, combine:
1084     string waits_for_d_full = combine_paths(parent_path(service_file_path), waits_for_d.c_str());
1085
1086     // check if dependency already exists
1087     string dep_link_path = combine_paths(waits_for_d_full, to);
1088     struct stat stat_buf;
1089     if (lstat(dep_link_path.c_str(), &stat_buf) == -1) {
1090         if (errno != ENOENT) {
1091             cerr << "dinitctl: checking for existing dependency link: " << dep_link_path << ": "
1092                     << strerror(errno) << endl;
1093             return 1;
1094         }
1095     }
1096     else {
1097         // dependency already exists
1098         if (enable) {
1099             cerr << "dinitctl: service already enabled." << endl;
1100             return 1;
1101         }
1102     }
1103
1104     // warn if 'from' service is not started
1105     if (enable && from_state != service_state_t::STARTED) {
1106         cerr << "dinitctl: warning: enabling dependency for non-started service" << endl;
1107     }
1108
1109     // add/remove dependency
1110     constexpr int enable_pktsize = 2 + sizeof(handle_t) * 2;
1111     char cmdbuf[enable_pktsize] = { char(enable ? DINIT_CP_ENABLESERVICE : DINIT_CP_REM_DEP),
1112             char(dependency_type::WAITS_FOR)};
1113     memcpy(cmdbuf + 2, &from_handle, sizeof(from_handle));
1114     memcpy(cmdbuf + 2 + sizeof(from_handle), &to_handle, sizeof(to_handle));
1115     write_all_x(socknum, cmdbuf, enable_pktsize);
1116
1117     wait_for_reply(rbuffer, socknum);
1118
1119     // check reply
1120     if (enable && rbuffer[0] == DINIT_RP_NAK) {
1121         cerr << "dinitctl: Could not enable service: possible circular dependency" << endl;
1122         return 1;
1123     }
1124     if (rbuffer[0] != DINIT_RP_ACK) {
1125         cerr << "dinitctl: Control socket protocol error" << endl;
1126         return 1;
1127     }
1128
1129     // create link
1130     if (enable) {
1131         if (symlink((string("../") + to).c_str(), dep_link_path.c_str()) == -1) {
1132             cerr << "dinitctl: Could not create symlink at " << dep_link_path << ": " << strerror(errno)
1133                     << "\n" "dinitctl: Note: service was activated, but will not be enabled on restart."
1134                     << endl;
1135             return 1;
1136         }
1137     }
1138     else {
1139         if (unlink(dep_link_path.c_str()) == -1) {
1140             cerr << "dinitctl: Could not unlink dependency entry " << dep_link_path << ": "
1141                     << strerror(errno) << "\n"
1142                     "dinitctl: Note: service was disabled, but will be re-enabled on restart." << endl;
1143             return 1;
1144         }
1145     }
1146
1147     return 0;
1148 }