unit.h revision 8a0867d6c5b47c8697d1ddd815116a548433c718
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
#ifndef foounithfoo
#define foounithfoo
/***
This file is part of systemd.
Copyright 2010 Lennart Poettering
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <stdbool.h>
#include <stdlib.h>
typedef struct UnitVTable UnitVTable;
typedef enum UnitLoadState UnitLoadState;
typedef enum UnitActiveState UnitActiveState;
typedef enum UnitDependency UnitDependency;
#include "set.h"
#include "util.h"
#include "list.h"
#include "socket-util.h"
#include "execute.h"
#include "condition.h"
enum UnitType {
UNIT_SERVICE = 0,
_UNIT_TYPE_INVALID = -1
};
enum UnitLoadState {
};
enum UnitActiveState {
};
static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
return t == UNIT_ACTIVE || t == UNIT_RELOADING;
}
static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
}
static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
}
static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
return t == UNIT_INACTIVE || t == UNIT_FAILED;
}
enum UnitDependency {
/* Positive dependencies */
/* Inverse of the above */
UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
UNIT_WANTED_BY, /* inverse of 'wants' */
/* Negative dependencies */
UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
/* Order */
UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
/* On Failure */
/* Reference information for GC logic */
UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
};
#include "manager.h"
#include "job.h"
#include "cgroup.h"
struct Meta {
char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
char *instance;
char *description;
char *fragment_path; /* if loaded from a config file this is the primary path to it */
/* If there is something to do with this unit, then this is
* the job for it */
/* Conditions to check */
/* Counterparts in the cgroup filesystem */
/* Per type list */
/* Load queue */
/* D-Bus queue */
/* Cleanup queue */
/* GC queue */
/* Used during GC sweeps */
unsigned gc_marker;
/* When deserializing, temporarily store the job type for this
* unit here, if there was a job scheduled */
int deserialized_job; /* This is actually of type JobType */
/* Error code when we didn't manage to load the unit (negative) */
int load_error;
/* If we go down, pull down everything that depends on us, too */
bool recursive_stop;
/* Garbage collect us we nobody wants or requires us anymore */
bool stop_when_unneeded;
/* Create default depedencies */
bool default_dependencies;
/* Bring up this unit even if a dependency fails to start */
/* Refuse manual starting, allow starting only indirectly via dependency. */
bool refuse_manual_start;
/* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
bool refuse_manual_stop;
/* Allow isolation requests */
bool allow_isolate;
bool in_load_queue:1;
bool in_dbus_queue:1;
bool in_cleanup_queue:1;
bool in_gc_queue:1;
bool sent_dbus_new_signal:1;
bool no_gc:1;
bool in_audit:1;
};
#include "service.h"
#include "timer.h"
#include "socket.h"
#include "target.h"
#include "device.h"
#include "mount.h"
#include "automount.h"
#include "snapshot.h"
#include "swap.h"
#include "path.h"
union Unit {
};
struct UnitVTable {
const char *suffix;
/* This should reset all type-specific variables. This should
* not allocate memory, and is called with zero-initialized
* data. It should hence only initialize variables that need
* to be set != 0. */
/* This should free all type-specific variables. It should be
* idempotent. */
/* Actually load data from disk. This may fail, and should set
* load_state to UNIT_LOADED, UNIT_MERGED or leave it at
* UNIT_STUB if no configuration could be found. */
/* If a a lot of units got created via enumerate(), this is
* where to actually set the state and call unit_notify(). */
bool (*can_reload)(Unit *u);
/* Write all data that cannot be restored from other sources
* away using unit_serialize_item() */
/* Restore one item from the serialization */
/* Boils down the more complex internal state of this unit to
* a simpler one that the engine can understand */
/* Returns the substate specific to this unit type as
* string. This is purely information so that we can give the
* user a more finegrained explanation in which actual state a
* unit is in. */
const char* (*sub_state_to_string)(Unit *u);
/* Return true when there is reason to keep this entry around
* even nothing references it and it isn't active in any
* way */
/* Return true when this unit is suitable for snapshotting */
bool (*check_snapshot)(Unit *u);
/* Reset failed state if we are in failed state */
void (*reset_failed)(Unit *u);
/* Called whenever any of the cgroups this unit watches for
* ran empty */
void (*cgroup_notify_empty)(Unit *u);
/* Called whenever a process of this unit sends us a message */
/* Called whenever a name thus Unit registered for comes or
* goes away. */
void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
/* Called whenever a bus PID lookup finishes */
/* Called for each message received on the bus */
/* Return the unit this unit is following */
/* This is called for each unit type and should be used to
* enumerate existing devices and load them. However,
* everything that is loaded here should still stay in
* inactive state. It is the job of the coldplug() call above
* to put the units into the initial state. */
/* Type specific cleanups. */
/* When sending out PropertiesChanged signal, which properties
* shall be invalidated? This is a NUL separated list of
* strings, to minimize relocations a little. */
const char *bus_invalidating_properties;
/* The interface name */
const char *bus_interface;
/* Can units of this type have multiple names? */
bool no_alias:1;
/* If true units of this types can never have "Requires"
* dependencies, because state changes can only be observed,
* not triggered */
bool no_requires:1;
/* Instances make no sense for this type */
bool no_instances:1;
/* Exclude this type from snapshots */
bool no_snapshots:1;
/* Exclude from automatic gc */
bool no_gc:1;
/* Exclude from stopping on isolation requests */
bool no_isolate:1;
/* Show status updates on the console */
bool show_status:1;
};
/* For casting a unit into the various unit types */
return NULL; \
\
return (MixedCase*) u; \
}
/* For casting the various unit types into a unit */
int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
int unit_add_default_cgroup(Unit *u);
bool unit_check_gc(Unit *u);
void unit_add_to_load_queue(Unit *u);
void unit_add_to_dbus_queue(Unit *u);
void unit_add_to_cleanup_queue(Unit *u);
void unit_add_to_gc_queue(Unit *u);
int unit_load_fragment_and_dropin(Unit *u);
const char *unit_description(Unit *u);
const char* unit_sub_state_to_string(Unit *u);
bool unit_can_reload(Unit *u);
bool unit_can_start(Unit *u);
bool unit_can_isolate(Unit *u);
int unit_start(Unit *u);
int unit_reload(Unit *u);
int set_unit_path(const char *p);
char *unit_dbus_path(Unit *u);
char **unit_full_printf_strv(Unit *u, char **l);
bool unit_can_serialize(Unit *u);
void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
int unit_coldplug(Unit *u);
bool unit_need_daemon_reload(Unit *u);
void unit_reset_failed(Unit *u);
bool unit_pending_inactive(Unit *u);
bool unit_pending_active(Unit *u);
UnitType unit_name_to_type(const char *n);
bool unit_name_is_valid(const char *n, bool template_ok);
const char *unit_load_state_to_string(UnitLoadState i);
UnitLoadState unit_load_state_from_string(const char *s);
const char *unit_active_state_to_string(UnitActiveState i);
UnitActiveState unit_active_state_from_string(const char *s);
const char *unit_dependency_to_string(UnitDependency i);
UnitDependency unit_dependency_from_string(const char *s);
#endif