uuid.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2018 Freie Universit├Ąt Berlin
3 * Copyright (C) 2018 Inria
4 *
5 * This file is subject to the terms and conditions of the GNU Lesser
6 * General Public License v2.1. See the file LICENSE in the top level
7 * directory for more details.
8 */
9
26#ifndef UUID_H
27#define UUID_H
28
29#include <stdbool.h>
30#include <stdint.h>
31#include <stdlib.h>
32#include <string.h>
33#include "byteorder.h"
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#define UUID_NODE_LEN (6U)
41#define UUID_STR_LEN (36U)
47#define UUID_V1 (0x01)
48#define UUID_V2 (0x02)
49#define UUID_V3 (0x03)
50#define UUID_V4 (0x04)
51#define UUID_V5 (0x05)
57#define UUID_VERSION_MASK (0xF000)
58
64typedef struct __attribute__((packed)) {
71 uint8_t clk_seq_low;
72 uint8_t node[UUID_NODE_LEN];
73} uuid_t;
74
83extern const uuid_t uuid_namespace_dns;
84extern const uuid_t uuid_namespace_url;
85extern const uuid_t uuid_namespace_iso;
86extern const uuid_t uuid_namespace_x500;
97void uuid_v3(uuid_t *uuid, const uuid_t *ns, const uint8_t *name, size_t len);
98
104void uuid_v4(uuid_t *uuid);
105
114void uuid_v5(uuid_t *uuid, const uuid_t *ns, const uint8_t *name, size_t len);
115
123static inline unsigned uuid_version(const uuid_t *uuid)
124{
125 uint16_t time_hi_vers = byteorder_ntohs(uuid->time_hi);
126
127 return (time_hi_vers & 0xF000) >> 12;
128}
129
138static inline bool uuid_equal(const uuid_t *uuid1, const uuid_t *uuid2)
139{
140 return (memcmp(uuid1, uuid2, sizeof(uuid_t)) == 0);
141}
142
149void uuid_to_string(const uuid_t *uuid, char *str);
150
159int uuid_from_string(uuid_t *uuid, const char *str);
160
161#ifdef __cplusplus
162}
163#endif
164#endif /* UUID_H */
Functions to work with different byte orders.
static uint16_t byteorder_ntohs(network_uint16_t v)
Convert from network byte order to host byte order, 16 bit.
Definition: byteorder.h:534
void uuid_v3(uuid_t *uuid, const uuid_t *ns, const uint8_t *name, size_t len)
Generate a version 3(md5 based) UUID from a namespace and a byte array.
#define UUID_NODE_LEN
Size of the node identifier in bytes.
Definition: uuid.h:39
const uuid_t uuid_namespace_url
URL namespace UUID.
static unsigned uuid_version(const uuid_t *uuid)
Retrieve the type number of a UUID.
Definition: uuid.h:123
void uuid_to_string(const uuid_t *uuid, char *str)
Generate an UUID string from an UUID structure.
const uuid_t uuid_namespace_iso
ISO OID namespace UUID.
static bool uuid_equal(const uuid_t *uuid1, const uuid_t *uuid2)
Compare two UUID's.
Definition: uuid.h:138
const uuid_t uuid_namespace_dns
DNS namespace UUID.
int uuid_from_string(uuid_t *uuid, const char *str)
Populate an UUID structure from an UUID string.
const uuid_t uuid_namespace_x500
X.500 DN namespace UUID.
void uuid_v5(uuid_t *uuid, const uuid_t *ns, const uint8_t *name, size_t len)
Generate a version 5(sha1 based) UUID from a namespace and a byte array.
void uuid_v4(uuid_t *uuid)
Generate a version 4(Full random) UUID.
UUID layout.
Definition: uuid.h:64
network_uint16_t time_mid
The middle field of the timestamp
Definition: uuid.h:66
network_uint16_t time_hi
The high field of the timestamp multiplexed with the version number.
Definition: uuid.h:67
uint8_t clk_seq_hi_res
The high field of the clock sequence Multiplexed with the variant
Definition: uuid.h:69
network_uint32_t time_low
The low field of the timestamp
Definition: uuid.h:65
uint8_t clk_seq_low
The low field of the clock sequence
Definition: uuid.h:71
A 16 bit integer in big endian aka network byte order.
Definition: byteorder.h:73
A 32 bit integer in big endian aka network byte order.
Definition: byteorder.h:83