xref: /unit/src/nxt_application.h (revision 2014:f8a0992944df)
1 
2 /*
3  * Copyright (C) Max Romanov
4  * Copyright (C) Valentin V. Bartenev
5  * Copyright (C) NGINX, Inc.
6  */
7 
8 #ifndef _NXT_APPLICATION_H_INCLUDED_
9 #define _NXT_APPLICATION_H_INCLUDED_
10 
11 
12 #include <nxt_conf.h>
13 
14 #include <nxt_unit_typedefs.h>
15 
16 
17 typedef enum {
18     NXT_APP_EXTERNAL,
19     NXT_APP_PYTHON,
20     NXT_APP_PHP,
21     NXT_APP_PERL,
22     NXT_APP_RUBY,
23     NXT_APP_JAVA,
24 
25     NXT_APP_UNKNOWN,
26 } nxt_app_type_t;
27 
28 
29 typedef struct nxt_app_module_s  nxt_app_module_t;
30 typedef nxt_int_t (*nxt_application_setup_t)(nxt_task_t *task,
31     nxt_process_t *process, nxt_common_app_conf_t *conf);
32 
33 
34 typedef struct {
35     nxt_app_type_t            type;
36     u_char                    *version;
37     char                      *file;
38     nxt_app_module_t          *module;
39     nxt_array_t               *mounts;    /* of nxt_fs_mount_t */
40 } nxt_app_lang_module_t;
41 
42 
43 typedef struct {
44     char                       *executable;
45     nxt_conf_value_t           *arguments;
46 } nxt_external_app_conf_t;
47 
48 
49 typedef struct {
50     char                       *home;
51     nxt_conf_value_t           *path;
52     nxt_str_t                  module;
53     char                       *callable;
54     nxt_str_t                  protocol;
55     uint32_t                   threads;
56     uint32_t                   thread_stack_size;
57     nxt_conf_value_t           *targets;
58 } nxt_python_app_conf_t;
59 
60 
61 typedef struct {
62     nxt_conf_value_t           *targets;
63     nxt_conf_value_t           *options;
64 } nxt_php_app_conf_t;
65 
66 
67 typedef struct {
68     char       *script;
69     uint32_t   threads;
70     uint32_t   thread_stack_size;
71 } nxt_perl_app_conf_t;
72 
73 
74 typedef struct {
75     nxt_str_t  script;
76     uint32_t   threads;
77     nxt_str_t  hooks;
78 } nxt_ruby_app_conf_t;
79 
80 
81 typedef struct {
82     nxt_conf_value_t           *classpath;
83     char                       *webapp;
84     nxt_conf_value_t           *options;
85     char                       *unit_jars;
86     uint32_t                   threads;
87     uint32_t                   thread_stack_size;
88 } nxt_java_app_conf_t;
89 
90 
91 struct nxt_common_app_conf_s {
92     nxt_str_t                  name;
93     nxt_str_t                  type;
94     nxt_str_t                  user;
95     nxt_str_t                  group;
96 
97     char                       *working_directory;
98     nxt_conf_value_t           *environment;
99 
100     nxt_conf_value_t           *isolation;
101     nxt_conf_value_t           *limits;
102 
103     size_t                     shm_limit;
104     uint32_t                   request_limit;
105 
106     nxt_fd_t                   shared_port_fd;
107     nxt_fd_t                   shared_queue_fd;
108 
109     union {
110         nxt_external_app_conf_t  external;
111         nxt_python_app_conf_t    python;
112         nxt_php_app_conf_t       php;
113         nxt_perl_app_conf_t      perl;
114         nxt_ruby_app_conf_t      ruby;
115         nxt_java_app_conf_t      java;
116     } u;
117 
118     nxt_conf_value_t           *self;
119 };
120 
121 
122 struct nxt_app_module_s {
123     size_t                     compat_length;
124     uint32_t                   *compat;
125 
126     nxt_str_t                  type;
127     const char                 *version;
128 
129     const nxt_fs_mount_t       *mounts;
130     nxt_uint_t                 nmounts;
131 
132     nxt_application_setup_t    setup;
133     nxt_process_start_t        start;
134 };
135 
136 
137 nxt_app_lang_module_t *nxt_app_lang_module(nxt_runtime_t *rt, nxt_str_t *name);
138 nxt_app_type_t nxt_app_parse_type(u_char *p, size_t length);
139 
140 NXT_EXPORT extern nxt_str_t  nxt_server;
141 extern nxt_app_module_t      nxt_external_module;
142 
143 NXT_EXPORT nxt_int_t nxt_unit_default_init(nxt_task_t *task,
144     nxt_unit_init_t *init, nxt_common_app_conf_t *conf);
145 
146 
147 #endif /* _NXT_APPLICATION_H_INCLIDED_ */
148