bus-message.h 4.59 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

#pragma once

/***
  This file is part of systemd.

  Copyright 2013 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#include <stdbool.h>
#include <byteswap.h>
26
#include <sys/socket.h>
27 28 29

#include "macro.h"
#include "sd-bus.h"
30
#include "kdbus.h"
Lennart Poettering's avatar
Lennart Poettering committed
31
#include "time-util.h"
32 33 34 35 36 37 38 39

struct bus_container {
        char enclosing;

        char *signature;
        unsigned index;

        uint32_t *array_size;
40
        size_t begin;
41 42
};

43
struct bus_header {
44 45 46 47 48 49 50
        uint8_t endian;
        uint8_t type;
        uint8_t flags;
        uint8_t version;
        uint32_t body_size;
        uint32_t serial;
        uint32_t fields_size;
51
} _packed_;
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

struct sd_bus_message {
        unsigned n_ref;

        uint32_t reply_serial;

        const char *path;
        const char *interface;
        const char *member;
        const char *destination;
        const char *sender;

        sd_bus_error error;

        uid_t uid;
        gid_t gid;
        pid_t pid;
        pid_t tid;
70
        usec_t pid_starttime;
71
        usec_t timestamp;
72 73

        bool sealed:1;
74 75
        bool dont_send:1;
        bool allow_fds:1;
76 77 78 79 80
        bool uid_valid:1;
        bool gid_valid:1;
        bool free_header:1;
        bool free_fields:1;
        bool free_body:1;
81
        bool free_kdbus:1;
82
        bool free_fds:1;
83 84 85 86

        struct bus_header *header;
        void *fields;
        void *body;
87
        struct kdbus_msg *kdbus;
88

89 90
        char *label;

91 92
        size_t rindex;

93 94 95
        uint32_t n_fds;
        int *fds;

96
        struct bus_container root_container, *containers;
97 98 99 100
        unsigned n_containers;

        struct iovec iovec[4];
        unsigned n_iovec;
101 102

        char *peeked_signature;
103 104

        usec_t timeout;
105 106
};

107
#define BUS_MESSAGE_NEED_BSWAP(m) ((m)->header->endian != SD_BUS_NATIVE_ENDIAN)
108

109 110 111 112 113
static inline uint16_t BUS_MESSAGE_BSWAP16(sd_bus_message *m, uint16_t u) {
        return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_16(u) : u;
}

static inline uint32_t BUS_MESSAGE_BSWAP32(sd_bus_message *m, uint32_t u) {
114 115 116
        return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_32(u) : u;
}

117 118 119 120
static inline uint64_t BUS_MESSAGE_BSWAP64(sd_bus_message *m, uint64_t u) {
        return BUS_MESSAGE_NEED_BSWAP(m) ? bswap_64(u) : u;
}

121
static inline uint32_t BUS_MESSAGE_SERIAL(sd_bus_message *m) {
122
        return BUS_MESSAGE_BSWAP32(m, m->header->serial);
123 124 125
}

static inline uint32_t BUS_MESSAGE_BODY_SIZE(sd_bus_message *m) {
126
        return BUS_MESSAGE_BSWAP32(m, m->header->body_size);
127 128 129
}

static inline uint32_t BUS_MESSAGE_FIELDS_SIZE(sd_bus_message *m) {
130
        return BUS_MESSAGE_BSWAP32(m, m->header->fields_size);
131 132
}

133 134 135 136 137 138 139
static inline uint32_t BUS_MESSAGE_SIZE(sd_bus_message *m) {
        return
                sizeof(struct bus_header) +
                ALIGN8(BUS_MESSAGE_FIELDS_SIZE(m)) +
                BUS_MESSAGE_BODY_SIZE(m);
}

140 141 142 143 144 145
static inline void bus_message_unrefp(sd_bus_message **m) {
        sd_bus_message_unref(*m);
}

#define _cleanup_bus_message_unref_ __attribute__((cleanup(bus_message_unrefp)))

146 147
int bus_message_seal(sd_bus_message *m, uint64_t serial);
int bus_message_dump(sd_bus_message *m);
148
int bus_message_get_blob(sd_bus_message *m, void **buffer, size_t *sz);
149
int bus_message_read_strv_extend(sd_bus_message *m, char ***l);
150

151 152 153 154 155 156 157 158 159 160
int bus_message_from_header(
                void *header,
                size_t length,
                int *fds,
                unsigned n_fds,
                const struct ucred *ucred,
                const char *label,
                size_t extra,
                sd_bus_message **ret);

161 162 163 164 165 166 167 168
int bus_message_from_malloc(
                void *buffer,
                size_t length,
                int *fds,
                unsigned n_fds,
                const struct ucred *ucred,
                const char *label,
                sd_bus_message **ret);
169 170

const char* bus_message_get_arg(sd_bus_message *m, unsigned i);
171 172

int bus_message_append_ap(sd_bus_message *m, const char *types, va_list ap);
173

174 175 176
int bus_message_parse_fields(sd_bus_message *m);

int bus_header_size(struct bus_header *h, size_t *sum);