usr/src/lib/libcmdutils/libcmdutils.h

   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 2018 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 <stdarg.h>
  48 #include <errno.h>
  49 #include <fcntl.h>
  50 #include <limits.h>
  51 #include <libintl.h>
  52 #include <string.h>
  53 #include <dirent.h>
  54 #include <attr.h>
  55 #include <sys/avl.h>
  56 #include <sys/types.h>
  57 #include <sys/stat.h>
  58 #include <sys/mman.h>
  59 #include <libnvpair.h>
  60
  61 #ifdef  __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 /* extended system attribute support */
  66 #define _NOT_SATTR      0
  67 #define _RO_SATTR       1
  68 #define _RW_SATTR       2
  69
  70 #define MAXMAPSIZE      (1024*1024*8)   /* map at most 8MB */
  71 #define SMALLFILESIZE   (32*1024)       /* don't use mmap on little file */
  72
  73 /* Type used for a node containing a device id and inode number */
  74
  75 typedef struct tree_node {
  76         dev_t           node_dev;
  77         ino_t           node_ino;
  78         avl_node_t      avl_link;
  79 } tree_node_t;
  80
  81                 /* extended system attribute support */
  82
  83 /* Determine if a file is the name of an extended system attribute file */
  84 extern int sysattr_type(char *);
  85
  86 /* Determine if the underlying file system supports system attributes */
  87 extern int sysattr_support(char *, int);
  88
  89 /* Copies the content of the source file to the target file */
  90 extern int writefile(int, int, char *, char *, char *, char *,
  91         struct stat *, struct stat *);
  92
  93 /* Gets file descriptors of the source and target attribute files */
  94 extern int get_attrdirs(int, int, char *, int *, int *);
  95
  96 /* Move extended attribute and extended system attribute */
  97 extern int mv_xattrs(char *, char *, char *, int, int);
  98
  99 /* Returns non default extended system attribute list */
 100 extern nvlist_t *sysattr_list(char *, int, char *);
 101
 102
 103
 104                 /* avltree */
 105
 106 /*
 107  * Used to compare two nodes.  We are attempting to match the 1st
 108  * argument (node) against the 2nd argument (a node which
 109  * is already in the search tree).
 110  */
 111
 112 extern int tnode_compare(const void *, const void *);
 113
 114 /*
 115  * Used to add a single node (containing the input device id and
 116  * inode number) to the specified search tree.  The calling
 117  * application must set the tree pointer to NULL before calling
 118  * add_tnode() for the first time.
 119  */
 120 extern int add_tnode(avl_tree_t **, dev_t, ino_t);
 121
 122 /*
 123  * Used to destroy a whole tree (all nodes) without rebalancing.
 124  * The calling application is responsible for setting the tree
 125  * pointer to NULL upon return.
 126  */
 127 extern void destroy_tree(avl_tree_t *);
 128
 129
 130
 131                 /* user/group id helpers */
 132
 133 /*
 134  * Used to get the next available user id in given range.
 135  */
 136 extern int findnextuid(uid_t, uid_t, uid_t *);
 137
 138 /*
 139  * Used to get the next available group id in given range.
 140  */
 141 extern int findnextgid(gid_t, gid_t, gid_t *);
 142
 143 #define NN_DIVISOR_1000         (1U << 0)
 144
 145 /* Minimum size for the output of nicenum, including NULL */
 146 #define NN_NUMBUF_SZ            (6)
 147
 148 void nicenum(uint64_t, char *, size_t);
 149 void nicenum_scale(uint64_t, size_t, char *, size_t, uint32_t);
 150
 151 #ifdef  __cplusplus
 152 }
 153 #endif
 154
 155 #endif /* _LIBCMDUTILS_H */