src/machine/machine.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2013 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 typedef struct Machine Machine;
  23 typedef struct MachineOperation MachineOperation;
  24 typedef enum KillWho KillWho;
  25
  26 #include "list.h"
  27 #include "machined.h"
  28
  29 typedef enum MachineState {
  30         MACHINE_OPENING,    /* Machine is being registered */
  31         MACHINE_RUNNING,    /* Machine is running */
  32         MACHINE_CLOSING,    /* Machine is terminating */
  33         _MACHINE_STATE_MAX,
  34         _MACHINE_STATE_INVALID = -1
  35 } MachineState;
  36
  37 typedef enum MachineClass {
  38         MACHINE_CONTAINER,
  39         MACHINE_VM,
  40         MACHINE_HOST,
  41         _MACHINE_CLASS_MAX,
  42         _MACHINE_CLASS_INVALID = -1
  43 } MachineClass;
  44
  45 enum KillWho {
  46         KILL_LEADER,
  47         KILL_ALL,
  48         _KILL_WHO_MAX,
  49         _KILL_WHO_INVALID = -1
  50 };
  51
  52 #define MACHINE_OPERATIONS_MAX 64
  53
  54 struct MachineOperation {
  55         Machine *machine;
  56         pid_t pid;
  57         sd_bus_message *message;
  58         int errno_fd;
  59         sd_event_source *event_source;
  60         LIST_FIELDS(MachineOperation, operations);
  61 };
  62
  63 struct Machine {
  64         Manager *manager;
  65
  66         char *name;
  67         sd_id128_t id;
  68
  69         MachineClass class;
  70
  71         char *state_file;
  72         char *service;
  73         char *root_directory;
  74
  75         char *unit;
  76         char *scope_job;
  77
  78         pid_t leader;
  79
  80         dual_timestamp timestamp;
  81
  82         bool in_gc_queue:1;
  83         bool started:1;
  84         bool stopping:1;
  85
  86         sd_bus_message *create_message;
  87
  88         int *netif;
  89         unsigned n_netif;
  90
  91         LIST_FIELDS(Machine, gc_queue);
  92
  93         MachineOperation *operations;
  94         unsigned n_operations;
  95 };
  96
  97 Machine* machine_new(Manager *manager, MachineClass class, const char *name);
  98 void machine_free(Machine *m);
  99 bool machine_check_gc(Machine *m, bool drop_not_started);
 100 void machine_add_to_gc_queue(Machine *m);
 101 int machine_start(Machine *m, sd_bus_message *properties, sd_bus_error *error);
 102 int machine_stop(Machine *m);
 103 int machine_finalize(Machine *m);
 104 int machine_save(Machine *m);
 105 int machine_load(Machine *m);
 106 int machine_kill(Machine *m, KillWho who, int signo);
 107
 108 void machine_release_unit(Machine *m);
 109
 110 MachineState machine_get_state(Machine *u);
 111
 112 MachineOperation *machine_operation_unref(MachineOperation *o);
 113
 114 const char* machine_class_to_string(MachineClass t) _const_;
 115 MachineClass machine_class_from_string(const char *s) _pure_;
 116
 117 const char* machine_state_to_string(MachineState t) _const_;
 118 MachineState machine_state_from_string(const char *s) _pure_;
 119
 120 const char *kill_who_to_string(KillWho k) _const_;
 121 KillWho kill_who_from_string(const char *s) _pure_;
 122
 123 int machine_openpt(Machine *m, int flags);
 124 int machine_open_terminal(Machine *m, const char *path, int mode);