xref: /illumos-gate/usr/src/uts/common/sys/uuid.h (revision fafb665d)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
57c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
67c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
77c478bd9Sstevel@tonic-gate  * with the License.
87c478bd9Sstevel@tonic-gate  *
97c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate  * and limitations under the License.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate  *
207c478bd9Sstevel@tonic-gate  * CDDL HEADER END
217c478bd9Sstevel@tonic-gate  */
227c478bd9Sstevel@tonic-gate /*
23*6be356c5Sgz  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate 
277c478bd9Sstevel@tonic-gate #ifndef	_SYS_UUID_H
287c478bd9Sstevel@tonic-gate #define	_SYS_UUID_H
297c478bd9Sstevel@tonic-gate 
307c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
317c478bd9Sstevel@tonic-gate extern "C" {
327c478bd9Sstevel@tonic-gate #endif
337c478bd9Sstevel@tonic-gate 
347c478bd9Sstevel@tonic-gate /*
357c478bd9Sstevel@tonic-gate  * The copyright in this file is taken from the original Leach
367c478bd9Sstevel@tonic-gate  * & Salz UUID specification, from which this implementation
377c478bd9Sstevel@tonic-gate  * is derived.
387c478bd9Sstevel@tonic-gate  */
397c478bd9Sstevel@tonic-gate 
407c478bd9Sstevel@tonic-gate /*
417c478bd9Sstevel@tonic-gate  * Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
427c478bd9Sstevel@tonic-gate  * Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
437c478bd9Sstevel@tonic-gate  * Digital Equipment Corporation, Maynard, Mass.  Copyright (c) 1998
447c478bd9Sstevel@tonic-gate  * Microsoft.  To anyone who acknowledges that this file is provided
457c478bd9Sstevel@tonic-gate  * "AS IS" without any express or implied warranty: permission to use,
467c478bd9Sstevel@tonic-gate  * copy, modify, and distribute this file for any purpose is hereby
477c478bd9Sstevel@tonic-gate  * granted without fee, provided that the above copyright notices and
487c478bd9Sstevel@tonic-gate  * this notice appears in all source code copies, and that none of the
497c478bd9Sstevel@tonic-gate  * names of Open Software Foundation, Inc., Hewlett-Packard Company,
507c478bd9Sstevel@tonic-gate  * or Digital Equipment Corporation be used in advertising or
517c478bd9Sstevel@tonic-gate  * publicity pertaining to distribution of the software without
527c478bd9Sstevel@tonic-gate  * specific, written prior permission.  Neither Open Software
537c478bd9Sstevel@tonic-gate  * Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital
547c478bd9Sstevel@tonic-gate  * Equipment Corporation makes any representations about the
557c478bd9Sstevel@tonic-gate  * suitability of this software for any purpose.
567c478bd9Sstevel@tonic-gate  */
577c478bd9Sstevel@tonic-gate 
587c478bd9Sstevel@tonic-gate #include <sys/types.h>
597c478bd9Sstevel@tonic-gate #include <sys/byteorder.h>
607c478bd9Sstevel@tonic-gate 
617c478bd9Sstevel@tonic-gate typedef struct {
627c478bd9Sstevel@tonic-gate 	uint8_t		nodeID[6];
637c478bd9Sstevel@tonic-gate } uuid_node_t;
647c478bd9Sstevel@tonic-gate 
657c478bd9Sstevel@tonic-gate /*
667c478bd9Sstevel@tonic-gate  * The uuid type used throughout when referencing uuids themselves
677c478bd9Sstevel@tonic-gate  */
687c478bd9Sstevel@tonic-gate struct uuid {
697c478bd9Sstevel@tonic-gate 	uint32_t	time_low;
707c478bd9Sstevel@tonic-gate 	uint16_t	time_mid;
717c478bd9Sstevel@tonic-gate 	uint16_t	time_hi_and_version;
727c478bd9Sstevel@tonic-gate 	uint8_t		clock_seq_hi_and_reserved;
737c478bd9Sstevel@tonic-gate 	uint8_t		clock_seq_low;
747c478bd9Sstevel@tonic-gate 	uint8_t		node_addr[6];
757c478bd9Sstevel@tonic-gate };
767c478bd9Sstevel@tonic-gate 
777c478bd9Sstevel@tonic-gate #define	UUID_LEN	16
787c478bd9Sstevel@tonic-gate 
79*6be356c5Sgz #define	UUID_PRINTABLE_STRING_LENGTH 37
80*6be356c5Sgz 
817c478bd9Sstevel@tonic-gate typedef uchar_t		uuid_t[UUID_LEN];
827c478bd9Sstevel@tonic-gate 
837c478bd9Sstevel@tonic-gate /*
847c478bd9Sstevel@tonic-gate  * Convert a uuid to/from little-endian format
857c478bd9Sstevel@tonic-gate  */
867c478bd9Sstevel@tonic-gate #define	UUID_LE_CONVERT(dest, src)					\
877c478bd9Sstevel@tonic-gate {									\
887c478bd9Sstevel@tonic-gate 	(dest) = (src);							\
897c478bd9Sstevel@tonic-gate 	(dest).time_low = LE_32((dest).time_low);			\
907c478bd9Sstevel@tonic-gate 	(dest).time_mid = LE_16((dest).time_mid);			\
917c478bd9Sstevel@tonic-gate 	(dest).time_hi_and_version = LE_16((dest).time_hi_and_version);	\
927c478bd9Sstevel@tonic-gate }
937c478bd9Sstevel@tonic-gate 
947c478bd9Sstevel@tonic-gate #ifdef __cplusplus
957c478bd9Sstevel@tonic-gate }
967c478bd9Sstevel@tonic-gate #endif
977c478bd9Sstevel@tonic-gate 
987c478bd9Sstevel@tonic-gate #endif /* _SYS_UUID_H */
99