xref: /unit/src/nxt_application.h (revision 611)
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,
16510Salexander.borisov@nginx.com     NXT_APP_PERL,
17584Salexander.borisov@nginx.com     NXT_APP_RUBY,
18141Smax.romanov@nginx.com 
19216Sigor@sysoev.ru     NXT_APP_UNKNOWN,
20133Sigor@sysoev.ru } nxt_app_type_t;
21133Sigor@sysoev.ru 
22133Sigor@sysoev.ru 
23216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_application_module_t;
24216Sigor@sysoev.ru typedef struct nxt_app_module_s  nxt_app_module_t;
25216Sigor@sysoev.ru 
26216Sigor@sysoev.ru 
27216Sigor@sysoev.ru typedef struct {
28356Svbart@nginx.com     nxt_app_type_t            type;
29354Svbart@nginx.com     u_char                    *version;
30216Sigor@sysoev.ru     char                      *file;
31216Sigor@sysoev.ru     nxt_application_module_t  *module;
32216Sigor@sysoev.ru } nxt_app_lang_module_t;
33216Sigor@sysoev.ru 
34216Sigor@sysoev.ru 
35141Smax.romanov@nginx.com typedef struct nxt_common_app_conf_s nxt_common_app_conf_t;
36141Smax.romanov@nginx.com 
37141Smax.romanov@nginx.com 
38141Smax.romanov@nginx.com typedef struct {
39394Smax.romanov@nginx.com     char       *home;
40141Smax.romanov@nginx.com     nxt_str_t  path;
41141Smax.romanov@nginx.com     nxt_str_t  module;
42141Smax.romanov@nginx.com } nxt_python_app_conf_t;
43141Smax.romanov@nginx.com 
44141Smax.romanov@nginx.com 
45141Smax.romanov@nginx.com typedef struct {
46462Smax.romanov@nginx.com     char       *root;
47141Smax.romanov@nginx.com     nxt_str_t  script;
48141Smax.romanov@nginx.com     nxt_str_t  index;
49141Smax.romanov@nginx.com } nxt_php_app_conf_t;
50141Smax.romanov@nginx.com 
51141Smax.romanov@nginx.com 
52141Smax.romanov@nginx.com typedef struct {
53272Smax.romanov@nginx.com     char       *executable;
54141Smax.romanov@nginx.com } nxt_go_app_conf_t;
55141Smax.romanov@nginx.com 
56141Smax.romanov@nginx.com 
57510Salexander.borisov@nginx.com typedef struct {
58510Salexander.borisov@nginx.com     char       *script;
59510Salexander.borisov@nginx.com } nxt_perl_app_conf_t;
60510Salexander.borisov@nginx.com 
61510Salexander.borisov@nginx.com 
62584Salexander.borisov@nginx.com typedef struct {
63584Salexander.borisov@nginx.com     nxt_str_t  script;
64584Salexander.borisov@nginx.com } nxt_ruby_app_conf_t;
65584Salexander.borisov@nginx.com 
66584Salexander.borisov@nginx.com 
67141Smax.romanov@nginx.com struct nxt_common_app_conf_s {
68174Sigor@sysoev.ru     nxt_str_t       name;
69141Smax.romanov@nginx.com     nxt_str_t       type;
70141Smax.romanov@nginx.com     nxt_str_t       user;
71141Smax.romanov@nginx.com     nxt_str_t       group;
72141Smax.romanov@nginx.com 
73271Smax.romanov@nginx.com     char       *working_directory;
74271Smax.romanov@nginx.com 
75141Smax.romanov@nginx.com     union {
76141Smax.romanov@nginx.com         nxt_python_app_conf_t  python;
77141Smax.romanov@nginx.com         nxt_php_app_conf_t     php;
78141Smax.romanov@nginx.com         nxt_go_app_conf_t      go;
79510Salexander.borisov@nginx.com         nxt_perl_app_conf_t    perl;
80584Salexander.borisov@nginx.com         nxt_ruby_app_conf_t    ruby;
81141Smax.romanov@nginx.com     } u;
82141Smax.romanov@nginx.com };
83141Smax.romanov@nginx.com 
84141Smax.romanov@nginx.com 
850Sigor@sysoev.ru typedef struct {
860Sigor@sysoev.ru     nxt_str_t                  name;
870Sigor@sysoev.ru     nxt_str_t                  value;
880Sigor@sysoev.ru } nxt_app_header_field_t;
890Sigor@sysoev.ru 
900Sigor@sysoev.ru 
910Sigor@sysoev.ru typedef struct {
920Sigor@sysoev.ru     nxt_str_t                  method;
93112Smax.romanov@nginx.com     nxt_str_t                  target;
94112Smax.romanov@nginx.com     nxt_str_t                  version;
950Sigor@sysoev.ru     nxt_str_t                  path;
9684Smax.romanov@nginx.com     nxt_str_t                  query;
9784Smax.romanov@nginx.com 
9884Smax.romanov@nginx.com     nxt_list_t                 *fields;
990Sigor@sysoev.ru 
10084Smax.romanov@nginx.com     nxt_str_t                  cookie;
10184Smax.romanov@nginx.com     nxt_str_t                  content_length;
10284Smax.romanov@nginx.com     nxt_str_t                  content_type;
10384Smax.romanov@nginx.com     nxt_str_t                  host;
10484Smax.romanov@nginx.com 
10584Smax.romanov@nginx.com     off_t                      parsed_content_length;
10684Smax.romanov@nginx.com     nxt_bool_t                 done;
107206Smax.romanov@nginx.com 
108206Smax.romanov@nginx.com     size_t                     bufs;
109206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
1100Sigor@sysoev.ru } nxt_app_request_header_t;
1110Sigor@sysoev.ru 
1120Sigor@sysoev.ru 
1130Sigor@sysoev.ru typedef struct {
114206Smax.romanov@nginx.com     size_t                     preread_size;
11584Smax.romanov@nginx.com     nxt_bool_t                 done;
116206Smax.romanov@nginx.com 
117206Smax.romanov@nginx.com     nxt_buf_t                  *buf;
11884Smax.romanov@nginx.com } nxt_app_request_body_t;
1190Sigor@sysoev.ru 
1200Sigor@sysoev.ru 
12184Smax.romanov@nginx.com typedef struct {
1220Sigor@sysoev.ru     nxt_app_request_header_t   header;
12384Smax.romanov@nginx.com     nxt_app_request_body_t     body;
124113Smax.romanov@nginx.com 
125113Smax.romanov@nginx.com     nxt_str_t                  remote;
126268Sigor@sysoev.ru     nxt_str_t                  local;
1270Sigor@sysoev.ru } nxt_app_request_t;
1280Sigor@sysoev.ru 
1290Sigor@sysoev.ru 
130431Sigor@sysoev.ru typedef struct nxt_app_parse_ctx_s  nxt_app_parse_ctx_t;
131163Smax.romanov@nginx.com 
132163Smax.romanov@nginx.com struct nxt_app_parse_ctx_s {
13384Smax.romanov@nginx.com     nxt_app_request_t         r;
134431Sigor@sysoev.ru     nxt_http_request_t        *request;
135431Sigor@sysoev.ru     nxt_timer_t               timer;
13684Smax.romanov@nginx.com     nxt_http_request_parse_t  parser;
137431Sigor@sysoev.ru     nxt_http_request_parse_t  resp_parser;
13884Smax.romanov@nginx.com     nxt_mp_t                  *mem_pool;
139163Smax.romanov@nginx.com };
14084Smax.romanov@nginx.com 
14184Smax.romanov@nginx.com 
14284Smax.romanov@nginx.com nxt_int_t nxt_app_http_req_done(nxt_task_t *task, nxt_app_parse_ctx_t *ctx);
14384Smax.romanov@nginx.com 
14484Smax.romanov@nginx.com 
14584Smax.romanov@nginx.com typedef struct nxt_app_wmsg_s  nxt_app_wmsg_t;
14684Smax.romanov@nginx.com typedef struct nxt_app_rmsg_s  nxt_app_rmsg_t;
14784Smax.romanov@nginx.com 
14884Smax.romanov@nginx.com struct nxt_app_wmsg_s {
14984Smax.romanov@nginx.com     nxt_port_t                 *port;  /* where prepared buf will be sent */
15084Smax.romanov@nginx.com     nxt_buf_t                  *write;
15184Smax.romanov@nginx.com     nxt_buf_t                  **buf;
15284Smax.romanov@nginx.com     uint32_t                   stream;
15384Smax.romanov@nginx.com };
15484Smax.romanov@nginx.com 
155584Salexander.borisov@nginx.com 
15684Smax.romanov@nginx.com struct nxt_app_rmsg_s {
157584Salexander.borisov@nginx.com     nxt_buf_t                  *buf;   /* current buffer to read */
15884Smax.romanov@nginx.com };
15984Smax.romanov@nginx.com 
16084Smax.romanov@nginx.com 
16184Smax.romanov@nginx.com nxt_inline u_char *
16284Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length);
16384Smax.romanov@nginx.com 
16484Smax.romanov@nginx.com /* TODO asynchronous mmap buffer assignment */
165216Sigor@sysoev.ru NXT_EXPORT u_char *nxt_app_msg_write_get_buf(nxt_task_t *task,
166216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, size_t size);
16784Smax.romanov@nginx.com 
168216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write(nxt_task_t *task, nxt_app_wmsg_t *msg,
16984Smax.romanov@nginx.com     u_char *c, size_t size);
17084Smax.romanov@nginx.com 
171216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_prefixed_upcase(nxt_task_t *task,
172417Svbart@nginx.com     nxt_app_wmsg_t *msg, const nxt_str_t *prefix, u_char *c, size_t size);
17384Smax.romanov@nginx.com 
17484Smax.romanov@nginx.com nxt_inline nxt_int_t
17584Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
17684Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize);
17784Smax.romanov@nginx.com 
17884Smax.romanov@nginx.com 
17984Smax.romanov@nginx.com #define nxt_app_msg_write_const(task, msg, c)                                 \
18084Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (u_char *)(c), sizeof(c) - 1)
18184Smax.romanov@nginx.com 
18284Smax.romanov@nginx.com #define nxt_app_msg_write_str(task, msg, str)                                 \
18384Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (str)->start, (str)->length)
18484Smax.romanov@nginx.com 
18584Smax.romanov@nginx.com #define nxt_app_msg_write_cstr(task, msg, c)                                  \
18684Smax.romanov@nginx.com     nxt_app_msg_write((task), (msg), (c), nxt_strlen(c))
18784Smax.romanov@nginx.com 
18884Smax.romanov@nginx.com #define nxt_app_msg_write_nvp(task, msg, n, v)                                \
18984Smax.romanov@nginx.com     nxt_app_msg_write_nvp_((task), (msg), (u_char *)(n), sizeof(n) - 1,       \
19084Smax.romanov@nginx.com                            (v)->start, (v)->length)
19184Smax.romanov@nginx.com 
19284Smax.romanov@nginx.com nxt_inline nxt_int_t nxt_app_msg_write_size(nxt_task_t *task,
19384Smax.romanov@nginx.com     nxt_app_wmsg_t *msg, size_t size);
19484Smax.romanov@nginx.com 
195216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_flush(nxt_task_t *task, nxt_app_wmsg_t *msg,
19684Smax.romanov@nginx.com     nxt_bool_t last);
19784Smax.romanov@nginx.com 
198216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_write_raw(nxt_task_t *task,
199216Sigor@sysoev.ru     nxt_app_wmsg_t *msg, const u_char *c, size_t size);
20084Smax.romanov@nginx.com 
201216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_str(nxt_task_t *task, nxt_app_rmsg_t *msg,
20284Smax.romanov@nginx.com     nxt_str_t *str);
20384Smax.romanov@nginx.com 
204216Sigor@sysoev.ru NXT_EXPORT size_t nxt_app_msg_read_raw(nxt_task_t *task,
205216Sigor@sysoev.ru     nxt_app_rmsg_t *msg, void *buf, size_t size);
206206Smax.romanov@nginx.com 
207216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_nvp(nxt_task_t *task,
208216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, nxt_str_t *n, nxt_str_t *v);
20984Smax.romanov@nginx.com 
210216Sigor@sysoev.ru NXT_EXPORT nxt_int_t nxt_app_msg_read_size(nxt_task_t *task,
211216Sigor@sysoev.ru     nxt_app_rmsg_t *rmsg, size_t *size);
21284Smax.romanov@nginx.com 
21384Smax.romanov@nginx.com 
214216Sigor@sysoev.ru struct nxt_app_module_s {
215258Sigor@sysoev.ru     size_t                     compat_length;
216258Sigor@sysoev.ru     uint32_t                   *compat;
217258Sigor@sysoev.ru 
218216Sigor@sysoev.ru     nxt_str_t                  type;
219216Sigor@sysoev.ru     nxt_str_t                  version;
220141Smax.romanov@nginx.com 
221141Smax.romanov@nginx.com     nxt_int_t                  (*init)(nxt_task_t *task,
222141Smax.romanov@nginx.com                                     nxt_common_app_conf_t *conf);
22384Smax.romanov@nginx.com     nxt_int_t                  (*run)(nxt_task_t *task,
22484Smax.romanov@nginx.com                                     nxt_app_rmsg_t *rmsg,
22584Smax.romanov@nginx.com                                     nxt_app_wmsg_t *wmsg);
226421Smax.romanov@nginx.com     void                       (*atexit)(nxt_task_t *task);
227141Smax.romanov@nginx.com };
2280Sigor@sysoev.ru 
2290Sigor@sysoev.ru 
23020Sigor@sysoev.ru nxt_int_t nxt_app_http_read_body(nxt_app_request_t *r, u_char *data,
23120Sigor@sysoev.ru     size_t len);
2320Sigor@sysoev.ru nxt_int_t nxt_app_write(nxt_app_request_t *r, const u_char *data, size_t len);
2330Sigor@sysoev.ru 
23484Smax.romanov@nginx.com nxt_inline u_char *
23584Smax.romanov@nginx.com nxt_app_msg_write_length(u_char *dst, size_t length)
23684Smax.romanov@nginx.com {
23784Smax.romanov@nginx.com     if (length < 128) {
23884Smax.romanov@nginx.com         *dst = length;
23984Smax.romanov@nginx.com         dst++;
240277Sigor@sysoev.ru 
24184Smax.romanov@nginx.com     } else {
24284Smax.romanov@nginx.com         dst[0] = 0x80U | (length >> 24);
24384Smax.romanov@nginx.com         dst[1] = 0xFFU & (length >> 16);
24484Smax.romanov@nginx.com         dst[2] = 0xFFU & (length >> 8);
24584Smax.romanov@nginx.com         dst[3] = 0xFFU & length;
24684Smax.romanov@nginx.com         dst += 4;
24784Smax.romanov@nginx.com     }
24884Smax.romanov@nginx.com 
24984Smax.romanov@nginx.com     return dst;
25084Smax.romanov@nginx.com }
25184Smax.romanov@nginx.com 
25284Smax.romanov@nginx.com 
25384Smax.romanov@nginx.com nxt_inline nxt_int_t
25484Smax.romanov@nginx.com nxt_app_msg_write_nvp_(nxt_task_t *task, nxt_app_wmsg_t *msg,
25584Smax.romanov@nginx.com     u_char *n, size_t nsize, u_char *v, size_t vsize)
25684Smax.romanov@nginx.com {
25784Smax.romanov@nginx.com     nxt_int_t rc;
25884Smax.romanov@nginx.com 
25984Smax.romanov@nginx.com     rc = nxt_app_msg_write(task, msg, n, nsize);
26084Smax.romanov@nginx.com     if (nxt_slow_path(rc != NXT_OK)) {
26184Smax.romanov@nginx.com         return rc;
26284Smax.romanov@nginx.com     }
26384Smax.romanov@nginx.com 
26484Smax.romanov@nginx.com     return nxt_app_msg_write(task, msg, v, vsize);
26584Smax.romanov@nginx.com }
26684Smax.romanov@nginx.com 
26784Smax.romanov@nginx.com 
26884Smax.romanov@nginx.com nxt_inline nxt_int_t
26984Smax.romanov@nginx.com nxt_app_msg_write_size(nxt_task_t *task, nxt_app_wmsg_t *msg, size_t size)
27084Smax.romanov@nginx.com {
27184Smax.romanov@nginx.com     u_char  *dst;
27284Smax.romanov@nginx.com     size_t  dst_length;
27384Smax.romanov@nginx.com 
27484Smax.romanov@nginx.com     dst_length = size < 128 ? 1 : 4;
27584Smax.romanov@nginx.com 
27684Smax.romanov@nginx.com     dst = nxt_app_msg_write_get_buf(task, msg, dst_length);
27784Smax.romanov@nginx.com     if (nxt_slow_path(dst == NULL)) {
27884Smax.romanov@nginx.com         return NXT_ERROR;
27984Smax.romanov@nginx.com     }
28084Smax.romanov@nginx.com 
28184Smax.romanov@nginx.com     nxt_app_msg_write_length(dst, size);
28284Smax.romanov@nginx.com 
28384Smax.romanov@nginx.com     return NXT_OK;
28484Smax.romanov@nginx.com }
28584Smax.romanov@nginx.com 
28684Smax.romanov@nginx.com 
28784Smax.romanov@nginx.com nxt_inline u_char *
28884Smax.romanov@nginx.com nxt_app_msg_read_length(u_char *src, size_t *length)
28984Smax.romanov@nginx.com {
29084Smax.romanov@nginx.com     if (src[0] < 128) {
29184Smax.romanov@nginx.com         *length = src[0];
29284Smax.romanov@nginx.com         src++;
293277Sigor@sysoev.ru 
29484Smax.romanov@nginx.com     } else {
295*611Svbart@nginx.com         *length = ((src[0] & 0x7FU) << 24) +
29684Smax.romanov@nginx.com                   (src[1] << 16) +
29784Smax.romanov@nginx.com                   (src[2] << 8) +
29884Smax.romanov@nginx.com                   src[3];
29984Smax.romanov@nginx.com         src += 4;
30084Smax.romanov@nginx.com     }
30184Smax.romanov@nginx.com 
30284Smax.romanov@nginx.com     return src;
30384Smax.romanov@nginx.com }
30484Smax.romanov@nginx.com 
3050Sigor@sysoev.ru 
306216Sigor@sysoev.ru nxt_app_lang_module_t *nxt_app_lang_module(nxt_runtime_t *rt, nxt_str_t *name);
307510Salexander.borisov@nginx.com nxt_app_type_t nxt_app_parse_type(u_char *p, size_t length);
308216Sigor@sysoev.ru 
309216Sigor@sysoev.ru extern nxt_application_module_t  nxt_go_module;
310216Sigor@sysoev.ru 
311216Sigor@sysoev.ru 
3120Sigor@sysoev.ru #endif /* _NXT_APPLICATION_H_INCLIDED_ */
313