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     auto m = membuf()
 450             .append((char) DINIT_CP_QUERYSERVICENAME)
 451             .append((char) 0)
 452             .append(handle);
 453     write_all_x(socknum, m);
 454
 455     wait_for_reply(rbuffer, socknum);
 456
 457     if (rbuffer[0] != DINIT_RP_SERVICENAME) {
 458         throw cp_read_exception{0};
 459     }
 460
 461     // 1 byte reserved
 462     // uint16_t size
 463     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint16_t));
 464     uint16_t namesize;
 465     rbuffer.extract(&namesize, 2, sizeof(uint16_t));
 466     rbuffer.consume(2 + sizeof(uint16_t));
 467
 468     std::string name;
 469
 470     do {
 471         if (rbuffer.get_length() == 0) {
 472             rbuffer.fill(socknum);
 473         }
 474
 475         size_t to_extract = std::min(size_t(rbuffer.get_length()), namesize - name.length());
 476         size_t contiguous_len = rbuffer.get_contiguous_length(rbuffer.get_ptr(0));
 477         if (contiguous_len <= to_extract) {
 478             name.append(rbuffer.get_ptr(0), contiguous_len);
 479             rbuffer.consume(contiguous_len);
 480             name.append(rbuffer.get_ptr(0), to_extract - contiguous_len);
 481             rbuffer.consume(to_extract - contiguous_len);
 482         }
 483         else {
 484             name.append(rbuffer.get_ptr(0), to_extract);
 485             rbuffer.consume(to_extract);
 486             break;
 487         }
 488
 489     } while (name.length() < namesize);
 490
 491     return name;
 492 }
 493
 494 // Start/stop a service
 495 static int start_stop_service(int socknum, cpbuffer_t &rbuffer, const char *service_name,
 496         command_t command, bool do_pin, bool do_force, bool wait_for_service, bool verbose)
 497 {
 498     using namespace std;
 499
 500     bool do_stop = (command == command_t::STOP_SERVICE || command == command_t::RELEASE_SERVICE);
 501
 502     service_state_t state;
 503     handle_t handle;
 504
 505     if (! load_service(socknum, rbuffer, service_name, &handle, &state)) {
 506         return 1;
 507     }
 508
 509     service_state_t wanted_state = do_stop ? service_state_t::STOPPED : service_state_t::STARTED;
 510     int pcommand = 0;
 511     switch (command) {
 512         case command_t::STOP_SERVICE:
 513         case command_t::RESTART_SERVICE:  // stop, and then start
 514             pcommand = DINIT_CP_STOPSERVICE;
 515             break;
 516         case command_t::RELEASE_SERVICE:
 517             pcommand = DINIT_CP_RELEASESERVICE;
 518             break;
 519         case command_t::START_SERVICE:
 520             pcommand = DINIT_CP_STARTSERVICE;
 521             break;
 522         case command_t::WAKE_SERVICE:
 523             pcommand = DINIT_CP_WAKESERVICE;
 524             break;
 525         default: ;
 526     }
 527
 528     // Need to issue STOPSERVICE/STARTSERVICE
 529     // We'll do this regardless of the current service state / target state, since issuing
 530     // start/stop also sets or clears the "explicitly started" flag on the service.
 531     {
 532         char flags = (do_pin ? 1 : 0) | ((pcommand == DINIT_CP_STOPSERVICE && !do_force) ? 2 : 0);
 533         if (command == command_t::RESTART_SERVICE) {
 534             flags |= 4;
 535         }
 536
 537         auto m = membuf()
 538                 .append((char) pcommand)
 539                 .append(flags)
 540                 .append(handle);
 541         write_all_x(socknum, m);
 542
 543         wait_for_reply(rbuffer, socknum);
 544         auto reply_pkt_h = rbuffer[0];
 545         rbuffer.consume(1); // consume header
 546         if (reply_pkt_h == DINIT_RP_ALREADYSS) {
 547             bool already = (state == wanted_state);
 548             if (verbose) {
 549                 cout << "Service " << (already ? "(already) " : "")
 550                         << describeState(do_stop) << "." << endl;
 551             }
 552             return 0; // success!
 553         }
 554         if (reply_pkt_h == DINIT_RP_DEPENDENTS && pcommand == DINIT_CP_STOPSERVICE) {
 555             cerr << "dinitctl: Cannot stop service due to the following dependents:\n"
 556                     "(Only direct dependents are listed. Exercise caution before using '--force' !!)\n";
 557             // size_t number, N * handle_t handles
 558             size_t number;
 559             rbuffer.fill_to(socknum, sizeof(number));
 560             rbuffer.extract(&number, 0, sizeof(number));
 561             rbuffer.consume(sizeof(number));
 562             std::vector<handle_t> handles;
 563             handles.reserve(number);
 564             for (size_t i = 0; i < number; i++) {
 565                 handle_t handle;
 566                 rbuffer.fill_to(socknum, sizeof(handle_t));
 567                 rbuffer.extract(&handle, 0, sizeof(handle));
 568                 handles.push_back(handle);
 569                 rbuffer.consume(sizeof(handle));
 570             }
 571             // Print the directly affected dependents:
 572             cerr << " ";
 573             for (handle_t handle : handles) {
 574                 cerr << " " << get_service_name(socknum, rbuffer, handle);
 575             }
 576             cerr << "\n";
 577             return 1;
 578         }
 579         if (reply_pkt_h != DINIT_RP_ACK && reply_pkt_h != DINIT_RP_ALREADYSS) {
 580             cerr << "dinitctl: protocol error." << endl;
 581             return 1;
 582         }
 583     }
 584
 585     if (! wait_for_service) {
 586         if (verbose) {
 587             cout << "Issued " << describeVerb(do_stop) << " command successfully." << endl;
 588         }
 589         return 0;
 590     }
 591
 592     service_event_t completionEvent;
 593     service_event_t cancelledEvent;
 594
 595     if (do_stop) {
 596         completionEvent = service_event_t::STOPPED;
 597         cancelledEvent = service_event_t::STOPCANCELLED;
 598     }
 599     else {
 600         completionEvent = service_event_t::STARTED;
 601         cancelledEvent = service_event_t::STARTCANCELLED;
 602     }
 603
 604     // Wait until service started:
 605     int r = rbuffer.fill_to(socknum, 2);
 606     while (r > 0) {
 607         if (rbuffer[0] >= 100) {
 608             int pktlen = (unsigned char) rbuffer[1];
 609             fill_buffer_to(rbuffer, socknum, pktlen);
 610
 611             if (rbuffer[0] == DINIT_IP_SERVICEEVENT) {
 612                 handle_t ev_handle;
 613                 rbuffer.extract((char *) &ev_handle, 2, sizeof(ev_handle));
 614                 service_event_t event = static_cast<service_event_t>(rbuffer[2 + sizeof(ev_handle)]);
 615                 if (ev_handle == handle) {
 616                     if (event == completionEvent) {
 617                         if (verbose) {
 618                             cout << "Service " << describeState(do_stop) << "." << endl;
 619                         }
 620                         return 0;
 621                     }
 622                     else if (event == cancelledEvent) {
 623                         if (verbose) {
 624                             cout << "Service " << describeVerb(do_stop) << " cancelled." << endl;
 625                         }
 626                         return 1;
 627                     }
 628                     else if (! do_stop && event == service_event_t::FAILEDSTART) {
 629                         if (verbose) {
 630                             cout << "Service failed to start." << endl;
 631                         }
 632                         return 1;
 633                     }
 634                 }
 635             }
 636
 637             rbuffer.consume(pktlen);
 638             r = rbuffer.fill_to(socknum, 2);
 639         }
 640         else {
 641             // Not an information packet?
 642             cerr << "dinitctl: protocol error" << endl;
 643             return 1;
 644         }
 645     }
 646
 647     if (r == -1) {
 648         perror("dinitctl: read");
 649     }
 650     else {
 651         cerr << "protocol error (connection closed by server)" << endl;
 652     }
 653     return 1;
 654 }
 655
 656 // Issue a "load service" command (DINIT_CP_LOADSERVICE), without waiting for
 657 // a response. Returns 1 on failure (with error logged), 0 on success.
 658 static int issue_load_service(int socknum, const char *service_name, bool find_only)
 659 {
 660     // Build buffer;
 661     uint16_t sname_len = strlen(service_name);
 662     int bufsize = 3 + sname_len;
 663
 664     std::unique_ptr<char[]> ubuf(new char[bufsize]);
 665     auto buf = ubuf.get();
 666
 667     buf[0] = find_only ? DINIT_CP_FINDSERVICE : DINIT_CP_LOADSERVICE;
 668     memcpy(buf + 1, &sname_len, 2);
 669     memcpy(buf + 3, service_name, sname_len);
 670
 671     write_all_x(socknum, buf, bufsize);
 672
 673     return 0;
 674 }
 675
 676 // Check that a "load service" reply was received, and that the requested service was found.
 677 //   state_p may be null.
 678 static int check_load_reply(int socknum, cpbuffer_t &rbuffer, handle_t *handle_p, service_state_t *state_p)
 679 {
 680     using namespace std;
 681
 682     if (rbuffer[0] == DINIT_RP_SERVICERECORD) {
 683         fill_buffer_to(rbuffer, socknum, 2 + sizeof(*handle_p));
 684         rbuffer.extract((char *) handle_p, 2, sizeof(*handle_p));
 685         if (state_p) *state_p = static_cast<service_state_t>(rbuffer[1]);
 686         //target_state = static_cast<service_state_t>(rbuffer[2 + sizeof(handle)]);
 687         rbuffer.consume(3 + sizeof(*handle_p));
 688         return 0;
 689     }
 690     else if (rbuffer[0] == DINIT_RP_NOSERVICE) {
 691         cerr << "dinitctl: failed to find/load service." << endl;
 692         return 1;
 693     }
 694     else {
 695         cerr << "dinitctl: protocol error." << endl;
 696         return 1;
 697     }
 698 }
 699
 700 static int unpin_service(int socknum, cpbuffer_t &rbuffer, const char *service_name, bool verbose)
 701 {
 702     using namespace std;
 703
 704     handle_t handle;
 705
 706     // Build buffer;
 707     if (! load_service(socknum, rbuffer, service_name, &handle, nullptr)) {
 708         return 1;
 709     }
 710
 711     // Issue UNPIN command.
 712     {
 713         auto m = membuf()
 714                 .append<char>(DINIT_CP_UNPINSERVICE)
 715                 .append(handle);
 716         write_all_x(socknum, m);
 717
 718         wait_for_reply(rbuffer, socknum);
 719         if (rbuffer[0] != DINIT_RP_ACK) {
 720             cerr << "dinitctl: protocol error." << endl;
 721             return 1;
 722         }
 723         rbuffer.consume(1);
 724     }
 725
 726     if (verbose) {
 727         cout << "Service unpinned." << endl;
 728     }
 729     return 0;
 730 }
 731
 732 static int unload_service(int socknum, cpbuffer_t &rbuffer, const char *service_name)
 733 {
 734     using namespace std;
 735
 736     if (issue_load_service(socknum, service_name, true) == 1) {
 737         return 1;
 738     }
 739
 740     wait_for_reply(rbuffer, socknum);
 741
 742     handle_t handle;
 743
 744     if (rbuffer[0] == DINIT_RP_NOSERVICE) {
 745         cerr << "dinitctl: service not loaded." << endl;
 746         return 1;
 747     }
 748
 749     if (check_load_reply(socknum, rbuffer, &handle, nullptr) != 0) {
 750         return 1;
 751     }
 752
 753     // Issue UNLOAD command.
 754     {
 755         auto m = membuf()
 756                 .append<char>(DINIT_CP_UNLOADSERVICE)
 757                 .append(handle);
 758         write_all_x(socknum, m);
 759
 760         wait_for_reply(rbuffer, socknum);
 761         if (rbuffer[0] == DINIT_RP_NAK) {
 762             cerr << "dinitctl: Could not unload service; service not stopped, or is a dependency of "
 763                     "other service." << endl;
 764             return 1;
 765         }
 766         if (rbuffer[0] != DINIT_RP_ACK) {
 767             cerr << "dinitctl: Protocol error." << endl;
 768             return 1;
 769         }
 770         rbuffer.consume(1);
 771     }
 772
 773     cout << "Service unloaded." << endl;
 774     return 0;
 775 }
 776
 777 static int list_services(int socknum, cpbuffer_t &rbuffer)
 778 {
 779     using namespace std;
 780
 781     char cmdbuf[] = { (char)DINIT_CP_LISTSERVICES };
 782     write_all_x(socknum, cmdbuf, 1);
 783
 784     wait_for_reply(rbuffer, socknum);
 785     while (rbuffer[0] == DINIT_RP_SVCINFO) {
 786         int hdrsize = 8 + std::max(sizeof(int), sizeof(pid_t));
 787         fill_buffer_to(rbuffer, socknum, hdrsize);
 788         int nameLen = rbuffer[1];
 789         service_state_t current = static_cast<service_state_t>(rbuffer[2]);
 790         service_state_t target = static_cast<service_state_t>(rbuffer[3]);
 791
 792         int console_flags = rbuffer[4];
 793         bool has_console = (console_flags & 2) != 0;
 794         bool waiting_console = (console_flags & 1) != 0;
 795         bool was_skipped = (console_flags & 4) != 0;
 796
 797         stopped_reason_t stop_reason = static_cast<stopped_reason_t>(rbuffer[5]);
 798
 799         pid_t service_pid;
 800         int exit_status;
 801         if (current != service_state_t::STOPPED) {
 802             rbuffer.extract((char *)&service_pid, 8, sizeof(service_pid));
 803         }
 804         else {
 805                 rbuffer.extract((char *)&exit_status, 8, sizeof(exit_status));
 806         }
 807
 808         fill_buffer_to(rbuffer, socknum, nameLen + hdrsize);
 809
 810         char *name_ptr = rbuffer.get_ptr(hdrsize);
 811         int clength = std::min(rbuffer.get_contiguous_length(name_ptr), nameLen);
 812
 813         string name = string(name_ptr, clength);
 814         name.append(rbuffer.get_buf_base(), nameLen - clength);
 815
 816         cout << "[";
 817
 818         cout << (target  == service_state_t::STARTED ? "{" : " ");
 819         if (current == service_state_t::STARTED) {
 820             cout << (was_skipped ? "s" : "+");
 821         }
 822         else {
 823             cout << " ";
 824         }
 825         cout << (target  == service_state_t::STARTED ? "}" : " ");
 826
 827         if (current == service_state_t::STARTING) {
 828             cout << "<<";
 829         }
 830         else if (current == service_state_t::STOPPING) {
 831             cout << ">>";
 832         }
 833         else {
 834             cout << "  ";
 835         }
 836
 837         cout << (target  == service_state_t::STOPPED ? "{" : " ");
 838         if (current == service_state_t::STOPPED) {
 839             bool did_fail = false;
 840             if (stop_reason == stopped_reason_t::TERMINATED) {
 841                 if (!WIFEXITED(exit_status) || WEXITSTATUS(exit_status) != 0) {
 842                     did_fail = true;
 843                 }
 844             }
 845             else did_fail = (stop_reason != stopped_reason_t::NORMAL);
 846
 847             cout << (did_fail ? "X" : "-");
 848         }
 849         else {
 850                 cout << " ";
 851         }
 852         cout << (target == service_state_t::STOPPED ? "}" : " ");
 853
 854         cout << "] " << name;
 855
 856         if (current != service_state_t::STOPPED && service_pid != -1) {
 857                 cout << " (pid: " << service_pid << ")";
 858         }
 859
 860         if (current == service_state_t::STOPPED && stop_reason == stopped_reason_t::TERMINATED) {
 861             if (WIFEXITED(exit_status)) {
 862                 cout << " (exit status: " << WEXITSTATUS(exit_status) << ")";
 863             }
 864             else if (WIFSIGNALED(exit_status)) {
 865                 cout << " (signal: " << WTERMSIG(exit_status) << ")";
 866             }
 867         }
 868
 869         if (has_console) {
 870                 cout << " (has console)";
 871         }
 872         else if (waiting_console) {
 873                 cout << " (waiting for console)";
 874         }
 875
 876         cout << endl;
 877
 878         rbuffer.consume(hdrsize + nameLen);
 879         wait_for_reply(rbuffer, socknum);
 880     }
 881
 882     if (rbuffer[0] != DINIT_RP_LISTDONE) {
 883         cerr << "dinitctl: Control socket protocol error" << endl;
 884         return 1;
 885     }
 886
 887     return 0;
 888 }
 889
 890 static int add_remove_dependency(int socknum, cpbuffer_t &rbuffer, bool add,
 891         const char *service_from, const char *service_to, dependency_type dep_type)
 892 {
 893     using namespace std;
 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     auto m = membuf()
 904             .append<char>(add ? (char)DINIT_CP_ADD_DEP : (char)DINIT_CP_REM_DEP)
 905             .append(dep_type)
 906             .append(from_handle)
 907             .append(to_handle);
 908     write_all_x(socknum, m);
 909
 910     wait_for_reply(rbuffer, socknum);
 911
 912     // check reply
 913     if (rbuffer[0] == DINIT_RP_NAK) {
 914         cerr << "dinitctl: Could not add dependency: circular dependency or wrong state" << endl;
 915         return 1;
 916     }
 917     if (rbuffer[0] != DINIT_RP_ACK) {
 918         cerr << "dinitctl: Control socket protocol error" << endl;
 919         return 1;
 920     }
 921
 922     return 0;
 923 }
 924
 925 static int shutdown_dinit(int socknum, cpbuffer_t &rbuffer)
 926 {
 927     // TODO support no-wait option.
 928     using namespace std;
 929
 930     auto m = membuf()
 931             .append<char>(DINIT_CP_SHUTDOWN)
 932             .append(static_cast<char>(shutdown_type_t::HALT));
 933     write_all_x(socknum, m);
 934
 935     wait_for_reply(rbuffer, socknum);
 936
 937     if (rbuffer[0] != DINIT_RP_ACK) {
 938         cerr << "dinitctl: Control socket protocol error" << endl;
 939         return 1;
 940     }
 941
 942     // Now wait for rollback complete, by waiting for the connection to close:
 943     try {
 944         while (true) {
 945             wait_for_info(rbuffer, socknum);
 946             rbuffer.consume(rbuffer[1]);
 947         }
 948     }
 949     catch (cp_read_exception &exc) {
 950         // Assume that the connection closed.
 951     }
 952
 953     return 0;
 954 }
 955
 956 // exception for cancelling a service operation
 957 class service_op_cancel { };
 958
 959 static int enable_disable_service(int socknum, cpbuffer_t &rbuffer, const char *from, const char *to,
 960         bool enable)
 961 {
 962     using namespace std;
 963
 964     service_state_t from_state = service_state_t::STARTED;
 965     handle_t from_handle;
 966
 967     handle_t to_handle;
 968
 969     if (! load_service(socknum, rbuffer, from, &from_handle, &from_state)
 970             || ! load_service(socknum, rbuffer, to, &to_handle, nullptr)) {
 971         return 1;
 972     }
 973
 974     // Get service load path
 975     char buf[1] = { DINIT_CP_QUERY_LOAD_MECH };
 976     write_all_x(socknum, buf, 1);
 977
 978     wait_for_reply(rbuffer, socknum);
 979
 980     if (rbuffer[0] != DINIT_RP_LOADER_MECH) {
 981         cerr << "dinitctl: Control socket protocol error" << endl;
 982         return 1;
 983     }
 984
 985     // Packet type, load mechanism type, packet size:
 986     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint32_t));
 987
 988     if (rbuffer[1] != SSET_TYPE_DIRLOAD) {
 989         cerr << "dinitctl: unknown configuration, unable to load service descriptions" << endl;
 990         return 1;
 991     }
 992
 993     vector<string> paths;
 994
 995     uint32_t pktsize;
 996     rbuffer.extract(&pktsize, 2, sizeof(uint32_t));
 997
 998     fill_buffer_to(rbuffer, socknum, 2 + sizeof(uint32_t) * 3); // path entries, cwd length
 999
