blob: d119c1296f422ab03261a893a0df96f0be2be513 [file] [log] [blame]
Igor Sysoevd92bee52007-09-01 12:11:21 +00001
2/*
3 * Copyright (C) Igor Sysoev
Maxim Konovalovf8d59e32012-01-18 15:07:43 +00004 * Copyright (C) Nginx, Inc.
Igor Sysoevd92bee52007-09-01 12:11:21 +00005 */
6
7
8#include <ngx_config.h>
9#include <ngx_core.h>
10
11
12#ifndef _NGX_OPEN_FILE_CACHE_H_INCLUDED_
13#define _NGX_OPEN_FILE_CACHE_H_INCLUDED_
14
15
Igor Sysoevad1e1232008-10-16 13:31:00 +000016#define NGX_OPEN_FILE_DIRECTIO_OFF NGX_MAX_OFF_T_VALUE
17
18
Igor Sysoevd92bee52007-09-01 12:11:21 +000019typedef struct {
20 ngx_fd_t fd;
21 ngx_file_uniq_t uniq;
22 time_t mtime;
23 off_t size;
Igor Sysoevef1f33b2011-04-22 10:06:43 +000024 off_t fs_size;
Igor Sysoev385af282008-07-30 12:34:04 +000025 off_t directio;
Igor Sysoev32661712009-09-30 13:21:52 +000026 size_t read_ahead;
Igor Sysoevf1cc4572009-04-27 09:55:53 +000027
Igor Sysoevd92bee52007-09-01 12:11:21 +000028 ngx_err_t err;
Igor Sysoevf1cc4572009-04-27 09:55:53 +000029 char *failed;
Igor Sysoevd92bee52007-09-01 12:11:21 +000030
Igor Sysoev9b9616e2007-12-21 16:19:48 +000031 time_t valid;
Igor Sysoevd92bee52007-09-01 12:11:21 +000032
Igor Sysoevf3b0e492007-12-22 13:19:39 +000033 ngx_uint_t min_uses;
34
Andrey Belovbd1e7192012-02-13 16:29:04 +000035#if (NGX_HAVE_OPENAT)
Valentin Bartenev34679112012-02-27 16:46:57 +000036 size_t disable_symlinks_from;
Andrey Belovbd1e7192012-02-13 16:29:04 +000037 unsigned disable_symlinks:2;
38#endif
39
Igor Sysoevd92bee52007-09-01 12:11:21 +000040 unsigned test_dir:1;
Igor Sysoevf1cc4572009-04-27 09:55:53 +000041 unsigned test_only:1;
Igor Sysoevb8821542008-06-30 12:27:24 +000042 unsigned log:1;
Igor Sysoevd92bee52007-09-01 12:11:21 +000043 unsigned errors:1;
Igor Sysoev9afd58f2007-09-03 08:41:42 +000044 unsigned events:1;
Igor Sysoevd92bee52007-09-01 12:11:21 +000045
46 unsigned is_dir:1;
47 unsigned is_file:1;
48 unsigned is_link:1;
49 unsigned is_exec:1;
Igor Sysoev8633e1f2008-09-05 14:48:47 +000050 unsigned is_directio:1;
Igor Sysoevd92bee52007-09-01 12:11:21 +000051} ngx_open_file_info_t;
52
53
54typedef struct ngx_cached_open_file_s ngx_cached_open_file_t;
55
56struct ngx_cached_open_file_s {
57 ngx_rbtree_node_t node;
Igor Sysoevff71b942007-12-21 15:33:15 +000058 ngx_queue_t queue;
Igor Sysoevd92bee52007-09-01 12:11:21 +000059
60 u_char *name;
61 time_t created;
62 time_t accessed;
63
64 ngx_fd_t fd;
65 ngx_file_uniq_t uniq;
66 time_t mtime;
67 off_t size;
68 ngx_err_t err;
69
Igor Sysoevf3b0e492007-12-22 13:19:39 +000070 uint32_t uses;
71
Andrey Belovbd1e7192012-02-13 16:29:04 +000072#if (NGX_HAVE_OPENAT)
Valentin Bartenev34679112012-02-27 16:46:57 +000073 size_t disable_symlinks_from;
Andrey Belovbd1e7192012-02-13 16:29:04 +000074 unsigned disable_symlinks:2;
75#endif
76
Igor Sysoevd92bee52007-09-01 12:11:21 +000077 unsigned count:24;
78 unsigned close:1;
Igor Sysoev421a3b82007-12-25 10:46:40 +000079 unsigned use_event:1;
Igor Sysoevd92bee52007-09-01 12:11:21 +000080
81 unsigned is_dir:1;
82 unsigned is_file:1;
83 unsigned is_link:1;
84 unsigned is_exec:1;
Igor Sysoev77cdae12008-09-12 13:39:51 +000085 unsigned is_directio:1;
Igor Sysoevd92bee52007-09-01 12:11:21 +000086
87 ngx_event_t *event;
88};
89
90
91typedef struct {
92 ngx_rbtree_t rbtree;
Igor Sysoevddc8cbd2007-12-20 21:29:52 +000093 ngx_rbtree_node_t sentinel;
Igor Sysoevff71b942007-12-21 15:33:15 +000094 ngx_queue_t expire_queue;
Igor Sysoevd92bee52007-09-01 12:11:21 +000095
96 ngx_uint_t current;
97 ngx_uint_t max;
98 time_t inactive;
99} ngx_open_file_cache_t;
100
101
102typedef struct {
103 ngx_open_file_cache_t *cache;
104 ngx_cached_open_file_t *file;
Igor Sysoevf3b0e492007-12-22 13:19:39 +0000105 ngx_uint_t min_uses;
Igor Sysoevd92bee52007-09-01 12:11:21 +0000106 ngx_log_t *log;
107} ngx_open_file_cache_cleanup_t;
108
109
110typedef struct {
111
112 /* ngx_connection_t stub to allow use c->fd as event ident */
113 void *data;
114 ngx_event_t *read;
115 ngx_event_t *write;
116 ngx_fd_t fd;
117
118 ngx_cached_open_file_t *file;
119 ngx_open_file_cache_t *cache;
120} ngx_open_file_cache_event_t;
121
122
123ngx_open_file_cache_t *ngx_open_file_cache_init(ngx_pool_t *pool,
124 ngx_uint_t max, time_t inactive);
125ngx_int_t ngx_open_cached_file(ngx_open_file_cache_t *cache, ngx_str_t *name,
126 ngx_open_file_info_t *of, ngx_pool_t *pool);
127
128
129#endif /* _NGX_OPEN_FILE_CACHE_H_INCLUDED_ */