1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2002 Marcel Moolenaar 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 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 ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _SYS_UUID_H_ 32 #define _SYS_UUID_H_ 33 34 #include <sys/types.h> 35 36 /* Length of a node address (an IEEE 802 address). */ 37 #define _UUID_NODE_LEN 6 38 39 /* 40 * See also: 41 * http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt 42 * http://www.opengroup.org/onlinepubs/009629399/apdxa.htm 43 * 44 * A DCE 1.1 compatible source representation of UUIDs. 45 */ 46 struct uuid { 47 uint32_t time_low; 48 uint16_t time_mid; 49 uint16_t time_hi_and_version; 50 uint8_t clock_seq_hi_and_reserved; 51 uint8_t clock_seq_low; 52 uint8_t node[_UUID_NODE_LEN]; 53 }; 54 55 #ifdef _KERNEL 56 57 #define UUID_NODE_LEN _UUID_NODE_LEN 58 59 struct sbuf; 60 61 struct uuid *kern_uuidgen(struct uuid *, size_t); 62 63 int uuid_ether_add(const uint8_t *); 64 int uuid_ether_del(const uint8_t *); 65 66 int snprintf_uuid(char *, size_t, struct uuid *); 67 int printf_uuid(struct uuid *); 68 int sbuf_printf_uuid(struct sbuf *, struct uuid *); 69 70 /* 71 * validate_uuid will, with no flags passed, validate only the format of the 72 * passed in UUID. Flags below are available to give it part of or all of the 73 * functionality that parse_uuid has traditionally had: acknowledging an empty 74 * string as valid, and checking the semantics of the UUID as well. 75 */ 76 int validate_uuid(const char *, size_t, struct uuid *, int); 77 int parse_uuid(const char *, struct uuid *); 78 79 /* Flags to validate_uuid(). */ 80 #define VUUIDF_EMPTYOK 0x0001 81 #define VUUIDF_CHECKSEMANTICS 0x0002 82 83 int uuidcmp(const struct uuid *, const struct uuid *); 84 85 void be_uuid_dec(void const *buf, struct uuid *uuid); 86 void be_uuid_enc(void *buf, struct uuid const *uuid); 87 void le_uuid_dec(void const *buf, struct uuid *uuid); 88 void le_uuid_enc(void *buf, struct uuid const *uuid); 89 90 #else /* _KERNEL */ 91 92 /* XXX namespace pollution? */ 93 typedef struct uuid uuid_t; 94 95 __BEGIN_DECLS 96 int uuidgen(struct uuid *, int); 97 __END_DECLS 98 99 #endif /* _KERNEL */ 100 101 #endif /* _SYS_UUID_H_ */ 102