xref: /freebsd/sys/sys/caprights.h (revision c697fb7f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2013 FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Pawel Jakub Dawidek under sponsorship from
8  * the FreeBSD Foundation.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef _SYS_CAPRIGHTS_H_
35 #define	_SYS_CAPRIGHTS_H_
36 
37 /*
38  * The top two bits in the first element of the cr_rights[] array contain
39  * total number of elements in the array - 2. This means if those two bits are
40  * equal to 0, we have 2 array elements.
41  * The top two bits in all remaining array elements should be 0.
42  * The next five bits contain array index. Only one bit is used and bit position
43  * in this five-bits range defines array index. This means there can be at most
44  * five array elements.
45  */
46 #define	CAP_RIGHTS_VERSION_00	0
47 /*
48 #define	CAP_RIGHTS_VERSION_01	1
49 #define	CAP_RIGHTS_VERSION_02	2
50 #define	CAP_RIGHTS_VERSION_03	3
51 */
52 #define	CAP_RIGHTS_VERSION	CAP_RIGHTS_VERSION_00
53 
54 struct cap_rights {
55 	uint64_t	cr_rights[CAP_RIGHTS_VERSION + 2];
56 };
57 
58 #ifndef	_CAP_RIGHTS_T_DECLARED
59 #define	_CAP_RIGHTS_T_DECLARED
60 typedef	struct cap_rights	cap_rights_t;
61 #endif
62 
63 #endif /* !_SYS_CAPRIGHTS_H_ */
64