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 #define NGX_INVALID_FILE         -1
  16 #define NGX_FILE_ERROR           -1
  17
  18
  19
  20 #ifdef __CYGWIN__
  21
  22 #define NGX_HAVE_CASELESS_FILESYSTEM  1
  23
  24 #define ngx_open_file(name, mode, create, access)                            \
  25     open((const char *) name, mode|create|O_BINARY, access)
  26
  27 #else
  28
  29 #define ngx_open_file(name, mode, create, access)                            \
  30     open((const char *) name, mode|create, access)
  31
  32 #endif
  33
  34 #define ngx_open_file_n          "open()"
  35
  36 #define NGX_FILE_RDONLY          O_RDONLY
  37 #define NGX_FILE_WRONLY          O_WRONLY
  38 #define NGX_FILE_RDWR            O_RDWR
  39 #define NGX_FILE_CREATE_OR_OPEN  O_CREAT
  40 #define NGX_FILE_OPEN            0
  41 #define NGX_FILE_TRUNCATE        O_TRUNC
  42 #define NGX_FILE_APPEND          O_APPEND
  43
  44 #define NGX_FILE_DEFAULT_ACCESS  0644
  45
  46
  47 #define ngx_close_file           close
  48 #define ngx_close_file_n         "close()"
  49
  50
  51 #define ngx_delete_file(name)    unlink((const char *) name)
  52 #define ngx_delete_file_n        "unlink()"
  53
  54
  55 ngx_fd_t ngx_open_tempfile(u_char *name, ngx_uint_t persistent,
  56     ngx_uint_t access);
  57 #define ngx_open_tempfile_n      "open()"
  58
  59
  60 ssize_t ngx_read_file(ngx_file_t *file, u_char *buf, size_t size, off_t offset);
  61 #define ngx_read_file_n          "read()"
  62
  63 ssize_t ngx_write_file(ngx_file_t *file, u_char *buf, size_t size,
  64     off_t offset);
  65
  66 ssize_t ngx_write_chain_to_file(ngx_file_t *file, ngx_chain_t *ce,
  67     off_t offset, ngx_pool_t *pool);
  68
  69
  70 #define ngx_read_fd              read
  71 #define ngx_read_fd_n            "read()"
  72
  73 #define ngx_write_fd             write
  74 #define ngx_write_fd_n           "write()"
  75
  76 #define ngx_linefeed(p)          *p++ = LF;
  77 #define NGX_LINEFEED_SIZE        1
  78
  79
  80 #define ngx_rename_file(o, n)    rename((const char *) o, (const char *) n)
  81 #define ngx_rename_file_n        "rename()"
  82
  83
  84 #define ngx_change_file_access(n, a) chmod((const char *) n, a)
  85 #define ngx_change_file_access_n "chmod()"
  86
  87
  88 ngx_int_t ngx_set_file_time(u_char *name, ngx_fd_t fd, time_t s);
  89 #define ngx_set_file_time_n      "utimes()"
  90
  91
  92 #define ngx_file_info(file, sb)  stat((const char *) file, sb)
  93 #define ngx_file_info_n          "stat()"
  94
  95 #define ngx_fd_info(fd, sb)      fstat(fd, sb)
  96 #define ngx_fd_info_n            "fstat()"
  97
  98 #define ngx_is_dir(sb)           (S_ISDIR((sb)->st_mode))
  99 #define ngx_is_file(sb)          (S_ISREG((sb)->st_mode))
 100 #define ngx_is_link(sb)          (S_ISLNK((sb)->st_mode))
 101 #define ngx_is_exec(sb)          ((sb)->st_mode & S_IXUSR)
 102 #define ngx_file_access(sb)      ((sb)->st_mode & 0777)
 103 #define ngx_file_size(sb)        (sb)->st_size
 104 #define ngx_file_mtime(sb)       (sb)->st_mtime
 105 #define ngx_file_uniq(sb)        (sb)->st_ino
 106
 107
 108 #if (NGX_HAVE_CASELESS_FILESYSTEM)
 109
 110 #define ngx_filename_cmp(s1, s2, n)  strncasecmp((char *) s1, (char *) s2, n)
 111
 112 #else
 113
 114 #define ngx_filename_cmp         ngx_memcmp
 115
 116 #endif
 117
 118
 119 #define ngx_getcwd(buf, size)    (getcwd(buf, size) != NULL)
 120 #define ngx_getcwd_n             "getcwd()"
 121 #define NGX_MAX_PATH             PATH_MAX
 122
 123 #define NGX_DIR_MASK_LEN         0
 124
 125
 126 ngx_int_t ngx_open_dir(ngx_str_t *name, ngx_dir_t *dir);
 127 #define ngx_open_dir_n           "opendir()"
 128
 129
 130 #define ngx_close_dir(d)         closedir((d)->dir)
 131 #define ngx_close_dir_n          "closedir()"
 132
 133
 134 #define ngx_read_dir(d)                                                      \
 135     (((d)->de = readdir((d)->dir)) ? NGX_OK : NGX_ERROR)
 136 #define ngx_read_dir_n           "readdir()"
 137
 138
 139 #define ngx_create_dir(name, access) mkdir((const char *) name, access)
 140 #define ngx_create_dir_n         "mkdir()"
 141
 142
 143 #define ngx_delete_dir(name)     rmdir((const char *) name)
 144 #define ngx_delete_dir_n         "rmdir()"
 145
 146
 147 #define ngx_dir_access(a)        (a | (a & 0444) >> 2)
 148
 149
 150 #define ngx_de_name(dir)         ((u_char *) (dir)->de->d_name)
 151 #if (NGX_FREEBSD)
 152 #define ngx_de_namelen(dir)      (dir)->de->d_namlen
 153 #else
 154 #define ngx_de_namelen(dir)      ngx_strlen((dir)->de->d_name)
 155 #endif
 156 #define ngx_de_info(name, dir)   stat((const char *) name, &(dir)->info)
 157 #define ngx_de_info_n            "stat()"
 158 #define ngx_de_link_info(name, dir)  lstat((const char *) name, &(dir)->info)
 159 #define ngx_de_link_info_n       "lstat()"
 160 #define ngx_de_is_dir(dir)       (S_ISDIR((dir)->info.st_mode))
 161 #define ngx_de_is_file(dir)      (S_ISREG((dir)->info.st_mode))
 162 #define ngx_de_is_link(dir)      (S_ISLNK((dir)->info.st_mode))
 163 #define ngx_de_access(dir)       (((dir)->info.st_mode) & 0777)
 164 #define ngx_de_size(dir)         (dir)->info.st_size
 165 #define ngx_de_mtime(dir)        (dir)->info.st_mtime
 166
 167
 168 typedef struct {
 169     size_t       n;
 170     glob_t       pglob;
 171     u_char      *pattern;
 172     ngx_log_t   *log;
 173     ngx_uint_t   test;
 174 } ngx_glob_t;
 175
 176
 177 ngx_int_t ngx_open_glob(ngx_glob_t *gl);
 178 #define ngx_open_glob_n          "glob()"
 179 ngx_int_t ngx_read_glob(ngx_glob_t *gl, ngx_str_t *name);
 180 void ngx_close_glob(ngx_glob_t *gl);
 181
 182
 183 ngx_err_t ngx_trylock_fd(ngx_fd_t fd);
 184 ngx_err_t ngx_lock_fd(ngx_fd_t fd);
 185 ngx_err_t ngx_unlock_fd(ngx_fd_t fd);
 186
 187 #define ngx_trylock_fd_n         "fcntl(F_SETLK, F_WRLCK)"
 188 #define ngx_lock_fd_n            "fcntl(F_SETLKW, F_WRLCK)"
 189 #define ngx_unlock_fd_n          "fcntl(F_SETLK, F_UNLCK)"
 190
 191
 192 #if (NGX_HAVE_O_DIRECT)
 193
 194 ngx_int_t ngx_directio(ngx_fd_t fd);
 195 #define ngx_directio_n           "fcntl(O_DIRECT)"
 196
 197 #elif (NGX_HAVE_F_NOCACHE)
 198
 199 #define ngx_directio(fd)         fcntl(fd, F_NOCACHE, 1)
 200 #define ngx_directio_n           "fcntl(F_NOCACHE)"
 201
 202 #elif (NGX_HAVE_DIRECTIO)
 203
 204 #define ngx_directio(fd)         directio(fd, DIRECTIO_ON)
 205 #define ngx_directio_n           "directio(DIRECTIO_ON)"
 206
 207 #else
 208
 209 #define ngx_directio(fd)         0
 210 #define ngx_directio_n           "ngx_directio_n"
 211
 212 #endif
 213
 214
 215 #endif /* _NGX_FILES_H_INCLUDED_ */