src/libsystemd-bus/bus-util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2013 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include "sd-event.h"
  25 #include "sd-bus.h"
  26 #include "hashmap.h"
  27 #include "time-util.h"
  28 #include "util.h"
  29
  30 typedef enum BusTransport {
  31         BUS_TRANSPORT_LOCAL,
  32         BUS_TRANSPORT_REMOTE,
  33         BUS_TRANSPORT_CONTAINER,
  34         _BUS_TRANSPORT_MAX,
  35         _BUS_TRANSPORT_INVALID = -1
  36 } BusTransport;
  37
  38 typedef int (*bus_property_set_t) (sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  39
  40 struct bus_properties_map {
  41         const char *member;
  42         const char *signature;
  43         bus_property_set_t set;
  44         size_t offset;
  45 };
  46
  47 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata);
  48
  49 int bus_map_all_properties(sd_bus *bus,
  50                            const char *destination,
  51                            const char *path,
  52                            const struct bus_properties_map *map,
  53                            void *userdata);
  54
  55 int bus_async_unregister_and_quit(sd_event *e, sd_bus *bus, const char *name);
  56
  57 int bus_event_loop_with_idle(sd_event *e, sd_bus *bus, const char *name, usec_t timeout);
  58 int bus_property_get_tristate(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, sd_bus_error *error, void *userdata);
  59
  60 int bus_verify_polkit(sd_bus *bus, sd_bus_message *m, const char *action, bool interactive, bool *_challenge, sd_bus_error *e);
  61
  62 int bus_verify_polkit_async(sd_bus *bus, Hashmap **registry, sd_bus_message *m, const char *action, bool interactive, sd_bus_error *error, sd_bus_message_handler_t callback, void *userdata);
  63 void bus_verify_polkit_async_registry_free(sd_bus *bus, Hashmap *registry);
  64
  65 int bus_open_system_systemd(sd_bus **_bus);
  66 int bus_open_user_systemd(sd_bus **_bus);
  67
  68 int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  69 int bus_open_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus);
  70
  71 int bus_print_property(const char *name, sd_bus_message *property, bool all);
  72 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool all);
  73
  74 int bus_property_get_bool(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, sd_bus_error *error, void *userdata);
  75 int bus_property_get_uid(sd_bus *bus, const char *path, const char *interface, const char *property, sd_bus_message *reply, sd_bus_error *error, void *userdata);
  76
  77 #define bus_property_get_gid bus_property_get_uid
  78 #define bus_property_get_pid bus_property_get_uid
  79
  80 int bus_log_parse_error(int r);
  81 int bus_log_create_error(int r);
  82
  83 typedef struct UnitInfo {
  84         const char *id;
  85         const char *description;
  86         const char *load_state;
  87         const char *active_state;
  88         const char *sub_state;
  89         const char *following;
  90         const char *unit_path;
  91         uint32_t job_id;
  92         const char *job_type;
  93         const char *job_path;
  94 } UnitInfo;
  95
  96 int bus_parse_unit_info(sd_bus_message *message, UnitInfo *u);
  97
  98 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
  99 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
 100
 101 #define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
 102 #define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
 103 #define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
 104
 105 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
 106         int function(sd_bus *bus,                                       \
 107                      const char *path,                                  \
 108                      const char *interface,                             \
 109                      const char *property,                              \
 110                      sd_bus_message *reply,                             \
 111                      sd_bus_error *error,                               \
 112                      void *userdata) {                                  \
 113                                                                         \
 114                 const char *value;                                      \
 115                 type *field = userdata;                                 \
 116                 int r;                                                  \
 117                                                                         \
 118                 assert(bus);                                            \
 119                 assert(reply);                                          \
 120                 assert(field);                                          \
 121                                                                         \
 122                 value = strempty(name##_to_string(*field));             \
 123                                                                         \
 124                 r = sd_bus_message_append_basic(reply, 's', value);     \
 125                 if (r < 0)                                              \
 126                         return r;                                       \
 127                                                                         \
 128                 return 1;                                               \
 129         }                                                               \
 130         struct __useless_struct_to_allow_trailing_semicolon__
 131
 132 #define BUS_ERROR_NO_SUCH_UNIT "org.freedesktop.systemd1.NoSuchUnit"
 133 #define BUS_ERROR_LOAD_FAILED "org.freedesktop.systemd1.LoadFailed"
 134 #define BUS_ERROR_JOB_FAILED "org.freedesktop.systemd1.JobFailed"
 135
 136 #define BUS_ERROR_NO_SUCH_MACHINE "org.freedesktop.machine1.NoSuchMachine"
 137 #define BUS_ERROR_NO_MACHINE_FOR_PID "org.freedesktop.machine1.NoMachineForPID"
 138 #define BUS_ERROR_MACHINE_EXISTS "org.freedesktop.machine1.MachineExists"
 139
 140 #define BUS_ERROR_NO_SUCH_SESSION "org.freedesktop.login1.NoSuchSession"
 141 #define BUS_ERROR_NO_SESSION_FOR_PID "org.freedesktop.login1.NoSessionForPID"
 142 #define BUS_ERROR_NO_SUCH_USER "org.freedesktop.login1.NoSuchUser"
 143 #define BUS_ERROR_NO_USER_FOR_PID "org.freedesktop.login1.NoUserForPID"
 144 #define BUS_ERROR_NO_SUCH_SEAT "org.freedesktop.login1.NoSuchSeat"
 145 #define BUS_ERROR_SESSION_NOT_ON_SEAT "org.freedesktop.login1.SessionNotOnSeat"
 146 #define BUS_ERROR_NOT_IN_CONTROL "org.freedesktop.login1.NotInControl"
 147 #define BUS_ERROR_DEVICE_IS_TAKEN "org.freedesktop.login1.DeviceIsTaken"
 148 #define BUS_ERROR_DEVICE_NOT_TAKEN "org.freedesktop.login1.DeviceNotTaken"
 149 #define BUS_ERROR_OPERATION_IN_PROGRESS "org.freedesktop.login1.OperationInProgress"
 150 #define BUS_ERROR_SLEEP_VERB_NOT_SUPPORTED "org.freedesktop.login1.SleepVerbNotSupported"