nginx/src/os/unix/ngx_files.h

   1
   2 /*
   3  * Copyright (C) Igor Sysoev
   4  */
   5
   6
   7 #ifndef _NGX_FILES_H_INCLUDED_
   8 #define _NGX_FILES_H_INCLUDED_
   9
  10
  11 #include <ngx_config.h>
  12 #include <ngx_core.h>
  13
  14
  15 typedef int                      ngx_fd_t;
  16 typedef struct stat              ngx_file_info_t;
  17 typedef ino_t                    ngx_file_uniq_t;
  18
  19
  20 typedef struct {
  21     DIR                        *dir;
  22     struct dirent              *de;
  23     struct stat                 info;
  24
  25     unsigned                    type:8;
  26     unsigned                    valid_info:1;
  27     unsigned                    valid_type:1;
  28 } ngx_dir_t;
  29
  30
  31 typedef struct {
  32     size_t                       n;
  33     glob_t                       pglob;
  34     u_char                      *pattern;
  35     ngx_log_t                   *log;
  36     ngx_uint_t                   test;
  37 } ngx_glob_t;
  38
  39
  40 #define NGX_INVALID_FILE         -1
  41 #define NGX_FILE_ERROR           -1
  42
  43
  44
  45 #ifdef __CYGWIN__
  46
  47 #define NGX_HAVE_CASELESS_FILESYSTEM  1
  48
  49 #define ngx_open_file(name, mode, create, access)                            \
  50     open((const char *) name, mode|create|O_BINARY, access)
  51
  52 #else
  53
  54 #define ngx_open_file(name, mode, create, access)                            \
  55     open((const char *) name, mode|create, access)
  56
  57 #endif
  58
  59 #define ngx_open_file_n          "open()"
  60
  61 #define NGX_FILE_RDONLY          O_RDONLY
  62 #define NGX_FILE_WRONLY          O_WRONLY
  63 #define NGX_FILE_RDWR            O_RDWR
  64 #define NGX_FILE_CREATE_OR_OPEN  O_CREAT
  65 #define NGX_FILE_OPEN            0
  66 #define NGX_FILE_TRUNCATE        O_TRUNC
  67 #define NGX_FILE_APPEND          O_APPEND
  68
  69 #define NGX_FILE_DEFAULT_ACCESS  0644
  70
  71
  72 #define ngx_close_file           close
  73 #define ngx_close_file_n         "close()"
  74
  75
  76 #define ngx_delete_file(name)    unlink((const char *) name)
  77 #define ngx_delete_file_n        "unlink()"
  78
  79
  80 ngx_fd_t ngx_open_tempfile(u_char *name, ngx_uint_t persistent,
  81     ngx_uint_t access);
  82 #define ngx_open_tempfile_n      "open()"
  83
  84
  85 ssize_t ngx_read_file(ngx_file_t *file, u_char *buf, size_t size, off_t offset);
  86 #if (NGX_HAVE_PREAD)
  87 #define ngx_read_file_n          "pread()"
  88 #else
  89 #define ngx_read_file_n          "read()"
  90 #endif
  91
  92 ssize_t ngx_write_file(ngx_file_t *file, u_char *buf, size_t size,
  93     off_t offset);
  94
  95 ssize_t ngx_write_chain_to_file(ngx_file_t *file, ngx_chain_t *ce,
  96     off_t offset, ngx_pool_t *pool);
  97
  98
  99 #define ngx_read_fd              read
 100 #define ngx_read_fd_n            "read()"
 101
 102 /*
 103  * we use inlined function instead of simple #define
 104  * because glibc 2.3 sets warn_unused_result attribute for write()
 105  * and in this case gcc 4.3 ignores (void) cast
 106  */
 107 static ngx_inline ssize_t
 108 ngx_write_fd(ngx_fd_t fd, void *buf, size_t n)
 109 {
 110     return write(fd, buf, n);
 111 }
 112
 113 #define ngx_write_fd_n           "write()"
 114
 115 #define ngx_linefeed(p)          *p++ = LF;
 116 #define NGX_LINEFEED_SIZE        1
 117
 118
 119 #define ngx_rename_file(o, n)    rename((const char *) o, (const char *) n)
 120 #define ngx_rename_file_n        "rename()"
 121
 122
 123 #define ngx_change_file_access(n, a) chmod((const char *) n, a)
 124 #define ngx_change_file_access_n "chmod()"
 125
 126
 127 ngx_int_t ngx_set_file_time(u_char *name, ngx_fd_t fd, time_t s);
 128 #define ngx_set_file_time_n      "utimes()"
 129
 130
 131 #define ngx_file_info(file, sb)  stat((const char *) file, sb)
 132 #define ngx_file_info_n          "stat()"
 133
 134 #define ngx_fd_info(fd, sb)      fstat(fd, sb)
 135 #define ngx_fd_info_n            "fstat()"
 136
 137 #define ngx_is_dir(sb)           (S_ISDIR((sb)->st_mode))
 138 #define ngx_is_file(sb)          (S_ISREG((sb)->st_mode))
 139 #define ngx_is_link(sb)          (S_ISLNK((sb)->st_mode))
 140 #define ngx_is_exec(sb)          ((sb)->st_mode & S_IXUSR)
 141 #define ngx_file_access(sb)      ((sb)->st_mode & 0777)
 142 #define ngx_file_size(sb)        (sb)->st_size
 143 #define ngx_file_mtime(sb)       (sb)->st_mtime
 144 #define ngx_file_uniq(sb)        (sb)->st_ino
 145
 146
 147 #if (NGX_HAVE_CASELESS_FILESYSTEM)
 148
 149 #define ngx_filename_cmp(s1, s2, n)  strncasecmp((char *) s1, (char *) s2, n)
 150
 151 #else
 152
 153 #define ngx_filename_cmp         ngx_memcmp
 154
 155 #endif
 156
 157
 158 #define ngx_realpath(p, r)       realpath((char *) p, (char *) r)
 159 #define ngx_realpath_n           "realpath()"
 160 #define ngx_getcwd(buf, size)    (getcwd(buf, size) != NULL)
 161 #define ngx_getcwd_n             "getcwd()"
 162 #define NGX_MAX_PATH             PATH_MAX
 163
 164 #define NGX_DIR_MASK_LEN         0
 165
 166
 167 ngx_int_t ngx_open_dir(ngx_str_t *name, ngx_dir_t *dir);
 168 #define ngx_open_dir_n           "opendir()"
 169
 170
 171 #define ngx_close_dir(d)         closedir((d)->dir)
 172 #define ngx_close_dir_n          "closedir()"
 173
 174
 175 ngx_int_t ngx_read_dir(ngx_dir_t *dir);
 176 #define ngx_read_dir_n           "readdir()"
 177
 178
 179 #define ngx_create_dir(name, access) mkdir((const char *) name, access)
 180 #define ngx_create_dir_n         "mkdir()"
 181
 182
 183 #define ngx_delete_dir(name)     rmdir((const char *) name)
 184 #define ngx_delete_dir_n         "rmdir()"
 185
 186
 187 #define ngx_dir_access(a)        (a | (a & 0444) >> 2)
 188
 189
 190 #define ngx_de_name(dir)         ((u_char *) (dir)->de->d_name)
 191 #if (NGX_HAVE_D_NAMLEN)
 192 #define ngx_de_namelen(dir)      (dir)->de->d_namlen
 193 #else
 194 #define ngx_de_namelen(dir)      ngx_strlen((dir)->de->d_name)
 195 #endif
 196 #define ngx_de_info(name, dir)   stat((const char *) name, &(dir)->info)
 197 #define ngx_de_info_n            "stat()"
 198 #define ngx_de_link_info(name, dir)  lstat((const char *) name, &(dir)->info)
 199 #define ngx_de_link_info_n       "lstat()"
 200
 201 #if (NGX_HAVE_D_TYPE)
 202
 203 #define ngx_de_is_dir(dir)       ((dir)->type == DT_DIR)
 204 #define ngx_de_is_file(dir)      ((dir)->type == DT_REG)
 205 #define ngx_de_is_link(dir)      ((dir)->type == DT_LINK)
 206
 207 #else
 208
 209 #define ngx_de_is_dir(dir)       (S_ISDIR((dir)->info.st_mode))
 210 #define ngx_de_is_file(dir)      (S_ISREG((dir)->info.st_mode))
 211 #define ngx_de_is_link(dir)      (S_ISLNK((dir)->info.st_mode))
 212
 213 #endif
 214
 215 #define ngx_de_access(dir)       (((dir)->info.st_mode) & 0777)
 216 #define ngx_de_size(dir)         (dir)->info.st_size
 217 #define ngx_de_mtime(dir)        (dir)->info.st_mtime
 218
 219
 220 ngx_int_t ngx_open_glob(ngx_glob_t *gl);
 221 #define ngx_open_glob_n          "glob()"
 222 ngx_int_t ngx_read_glob(ngx_glob_t *gl, ngx_str_t *name);
 223 void ngx_close_glob(ngx_glob_t *gl);
 224
 225
 226 ngx_err_t ngx_trylock_fd(ngx_fd_t fd);
 227 ngx_err_t ngx_lock_fd(ngx_fd_t fd);
 228 ngx_err_t ngx_unlock_fd(ngx_fd_t fd);
 229
 230 #define ngx_trylock_fd_n         "fcntl(F_SETLK, F_WRLCK)"
 231 #define ngx_lock_fd_n            "fcntl(F_SETLKW, F_WRLCK)"
 232 #define ngx_unlock_fd_n          "fcntl(F_SETLK, F_UNLCK)"
 233
 234
 235 #if (NGX_HAVE_O_DIRECT)
 236
 237 ngx_int_t ngx_directio_on(ngx_fd_t fd);
 238 #define ngx_directio_on_n        "fcntl(O_DIRECT)"
 239
 240 ngx_int_t ngx_directio_off(ngx_fd_t fd);
 241 #define ngx_directio_off_n       "fcntl(!O_DIRECT)"
 242
 243 #elif (NGX_HAVE_F_NOCACHE)
 244
 245 #define ngx_directio_on(fd)      fcntl(fd, F_NOCACHE, 1)
 246 #define ngx_directio_on_n        "fcntl(F_NOCACHE, 1)"
 247
 248 #elif (NGX_HAVE_DIRECTIO)
 249
 250 #define ngx_directio_on(fd)      directio(fd, DIRECTIO_ON)
 251 #define ngx_directio_on_n        "directio(DIRECTIO_ON)"
 252
 253 #else
 254
 255 #define ngx_directio_on(fd)      0
 256 #define ngx_directio_on_n        "ngx_directio_on_n"
 257
 258 #endif
 259
 260
 261 #endif /* _NGX_FILES_H_INCLUDED_ */