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 int bus_async_unregister_and_quit(sd_event *e, sd_bus *bus, const char *name);
  39
  40 int bus_event_loop_with_idle(sd_event *e, sd_bus *bus, const char *name, usec_t timeout);
  41 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);
  42
  43 int bus_verify_polkit(sd_bus *bus, sd_bus_message *m, const char *action, bool interactive, bool *_challenge, sd_bus_error *e);
  44
  45 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);
  46 void bus_verify_polkit_async_registry_free(sd_bus *bus, Hashmap *registry);
  47
  48 int bus_open_system_systemd(sd_bus **_bus);
  49
  50 int bus_open_transport(BusTransport transport, const char *host, bool user, sd_bus **bus);
  51
  52 int bus_generic_print_property(const char *name, sd_bus_message *property, bool all);
  53
  54 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus*, sd_bus_unref);
  55 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_bus_message*, sd_bus_message_unref);
  56
  57 #define _cleanup_bus_unref_ _cleanup_(sd_bus_unrefp)
  58 #define _cleanup_bus_message_unref_ _cleanup_(sd_bus_message_unrefp)
  59 #define _cleanup_bus_error_free_ _cleanup_(sd_bus_error_free)
  60
  61 #define BUS_DEFINE_PROPERTY_GET_ENUM(function, name, type)              \
  62         int function(sd_bus *bus,                                       \
  63                      const char *path,                                  \
  64                      const char *interface,                             \
  65                      const char *property,                              \
  66                      sd_bus_message *reply,                             \
  67                      sd_bus_error *error,                               \
  68                      void *userdata) {                                  \
  69                                                                         \
  70                 const char *value;                                      \
  71                 type *field = userdata;                                 \
  72                 int r;                                                  \
  73                                                                         \
  74                 assert(bus);                                            \
  75                 assert(reply);                                          \
  76                 assert(field);                                          \
  77                                                                         \
  78                 value = strempty(name##_to_string(*field));             \
  79                                                                         \
  80                 r = sd_bus_message_append_basic(reply, 's', value);     \
  81                 if (r < 0)                                              \
  82                         return r;                                       \
  83                                                                         \
  84                 return 1;                                               \
  85         }                                                               \
  86         struct __useless_struct_to_allow_trailing_semicolon__
  87
  88 #define BUS_ERROR_NO_SUCH_UNIT "org.freedesktop.systemd1.NoSuchUnit"
  89 #define BUS_ERROR_LOAD_FAILED "org.freedesktop.systemd1.LoadFailed"
  90 #define BUS_ERROR_JOB_FAILED "org.freedesktop.systemd1.JobFailed"
  91
  92 #define BUS_ERROR_NO_SUCH_MACHINE "org.freedesktop.machine1.NoSuchMachine"
  93 #define BUS_ERROR_NO_MACHINE_FOR_PID "org.freedesktop.machine1.NoMachineForPID"
  94 #define BUS_ERROR_MACHINE_EXISTS "org.freedesktop.machine1.MachineExists"