xref: /freebsd/lib/libc/posix1e/acl_init.3 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\"-
2.\" Copyright (c) 2000 Robert N. M. Watson
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\"       $FreeBSD$
27.\"
28.Dd January 28, 2000
29.Dt ACL_INIT 3
30.Os FreeBSD 4.0
31.Sh NAME
32.Nm acl_init
33.Nd Initialize ACL working storage
34.Sh SYNOPSIS
35.Fd #include <sys/types.h>
36.Fd #include <sys/acl.h>
37.Ft acl_t
38.Fn acl_init "int count"
39.Sh DESCRIPTION
40The
41.Fn acl_init
42function allocates and initializes the working storage for an ACL of at
43least
44.Va count
45ACL entries.  A pointer to the working storage is returned.  The working
46storage allocated to contain the ACL is freed by a call to
47.Xr acl_free 3 .
48When the area is first allocated, it shall contain an an ACL that contains
49no ACL entries.
50
51This function may cause memory to be allocated.  The caller should free any
52releasable memory, when the new ACL is no longer required, by calling
53.Xr acl_free 3
54with the
55.Va (void*)acl_t
56as an argument.
57.Sh IMPLEMENTATION NOTES
58FreeBSD's support for POSIX.1e interfaces and features is still under
59development at this time.
60.Sh RETURN VALUES
61Upon successful completion, this function shall return a pointer to the
62working storage.  Otherwise, a value of
63.Va (acl_t)NULL
64shall be returned, and
65.Va errno
66shall be set to indicate the error.
67.Sh ERRORS
68If any of the following conditions occur, the
69.Fn acl_init
70function shall return a value of
71.Va (acl_t)NULL
72and set
73.Va errno
74to the corresponding value:
75.Bl -tag -width Er
76.It Bq Er EINVAL
77The value of count is less than zero.
78.It Bq Er ENOMEM
79The
80.Va acl_t
81to be returned requires more memory than is allowed by the hardware or
82system-imposed memory management constraints.
83.El
84.Sh SEE ALSO
85.Xr acl 3 ,
86.Xr acl_free 3 ,
87.Xr posix1e 3
88.Sh STANDARDS
89POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
90of the draft continues on the cross-platform POSIX.1e implementation
91mailing list.  To join this list, see the
92.Fx
93POSIX.1e implementation
94page for more information.
95.Sh HISTORY
96POSIX.1e support was introduced in
97.Fx 4.0 ,
98and development continues.
99.Sh AUTHORS
100.An Robert N M Watson
101.Sh BUGS
102These features are not yet fully implemented.  In particular, the shipped
103version of UFS/FFS does not support storage of additional security labels,
104and so is unable to (easily) provide support for most of these features.
105