include/path.h

   1 /*
   2  * No copyright is claimed.  This code is in the public domain; do with
   3  * it what you wish.
   4  */
   5 #ifndef UTIL_LINUX_PATH_H
   6 #define UTIL_LINUX_PATH_H
   7
   8 #include <stdio.h>
   9 #include <stdint.h>
  10 #include <sys/stat.h>
  11 #include <sys/types.h>
  12 #include <dirent.h>
  13
  14 #include "c.h"
  15
  16 struct path_cxt {
  17         int     dir_fd;
  18         char    *dir_path;
  19
  20         int     refcount;
  21
  22         char *prefix;
  23         char path_buffer[PATH_MAX];
  24
  25         void    *dialect;
  26         void    (*free_dialect)(struct path_cxt *);
  27         int     (*redirect_on_enoent)(struct path_cxt *, const char *, int *);
  28 };
  29
  30 struct path_cxt *ul_new_path(const char *dir, ...)
  31                         __attribute__ ((__format__ (__printf__, 1, 2)));
  32 void ul_unref_path(struct path_cxt *pc);
  33 void ul_ref_path(struct path_cxt *pc);
  34
  35 void ul_path_init_debug(void);
  36
  37 int ul_path_set_prefix(struct path_cxt *pc, const char *prefix);
  38 const char *ul_path_get_prefix(struct path_cxt *pc);
  39
  40 int ul_path_set_dir(struct path_cxt *pc, const char *dir);
  41 const char *ul_path_get_dir(struct path_cxt *pc);
  42
  43 int ul_path_set_dialect(struct path_cxt *pc, void *data, void free_data(struct path_cxt *));
  44 void *ul_path_get_dialect(struct path_cxt *pc);
  45
  46 int ul_path_set_enoent_redirect(struct path_cxt *pc, int (*func)(struct path_cxt *, const char *, int *));
  47 int ul_path_get_dirfd(struct path_cxt *pc);
  48 void ul_path_close_dirfd(struct path_cxt *pc);
  49 int ul_path_isopen_dirfd(struct path_cxt *pc);
  50 int ul_path_is_accessible(struct path_cxt *pc);
  51
  52 char *ul_path_get_abspath(struct path_cxt *pc, char *buf, size_t bufsz, const char *path, ...)
  53                                 __attribute__ ((__format__ (__printf__, 4, 5)));
  54
  55 int ul_path_stat(struct path_cxt *pc, struct stat *sb, int flags, const char *path);
  56 int ul_path_vstatf(struct path_cxt *pc, struct stat *sb, int flags, const char *path, va_list ap);
  57 int ul_path_statf(struct path_cxt *pc, struct stat *sb, int flags, const char *path, ...);
  58
  59 int ul_path_access(struct path_cxt *pc, int mode, const char *path);
  60 int ul_path_accessf(struct path_cxt *pc, int mode, const char *path, ...)
  61                                 __attribute__ ((__format__ (__printf__, 3, 4)));
  62
  63 int ul_path_open(struct path_cxt *pc, int flags, const char *path);
  64 int ul_path_openf(struct path_cxt *pc, int flags, const char *path, ...)
  65                                 __attribute__ ((__format__ (__printf__, 3, 4)));
  66 int ul_path_vopenf(struct path_cxt *pc, int flags, const char *path, va_list ap)
  67                                 __attribute__ ((__format__ (__printf__, 3, 0)));
  68
  69 FILE *ul_path_fopen(struct path_cxt *pc, const char *mode, const char *path);
  70 FILE *ul_path_fopenf(struct path_cxt *pc, const char *mode, const char *path, ...)
  71                                 __attribute__ ((__format__ (__printf__, 3, 4)));
  72 FILE *ul_path_vfopenf(struct path_cxt *pc, const char *mode, const char *path, va_list ap)
  73                                 __attribute__ ((__format__ (__printf__, 3, 0)));
  74
  75 DIR *ul_path_opendir(struct path_cxt *pc, const char *path);
  76 DIR *ul_path_vopendirf(struct path_cxt *pc, const char *path, va_list ap)
  77                                 __attribute__ ((__format__ (__printf__, 2, 0)));
  78 DIR *ul_path_opendirf(struct path_cxt *pc, const char *path, ...)
  79                                 __attribute__ ((__format__ (__printf__, 2, 3)));
  80
  81 ssize_t ul_path_readlink(struct path_cxt *pc, char *buf, size_t bufsiz, const char *path);
  82 ssize_t ul_path_readlinkf(struct path_cxt *pc, char *buf, size_t bufsiz, const char *path, ...)
  83                                 __attribute__ ((__format__ (__printf__, 4, 5)));
  84
  85 int ul_path_read(struct path_cxt *pc, char *buf, size_t len, const char *path);
  86 int ul_path_vreadf(struct path_cxt *pc, char *buf, size_t len, const char *path, va_list ap)
  87                                 __attribute__ ((__format__ (__printf__, 4, 0)));
  88 int ul_path_readf(struct path_cxt *pc, char *buf, size_t len, const char *path, ...)
  89                                 __attribute__ ((__format__ (__printf__, 4, 5)));
  90
  91 int ul_path_read_string(struct path_cxt *pc, char **str, const char *path);
  92 int ul_path_readf_string(struct path_cxt *pc, char **str, const char *path, ...)
  93                                 __attribute__ ((__format__ (__printf__, 3, 4)));
  94
  95 int ul_path_read_buffer(struct path_cxt *pc, char *buf, size_t bufsz, const char *path);
  96 int ul_path_readf_buffer(struct path_cxt *pc, char *buf, size_t bufsz, const char *path, ...)
  97                                 __attribute__ ((__format__ (__printf__, 4, 5)));
  98 int ul_path_vreadf_buffer(struct path_cxt *pc, char *buf, size_t bufsz, const char *path, va_list ap)
  99                                 __attribute__ ((__format__ (__printf__, 4, 0)));
 100
 101 int ul_path_scanf(struct path_cxt *pc, const char *path, const char *fmt, ...)
 102                                 __attribute__ ((__format__ (__scanf__, 3, 4)));
 103 int ul_path_scanff(struct path_cxt *pc, const char *path, va_list ap, const char *fmt, ...)
 104                                 __attribute__ ((__format__ (__printf__, 2, 0)))
 105                                 __attribute__ ((__format__ (__scanf__, 4, 5)));
 106
 107 int ul_path_read_majmin(struct path_cxt *pc, dev_t *res, const char *path);
 108 int ul_path_readf_majmin(struct path_cxt *pc, dev_t *res, const char *path, ...)
 109                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 110
 111 int ul_path_read_u32(struct path_cxt *pc, uint32_t *res, const char *path);
 112 int ul_path_readf_u32(struct path_cxt *pc, uint32_t *res, const char *path, ...)
 113                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 114
 115 int ul_path_read_s32(struct path_cxt *pc, int32_t *res, const char *path);
 116 int ul_path_readf_s32(struct path_cxt *pc, int32_t *res, const char *path, ...)
 117                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 118
 119 int ul_path_read_u64(struct path_cxt *pc, uint64_t *res, const char *path);
 120 int ul_path_readf_u64(struct path_cxt *pc, uint64_t *res, const char *path, ...)
 121                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 122
 123 int ul_path_read_s64(struct path_cxt *pc, int64_t *res, const char *path);
 124 int ul_path_readf_s64(struct path_cxt *pc, int64_t *res, const char *path, ...)
 125                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 126
 127 int ul_path_write_string(struct path_cxt *pc, const char *str, const char *path);
 128 int ul_path_writef_string(struct path_cxt *pc, const char *str, const char *path, ...)
 129                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 130
 131 int ul_path_write_s64(struct path_cxt *pc, int64_t num, const char *path);
 132 int ul_path_write_u64(struct path_cxt *pc, uint64_t num, const char *path);
 133 int ul_path_writef_u64(struct path_cxt *pc, uint64_t num, const char *path, ...)
 134                                 __attribute__ ((__format__ (__printf__, 3, 4)));
 135
 136 int ul_path_count_dirents(struct path_cxt *pc, const char *path);
 137 int ul_path_countf_dirents(struct path_cxt *pc, const char *path, ...)
 138                                 __attribute__ ((__format__ (__printf__, 2, 3)));
 139
 140 int ul_path_next_dirent(struct path_cxt *pc, DIR **sub, const char *dirname, struct dirent **d);
 141
 142
 143 #ifdef HAVE_CPU_SET_T
 144 # include "cpuset.h"
 145 int ul_path_readf_cpuset(struct path_cxt *pc, cpu_set_t **set, int maxcpus, const char *path, ...)
 146                                 __attribute__ ((__format__ (__printf__, 4, 5)));
 147
 148 int ul_path_readf_cpulist(struct path_cxt *pc, cpu_set_t **set, int maxcpus, const char *path, ...)
 149                                 __attribute__ ((__format__ (__printf__, 4, 5)));
 150 #endif /* HAVE_CPU_SET_T */
 151 #endif /* UTIL_LINUX_PATH_H */