xref: /unit/src/nxt_application.h (revision 180)
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 
12133Sigor@sysoev.ru typedef enum {
13141Smax.romanov@nginx.com     NXT_APP_UNKNOWN = 0,
14141Smax.romanov@nginx.com     NXT_APP_PYTHON,
15141Smax.romanov@nginx.com     NXT_APP_PYTHON2,
16141Smax.romanov@nginx.com     NXT_APP_PYTHON3,
17133Sigor@sysoev.ru     NXT_APP_PHP,
18141Smax.romanov@nginx.com     NXT_APP_PHP5,
19141Smax.romanov@nginx.com     NXT_APP_PHP7,
20133Sigor@sysoev.ru     NXT_APP_RUBY,
21133Sigor@sysoev.ru     NXT_APP_GO,
22141Smax.romanov@nginx.com 
23141Smax.romanov@nginx.com     NXT_APP_MAX,
24133Sigor@sysoev.ru } nxt_app_type_t;
25133Sigor@sysoev.ru 
26133Sigor@sysoev.ru 
27141Smax.romanov@nginx.com typedef struct nxt_common_app_conf_s nxt_common_app_conf_t;
28141Smax.romanov@nginx.com 
29141Smax.romanov@nginx.com 
30141Smax.romanov@nginx.com typedef struct {
31141Smax.romanov@nginx.com     nxt_str_t  path;
32141Smax.romanov@nginx.com     nxt_str_t  module;
33141Smax.romanov@nginx.com } nxt_python_app_conf_t;
34141Smax.romanov@nginx.com 
35141Smax.romanov@nginx.com 
36141Smax.romanov@nginx.com typedef struct {
37141Smax.romanov@nginx.com     nxt_str_t  root;
38141Smax.romanov@nginx.com     nxt_str_t  script;
39141Smax.romanov@nginx.com     nxt_str_t  index;
40141Smax.romanov@nginx.com } nxt_php_app_conf_t;
41141Smax.romanov@nginx.com 
42141Smax.romanov@nginx.com 
43141Smax.romanov@nginx.com typedef struct {
44141Smax.romanov@nginx.com     nxt_str_t  executable;
45141Smax.romanov@nginx.com } nxt_go_app_conf_t;
46141Smax.romanov@nginx.com 
47141Smax.romanov@nginx.com 
48141Smax.romanov@nginx.com struct nxt_common_app_conf_s {
49174Sigor@sysoev.ru     nxt_str_t       name;
50141Smax.romanov@nginx.com     nxt_str_t       type;
51141Smax.romanov@nginx.com     nxt_app_type_t  type_id;
52141Smax.romanov@nginx.com     nxt_str_t       user;
53141Smax.romanov@nginx.com     nxt_str_t       group;
54141Smax.romanov@nginx.com 
55141Smax.romanov@nginx.com     uint32_t   workers;
56141Smax.romanov@nginx.com 
57141Smax.romanov@nginx.com     union {
58141Smax.romanov@nginx.com         nxt_python_app_conf_t  python;
59141Smax.romanov@nginx.com         nxt_php_app_conf_t     php;
60141Smax.romanov@nginx.com         nxt_go_app_conf_t      go;
61141Smax.romanov@nginx.com     } u;
62141Smax.romanov@nginx.com };
63141Smax.romanov@nginx.com 
64141Smax.romanov@nginx.com 
650Sigor@sysoev.ru typedef struct {
660Sigor@sysoev.ru     nxt_str_t                  name;
670Sigor@sysoev.ru     nxt_str_t                  value;
680Sigor@sysoev.ru } nxt_app_header_field_t;
690Sigor@sysoev.ru 
700Sigor@sysoev.ru 
710Sigor@sysoev.ru typedef struct {
720Sigor@sysoev.ru     nxt_str_t                  method;
73112Smax.romanov@nginx.com     nxt_str_t                  target;
74112Smax.romanov@nginx.com     nxt_str_t                  version;
750Sigor@sysoev.ru     nxt_str_t                  path;
7684Smax.romanov@nginx.com     nxt_str_t                  query;
7784Smax.romanov@nginx.com 
7884Smax.romanov@nginx.com     nxt_list_t                 *fields;
790Sigor@sysoev.ru 
8084Smax.romanov@nginx.com     nxt_str_t                  cookie;
8184Smax.romanov@nginx.com     nxt_str_t                  content_length;
8284Smax.romanov@nginx.com     nxt_str_t                  content_type;
8384Smax.romanov@nginx.com     nxt_str_t                  host;
8484Smax.romanov@nginx.com 
8584Smax.romanov@nginx.com     off_t                      parsed_content_length;
8684Smax.romanov@nginx.com     nxt_bool_t                 done;
870Sigor@sysoev.ru } nxt_app_request_header_t;
880Sigor@sysoev.ru 
890Sigor@sysoev.ru 
900Sigor@sysoev.ru typedef struct {
9184Smax.romanov@nginx.com     nxt_str_t                  preread;
9284Smax.romanov@nginx.com     nxt_bool_t                 done;
9384Smax.romanov@nginx.com } nxt_app_request_body_t;
940Sigor@sysoev.ru 
950Sigor@sysoev.ru 
9684Smax.romanov@nginx.com typedef struct {
970Sigor@sysoev.ru     nxt_app_request_header_t   header;
9884Smax.romanov@nginx.com     nxt_app_request_body_t     body;
99113Smax.romanov@nginx.com 
100113Smax.romanov@nginx.com     nxt_str_t                  remote;
1010Sigor@sysoev.ru } nxt_app_request_t;
1020Sigor@sysoev.ru 
1030Sigor@sysoev.ru 
104*180Smax.romanov@nginx.com typedef struct nxt_app_parse_ctx_s nxt_app_parse_ctx_t;
105163Smax.romanov@nginx.com 
106163Smax.romanov@nginx.com struct nxt_app_parse_ctx_s {
10784Smax.romanov@nginx.com     nxt_app_request_t         r;
10884Smax.romanov@nginx.com     nxt_http_request_parse_t  parser;
10984Smax.romanov@nginx.com     nxt_mp_t                  *mem_pool;
110163Smax.romanov@nginx.com };
11184Smax.romanov@nginx.com 
11284Smax.romanov@nginx.com 
11384Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_init(nxt_task_t *task, nxt_app_parse_ctx_t *ctx);
11484Smax.romanov@nginx.com 
11584Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_parse(nxt_task_t *task, nxt_app_parse_ctx_t *ctx,
11684Smax.romanov@nginx.com     nxt_buf_t *buf);
11784Smax.romanov@nginx.com 
11884Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_done(nxt_task_t *task, nxt_app_parse_ctx_t *ctx);
11984Smax.romanov@nginx.com 
12084Smax.romanov@nginx.com nxt_int_t nxt_app_http_init(nxt_task_t *task, nxt_runtime_t *rt);
12184Smax.romanov@nginx.com 
12284Smax.romanov@nginx.com 
12384Smax.romanov@nginx.com typedef struct nxt_app_wmsg_s  nxt_app_wmsg_t;
12484Smax.romanov@nginx.com typedef struct nxt_app_rmsg_s  nxt_app_rmsg_t;
12584Smax.romanov@nginx.com 
12684Smax.romanov@nginx.com struct nxt_app_wmsg_s {
12784Smax.romanov@nginx.com     nxt_port_t                 *port;  /* where prepared buf will be sent */
12884Smax.romanov@nginx.com     nxt_buf_t                  *write;
12984Smax.romanov@nginx.com     nxt_buf_t                  **buf;
13084Smax.romanov@nginx.com     uint32_t                   stream;
13184Smax.romanov@nginx.com };
13284Smax.romanov@nginx.com 
13384Smax.romanov@nginx.com struct nxt_app_rmsg_s {
13484Smax.romanov@nginx.com     nxt_buf_t                 *buf;   /* current buffer to read */
13584Smax.romanov@nginx.com };
13684Smax.romanov@nginx.com 
13784Smax.romanov@nginx.com 
13884Smax.romanov@nginx.com nxt_inline u_char *
13984Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length);
14084Smax.romanov@nginx.com 
14184Smax.romanov@nginx.com /* TODO asynchronous mmap buffer assignment */
14284Smax.romanov@nginx.com u_char *nxt_app_msg_write_get_buf(nxt_task_t *task, nxt_app_wmsg_t *msg,
14384Smax.romanov@nginx.com     size_t size);
14484Smax.romanov@nginx.com 
14584Smax.romanov@nginx.com nxt_int_t nxt_app_msg_write(nxt_task_t *task, nxt_app_wmsg_t *msg,
14684Smax.romanov@nginx.com     u_char *c, size_t size);
14784Smax.romanov@nginx.com 
14884Smax.romanov@nginx.com nxt_int_t nxt_app_msg_write_prefixed_upcase(nxt_task_t *task,
14984Smax.romanov@nginx.com     nxt_app_wmsg_t *msg, const nxt_str_t *prefix, const nxt_str_t *v);
15084Smax.romanov@nginx.com 
15184Smax.romanov@nginx.com nxt_inline nxt_int_t
15284Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
15384Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize);
15484Smax.romanov@nginx.com 
15584Smax.romanov@nginx.com 
15684Smax.romanov@nginx.com #define nxt_app_msg_write_const(task, msg, c)                                 \
15784Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (u_char *)(c), sizeof(c) - 1)
15884Smax.romanov@nginx.com 
15984Smax.romanov@nginx.com #define nxt_app_msg_write_str(task, msg, str)                                 \
16084Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (str)->start, (str)->length)
16184Smax.romanov@nginx.com 
16284Smax.romanov@nginx.com #define nxt_app_msg_write_cstr(task, msg, c)                                  \
16384Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (c), nxt_strlen(c))
16484Smax.romanov@nginx.com 
16584Smax.romanov@nginx.com #define nxt_app_msg_write_nvp(task, msg, n, v)                                \
16684Smax.romanov@nginx.com     nxt_app_msg_write_nvp_((task), (msg), (u_char *)(n), sizeof(n) - 1,       \
16784Smax.romanov@nginx.com                            (v)->start, (v)->length)
16884Smax.romanov@nginx.com 
16984Smax.romanov@nginx.com nxt_inline nxt_int_t nxt_app_msg_write_size(nxt_task_t *task,
17084Smax.romanov@nginx.com     nxt_app_wmsg_t *msg, size_t size);
17184Smax.romanov@nginx.com 
17284Smax.romanov@nginx.com nxt_int_t nxt_app_msg_flush(nxt_task_t *task, nxt_app_wmsg_t *msg,
17384Smax.romanov@nginx.com     nxt_bool_t last);
17484Smax.romanov@nginx.com 
17584Smax.romanov@nginx.com nxt_int_t nxt_app_msg_write_raw(nxt_task_t *task, nxt_app_wmsg_t *msg,
17684Smax.romanov@nginx.com     const u_char *c, size_t size);
17784Smax.romanov@nginx.com 
17884Smax.romanov@nginx.com nxt_int_t nxt_app_msg_read_str(nxt_task_t *task, nxt_app_rmsg_t *msg,
17984Smax.romanov@nginx.com     nxt_str_t *str);
18084Smax.romanov@nginx.com 
18184Smax.romanov@nginx.com nxt_int_t nxt_app_msg_read_nvp(nxt_task_t *task, nxt_app_rmsg_t *rmsg,
18284Smax.romanov@nginx.com     nxt_str_t *n, nxt_str_t *v);
18384Smax.romanov@nginx.com 
18484Smax.romanov@nginx.com nxt_int_t nxt_app_msg_read_size(nxt_task_t *task, nxt_app_rmsg_t *rmsg,
18584Smax.romanov@nginx.com     size_t *size);
18684Smax.romanov@nginx.com 
18784Smax.romanov@nginx.com 
188141Smax.romanov@nginx.com typedef struct nxt_app_module_s  nxt_application_module_t;
189141Smax.romanov@nginx.com typedef struct nxt_app_module_s  nxt_app_module_t;
190141Smax.romanov@nginx.com 
191141Smax.romanov@nginx.com struct nxt_app_module_s {
192141Smax.romanov@nginx.com     nxt_int_t                  (*init)(nxt_task_t *task,
193141Smax.romanov@nginx.com                                     nxt_common_app_conf_t *conf);
19484Smax.romanov@nginx.com     nxt_int_t                  (*prepare_msg)(nxt_task_t *task,
19584Smax.romanov@nginx.com                                     nxt_app_request_t *r,
19684Smax.romanov@nginx.com                                     nxt_app_wmsg_t *wmsg);
19784Smax.romanov@nginx.com     nxt_int_t                  (*run)(nxt_task_t *task,
19884Smax.romanov@nginx.com                                     nxt_app_rmsg_t *rmsg,
19984Smax.romanov@nginx.com                                     nxt_app_wmsg_t *wmsg);
200141Smax.romanov@nginx.com };
2010Sigor@sysoev.ru 
2020Sigor@sysoev.ru 
203141Smax.romanov@nginx.com extern nxt_application_module_t  *nxt_app_modules[NXT_APP_MAX];
20421Sigor@sysoev.ru 
2050Sigor@sysoev.ru 
2060Sigor@sysoev.ru 
20720Sigor@sysoev.ru nxt_int_t nxt_app_http_read_body(nxt_app_request_t *r, u_char *data,
20820Sigor@sysoev.ru     size_t len);
2090Sigor@sysoev.ru nxt_int_t nxt_app_write(nxt_app_request_t *r, const u_char *data, size_t len);
2100Sigor@sysoev.ru 
21184Smax.romanov@nginx.com nxt_inline u_char *
21284Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length)
21384Smax.romanov@nginx.com {
21484Smax.romanov@nginx.com     if (length < 128) {
21584Smax.romanov@nginx.com         *dst = length;
21684Smax.romanov@nginx.com         dst++;
21784Smax.romanov@nginx.com     } else {
21884Smax.romanov@nginx.com         dst[0] = 0x80U | (length >> 24);
21984Smax.romanov@nginx.com         dst[1] = 0xFFU & (length >> 16);
22084Smax.romanov@nginx.com         dst[2] = 0xFFU & (length >> 8);
22184Smax.romanov@nginx.com         dst[3] = 0xFFU & length;
22284Smax.romanov@nginx.com         dst += 4;
22384Smax.romanov@nginx.com     }
22484Smax.romanov@nginx.com 
22584Smax.romanov@nginx.com     return dst;
22684Smax.romanov@nginx.com }
22784Smax.romanov@nginx.com 
22884Smax.romanov@nginx.com 
22984Smax.romanov@nginx.com nxt_inline nxt_int_t
23084Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
23184Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize)
23284Smax.romanov@nginx.com {
23384Smax.romanov@nginx.com     nxt_int_t rc;
23484Smax.romanov@nginx.com 
23584Smax.romanov@nginx.com     rc = nxt_app_msg_write(task, msg, n, nsize);
23684Smax.romanov@nginx.com     if (nxt_slow_path(rc != NXT_OK)) {
23784Smax.romanov@nginx.com         return rc;
23884Smax.romanov@nginx.com     }
23984Smax.romanov@nginx.com 
24084Smax.romanov@nginx.com     return nxt_app_msg_write(task, msg, v, vsize);
24184Smax.romanov@nginx.com }
24284Smax.romanov@nginx.com 
24384Smax.romanov@nginx.com 
24484Smax.romanov@nginx.com nxt_inline nxt_int_t
24584Smax.romanov@nginx.com nxt_app_msg_write_size(nxt_task_t *task, nxt_app_wmsg_t *msg, size_t size)
24684Smax.romanov@nginx.com {
24784Smax.romanov@nginx.com     u_char  *dst;
24884Smax.romanov@nginx.com     size_t  dst_length;
24984Smax.romanov@nginx.com 
25084Smax.romanov@nginx.com     dst_length = size < 128 ? 1 : 4;
25184Smax.romanov@nginx.com 
25284Smax.romanov@nginx.com     dst = nxt_app_msg_write_get_buf(task, msg, dst_length);
25384Smax.romanov@nginx.com     if (nxt_slow_path(dst == NULL)) {
25484Smax.romanov@nginx.com         return NXT_ERROR;
25584Smax.romanov@nginx.com     }
25684Smax.romanov@nginx.com 
25784Smax.romanov@nginx.com     nxt_app_msg_write_length(dst, size);
25884Smax.romanov@nginx.com 
25984Smax.romanov@nginx.com     return NXT_OK;
26084Smax.romanov@nginx.com }
26184Smax.romanov@nginx.com 
26284Smax.romanov@nginx.com 
26384Smax.romanov@nginx.com nxt_inline u_char *
26484Smax.romanov@nginx.com nxt_app_msg_read_length(u_char *src, size_t *length)
26584Smax.romanov@nginx.com {
26684Smax.romanov@nginx.com     if (src[0] < 128) {
26784Smax.romanov@nginx.com         *length = src[0];
26884Smax.romanov@nginx.com         src++;
26984Smax.romanov@nginx.com     } else {
27084Smax.romanov@nginx.com         *length = ((src[0] & 0x7fU) << 24) +
27184Smax.romanov@nginx.com                   (src[1] << 16) +
27284Smax.romanov@nginx.com                   (src[2] << 8) +
27384Smax.romanov@nginx.com                   src[3];
27484Smax.romanov@nginx.com         src += 4;
27584Smax.romanov@nginx.com     }
27684Smax.romanov@nginx.com 
27784Smax.romanov@nginx.com     return src;
27884Smax.romanov@nginx.com }
27984Smax.romanov@nginx.com 
2800Sigor@sysoev.ru 
281141Smax.romanov@nginx.com nxt_app_type_t nxt_app_parse_type(nxt_str_t *str);
282141Smax.romanov@nginx.com 
2830Sigor@sysoev.ru #endif /* _NXT_APPLICATION_H_INCLIDED_ */
284