src/systemd/sd-id128.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #ifndef foosdid128hfoo
   3 #define foosdid128hfoo
   4
   5 /***
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <https://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <inttypes.h>
  21 #include <stdarg.h>
  22 #include <string.h>
  23
  24 #include "_sd-common.h"
  25
  26 _SD_BEGIN_DECLARATIONS;
  27
  28 /* 128-bit ID APIs. See sd-id128(3) for more information. */
  29
  30 typedef union sd_id128 sd_id128_t;
  31
  32 union sd_id128 {
  33         uint8_t bytes[16];
  34         uint64_t qwords[2];
  35 };
  36
  37 #define SD_ID128_STRING_MAX 33U
  38 #define SD_ID128_UUID_STRING_MAX 37U
  39
  40 char *sd_id128_to_string(sd_id128_t id, char s[_SD_ARRAY_STATIC SD_ID128_STRING_MAX]);
  41 char *sd_id128_to_uuid_string(sd_id128_t id, char s[_SD_ARRAY_STATIC SD_ID128_UUID_STRING_MAX]);
  42 int sd_id128_from_string(const char *s, sd_id128_t *ret);
  43
  44 #define SD_ID128_TO_STRING(id) sd_id128_to_string((id), (char[SD_ID128_STRING_MAX]) {})
  45 #define SD_ID128_TO_UUID_STRING(id) sd_id128_to_uuid_string((id), (char[SD_ID128_UUID_STRING_MAX]) {})
  46
  47 int sd_id128_randomize(sd_id128_t *ret);
  48
  49 int sd_id128_get_machine(sd_id128_t *ret);
  50 int sd_id128_get_boot(sd_id128_t *ret);
  51 int sd_id128_get_invocation(sd_id128_t *ret);
  52
  53 int sd_id128_get_app_specific(sd_id128_t base, sd_id128_t app_id, sd_id128_t *ret);
  54 int sd_id128_get_machine_app_specific(sd_id128_t app_id, sd_id128_t *ret);
  55 int sd_id128_get_boot_app_specific(sd_id128_t app_id, sd_id128_t *ret);
  56 int sd_id128_get_invocation_app_specific(sd_id128_t app_id, sd_id128_t *ret);
  57
  58 #define SD_ID128_ARRAY(v0, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) \
  59         { .bytes = { 0x##v0, 0x##v1, 0x##v2, 0x##v3, 0x##v4, 0x##v5, 0x##v6, 0x##v7, \
  60                      0x##v8, 0x##v9, 0x##v10, 0x##v11, 0x##v12, 0x##v13, 0x##v14, 0x##v15 }}
  61
  62 #define SD_ID128_MAKE(v0, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) \
  63         ((const sd_id128_t) SD_ID128_ARRAY(v0, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15))
  64
  65 /* Note that SD_ID128_FORMAT_VAL will evaluate the passed argument 16
  66  * times. It is hence not a good idea to call this macro with an
  67  * expensive function as parameter or an expression with side
  68  * effects */
  69
  70 #define SD_ID128_FORMAT_STR "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x"
  71 #define SD_ID128_FORMAT_VAL(x) (x).bytes[0], (x).bytes[1], (x).bytes[2], (x).bytes[3], (x).bytes[4], (x).bytes[5], (x).bytes[6], (x).bytes[7], (x).bytes[8], (x).bytes[9], (x).bytes[10], (x).bytes[11], (x).bytes[12], (x).bytes[13], (x).bytes[14], (x).bytes[15]
  72
  73 /* Like SD_ID128_FORMAT_STR, but formats as UUID, not in plain format (Strictly Big Endian byte order,
  74  * i.e. treats everything as RFC4122 Variant 1 UUIDs, even if variant says otherwise, but matching other
  75  * Linux userspace behaviour.) */
  76 #define SD_ID128_UUID_FORMAT_STR "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x"
  77
  78 #define SD_ID128_CONST_STR(x)                                           \
  79         ((const char[SD_ID128_STRING_MAX]) {                            \
  80                 ((x).bytes[0] >> 4) >= 10 ? 'a' + ((x).bytes[0] >> 4) - 10 : '0' + ((x).bytes[0] >> 4), \
  81                 ((x).bytes[0] & 15) >= 10 ? 'a' + ((x).bytes[0] & 15) - 10 : '0' + ((x).bytes[0] & 15), \
  82                 ((x).bytes[1] >> 4) >= 10 ? 'a' + ((x).bytes[1] >> 4) - 10 : '0' + ((x).bytes[1] >> 4), \
  83                 ((x).bytes[1] & 15) >= 10 ? 'a' + ((x).bytes[1] & 15) - 10 : '0' + ((x).bytes[1] & 15), \
  84                 ((x).bytes[2] >> 4) >= 10 ? 'a' + ((x).bytes[2] >> 4) - 10 : '0' + ((x).bytes[2] >> 4), \
  85                 ((x).bytes[2] & 15) >= 10 ? 'a' + ((x).bytes[2] & 15) - 10 : '0' + ((x).bytes[2] & 15), \
  86                 ((x).bytes[3] >> 4) >= 10 ? 'a' + ((x).bytes[3] >> 4) - 10 : '0' + ((x).bytes[3] >> 4), \
  87                 ((x).bytes[3] & 15) >= 10 ? 'a' + ((x).bytes[3] & 15) - 10 : '0' + ((x).bytes[3] & 15), \
  88                 ((x).bytes[4] >> 4) >= 10 ? 'a' + ((x).bytes[4] >> 4) - 10 : '0' + ((x).bytes[4] >> 4), \
  89                 ((x).bytes[4] & 15) >= 10 ? 'a' + ((x).bytes[4] & 15) - 10 : '0' + ((x).bytes[4] & 15), \
  90                 ((x).bytes[5] >> 4) >= 10 ? 'a' + ((x).bytes[5] >> 4) - 10 : '0' + ((x).bytes[5] >> 4), \
  91                 ((x).bytes[5] & 15) >= 10 ? 'a' + ((x).bytes[5] & 15) - 10 : '0' + ((x).bytes[5] & 15), \
  92                 ((x).bytes[6] >> 4) >= 10 ? 'a' + ((x).bytes[6] >> 4) - 10 : '0' + ((x).bytes[6] >> 4), \
  93                 ((x).bytes[6] & 15) >= 10 ? 'a' + ((x).bytes[6] & 15) - 10 : '0' + ((x).bytes[6] & 15), \
  94                 ((x).bytes[7] >> 4) >= 10 ? 'a' + ((x).bytes[7] >> 4) - 10 : '0' + ((x).bytes[7] >> 4), \
  95                 ((x).bytes[7] & 15) >= 10 ? 'a' + ((x).bytes[7] & 15) - 10 : '0' + ((x).bytes[7] & 15), \
  96                 ((x).bytes[8] >> 4) >= 10 ? 'a' + ((x).bytes[8] >> 4) - 10 : '0' + ((x).bytes[8] >> 4), \
  97                 ((x).bytes[8] & 15) >= 10 ? 'a' + ((x).bytes[8] & 15) - 10 : '0' + ((x).bytes[8] & 15), \
  98                 ((x).bytes[9] >> 4) >= 10 ? 'a' + ((x).bytes[9] >> 4) - 10 : '0' + ((x).bytes[9] >> 4), \
  99                 ((x).bytes[9] & 15) >= 10 ? 'a' + ((x).bytes[9] & 15) - 10 : '0' + ((x).bytes[9] & 15), \
 100                 ((x).bytes[10] >> 4) >= 10 ? 'a' + ((x).bytes[10] >> 4) - 10 : '0' + ((x).bytes[10] >> 4), \
 101                 ((x).bytes[10] & 15) >= 10 ? 'a' + ((x).bytes[10] & 15) - 10 : '0' + ((x).bytes[10] & 15), \
 102                 ((x).bytes[11] >> 4) >= 10 ? 'a' + ((x).bytes[11] >> 4) - 10 : '0' + ((x).bytes[11] >> 4), \
 103                 ((x).bytes[11] & 15) >= 10 ? 'a' + ((x).bytes[11] & 15) - 10 : '0' + ((x).bytes[11] & 15), \
 104                 ((x).bytes[12] >> 4) >= 10 ? 'a' + ((x).bytes[12] >> 4) - 10 : '0' + ((x).bytes[12] >> 4), \
 105                 ((x).bytes[12] & 15) >= 10 ? 'a' + ((x).bytes[12] & 15) - 10 : '0' + ((x).bytes[12] & 15), \
 106                 ((x).bytes[13] >> 4) >= 10 ? 'a' + ((x).bytes[13] >> 4) - 10 : '0' + ((x).bytes[13] >> 4), \
 107                 ((x).bytes[13] & 15) >= 10 ? 'a' + ((x).bytes[13] & 15) - 10 : '0' + ((x).bytes[13] & 15), \
 108                 ((x).bytes[14] >> 4) >= 10 ? 'a' + ((x).bytes[14] >> 4) - 10 : '0' + ((x).bytes[14] >> 4), \
 109                 ((x).bytes[14] & 15) >= 10 ? 'a' + ((x).bytes[14] & 15) - 10 : '0' + ((x).bytes[14] & 15), \
 110                 ((x).bytes[15] >> 4) >= 10 ? 'a' + ((x).bytes[15] >> 4) - 10 : '0' + ((x).bytes[15] >> 4), \
 111                 ((x).bytes[15] & 15) >= 10 ? 'a' + ((x).bytes[15] & 15) - 10 : '0' + ((x).bytes[15] & 15), \
 112                 0 })
 113
 114 #define SD_ID128_MAKE_STR(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
 115         #a #b #c #d #e #f #g #h #i #j #k #l #m #n #o #p
 116
 117 #define SD_ID128_MAKE_UUID_STR(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p) \
 118         #a #b #c #d "-" #e #f "-" #g #h "-" #i #j "-" #k #l #m #n #o #p
 119
 120 _sd_pure_ static __inline__ int sd_id128_equal(sd_id128_t a, sd_id128_t b) {
 121         return a.qwords[0] == b.qwords[0] && a.qwords[1] == b.qwords[1];
 122 }
 123
 124 int sd_id128_string_equal(const char *s, sd_id128_t id);
 125
 126 _sd_pure_ static __inline__ int sd_id128_is_null(sd_id128_t a) {
 127         return a.qwords[0] == 0 && a.qwords[1] == 0;
 128 }
 129
 130 _sd_pure_ static __inline__ int sd_id128_is_allf(sd_id128_t a) {
 131         return a.qwords[0] == UINT64_C(0xFFFFFFFFFFFFFFFF) && a.qwords[1] == UINT64_C(0xFFFFFFFFFFFFFFFF);
 132 }
 133
 134 #define SD_ID128_NULL ((const sd_id128_t) { .qwords = { 0, 0 }})
 135 #define SD_ID128_ALLF ((const sd_id128_t) { .qwords = { UINT64_C(0xFFFFFFFFFFFFFFFF), UINT64_C(0xFFFFFFFFFFFFFFFF) }})
 136
 137 _sd_pure_ static __inline__ int sd_id128_in_setv(sd_id128_t a, va_list ap) {
 138         for (;;) {
 139                 sd_id128_t b = va_arg(ap, sd_id128_t);
 140
 141                 if (sd_id128_is_null(b))
 142                         return 0;
 143
 144                 if (sd_id128_equal(a, b))
 145                         return 1;
 146         }
 147 }
 148
 149 _sd_pure_ static __inline__ int sd_id128_in_set_sentinel(sd_id128_t a, ...) {
 150         va_list ap;
 151         int r;
 152
 153         va_start(ap, a);
 154         r = sd_id128_in_setv(a, ap);
 155         va_end(ap);
 156
 157         return r;
 158 }
 159
 160 #define sd_id128_in_set(a, ...) \
 161         sd_id128_in_set_sentinel(a, ##__VA_ARGS__, SD_ID128_NULL)
 162
 163 _SD_END_DECLARATIONS;
 164
 165 #endif