xref: /unit/src/nxt_application.h (revision 1684:a10e10f3071f)
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_str_t  path;
52     nxt_str_t  module;
53     char       *callable;
54     uint32_t   threads;
55     uint32_t   thread_stack_size;
56 } nxt_python_app_conf_t;
57 
58 
59 typedef struct {
60     nxt_conf_value_t           *targets;
61     nxt_conf_value_t           *options;
62 } nxt_php_app_conf_t;
63 
64 
65 typedef struct {
66     char       *script;
67 } nxt_perl_app_conf_t;
68 
69 
70 typedef struct {
71     nxt_str_t  script;
72 } nxt_ruby_app_conf_t;
73 
74 
75 typedef struct {
76     nxt_conf_value_t           *classpath;
77     char                       *webapp;
78     nxt_conf_value_t           *options;
79     char                       *unit_jars;
80     uint32_t                   threads;
81     uint32_t                   thread_stack_size;
82 } nxt_java_app_conf_t;
83 
84 
85 struct nxt_common_app_conf_s {
86     nxt_str_t                  name;
87     nxt_str_t                  type;
88     nxt_str_t                  user;
89     nxt_str_t                  group;
90 
91     char                       *working_directory;
92     nxt_conf_value_t           *environment;
93 
94     nxt_conf_value_t           *isolation;
95     nxt_conf_value_t           *limits;
96 
97     size_t                     shm_limit;
98 
99     union {
100         nxt_external_app_conf_t  external;
101         nxt_python_app_conf_t    python;
102         nxt_php_app_conf_t       php;
103         nxt_perl_app_conf_t      perl;
104         nxt_ruby_app_conf_t      ruby;
105         nxt_java_app_conf_t      java;
106     } u;
107 
108     nxt_conf_value_t           *self;
109 };
110 
111 
112 struct nxt_app_module_s {
113     size_t                     compat_length;
114     uint32_t                   *compat;
115 
116     nxt_str_t                  type;
117     const char                 *version;
118 
119     const nxt_fs_mount_t       *mounts;
120     nxt_uint_t                 nmounts;
121 
122     nxt_application_setup_t    setup;
123     nxt_process_start_t        start;
124 };
125 
126 
127 nxt_app_lang_module_t *nxt_app_lang_module(nxt_runtime_t *rt, nxt_str_t *name);
128 nxt_app_type_t nxt_app_parse_type(u_char *p, size_t length);
129 
130 NXT_EXPORT extern nxt_str_t  nxt_server;
131 extern nxt_app_module_t      nxt_external_module;
132 
133 NXT_EXPORT nxt_int_t nxt_unit_default_init(nxt_task_t *task,
134     nxt_unit_init_t *init);
135 
136 
137 #endif /* _NXT_APPLICATION_H_INCLIDED_ */
138