xref: /freebsd/include/uuid.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2002,2005 Marcel Moolenaar
5  * Copyright (c) 2002 Hiten Mahesh Pandya
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef _UUID_H_
31 #define	_UUID_H_
32 
33 #include <sys/types.h>
34 #include <sys/uuid.h>
35 
36 /*
37  * This implementation mostly conforms to the DCE 1.1 specification.
38  * See Also:
39  *	uuidgen(1), uuidgen(2), uuid(3)
40  */
41 
42 /* Status codes returned by the functions. */
43 #define	uuid_s_ok			0
44 #define	uuid_s_bad_version		1
45 #define	uuid_s_invalid_string_uuid	2
46 #define	uuid_s_no_memory		3
47 
48 __BEGIN_DECLS
49 int32_t	uuid_compare(const uuid_t *, const uuid_t *, uint32_t *);
50 void	uuid_create(uuid_t *, uint32_t *);
51 void	uuid_create_nil(uuid_t *, uint32_t *);
52 int32_t	uuid_equal(const uuid_t *, const uuid_t *, uint32_t *);
53 void	uuid_from_string(const char *, uuid_t *, uint32_t *);
54 uint16_t uuid_hash(const uuid_t *, uint32_t *);
55 int32_t	uuid_is_nil(const uuid_t *, uint32_t *);
56 void	uuid_to_string(const uuid_t *, char **, uint32_t *);
57 void	uuid_enc_le(void *, const uuid_t *);
58 void	uuid_dec_le(const void *, uuid_t *);
59 void	uuid_enc_be(void *, const uuid_t *);
60 void	uuid_dec_be(const void *, uuid_t *);
61 __END_DECLS
62 
63 #endif	/* _UUID_H_ */
64