xref: /unit/src/nxt_process.h (revision 364:742e5c203c6d)
1 
2 /*
3  * Copyright (C) Igor Sysoev
4  * Copyright (C) NGINX, Inc.
5  */
6 
7 #ifndef _NXT_PROCESS_H_INCLUDED_
8 #define _NXT_PROCESS_H_INCLUDED_
9 
10 
11 typedef pid_t            nxt_pid_t;
12 typedef uid_t            nxt_uid_t;
13 typedef gid_t            nxt_gid_t;
14 
15 
16 typedef struct {
17     const char           *user;
18     nxt_uid_t            uid;
19     nxt_gid_t            base_gid;
20     nxt_uint_t           ngroups;
21     nxt_gid_t            *gids;
22 } nxt_user_cred_t;
23 
24 typedef struct nxt_process_init_s  nxt_process_init_t;
25 typedef nxt_int_t (*nxt_process_start_t)(nxt_task_t *task, void *data);
26 
27 
28 struct nxt_process_init_s {
29     nxt_process_start_t    start;
30     const char             *name;
31     nxt_user_cred_t        *user_cred;
32 
33     nxt_port_handlers_t    *port_handlers;
34     const nxt_sig_event_t  *signals;
35 
36     nxt_process_type_t     type;
37 
38     void                   *data;
39     uint32_t               stream;
40 
41     nxt_bool_t             restart;
42 };
43 
44 
45 typedef struct nxt_port_mmap_s  nxt_port_mmap_t;
46 typedef struct nxt_port_mmaps_s nxt_port_mmaps_t;
47 
48 struct nxt_port_mmaps_s {
49     nxt_thread_mutex_t  mutex;
50     uint32_t            size;
51     uint32_t            cap;
52     nxt_port_mmap_t     *elts;
53 };
54 
55 
56 typedef struct {
57     nxt_pid_t           pid;
58     nxt_queue_t         ports;      /* of nxt_port_t */
59     nxt_bool_t          ready;
60     nxt_bool_t          registered;
61     nxt_int_t           use_count;
62 
63     nxt_process_init_t  *init;
64 
65     nxt_port_mmaps_t    incoming;
66     nxt_port_mmaps_t    outgoing;
67 
68     nxt_thread_mutex_t  cp_mutex;
69     nxt_lvlhsh_t        connected_ports; /* of nxt_port_t */
70 } nxt_process_t;
71 
72 
73 NXT_EXPORT nxt_pid_t nxt_process_create(nxt_task_t *task,
74     nxt_process_t *process);
75 NXT_EXPORT nxt_pid_t nxt_process_execute(nxt_task_t *task, char *name,
76     char **argv, char **envp);
77 NXT_EXPORT nxt_int_t nxt_process_daemon(nxt_task_t *task);
78 NXT_EXPORT void nxt_nanosleep(nxt_nsec_t ns);
79 
80 NXT_EXPORT void nxt_process_arguments(nxt_task_t *task, char **orig_argv,
81     char ***orig_envp);
82 
83 #define nxt_process_port_remove(port)                                         \
84     nxt_queue_remove(&port->link)
85 
86 #define nxt_process_port_first(process)                                       \
87     nxt_queue_link_data(nxt_queue_first(&process->ports), nxt_port_t, link)
88 
89 NXT_EXPORT void nxt_process_port_add(nxt_task_t *task, nxt_process_t *process,
90     nxt_port_t *port);
91 
92 #define nxt_process_port_each(process, port)                                   \
93     nxt_queue_each(port, &process->ports, nxt_port_t, link)
94 
95 #define nxt_process_port_loop                                                 \
96     nxt_queue_loop
97 
98 void nxt_process_close_ports(nxt_task_t *task, nxt_process_t *process);
99 
100 void nxt_process_connected_port_add(nxt_process_t *process, nxt_port_t *port);
101 
102 void nxt_process_connected_port_remove(nxt_process_t *process,
103     nxt_port_t *port);
104 
105 nxt_port_t *nxt_process_connected_port_find(nxt_process_t *process,
106     nxt_pid_t pid, nxt_port_id_t port_id);
107 
108 
109 void nxt_worker_process_quit_handler(nxt_task_t *task,
110     nxt_port_recv_msg_t *msg);
111 
112 
113 #if (NXT_HAVE_SETPROCTITLE)
114 
115 #define nxt_process_title(task, fmt, ...)                                     \
116     setproctitle(fmt, __VA_ARGS__)
117 
118 #elif (NXT_LINUX || NXT_SOLARIS || NXT_MACOSX)
119 
120 #define NXT_SETPROCTITLE_ARGV  1
121 NXT_EXPORT void nxt_process_title(nxt_task_t *task, const char *fmt, ...);
122 
123 #endif
124 
125 
126 #define nxt_sched_yield()                                                     \
127     sched_yield()
128 
129 /*
130  * Solaris declares abort() as __NORETURN,
131  * raise(SIGABRT) is mostly the same.
132  */
133 
134 #define nxt_abort()                                                           \
135     (void) raise(SIGABRT)
136 
137 NXT_EXPORT nxt_int_t nxt_user_cred_get(nxt_task_t *task, nxt_user_cred_t *uc,
138     const char *group);
139 NXT_EXPORT nxt_int_t nxt_user_cred_set(nxt_task_t *task, nxt_user_cred_t *uc);
140 
141 NXT_EXPORT extern nxt_pid_t  nxt_pid;
142 NXT_EXPORT extern nxt_pid_t  nxt_ppid;
143 NXT_EXPORT extern char       **nxt_process_argv;
144 NXT_EXPORT extern char       ***nxt_process_environ;
145 
146 
147 #endif /* _NXT_PROCESS_H_INCLUDED_ */
148