1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 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 29 #ifndef _SYS_UUID_H_ 30 #define _SYS_UUID_H_ 31 32 #include <sys/types.h> 33 34 /* Length of a node address (an IEEE 802 address). */ 35 #define _UUID_NODE_LEN 6 36 37 /* 38 * The kernel imposes a limit on the number of UUIDs generated per call 39 * to avoid unbounded allocations. 40 */ 41 #define UUIDGEN_BATCH_MAX 2048 42 43 /* 44 * See also: 45 * http://www.opengroup.org/dce/info/draft-leach-uuids-guids-01.txt 46 * http://www.opengroup.org/onlinepubs/009629399/apdxa.htm 47 * 48 * A DCE 1.1 compatible source representation of UUIDs. 49 */ 50 struct uuid { 51 uint32_t time_low; 52 uint16_t time_mid; 53 uint16_t time_hi_and_version; 54 uint8_t clock_seq_hi_and_reserved; 55 uint8_t clock_seq_low; 56 uint8_t node[_UUID_NODE_LEN]; 57 }; 58 59 #ifdef _KERNEL 60 61 #define UUID_NODE_LEN _UUID_NODE_LEN 62 63 struct sbuf; 64 65 struct uuid *kern_uuidgen(struct uuid *, size_t); 66 67 int uuid_ether_add(const uint8_t *); 68 int uuid_ether_del(const uint8_t *); 69 70 int snprintf_uuid(char *, size_t, struct uuid *); 71 int printf_uuid(struct uuid *); 72 int sbuf_printf_uuid(struct sbuf *, struct uuid *); 73 74 /* 75 * validate_uuid will, with no flags passed, validate only the format of the 76 * passed in UUID. Flags below are available to give it part of or all of the 77 * functionality that parse_uuid has traditionally had: acknowledging an empty 78 * string as valid, and checking the semantics of the UUID as well. 79 */ 80 int validate_uuid(const char *, size_t, struct uuid *, int); 81 int parse_uuid(const char *, struct uuid *); 82 83 /* Flags to validate_uuid(). */ 84 #define VUUIDF_EMPTYOK 0x0001 85 #define VUUIDF_CHECKSEMANTICS 0x0002 86 87 int uuidcmp(const struct uuid *, const struct uuid *); 88 89 void be_uuid_dec(void const *buf, struct uuid *uuid); 90 void be_uuid_enc(void *buf, struct uuid const *uuid); 91 void le_uuid_dec(void const *buf, struct uuid *uuid); 92 void le_uuid_enc(void *buf, struct uuid const *uuid); 93 94 #else /* _KERNEL */ 95 96 /* XXX namespace pollution? */ 97 typedef struct uuid uuid_t; 98 99 __BEGIN_DECLS 100 int uuidgen(struct uuid *, int); 101 __END_DECLS 102 103 #endif /* _KERNEL */ 104 105 #endif /* _SYS_UUID_H_ */ 106