xref: /titanic_41/usr/src/lib/libcmdutils/libcmdutils.h (revision 6c9e17859f07daef4c2a848835bd029c9798c9e3)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 /*
26  * Copyright (c) 2013 RackTop Systems.
27  */
28 /*
29  * Copyright 2014 Joyent, Inc.
30  */
31 
32 /*
33  * Declarations for the functions in libcmdutils.
34  */
35 
36 #ifndef	_LIBCMDUTILS_H
37 #define	_LIBCMDUTILS_H
38 
39 /*
40  * This is a private header file.  Applications should not directly include
41  * this file.
42  */
43 
44 #include <stdio.h>
45 #include <unistd.h>
46 #include <stdlib.h>
47 #include <errno.h>
48 #include <fcntl.h>
49 #include <limits.h>
50 #include <libintl.h>
51 #include <string.h>
52 #include <dirent.h>
53 #include <attr.h>
54 #include <sys/avl.h>
55 #include <sys/types.h>
56 #include <sys/stat.h>
57 #include <sys/mman.h>
58 #include <libnvpair.h>
59 
60 #ifdef	__cplusplus
61 extern "C" {
62 #endif
63 
64 /* extended system attribute support */
65 #define	_NOT_SATTR	0
66 #define	_RO_SATTR	1
67 #define	_RW_SATTR	2
68 
69 #define	MAXMAPSIZE	(1024*1024*8)	/* map at most 8MB */
70 #define	SMALLFILESIZE	(32*1024)	/* don't use mmap on little file */
71 
72 /* avltree */
73 #define	OFFSETOF(s, m)	((size_t)(&(((s *)0)->m)))
74 
75 /* Type used for a node containing a device id and inode number */
76 typedef struct tree_node {
77 	dev_t		node_dev;
78 	ino_t		node_ino;
79 	avl_node_t	avl_link;
80 } tree_node_t;
81 
82 
83 		/* extended system attribute support */
84 
85 /* Determine if a file is the name of an extended system attribute file */
86 extern int sysattr_type(char *);
87 
88 /* Determine if the underlying file system supports system attributes */
89 extern int sysattr_support(char *, int);
90 
91 /* Copies the content of the source file to the target file */
92 extern int writefile(int, int, char *, char *, char *, char *,
93 struct stat *, struct stat *);
94 
95 /* Gets file descriptors of the source and target attribute files */
96 extern int get_attrdirs(int, int, char *, int *, int *);
97 
98 /* Move extended attribute and extended system attribute */
99 extern int mv_xattrs(char *, char *, char *, int, int);
100 
101 /* Returns non default extended system attribute list */
102 extern nvlist_t *sysattr_list(char *, int, char *);
103 
104 
105 
106 		/* avltree */
107 
108 /*
109  * Used to compare two nodes.  We are attempting to match the 1st
110  * argument (node) against the 2nd argument (a node which
111  * is already in the search tree).
112  */
113 
114 extern int tnode_compare(const void *, const void *);
115 
116 /*
117  * Used to add a single node (containing the input device id and
118  * inode number) to the specified search tree.  The calling
119  * application must set the tree pointer to NULL before calling
120  * add_tnode() for the first time.
121  */
122 extern int add_tnode(avl_tree_t **, dev_t, ino_t);
123 
124 /*
125  * Used to destroy a whole tree (all nodes) without rebalancing.
126  * The calling application is responsible for setting the tree
127  * pointer to NULL upon return.
128  */
129 extern void destroy_tree(avl_tree_t *);
130 
131 
132 
133 		/* user/group id helpers */
134 
135 /*
136  * Used to get the next available user id in given range.
137  */
138 extern int findnextuid(uid_t, uid_t, uid_t *);
139 
140 /*
141  * Used to get the next available group id in given range.
142  */
143 extern int findnextgid(gid_t, gid_t, gid_t *);
144 
145 
146 
147 		/* dynamic string utilities */
148 
149 typedef struct custr custr_t;
150 
151 /*
152  * Allocate and free a "custr_t" dynamic string object.  Returns 0 on success
153  * and -1 otherwise.
154  */
155 extern int custr_alloc(custr_t **);
156 extern void custr_free(custr_t *);
157 
158 /*
159  * Append a single character, or a NUL-terminated string of characters, to a
160  * dynamic string.  Returns 0 on success and -1 otherwise.  The dynamic string
161  * will be unmodified if the function returns -1.
162  */
163 extern int custr_appendc(custr_t *, char);
164 extern int custr_append(custr_t *, const char *);
165 
166 /*
167  * Determine the length in bytes, not including the NUL terminator, of the
168  * dynamic string.
169  */
170 extern size_t custr_len(custr_t *);
171 
172 /*
173  * Clear the contents of a dynamic string.  Does not free the underlying
174  * memory.
175  */
176 extern void custr_reset(custr_t *);
177 
178 /*
179  * Retrieve a const pointer to a NUL-terminated string version of the contents
180  * of the dynamic string.  Storage for this string should not be freed, and
181  * the pointer will be invalidated by any mutations to the dynamic string.
182  */
183 extern const char *custr_cstr(custr_t *str);
184 
185 #ifdef	__cplusplus
186 }
187 #endif
188 
189 #endif /* _LIBCMDUTILS_H */
190