xref: /unit/src/nxt_application.h (revision 678)
10Sigor@sysoev.ru 
20Sigor@sysoev.ru /*
384Smax.romanov@nginx.com  * Copyright (C) Max Romanov
40Sigor@sysoev.ru  * Copyright (C) Valentin V. Bartenev
50Sigor@sysoev.ru  * Copyright (C) NGINX, Inc.
60Sigor@sysoev.ru  */
70Sigor@sysoev.ru 
80Sigor@sysoev.ru #ifndef _NXT_APPLICATION_H_INCLUDED_
90Sigor@sysoev.ru #define _NXT_APPLICATION_H_INCLUDED_
100Sigor@sysoev.ru 
110Sigor@sysoev.ru 
12*678Svbart@nginx.com #include <nxt_conf.h>
13*678Svbart@nginx.com 
14*678Svbart@nginx.com 
15133Sigor@sysoev.ru typedef enum {
16141Smax.romanov@nginx.com     NXT_APP_PYTHON,
17133Sigor@sysoev.ru     NXT_APP_PHP,
18133Sigor@sysoev.ru     NXT_APP_GO,
19510Salexander.borisov@nginx.com     NXT_APP_PERL,
20584Salexander.borisov@nginx.com     NXT_APP_RUBY,
21141Smax.romanov@nginx.com 
22216Sigor@sysoev.ru     NXT_APP_UNKNOWN,
23133Sigor@sysoev.ru } nxt_app_type_t;
24133Sigor@sysoev.ru 
25133Sigor@sysoev.ru 
26216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_application_module_t;
27216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_app_module_t;
28216Sigor@sysoev.ru 
29216Sigor@sysoev.ru 
30216Sigor@sysoev.ru typedef struct {
31356Svbart@nginx.com     nxt_app_type_t            type;
32354Svbart@nginx.com     u_char                    *version;
33216Sigor@sysoev.ru     char                      *file;
34216Sigor@sysoev.ru     nxt_application_module_t  *module;
35216Sigor@sysoev.ru } nxt_app_lang_module_t;
36216Sigor@sysoev.ru 
37216Sigor@sysoev.ru 
38141Smax.romanov@nginx.com typedef struct nxt_common_app_conf_s nxt_common_app_conf_t;
39141Smax.romanov@nginx.com 
40141Smax.romanov@nginx.com 
41141Smax.romanov@nginx.com typedef struct {
42394Smax.romanov@nginx.com     char       *home;
43141Smax.romanov@nginx.com     nxt_str_t  path;
44141Smax.romanov@nginx.com     nxt_str_t  module;
45141Smax.romanov@nginx.com } nxt_python_app_conf_t;
46141Smax.romanov@nginx.com 
47141Smax.romanov@nginx.com 
48141Smax.romanov@nginx.com typedef struct {
49462Smax.romanov@nginx.com     char       *root;
50141Smax.romanov@nginx.com     nxt_str_t  script;
51141Smax.romanov@nginx.com     nxt_str_t  index;
52141Smax.romanov@nginx.com } nxt_php_app_conf_t;
53141Smax.romanov@nginx.com 
54141Smax.romanov@nginx.com 
55141Smax.romanov@nginx.com typedef struct {
56272Smax.romanov@nginx.com     char       *executable;
57141Smax.romanov@nginx.com } nxt_go_app_conf_t;
58141Smax.romanov@nginx.com 
59141Smax.romanov@nginx.com 
60510Salexander.borisov@nginx.com typedef struct {
61510Salexander.borisov@nginx.com     char       *script;
62510Salexander.borisov@nginx.com } nxt_perl_app_conf_t;
63510Salexander.borisov@nginx.com 
64510Salexander.borisov@nginx.com 
65584Salexander.borisov@nginx.com typedef struct {
66584Salexander.borisov@nginx.com     nxt_str_t  script;
67584Salexander.borisov@nginx.com } nxt_ruby_app_conf_t;
68584Salexander.borisov@nginx.com 
69584Salexander.borisov@nginx.com 
70141Smax.romanov@nginx.com struct nxt_common_app_conf_s {
71*678Svbart@nginx.com     nxt_str_t                  name;
72*678Svbart@nginx.com     nxt_str_t                  type;
73*678Svbart@nginx.com     nxt_str_t                  user;
74*678Svbart@nginx.com     nxt_str_t                  group;
75141Smax.romanov@nginx.com 
76*678Svbart@nginx.com     char                       *working_directory;
77*678Svbart@nginx.com     nxt_conf_value_t           *environment;
78271Smax.romanov@nginx.com 
79141Smax.romanov@nginx.com     union {
80141Smax.romanov@nginx.com         nxt_python_app_conf_t  python;
81141Smax.romanov@nginx.com         nxt_php_app_conf_t     php;
82141Smax.romanov@nginx.com         nxt_go_app_conf_t      go;
83510Salexander.borisov@nginx.com         nxt_perl_app_conf_t    perl;
84584Salexander.borisov@nginx.com         nxt_ruby_app_conf_t    ruby;
85141Smax.romanov@nginx.com     } u;
86141Smax.romanov@nginx.com };
87141Smax.romanov@nginx.com 
88141Smax.romanov@nginx.com 
890Sigor@sysoev.ru typedef struct {
900Sigor@sysoev.ru     nxt_str_t                  name;
910Sigor@sysoev.ru     nxt_str_t                  value;
920Sigor@sysoev.ru } nxt_app_header_field_t;
930Sigor@sysoev.ru 
940Sigor@sysoev.ru 
950Sigor@sysoev.ru typedef struct {
960Sigor@sysoev.ru     nxt_str_t                  method;
97112Smax.romanov@nginx.com     nxt_str_t                  target;
98112Smax.romanov@nginx.com     nxt_str_t                  version;
990Sigor@sysoev.ru     nxt_str_t                  path;
10084Smax.romanov@nginx.com     nxt_str_t                  query;
10184Smax.romanov@nginx.com 
10284Smax.romanov@nginx.com     nxt_list_t                 *fields;
1030Sigor@sysoev.ru 
10484Smax.romanov@nginx.com     nxt_str_t                  cookie;
10584Smax.romanov@nginx.com     nxt_str_t                  content_length;
10684Smax.romanov@nginx.com     nxt_str_t                  content_type;
10784Smax.romanov@nginx.com     nxt_str_t                  host;
10884Smax.romanov@nginx.com 
10984Smax.romanov@nginx.com     off_t                      parsed_content_length;
11084Smax.romanov@nginx.com     nxt_bool_t                 done;
111206Smax.romanov@nginx.com 
112206Smax.romanov@nginx.com     size_t                     bufs;
113206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
1140Sigor@sysoev.ru } nxt_app_request_header_t;
1150Sigor@sysoev.ru 
1160Sigor@sysoev.ru 
1170Sigor@sysoev.ru typedef struct {
118206Smax.romanov@nginx.com     size_t                     preread_size;
11984Smax.romanov@nginx.com     nxt_bool_t                 done;
120206Smax.romanov@nginx.com 
121206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
12284Smax.romanov@nginx.com } nxt_app_request_body_t;
1230Sigor@sysoev.ru 
1240Sigor@sysoev.ru 
12584Smax.romanov@nginx.com typedef struct {
1260Sigor@sysoev.ru     nxt_app_request_header_t   header;
12784Smax.romanov@nginx.com     nxt_app_request_body_t     body;
128113Smax.romanov@nginx.com 
129113Smax.romanov@nginx.com     nxt_str_t                  remote;
130268Sigor@sysoev.ru     nxt_str_t                  local;
1310Sigor@sysoev.ru } nxt_app_request_t;
1320Sigor@sysoev.ru 
1330Sigor@sysoev.ru 
134431Sigor@sysoev.ru typedef struct nxt_app_parse_ctx_s  nxt_app_parse_ctx_t;
135163Smax.romanov@nginx.com 
136163Smax.romanov@nginx.com struct nxt_app_parse_ctx_s {
13784Smax.romanov@nginx.com     nxt_app_request_t         r;
138431Sigor@sysoev.ru     nxt_http_request_t        *request;
139431Sigor@sysoev.ru     nxt_timer_t               timer;
140615Smax.romanov@nginx.com     void                      *timer_data;
14184Smax.romanov@nginx.com     nxt_http_request_parse_t  parser;
142431Sigor@sysoev.ru     nxt_http_request_parse_t  resp_parser;
14384Smax.romanov@nginx.com     nxt_mp_t                  *mem_pool;
144163Smax.romanov@nginx.com };
14584Smax.romanov@nginx.com 
14684Smax.romanov@nginx.com 
14784Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_done(nxt_task_t *task, nxt_app_parse_ctx_t *ctx);
14884Smax.romanov@nginx.com 
14984Smax.romanov@nginx.com 
15084Smax.romanov@nginx.com typedef struct nxt_app_wmsg_s  nxt_app_wmsg_t;
15184Smax.romanov@nginx.com typedef struct nxt_app_rmsg_s  nxt_app_rmsg_t;
15284Smax.romanov@nginx.com 
15384Smax.romanov@nginx.com struct nxt_app_wmsg_s {
15484Smax.romanov@nginx.com     nxt_port_t                 *port;  /* where prepared buf will be sent */
15584Smax.romanov@nginx.com     nxt_buf_t                  *write;
15684Smax.romanov@nginx.com     nxt_buf_t                  **buf;
15784Smax.romanov@nginx.com     uint32_t                   stream;
15884Smax.romanov@nginx.com };
15984Smax.romanov@nginx.com 
160584Salexander.borisov@nginx.com 
16184Smax.romanov@nginx.com struct nxt_app_rmsg_s {
162584Salexander.borisov@nginx.com     nxt_buf_t                  *buf;   /* current buffer to read */
16384Smax.romanov@nginx.com };
16484Smax.romanov@nginx.com 
16584Smax.romanov@nginx.com 
16684Smax.romanov@nginx.com nxt_inline u_char *
16784Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length);
16884Smax.romanov@nginx.com 
16984Smax.romanov@nginx.com /* TODO asynchronous mmap buffer assignment */
170216Sigor@sysoev.ru NXT_EXPORT u_char *nxt_app_msg_write_get_buf(nxt_task_t *task,
171216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, size_t size);
17284Smax.romanov@nginx.com 
173216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write(nxt_task_t *task, nxt_app_wmsg_t *msg,
17484Smax.romanov@nginx.com     u_char *c, size_t size);
17584Smax.romanov@nginx.com 
176216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_prefixed_upcase(nxt_task_t *task,
177417Svbart@nginx.com     nxt_app_wmsg_t *msg, const nxt_str_t *prefix, u_char *c, size_t size);
17884Smax.romanov@nginx.com 
17984Smax.romanov@nginx.com nxt_inline nxt_int_t
18084Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
18184Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize);
18284Smax.romanov@nginx.com 
18384Smax.romanov@nginx.com 
18484Smax.romanov@nginx.com #define nxt_app_msg_write_const(task, msg, c)                                 \
18584Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (u_char *)(c), sizeof(c) - 1)
18684Smax.romanov@nginx.com 
18784Smax.romanov@nginx.com #define nxt_app_msg_write_str(task, msg, str)                                 \
18884Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (str)->start, (str)->length)
18984Smax.romanov@nginx.com 
19084Smax.romanov@nginx.com #define nxt_app_msg_write_cstr(task, msg, c)                                  \
19184Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (c), nxt_strlen(c))
19284Smax.romanov@nginx.com 
19384Smax.romanov@nginx.com #define nxt_app_msg_write_nvp(task, msg, n, v)                                \
19484Smax.romanov@nginx.com     nxt_app_msg_write_nvp_((task), (msg), (u_char *)(n), sizeof(n) - 1,       \
19584Smax.romanov@nginx.com                            (v)->start, (v)->length)
19684Smax.romanov@nginx.com 
19784Smax.romanov@nginx.com nxt_inline nxt_int_t nxt_app_msg_write_size(nxt_task_t *task,
19884Smax.romanov@nginx.com     nxt_app_wmsg_t *msg, size_t size);
19984Smax.romanov@nginx.com 
200216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_flush(nxt_task_t *task, nxt_app_wmsg_t *msg,
20184Smax.romanov@nginx.com     nxt_bool_t last);
20284Smax.romanov@nginx.com 
203216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_raw(nxt_task_t *task,
204216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, const u_char *c, size_t size);
20584Smax.romanov@nginx.com 
206216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_str(nxt_task_t *task, nxt_app_rmsg_t *msg,
20784Smax.romanov@nginx.com     nxt_str_t *str);
20884Smax.romanov@nginx.com 
209216Sigor@sysoev.ru NXT_EXPORT size_t nxt_app_msg_read_raw(nxt_task_t *task,
210216Sigor@sysoev.ru     nxt_app_rmsg_t *msg, void *buf, size_t size);
211206Smax.romanov@nginx.com 
212216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_nvp(nxt_task_t *task,
213216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, nxt_str_t *n, nxt_str_t *v);
21484Smax.romanov@nginx.com 
215216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_size(nxt_task_t *task,
216216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, size_t *size);
21784Smax.romanov@nginx.com 
21884Smax.romanov@nginx.com 
219216Sigor@sysoev.ru struct nxt_app_module_s {
220258Sigor@sysoev.ru     size_t                     compat_length;
221258Sigor@sysoev.ru     uint32_t                   *compat;
222258Sigor@sysoev.ru 
223216Sigor@sysoev.ru     nxt_str_t                  type;
224612Salexander.borisov@nginx.com     const char                 *version;
225141Smax.romanov@nginx.com 
226141Smax.romanov@nginx.com     nxt_int_t                  (*init)(nxt_task_t *task,
227141Smax.romanov@nginx.com                                     nxt_common_app_conf_t *conf);
22884Smax.romanov@nginx.com     nxt_int_t                  (*run)(nxt_task_t *task,
22984Smax.romanov@nginx.com                                     nxt_app_rmsg_t *rmsg,
23084Smax.romanov@nginx.com                                     nxt_app_wmsg_t *wmsg);
231421Smax.romanov@nginx.com     void                       (*atexit)(nxt_task_t *task);
232141Smax.romanov@nginx.com };
2330Sigor@sysoev.ru 
2340Sigor@sysoev.ru 
23520Sigor@sysoev.ru nxt_int_t nxt_app_http_read_body(nxt_app_request_t *r, u_char *data,
23620Sigor@sysoev.ru     size_t len);
2370Sigor@sysoev.ru nxt_int_t nxt_app_write(nxt_app_request_t *r, const u_char *data, size_t len);
2380Sigor@sysoev.ru 
23984Smax.romanov@nginx.com nxt_inline u_char *
24084Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length)
24184Smax.romanov@nginx.com {
24284Smax.romanov@nginx.com     if (length < 128) {
24384Smax.romanov@nginx.com         *dst = length;
24484Smax.romanov@nginx.com         dst++;
245277Sigor@sysoev.ru 
24684Smax.romanov@nginx.com     } else {
24784Smax.romanov@nginx.com         dst[0] = 0x80U | (length >> 24);
24884Smax.romanov@nginx.com         dst[1] = 0xFFU & (length >> 16);
24984Smax.romanov@nginx.com         dst[2] = 0xFFU & (length >> 8);
25084Smax.romanov@nginx.com         dst[3] = 0xFFU & length;
25184Smax.romanov@nginx.com         dst += 4;
25284Smax.romanov@nginx.com     }
25384Smax.romanov@nginx.com 
25484Smax.romanov@nginx.com     return dst;
25584Smax.romanov@nginx.com }
25684Smax.romanov@nginx.com 
25784Smax.romanov@nginx.com 
25884Smax.romanov@nginx.com nxt_inline nxt_int_t
25984Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
26084Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize)
26184Smax.romanov@nginx.com {
26284Smax.romanov@nginx.com     nxt_int_t rc;
26384Smax.romanov@nginx.com 
26484Smax.romanov@nginx.com     rc = nxt_app_msg_write(task, msg, n, nsize);
26584Smax.romanov@nginx.com     if (nxt_slow_path(rc != NXT_OK)) {
26684Smax.romanov@nginx.com         return rc;
26784Smax.romanov@nginx.com     }
26884Smax.romanov@nginx.com 
26984Smax.romanov@nginx.com     return nxt_app_msg_write(task, msg, v, vsize);
27084Smax.romanov@nginx.com }
27184Smax.romanov@nginx.com 
27284Smax.romanov@nginx.com 
27384Smax.romanov@nginx.com nxt_inline nxt_int_t
27484Smax.romanov@nginx.com nxt_app_msg_write_size(nxt_task_t *task, nxt_app_wmsg_t *msg, size_t size)
27584Smax.romanov@nginx.com {
27684Smax.romanov@nginx.com     u_char  *dst;
27784Smax.romanov@nginx.com     size_t  dst_length;
27884Smax.romanov@nginx.com 
27984Smax.romanov@nginx.com     dst_length = size < 128 ? 1 : 4;
28084Smax.romanov@nginx.com 
28184Smax.romanov@nginx.com     dst = nxt_app_msg_write_get_buf(task, msg, dst_length);
28284Smax.romanov@nginx.com     if (nxt_slow_path(dst == NULL)) {
28384Smax.romanov@nginx.com         return NXT_ERROR;
28484Smax.romanov@nginx.com     }
28584Smax.romanov@nginx.com 
28684Smax.romanov@nginx.com     nxt_app_msg_write_length(dst, size);
28784Smax.romanov@nginx.com 
28884Smax.romanov@nginx.com     return NXT_OK;
28984Smax.romanov@nginx.com }
29084Smax.romanov@nginx.com 
29184Smax.romanov@nginx.com 
29284Smax.romanov@nginx.com nxt_inline u_char *
29384Smax.romanov@nginx.com nxt_app_msg_read_length(u_char *src, size_t *length)
29484Smax.romanov@nginx.com {
29584Smax.romanov@nginx.com     if (src[0] < 128) {
29684Smax.romanov@nginx.com         *length = src[0];
29784Smax.romanov@nginx.com         src++;
298277Sigor@sysoev.ru 
29984Smax.romanov@nginx.com     } else {
300613Svbart@nginx.com         *length = ((src[0] & 0x7FU) << 24)
301613Svbart@nginx.com                 + ( src[1]          << 16)
302613Svbart@nginx.com                 + ( src[2]          <<  8)
303613Svbart@nginx.com                 +   src[3];
30484Smax.romanov@nginx.com         src += 4;
30584Smax.romanov@nginx.com     }
30684Smax.romanov@nginx.com 
30784Smax.romanov@nginx.com     return src;
30884Smax.romanov@nginx.com }
30984Smax.romanov@nginx.com 
3100Sigor@sysoev.ru 
311216Sigor@sysoev.ru nxt_app_lang_module_t *nxt_app_lang_module(nxt_runtime_t *rt, nxt_str_t *name);
312510Salexander.borisov@nginx.com nxt_app_type_t nxt_app_parse_type(u_char *p, size_t length);
313216Sigor@sysoev.ru 
314673Svbart@nginx.com NXT_EXPORT extern nxt_str_t      nxt_server;
315216Sigor@sysoev.ru extern nxt_application_module_t  nxt_go_module;
316216Sigor@sysoev.ru 
317216Sigor@sysoev.ru 
3180Sigor@sysoev.ru #endif /* _NXT_APPLICATION_H_INCLIDED_ */
319