include/path.h

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