xref: /unit/src/nxt_application.h (revision 510)
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_PYTHON,
14133Sigor@sysoev.ru     NXT_APP_PHP,
15133Sigor@sysoev.ru     NXT_APP_GO,
16*510Salexander.borisov@nginx.com     NXT_APP_PERL,
17141Smax.romanov@nginx.com 
18216Sigor@sysoev.ru     NXT_APP_UNKNOWN,
19133Sigor@sysoev.ru } nxt_app_type_t;
20133Sigor@sysoev.ru 
21133Sigor@sysoev.ru 
22216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_application_module_t;
23216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_app_module_t;
24216Sigor@sysoev.ru 
25216Sigor@sysoev.ru 
26216Sigor@sysoev.ru typedef struct {
27356Svbart@nginx.com     nxt_app_type_t            type;
28354Svbart@nginx.com     u_char                    *version;
29216Sigor@sysoev.ru     char                      *file;
30216Sigor@sysoev.ru     nxt_application_module_t  *module;
31216Sigor@sysoev.ru } nxt_app_lang_module_t;
32216Sigor@sysoev.ru 
33216Sigor@sysoev.ru 
34141Smax.romanov@nginx.com typedef struct nxt_common_app_conf_s nxt_common_app_conf_t;
35141Smax.romanov@nginx.com 
36141Smax.romanov@nginx.com 
37141Smax.romanov@nginx.com typedef struct {
38394Smax.romanov@nginx.com     char       *home;
39141Smax.romanov@nginx.com     nxt_str_t  path;
40141Smax.romanov@nginx.com     nxt_str_t  module;
41141Smax.romanov@nginx.com } nxt_python_app_conf_t;
42141Smax.romanov@nginx.com 
43141Smax.romanov@nginx.com 
44141Smax.romanov@nginx.com typedef struct {
45462Smax.romanov@nginx.com     char       *root;
46141Smax.romanov@nginx.com     nxt_str_t  script;
47141Smax.romanov@nginx.com     nxt_str_t  index;
48141Smax.romanov@nginx.com } nxt_php_app_conf_t;
49141Smax.romanov@nginx.com 
50141Smax.romanov@nginx.com 
51141Smax.romanov@nginx.com typedef struct {
52272Smax.romanov@nginx.com     char       *executable;
53141Smax.romanov@nginx.com } nxt_go_app_conf_t;
54141Smax.romanov@nginx.com 
55141Smax.romanov@nginx.com 
56*510Salexander.borisov@nginx.com typedef struct {
57*510Salexander.borisov@nginx.com     char       *script;
58*510Salexander.borisov@nginx.com } nxt_perl_app_conf_t;
59*510Salexander.borisov@nginx.com 
60*510Salexander.borisov@nginx.com 
61141Smax.romanov@nginx.com struct nxt_common_app_conf_s {
62174Sigor@sysoev.ru     nxt_str_t       name;
63141Smax.romanov@nginx.com     nxt_str_t       type;
64141Smax.romanov@nginx.com     nxt_str_t       user;
65141Smax.romanov@nginx.com     nxt_str_t       group;
66141Smax.romanov@nginx.com 
67271Smax.romanov@nginx.com     char       *working_directory;
68271Smax.romanov@nginx.com 
69141Smax.romanov@nginx.com     union {
70141Smax.romanov@nginx.com         nxt_python_app_conf_t  python;
71141Smax.romanov@nginx.com         nxt_php_app_conf_t     php;
72141Smax.romanov@nginx.com         nxt_go_app_conf_t      go;
73*510Salexander.borisov@nginx.com         nxt_perl_app_conf_t    perl;
74141Smax.romanov@nginx.com     } u;
75141Smax.romanov@nginx.com };
76141Smax.romanov@nginx.com 
77141Smax.romanov@nginx.com 
780Sigor@sysoev.ru typedef struct {
790Sigor@sysoev.ru     nxt_str_t                  name;
800Sigor@sysoev.ru     nxt_str_t                  value;
810Sigor@sysoev.ru } nxt_app_header_field_t;
820Sigor@sysoev.ru 
830Sigor@sysoev.ru 
840Sigor@sysoev.ru typedef struct {
850Sigor@sysoev.ru     nxt_str_t                  method;
86112Smax.romanov@nginx.com     nxt_str_t                  target;
87112Smax.romanov@nginx.com     nxt_str_t                  version;
880Sigor@sysoev.ru     nxt_str_t                  path;
8984Smax.romanov@nginx.com     nxt_str_t                  query;
9084Smax.romanov@nginx.com 
9184Smax.romanov@nginx.com     nxt_list_t                 *fields;
920Sigor@sysoev.ru 
9384Smax.romanov@nginx.com     nxt_str_t                  cookie;
9484Smax.romanov@nginx.com     nxt_str_t                  content_length;
9584Smax.romanov@nginx.com     nxt_str_t                  content_type;
9684Smax.romanov@nginx.com     nxt_str_t                  host;
9784Smax.romanov@nginx.com 
9884Smax.romanov@nginx.com     off_t                      parsed_content_length;
9984Smax.romanov@nginx.com     nxt_bool_t                 done;
100206Smax.romanov@nginx.com 
101206Smax.romanov@nginx.com     size_t                     bufs;
102206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
1030Sigor@sysoev.ru } nxt_app_request_header_t;
1040Sigor@sysoev.ru 
1050Sigor@sysoev.ru 
1060Sigor@sysoev.ru typedef struct {
107206Smax.romanov@nginx.com     size_t                     preread_size;
10884Smax.romanov@nginx.com     nxt_bool_t                 done;
109206Smax.romanov@nginx.com 
110206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
11184Smax.romanov@nginx.com } nxt_app_request_body_t;
1120Sigor@sysoev.ru 
1130Sigor@sysoev.ru 
11484Smax.romanov@nginx.com typedef struct {
1150Sigor@sysoev.ru     nxt_app_request_header_t   header;
11684Smax.romanov@nginx.com     nxt_app_request_body_t     body;
117113Smax.romanov@nginx.com 
118113Smax.romanov@nginx.com     nxt_str_t                  remote;
119268Sigor@sysoev.ru     nxt_str_t                  local;
1200Sigor@sysoev.ru } nxt_app_request_t;
1210Sigor@sysoev.ru 
1220Sigor@sysoev.ru 
123431Sigor@sysoev.ru typedef struct nxt_app_parse_ctx_s  nxt_app_parse_ctx_t;
124163Smax.romanov@nginx.com 
125163Smax.romanov@nginx.com struct nxt_app_parse_ctx_s {
12684Smax.romanov@nginx.com     nxt_app_request_t         r;
127431Sigor@sysoev.ru     nxt_http_request_t        *request;
128431Sigor@sysoev.ru     nxt_timer_t               timer;
12984Smax.romanov@nginx.com     nxt_http_request_parse_t  parser;
130431Sigor@sysoev.ru     nxt_http_request_parse_t  resp_parser;
13184Smax.romanov@nginx.com     nxt_mp_t                  *mem_pool;
132163Smax.romanov@nginx.com };
13384Smax.romanov@nginx.com 
13484Smax.romanov@nginx.com 
13584Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_done(nxt_task_t *task, nxt_app_parse_ctx_t *ctx);
13684Smax.romanov@nginx.com 
13784Smax.romanov@nginx.com 
13884Smax.romanov@nginx.com typedef struct nxt_app_wmsg_s  nxt_app_wmsg_t;
13984Smax.romanov@nginx.com typedef struct nxt_app_rmsg_s  nxt_app_rmsg_t;
14084Smax.romanov@nginx.com 
14184Smax.romanov@nginx.com struct nxt_app_wmsg_s {
14284Smax.romanov@nginx.com     nxt_port_t                 *port;  /* where prepared buf will be sent */
14384Smax.romanov@nginx.com     nxt_buf_t                  *write;
14484Smax.romanov@nginx.com     nxt_buf_t                  **buf;
14584Smax.romanov@nginx.com     uint32_t                   stream;
14684Smax.romanov@nginx.com };
14784Smax.romanov@nginx.com 
14884Smax.romanov@nginx.com struct nxt_app_rmsg_s {
14984Smax.romanov@nginx.com     nxt_buf_t                 *buf;   /* current buffer to read */
15084Smax.romanov@nginx.com };
15184Smax.romanov@nginx.com 
15284Smax.romanov@nginx.com 
15384Smax.romanov@nginx.com nxt_inline u_char *
15484Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length);
15584Smax.romanov@nginx.com 
15684Smax.romanov@nginx.com /* TODO asynchronous mmap buffer assignment */
157216Sigor@sysoev.ru NXT_EXPORT u_char *nxt_app_msg_write_get_buf(nxt_task_t *task,
158216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, size_t size);
15984Smax.romanov@nginx.com 
160216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write(nxt_task_t *task, nxt_app_wmsg_t *msg,
16184Smax.romanov@nginx.com     u_char *c, size_t size);
16284Smax.romanov@nginx.com 
163216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_prefixed_upcase(nxt_task_t *task,
164417Svbart@nginx.com     nxt_app_wmsg_t *msg, const nxt_str_t *prefix, u_char *c, size_t size);
16584Smax.romanov@nginx.com 
16684Smax.romanov@nginx.com nxt_inline nxt_int_t
16784Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
16884Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize);
16984Smax.romanov@nginx.com 
17084Smax.romanov@nginx.com 
17184Smax.romanov@nginx.com #define nxt_app_msg_write_const(task, msg, c)                                 \
17284Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (u_char *)(c), sizeof(c) - 1)
17384Smax.romanov@nginx.com 
17484Smax.romanov@nginx.com #define nxt_app_msg_write_str(task, msg, str)                                 \
17584Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (str)->start, (str)->length)
17684Smax.romanov@nginx.com 
17784Smax.romanov@nginx.com #define nxt_app_msg_write_cstr(task, msg, c)                                  \
17884Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (c), nxt_strlen(c))
17984Smax.romanov@nginx.com 
18084Smax.romanov@nginx.com #define nxt_app_msg_write_nvp(task, msg, n, v)                                \
18184Smax.romanov@nginx.com     nxt_app_msg_write_nvp_((task), (msg), (u_char *)(n), sizeof(n) - 1,       \
18284Smax.romanov@nginx.com                            (v)->start, (v)->length)
18384Smax.romanov@nginx.com 
18484Smax.romanov@nginx.com nxt_inline nxt_int_t nxt_app_msg_write_size(nxt_task_t *task,
18584Smax.romanov@nginx.com     nxt_app_wmsg_t *msg, size_t size);
18684Smax.romanov@nginx.com 
187216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_flush(nxt_task_t *task, nxt_app_wmsg_t *msg,
18884Smax.romanov@nginx.com     nxt_bool_t last);
18984Smax.romanov@nginx.com 
190216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_raw(nxt_task_t *task,
191216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, const u_char *c, size_t size);
19284Smax.romanov@nginx.com 
193216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_str(nxt_task_t *task, nxt_app_rmsg_t *msg,
19484Smax.romanov@nginx.com     nxt_str_t *str);
19584Smax.romanov@nginx.com 
196216Sigor@sysoev.ru NXT_EXPORT size_t nxt_app_msg_read_raw(nxt_task_t *task,
197216Sigor@sysoev.ru     nxt_app_rmsg_t *msg, void *buf, size_t size);
198206Smax.romanov@nginx.com 
199216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_nvp(nxt_task_t *task,
200216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, nxt_str_t *n, nxt_str_t *v);
20184Smax.romanov@nginx.com 
202216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_size(nxt_task_t *task,
203216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, size_t *size);
20484Smax.romanov@nginx.com 
20584Smax.romanov@nginx.com 
206216Sigor@sysoev.ru struct nxt_app_module_s {
207258Sigor@sysoev.ru     size_t                     compat_length;
208258Sigor@sysoev.ru     uint32_t                   *compat;
209258Sigor@sysoev.ru 
210216Sigor@sysoev.ru     nxt_str_t                  type;
211216Sigor@sysoev.ru     nxt_str_t                  version;
212141Smax.romanov@nginx.com 
213141Smax.romanov@nginx.com     nxt_int_t                  (*init)(nxt_task_t *task,
214141Smax.romanov@nginx.com                                     nxt_common_app_conf_t *conf);
21584Smax.romanov@nginx.com     nxt_int_t                  (*run)(nxt_task_t *task,
21684Smax.romanov@nginx.com                                     nxt_app_rmsg_t *rmsg,
21784Smax.romanov@nginx.com                                     nxt_app_wmsg_t *wmsg);
218421Smax.romanov@nginx.com     void                       (*atexit)(nxt_task_t *task);
219141Smax.romanov@nginx.com };
2200Sigor@sysoev.ru 
2210Sigor@sysoev.ru 
22220Sigor@sysoev.ru nxt_int_t nxt_app_http_read_body(nxt_app_request_t *r, u_char *data,
22320Sigor@sysoev.ru     size_t len);
2240Sigor@sysoev.ru nxt_int_t nxt_app_write(nxt_app_request_t *r, const u_char *data, size_t len);
2250Sigor@sysoev.ru 
22684Smax.romanov@nginx.com nxt_inline u_char *
22784Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length)
22884Smax.romanov@nginx.com {
22984Smax.romanov@nginx.com     if (length < 128) {
23084Smax.romanov@nginx.com         *dst = length;
23184Smax.romanov@nginx.com         dst++;
232277Sigor@sysoev.ru 
23384Smax.romanov@nginx.com     } else {
23484Smax.romanov@nginx.com         dst[0] = 0x80U | (length >> 24);
23584Smax.romanov@nginx.com         dst[1] = 0xFFU & (length >> 16);
23684Smax.romanov@nginx.com         dst[2] = 0xFFU & (length >> 8);
23784Smax.romanov@nginx.com         dst[3] = 0xFFU & length;
23884Smax.romanov@nginx.com         dst += 4;
23984Smax.romanov@nginx.com     }
24084Smax.romanov@nginx.com 
24184Smax.romanov@nginx.com     return dst;
24284Smax.romanov@nginx.com }
24384Smax.romanov@nginx.com 
24484Smax.romanov@nginx.com 
24584Smax.romanov@nginx.com nxt_inline nxt_int_t
24684Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
24784Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize)
24884Smax.romanov@nginx.com {
24984Smax.romanov@nginx.com     nxt_int_t rc;
25084Smax.romanov@nginx.com 
25184Smax.romanov@nginx.com     rc = nxt_app_msg_write(task, msg, n, nsize);
25284Smax.romanov@nginx.com     if (nxt_slow_path(rc != NXT_OK)) {
25384Smax.romanov@nginx.com         return rc;
25484Smax.romanov@nginx.com     }
25584Smax.romanov@nginx.com 
25684Smax.romanov@nginx.com     return nxt_app_msg_write(task, msg, v, vsize);
25784Smax.romanov@nginx.com }
25884Smax.romanov@nginx.com 
25984Smax.romanov@nginx.com 
26084Smax.romanov@nginx.com nxt_inline nxt_int_t
26184Smax.romanov@nginx.com nxt_app_msg_write_size(nxt_task_t *task, nxt_app_wmsg_t *msg, size_t size)
26284Smax.romanov@nginx.com {
26384Smax.romanov@nginx.com     u_char  *dst;
26484Smax.romanov@nginx.com     size_t  dst_length;
26584Smax.romanov@nginx.com 
26684Smax.romanov@nginx.com     dst_length = size < 128 ? 1 : 4;
26784Smax.romanov@nginx.com 
26884Smax.romanov@nginx.com     dst = nxt_app_msg_write_get_buf(task, msg, dst_length);
26984Smax.romanov@nginx.com     if (nxt_slow_path(dst == NULL)) {
27084Smax.romanov@nginx.com         return NXT_ERROR;
27184Smax.romanov@nginx.com     }
27284Smax.romanov@nginx.com 
27384Smax.romanov@nginx.com     nxt_app_msg_write_length(dst, size);
27484Smax.romanov@nginx.com 
27584Smax.romanov@nginx.com     return NXT_OK;
27684Smax.romanov@nginx.com }
27784Smax.romanov@nginx.com 
27884Smax.romanov@nginx.com 
27984Smax.romanov@nginx.com nxt_inline u_char *
28084Smax.romanov@nginx.com nxt_app_msg_read_length(u_char *src, size_t *length)
28184Smax.romanov@nginx.com {
28284Smax.romanov@nginx.com     if (src[0] < 128) {
28384Smax.romanov@nginx.com         *length = src[0];
28484Smax.romanov@nginx.com         src++;
285277Sigor@sysoev.ru 
28684Smax.romanov@nginx.com     } else {
28784Smax.romanov@nginx.com         *length = ((src[0] & 0x7fU) << 24) +
28884Smax.romanov@nginx.com                   (src[1] << 16) +
28984Smax.romanov@nginx.com                   (src[2] << 8) +
29084Smax.romanov@nginx.com                   src[3];
29184Smax.romanov@nginx.com         src += 4;
29284Smax.romanov@nginx.com     }
29384Smax.romanov@nginx.com 
29484Smax.romanov@nginx.com     return src;
29584Smax.romanov@nginx.com }
29684Smax.romanov@nginx.com 
2970Sigor@sysoev.ru 
298216Sigor@sysoev.ru nxt_app_lang_module_t *nxt_app_lang_module(nxt_runtime_t *rt, nxt_str_t *name);
299*510Salexander.borisov@nginx.com nxt_app_type_t nxt_app_parse_type(u_char *p, size_t length);
300216Sigor@sysoev.ru 
301216Sigor@sysoev.ru extern nxt_application_module_t  nxt_go_module;
302216Sigor@sysoev.ru 
303216Sigor@sysoev.ru 
3040Sigor@sysoev.ru #endif /* _NXT_APPLICATION_H_INCLIDED_ */
305