One Level Up Top Level

src/os/win32/ngx_files.h - nginx source code

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_FILES_H_INCLUDED_
  9. ‌#define _NGX_FILES_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>


  16. ‌typedef HANDLE                      ngx_fd_t;
  17. ‌typedef BY_HANDLE_FILE_INFORMATION  ngx_file_info_t;
  18. ‌typedef uint64_t                    ngx_file_uniq_t;


  21. ‌typedef struct {
  22.     u_char                         *name;
  23.     size_t                          size;
  24.     void                           *addr;
  25.     ngx_fd_t                        fd;
  26.     HANDLE                          handle;
  27.     ngx_log_t                      *log;
  28. ‌} ngx_file_mapping_t;


  31. ‌typedef struct {
  32.     HANDLE                          dir;
  33.     WIN32_FIND_DATAW                finddata;

  35.     u_char                         *name;
  36.     size_t                          namelen;
  37.     size_t                          allocated;

  39.     unsigned                        valid_info:1;
  40.     unsigned                        type:1;
  41.     unsigned                        ready:1;
  42. ‌} ngx_dir_t;


  45. ‌typedef struct {
  46.     HANDLE                          dir;
  47.     WIN32_FIND_DATAW                finddata;

  49.     unsigned                        ready:1;
  50.     unsigned                        test:1;
  51.     unsigned                        no_match:1;

  53.     u_char                         *pattern;
  54.     ngx_str_t                       name;
  55.     size_t                          last;
  56.     ngx_log_t                      *log;
  57. ‌} ngx_glob_t;



  61. /* INVALID_FILE_ATTRIBUTES is specified but not defined at least in MSVC6SP2 */
  62. #ifndef INVALID_FILE_ATTRIBUTES
  63. ‌#define INVALID_FILE_ATTRIBUTES     0xffffffff
  64. #endif

  66. /* INVALID_SET_FILE_POINTER is not defined at least in MSVC6SP2 */
  67. #ifndef INVALID_SET_FILE_POINTER
  68. ‌#define INVALID_SET_FILE_POINTER    0xffffffff
  69. #endif


  72. ‌#define NGX_INVALID_FILE            INVALID_HANDLE_VALUE
  73. ‌#define NGX_FILE_ERROR              0


  76. ngx_fd_t ngx_open_file(u_char *name, u_long mode, u_long create, u_long access);
  77. ‌#define ngx_open_file_n             "CreateFile()"

  79. ‌#define NGX_FILE_RDONLY             GENERIC_READ
  80. ‌#define NGX_FILE_WRONLY             GENERIC_WRITE
  81. ‌#define NGX_FILE_RDWR               GENERIC_READ|GENERIC_WRITE
  82. ‌#define NGX_FILE_APPEND             FILE_APPEND_DATA|SYNCHRONIZE
  83. ‌#define NGX_FILE_NONBLOCK           0

  85. ‌#define NGX_FILE_CREATE_OR_OPEN     OPEN_ALWAYS
  86. ‌#define NGX_FILE_OPEN               OPEN_EXISTING
  87. ‌#define NGX_FILE_TRUNCATE           CREATE_ALWAYS

  89. ‌#define NGX_FILE_DEFAULT_ACCESS     0
  90. ‌#define NGX_FILE_OWNER_ACCESS       0


  93. ngx_fd_t ngx_open_tempfile(u_char *name, ngx_uint_t persistent,
  94.     ngx_uint_t access);
  95. ‌#define ngx_open_tempfile_n         "CreateFile()"


  98. ‌#define ngx_close_file              CloseHandle
  99. ‌#define ngx_close_file_n            "CloseHandle()"


  102. ssize_t ngx_read_fd(ngx_fd_t fd, void *buf, size_t size);
  103. ‌#define ngx_read_fd_n               "ReadFile()"


  106. ssize_t ngx_write_fd(ngx_fd_t fd, void *buf, size_t size);
  107. ‌#define ngx_write_fd_n              "WriteFile()"


  110. ssize_t ngx_write_console(ngx_fd_t fd, void *buf, size_t size);


  113. ‌#define ngx_linefeed(p)             *p++ = CR; *p++ = LF;
  114. ‌#define NGX_LINEFEED_SIZE           2
  115. ‌#define NGX_LINEFEED                CRLF


  118. ngx_int_t ngx_delete_file(u_char *name);
  119. ‌#define ngx_delete_file_n           "DeleteFile()"


  122. ngx_int_t ngx_rename_file(u_char *from, u_char *to);
  123. ‌#define ngx_rename_file_n           "MoveFile()"
  124. ngx_err_t ngx_win32_rename_file(ngx_str_t *from, ngx_str_t *to, ngx_log_t *log);



  128. ngx_int_t ngx_set_file_time(u_char *name, ngx_fd_t fd, time_t s);
  129. ‌#define ngx_set_file_time_n         "SetFileTime()"


  132. ngx_int_t ngx_file_info(u_char *filename, ngx_file_info_t *fi);
  133. ‌#define ngx_file_info_n             "GetFileAttributesEx()"


  136. ‌#define ngx_fd_info(fd, fi)         GetFileInformationByHandle(fd, fi)
  137. ‌#define ngx_fd_info_n               "GetFileInformationByHandle()"


  140. ‌#define ngx_link_info(name, fi)     ngx_file_info(name, fi)
  141. ‌#define ngx_link_info_n             "GetFileAttributesEx()"


  144. ‌#define ngx_is_dir(fi)                                                       \
  145.     (((fi)->dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0)
  146. ‌#define ngx_is_file(fi)                                                      \
  147.     (((fi)->dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) == 0)
  148. ‌#define ngx_is_link(fi)     0
  149. ‌#define ngx_is_exec(fi)     0

  151. ‌#define ngx_file_access(fi) 0

  153. ‌#define ngx_file_size(fi)                                                    \
  154.     (((off_t) (fi)->nFileSizeHigh << 32) | (fi)->nFileSizeLow)
  155. ‌#define ngx_file_fs_size(fi)        ngx_file_size(fi)

  157. ‌#define ngx_file_uniq(fi)                                                    \
  158.     (((ngx_file_uniq_t) (fi)->nFileIndexHigh << 32) | (fi)->nFileIndexLow)


  161. /* 116444736000000000 is commented in src/os/win32/ngx_time.c */

  163. ‌#define ngx_file_mtime(fi)                                                   \
  164. (time_t) (((((unsigned __int64) (fi)->ftLastWriteTime.dwHighDateTime << 32) \
  165.                                | (fi)->ftLastWriteTime.dwLowDateTime)        \
  166.                                           - 116444736000000000) / 10000000)

  168. ngx_int_t ngx_create_file_mapping(ngx_file_mapping_t *fm);
  169. void ngx_close_file_mapping(ngx_file_mapping_t *fm);


  172. u_char *ngx_realpath(u_char *path, u_char *resolved);
  173. ‌#define ngx_realpath_n              ""


  176. size_t ngx_getcwd(u_char *buf, size_t size);
  177. ‌#define ngx_getcwd_n                "GetCurrentDirectory()"


  180. ‌#define ngx_path_separator(c)       ((c) == '/' || (c) == '\\')

  182. ‌#define NGX_HAVE_MAX_PATH           1
  183. ‌#define NGX_MAX_PATH                MAX_PATH


  186. ngx_int_t ngx_open_dir(ngx_str_t *name, ngx_dir_t *dir);
  187. ‌#define ngx_open_dir_n              "FindFirstFile()"


  190. ngx_int_t ngx_read_dir(ngx_dir_t *dir);
  191. ‌#define ngx_read_dir_n              "FindNextFile()"


  194. ngx_int_t ngx_close_dir(ngx_dir_t *dir);
  195. ‌#define ngx_close_dir_n             "FindClose()"


  198. ngx_int_t ngx_create_dir(u_char *name, ngx_uint_t access);
  199. ‌#define ngx_create_dir_n            "CreateDirectory()"


  202. ngx_int_t ngx_delete_dir(u_char *name);
  203. ‌#define ngx_delete_dir_n            "RemoveDirectory()"


  206. ‌#define ngx_dir_access(a)           (a)


  209. ‌#define ngx_de_name(dir)            (dir)->name
  210. ‌#define ngx_de_namelen(dir)         (dir)->namelen

  212. ngx_int_t ngx_de_info(u_char *name, ngx_dir_t *dir);
  213. ‌#define ngx_de_info_n               "dummy()"

  215. ngx_int_t ngx_de_link_info(u_char *name, ngx_dir_t *dir);
  216. ‌#define ngx_de_link_info_n          "dummy()"

  218. ‌#define ngx_de_is_dir(dir)                                                   \
  219.     (((dir)->finddata.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0)
  220. ‌#define ngx_de_is_file(dir)                                                  \
  221.     (((dir)->finddata.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) == 0)
  222. ‌#define ngx_de_is_link(dir)         0
  223. ‌#define ngx_de_access(dir)          0
  224. ‌#define ngx_de_size(dir)                                                     \
  225.   (((off_t) (dir)->finddata.nFileSizeHigh << 32) | (dir)->finddata.nFileSizeLow)
  226. ‌#define ngx_de_fs_size(dir)         ngx_de_size(dir)

  228. /* 116444736000000000 is commented in src/os/win32/ngx_time.c */

  230. ‌#define ngx_de_mtime(dir)                                                    \
  231.     (time_t) (((((unsigned __int64)                                          \
  232.                      (dir)->finddata.ftLastWriteTime.dwHighDateTime << 32)   \
  233.                       | (dir)->finddata.ftLastWriteTime.dwLowDateTime)       \
  234.                                           - 116444736000000000) / 10000000)


  237. ngx_int_t ngx_open_glob(ngx_glob_t *gl);
  238. ‌#define ngx_open_glob_n             "FindFirstFile()"

  240. ngx_int_t ngx_read_glob(ngx_glob_t *gl, ngx_str_t *name);
  241. void ngx_close_glob(ngx_glob_t *gl);


  244. ssize_t ngx_read_file(ngx_file_t *file, u_char *buf, size_t size, off_t offset);
  245. ‌#define ngx_read_file_n             "ReadFile()"

  247. ssize_t ngx_write_file(ngx_file_t *file, u_char *buf, size_t size,
  248.     off_t offset);

  250. ssize_t ngx_write_chain_to_file(ngx_file_t *file, ngx_chain_t *ce,
  251.     off_t offset, ngx_pool_t *pool);

  253. ngx_int_t ngx_read_ahead(ngx_fd_t fd, size_t n);
  254. ‌#define ngx_read_ahead_n            "ngx_read_ahead_n"

  256. ngx_int_t ngx_directio_on(ngx_fd_t fd);
  257. ‌#define ngx_directio_on_n           "ngx_directio_on_n"

  259. ngx_int_t ngx_directio_off(ngx_fd_t fd);
  260. ‌#define ngx_directio_off_n          "ngx_directio_off_n"

  262. size_t ngx_fs_bsize(u_char *name);
  263. off_t ngx_fs_available(u_char *name);


  266. ‌#define ngx_stdout               GetStdHandle(STD_OUTPUT_HANDLE)
  267. ‌#define ngx_stderr               GetStdHandle(STD_ERROR_HANDLE)
  268. ‌#define ngx_set_stderr(fd)       SetStdHandle(STD_ERROR_HANDLE, fd)
  269. ‌#define ngx_set_stderr_n         "SetStdHandle(STD_ERROR_HANDLE)"


  272. #endif /* _NGX_FILES_H_INCLUDED_ */

One Level Up Top Level