1000     uint32_t path_entries;  // number of service directories
1001     rbuffer.extract(&path_entries, 2 + sizeof(uint32_t), sizeof(uint32_t));
1002
1003     uint32_t cwd_len;
1004     rbuffer.extract(&cwd_len, 2 + sizeof(uint32_t) * 2, sizeof(uint32_t));
1005     rbuffer.consume(2 + sizeof(uint32_t) * 3);
1006     pktsize -= 2 + sizeof(uint32_t) * 3;
1007
1008     // Read current working directory of daemon:
1009     std::string dinit_cwd = read_string(socknum, rbuffer, cwd_len);
1010
1011     // dinit daemon base directory against which service paths are resolved is in dinit_cwd
1012
1013     for (int i = 0; i < (int)path_entries; i++) {
1014         uint32_t plen;
1015         fill_buffer_to(rbuffer, socknum, sizeof(uint32_t));
1016         rbuffer.extract(&plen, 0, sizeof(uint32_t));
1017         rbuffer.consume(sizeof(uint32_t));
1018         paths.push_back(read_string(socknum, rbuffer, plen));
1019     }
1020
1021     // all service directories are now in the 'paths' vector
1022     // Load/read service description for 'from' service:
1023
1024     ifstream service_file;
1025     string service_file_path;
1026
1027     for (std::string path : paths) {
1028         string test_path = combine_paths(combine_paths(dinit_cwd, path.c_str()), from);
1029
1030         service_file.open(test_path.c_str(), ios::in);
1031         if (service_file) {
1032             service_file_path = test_path;
1033             break;
1034         }
1035     }
1036
1037     if (! service_file) {
1038         cerr << "dinitctl: could not locate service file for service '" << from << "'" << endl;
1039         return 1;
1040     }
1041
1042     // We now need to read the service file, identify the waits-for.d directory (bail out if more than one),
1043     // make sure the service is not listed as a dependency individually.
1044
1045     string waits_for_d;
1046
1047     try {
1048         process_service_file(from, service_file, [&](string &line, string &setting,
1049                 dinit_load::string_iterator i, dinit_load::string_iterator end) -> void {
1050             if (setting == "waits-for" || setting == "depends-on" || setting == "depends-ms") {
1051                 string dname = dinit_load::read_setting_value(i, end);
1052                 if (dname == to) {
1053                     // There is already a dependency
1054                     cerr << "dinitctl: there is a fixed dependency to service '" << to
1055                             << "' in the service description of '" << from << "'." << endl;
1056                     throw service_op_cancel();
1057                 }
1058             }
1059             else if (setting == "waits-for.d") {
1060                 string dname = dinit_load::read_setting_value(i, end);
1061                 if (! waits_for_d.empty()) {
1062                     cerr << "dinitctl: service '" << from << "' has multiple waits-for.d directories "
1063                             << "specified in service description" << endl;
1064                     throw service_op_cancel();
1065                 }
1066                 waits_for_d = std::move(dname);
1067             }
1068         });
1069     }
1070     catch (const service_op_cancel &cexc) {
1071         return 1;
1072     }
1073
1074     // If the from service has no waits-for.d specified, we can't continue
1075     if (waits_for_d.empty()) {
1076         cerr << "dinitctl: service '" << from << "' has no waits-for.d directory specified" << endl;
1077         return 1;
1078     }
1079
1080     // The waits-for.d path is relative to the service file path, combine:
1081     string waits_for_d_full = combine_paths(parent_path(service_file_path), waits_for_d.c_str());
1082
1083     // check if dependency already exists
1084     string dep_link_path = combine_paths(waits_for_d_full, to);
1085     struct stat stat_buf;
1086     if (lstat(dep_link_path.c_str(), &stat_buf) == -1) {
1087         if (errno != ENOENT) {
1088             cerr << "dinitctl: checking for existing dependency link: " << dep_link_path << ": "
1089                     << strerror(errno) << endl;
1090             return 1;
1091         }
1092     }
1093     else {
1094         // dependency already exists
1095         if (enable) {
1096             cerr << "dinitctl: service already enabled." << endl;
1097             return 1;
1098         }
1099     }
1100
1101     // warn if 'from' service is not started
1102     if (enable && from_state != service_state_t::STARTED) {
1103         cerr << "dinitctl: warning: enabling dependency for non-started service" << endl;
1104     }
1105
1106     // add/remove dependency
1107     constexpr int enable_pktsize = 2 + sizeof(handle_t) * 2;
1108     char cmdbuf[enable_pktsize] = { char(enable ? DINIT_CP_ENABLESERVICE : DINIT_CP_REM_DEP),
1109             char(dependency_type::WAITS_FOR)};
1110     memcpy(cmdbuf + 2, &from_handle, sizeof(from_handle));
1111     memcpy(cmdbuf + 2 + sizeof(from_handle), &to_handle, sizeof(to_handle));
1112     write_all_x(socknum, cmdbuf, enable_pktsize);
1113
1114     wait_for_reply(rbuffer, socknum);
1115
1116     // check reply
1117     if (enable && rbuffer[0] == DINIT_RP_NAK) {
1118         cerr << "dinitctl: Could not enable service: possible circular dependency" << endl;
1119         return 1;
1120     }
1121     if (rbuffer[0] != DINIT_RP_ACK) {
1122         cerr << "dinitctl: Control socket protocol error" << endl;
1123         return 1;
1124     }
1125
1126     // create link
1127     if (enable) {
1128         if (symlink((string("../") + to).c_str(), dep_link_path.c_str()) == -1) {
1129             cerr << "dinitctl: Could not create symlink at " << dep_link_path << ": " << strerror(errno)
1130                     << "\n" "dinitctl: Note: service was activated, but will not be enabled on restart."
1131                     << endl;
1132             return 1;
1133         }
1134     }
1135     else {
1136         if (unlink(dep_link_path.c_str()) == -1) {
1137             cerr << "dinitctl: Could not unlink dependency entry " << dep_link_path << ": "
1138                     << strerror(errno) << "\n"
1139                     "dinitctl: Note: service was disabled, but will be re-enabled on restart." << endl;
1140             return 1;
1141         }
1142     }
1143
1144     return 0;
1145 }