src/common/compat/uuid.h

   1 /*
   2  * Copyright (C) 2011  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to
   6  * deal in the Software without restriction, including without limitation the
   7  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   8  * sell copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20  * IN THE SOFTWARE.
  21  */
  22
  23 #ifndef LTTNG_UUID_H
  24 #define LTTNG_UUID_H
  25
  26 #include <common/macros.h>
  27 #include <stdbool.h>
  28
  29 /*
  30  * Includes final \0.
  31  */
  32 #define UUID_STR_LEN            37
  33 #define UUID_LEN                16
  34
  35 typedef unsigned char lttng_uuid[UUID_LEN];
  36
  37 #ifdef LTTNG_HAVE_LIBUUID
  38 #include <uuid/uuid.h>
  39
  40 /*
  41  * uuid_out is of len UUID_LEN.
  42  */
  43 static inline
  44 int lttng_uuid_generate(lttng_uuid uuid_out)
  45 {
  46         uuid_generate(uuid_out);
  47         return 0;
  48 }
  49
  50 #elif defined(LTTNG_HAVE_LIBC_UUID)
  51 #include <uuid.h>
  52 #include <stdint.h>
  53
  54 /*
  55  * uuid_out is of len UUID_LEN.
  56  */
  57 static inline
  58 int lttng_uuid_generate(lttng_uuid uuid_out)
  59 {
  60         uint32_t status;
  61
  62         uuid_create((uuid_t *) uuid_out, &status);
  63         if (status == uuid_s_ok)
  64                 return 0;
  65         else
  66                 return -1;
  67 }
  68
  69 #else
  70 #error "LTTng-Tools needs to have a UUID generator configured."
  71 #endif
  72
  73 /*
  74  * Convert a UUID to a human-readable, NULL-terminated, string of the form
  75  * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
  76  *
  77  * Assumes uuid_str is at least UUID_STR_LEN byte long.
  78  */
  79 LTTNG_HIDDEN
  80 void lttng_uuid_to_str(const lttng_uuid uuid, char *uuid_str);
  81
  82 LTTNG_HIDDEN
  83 bool lttng_uuid_is_equal(const lttng_uuid a, const lttng_uuid b);
  84
  85 LTTNG_HIDDEN
  86 bool lttng_uuid_is_nil(const lttng_uuid uuid);
  87
  88 LTTNG_HIDDEN
  89 void lttng_uuid_copy(lttng_uuid dst, const lttng_uuid src);
  90
  91 #endif /* LTTNG_UUID_H */