[lttng-tools.git] / src / common / compat / uuid.h

/*
 * Copyright (C) 2011  Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef LTTNG_UUID_H
#define LTTNG_UUID_H

#include <common/macros.h>

/*
 * Includes final \0.
 */
#define UUID_STR_LEN		37
#define UUID_LEN		16

typedef unsigned char lttng_uuid[UUID_LEN];

#ifdef LTTNG_HAVE_LIBUUID
#include <uuid/uuid.h>

/*
 * uuid_out is of len UUID_LEN.
 */
static inline
int lttng_uuid_generate(lttng_uuid uuid_out)
{
	uuid_generate(uuid_out);
	return 0;
}

#elif defined(LTTNG_HAVE_LIBC_UUID)
#include <uuid.h>
#include <stdint.h>

/*
 * uuid_out is of len UUID_LEN.
 */
static inline
int lttng_uuid_generate(lttng_uuid uuid_out)
{
	uint32_t status;

	uuid_create((uuid_t *) uuid_out, &status);
	if (status == uuid_s_ok)
		return 0;
	else
		return -1;
}

#else
#error "LTTng-Tools needs to have a UUID generator configured."
#endif

/*
 * Convert a UUID to a human-readable, NULL-terminated, string of the form
 * xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
 *
 * Assumes uuid_str is at least UUID_STR_LEN byte long.
 */
LTTNG_HIDDEN
void lttng_uuid_to_str(const lttng_uuid uuid, char *uuid_str);

#endif /* LTTNG_UUID_H */
Commit	Line	Data
ffe60014 DG	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
bef4c7a1 JG	26	#include <common/macros.h>
bef4c7a1 JG	27
ffe60014 DG	28	/*
	29	* Includes final \0.
	30	*/
	31	#define UUID_STR_LEN 37
d0b96690	32	#define UUID_LEN 16
ffe60014	33
52a0e931 JG	34	typedef unsigned char lttng_uuid[UUID_LEN];
52a0e931 JG	35
ffe60014 DG	36	#ifdef LTTNG_HAVE_LIBUUID
	37	#include <uuid/uuid.h>
	38
d0b96690 DG	39	/*
	40	* uuid_out is of len UUID_LEN.
	41	*/
ffe60014	42	static inline
52a0e931	43	int lttng_uuid_generate(lttng_uuid uuid_out)
ffe60014 DG	44	{
	45	uuid_generate(uuid_out);
	46	return 0;
	47	}
	48
	49	#elif defined(LTTNG_HAVE_LIBC_UUID)
	50	#include <uuid.h>
	51	#include <stdint.h>
	52
d0b96690 DG	53	/*
	54	* uuid_out is of len UUID_LEN.
	55	*/
ffe60014	56	static inline
52a0e931	57	int lttng_uuid_generate(lttng_uuid uuid_out)
ffe60014 DG	58	{
	59	uint32_t status;
	60
	61	uuid_create((uuid_t *) uuid_out, &status);
	62	if (status == uuid_s_ok)
	63	return 0;
	64	else
	65	return -1;
	66	}
	67
	68	#else
	69	#error "LTTng-Tools needs to have a UUID generator configured."
	70	#endif
	71
bef4c7a1 JG	72	/*
	73	* Convert a UUID to a human-readable, NULL-terminated, string of the form
	74	* xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
	75	*
	76	* Assumes uuid_str is at least UUID_STR_LEN byte long.
	77	*/
	78	LTTNG_HIDDEN
52a0e931	79	void lttng_uuid_to_str(const lttng_uuid uuid, char *uuid_str);
bef4c7a1	80
ffe60014	81	#endif /* LTTNG_UUID_H */