0e798a00257235922c276f690ef8138e01098aa0
[openwrt.git] / package / system / procd / files / procd.sh
1 # procd API:
2 #
3 # procd_open_service(name, [script]):
4 #   Initialize a new procd command message containing a service with one or more instances
5 #
6 # procd_close_service()
7 #   Send the command message for the service
8 #
9 # procd_open_instance([name]):
10 #   Add an instance to the service described by the previous procd_open_service call
11 #
12 # procd_set_param(type, [value...])
13 #   Available types:
14 #     command: command line (array).
15 #     respawn info: array with 3 values $restart_timeout $fail_hreshold $max_fail
16 #     env: environment variable (passed to the process)
17 #     data: arbitrary name/value pairs for detecting config changes (table)
18 #     file: configuration files (array)
19 #     netdev: bound network device (detects ifindex changes)
20 #     limits: resource limits (passed to the process)
21 #     user info: array with 1 values $username
22 #
23 #   No space separation is done for arrays/tables - use one function argument per command line argument
24 #
25 # procd_close_instance():
26 #   Complete the instance being prepared
27 #
28 # procd_kill(service, [instance]):
29 #   Kill a service instance (or all instances)
30 #
31
32 . $IPKG_INSTROOT/usr/share/libubox/jshn.sh
33
34 _PROCD_SERVICE=
35
36 _procd_call() {
37         local old_cb
38
39         json_set_namespace procd old_cb
40         "$@"
41         json_set_namespace $old_cb
42 }
43
44 _procd_wrapper() {
45         while [ -n "$1" ]; do
46                 eval "$1() { _procd_call _$1 \"\$@\"; }"
47                 shift
48         done
49 }
50
51 _procd_ubus_call() {
52         local cmd="$1"
53
54         [ -n "$PROCD_DEBUG" ] && json_dump >&2
55         ubus call service "$cmd" "$(json_dump)"
56         json_cleanup
57 }
58
59 _procd_open_service() {
60         local name="$1"
61         local script="$2"
62
63         _PROCD_SERVICE="$name"
64         _PROCD_INSTANCE_SEQ=0
65
66         json_init
67         json_add_string name "$name"
68         [ -n "$script" ] && json_add_string script "$script"
69         json_add_object instances
70 }
71
72 _procd_close_service() {
73         json_close_object
74         service_triggers
75         _procd_ubus_call set
76 }
77
78 _procd_add_array_data() {
79         while [ "$#" -gt 0 ]; do
80                 json_add_string "" "$1"
81                 shift
82         done
83 }
84
85 _procd_add_array() {
86         json_add_array "$1"
87         shift
88         _procd_add_array_data "$@"
89         json_close_array
90 }
91
92 _procd_add_table_data() {
93         while [ -n "$1" ]; do
94                 local var="${1%%=*}"
95                 local val="${1#*=}"
96                 [ "$1" = "$val" ] && val=
97                 json_add_string "$var" "$val"
98                 shift
99         done
100 }
101
102 _procd_add_table() {
103         json_add_object "$1"
104         shift
105         _procd_add_table_data "$@"
106         json_close_object
107 }
108
109 _procd_open_instance() {
110         local name="$1"; shift
111
112         _PROCD_INSTANCE_SEQ="$(($_PROCD_INSTANCE_SEQ + 1))"
113         name="${name:-instance$_PROCD_INSTANCE_SEQ}"
114         json_add_object "$name"
115         [ -n "$TRACE_SYSCALLS" ] && json_add_boolean trace "1"
116 }
117
118 _procd_open_trigger() {
119         json_add_array "triggers"
120 }
121
122 _procd_open_validate() {
123         json_add_array "validate"
124 }
125
126 _procd_add_jail() {
127         json_add_object "jail"
128         json_add_string name "$1"
129         json_add_string root "/tmp/.jail/$1"
130
131         shift
132         
133         for a in $@; do
134                 case $a in
135                 log)    json_add_boolean "log" "1";;
136                 ubus)   json_add_boolean "ubus" "1";;
137                 procfs) json_add_boolean "procfs" "1";;
138                 sysfs)  json_add_boolean "sysfs" "1";;
139                 esac
140         done
141         json_add_object "mount"
142         json_close_object
143         json_close_object
144 }
145
146 _procd_add_jail_mount() {
147         local _json_no_warning=1
148
149         json_select "jail"
150         [ $? = 0 ] || return
151         json_select "mount"
152         [ $? = 0 ] || {
153                 json_select ..
154                 return
155         }
156         for a in $@; do
157                 json_add_string "$a" "0"
158         done
159         json_select ..
160         json_select ..
161 }
162
163 _procd_add_jail_mount_rw() {
164         local _json_no_warning=1
165
166         json_select "jail"
167         [ $? = 0 ] || return
168         json_select "mount"
169         [ $? = 0 ] || {
170                 json_select ..
171                 return
172         }
173         for a in $@; do
174                 json_add_string "$a" "1"
175         done
176         json_select ..
177         json_select ..
178 }
179
180 _procd_set_param() {
181         local type="$1"; shift
182
183         case "$type" in
184                 env|data|limits)
185                         _procd_add_table "$type" "$@"
186                 ;;
187                 command|netdev|file|respawn|watch)
188                         _procd_add_array "$type" "$@"
189                 ;;
190                 error)
191                         json_add_array "$type"
192                         json_add_string "" "$@"
193                         json_close_array
194                 ;;
195                 nice)
196                         json_add_int "$type" "$1"
197                 ;;
198                 user|seccomp)
199                         json_add_string "$type" "$1"
200                 ;;
201                 stdout|stderr)
202                         json_add_boolean "$type" "$1"
203                 ;;
204         esac
205 }
206
207 _procd_add_interface_trigger() {
208         json_add_array
209         _procd_add_array_data "$1"
210         shift
211
212         json_add_array
213         _procd_add_array_data "if"
214
215         json_add_array
216         _procd_add_array_data "eq" "interface" "$1"
217         shift
218         json_close_array
219
220         json_add_array
221         _procd_add_array_data "run_script" "$@"
222         json_close_array
223
224         json_close_array
225         json_close_array
226 }
227
228 _procd_add_reload_interface_trigger() {
229         local script=$(readlink "$initscript")
230         local name=$(basename ${script:-$initscript})
231
232         _procd_open_trigger
233         _procd_add_interface_trigger "interface.*" $1 /etc/init.d/$name reload
234         _procd_close_trigger
235 }
236
237 _procd_add_config_trigger() {
238         json_add_array
239         _procd_add_array_data "$1"
240         shift
241
242         json_add_array
243         _procd_add_array_data "if"
244
245         json_add_array
246         _procd_add_array_data "eq" "package" "$1"
247         shift
248         json_close_array
249
250         json_add_array
251         _procd_add_array_data "run_script" "$@"
252         json_close_array
253
254         json_close_array
255
256         json_close_array
257 }
258
259 _procd_add_raw_trigger() {
260         json_add_array
261         _procd_add_array_data "$1"
262         shift
263         local timeout=$1
264         shift
265
266         json_add_array
267         json_add_array
268         _procd_add_array_data "run_script" "$@"
269         json_close_array
270         json_close_array
271
272         json_add_int "" "$timeout"
273
274         json_close_array
275 }
276
277 _procd_add_reload_trigger() {
278         local script=$(readlink "$initscript")
279         local name=$(basename ${script:-$initscript})
280         local file
281
282         _procd_open_trigger
283         for file in "$@"; do
284                 _procd_add_config_trigger "config.change" "$file" /etc/init.d/$name reload
285         done
286         _procd_close_trigger
287 }
288
289 _procd_add_validation() {
290         _procd_open_validate
291         $@
292         _procd_close_validate
293 }
294
295 _procd_append_param() {
296         local type="$1"; shift
297         local _json_no_warning=1
298
299         json_select "$type"
300         [ $? = 0 ] || {
301                 _procd_set_param "$type" "$@"
302                 return
303         }
304         case "$type" in
305                 env|data|limits)
306                         _procd_add_table_data "$@"
307                 ;;
308                 command|netdev|file|respawn|watch)
309                         _procd_add_array_data "$@"
310                 ;;
311                 error)
312                         json_add_string "" "$@"
313                 ;;
314         esac
315         json_select ..
316 }
317
318 _procd_close_instance() {
319         json_close_object
320 }
321
322 _procd_close_trigger() {
323         json_close_array
324 }
325
326 _procd_close_validate() {
327         json_close_array
328 }
329
330 _procd_add_instance() {
331         _procd_open_instance
332         _procd_set_param command "$@"
333         _procd_close_instance
334 }
335
336 _procd_kill() {
337         local service="$1"
338         local instance="$2"
339
340         json_init
341         [ -n "$service" ] && json_add_string name "$service"
342         [ -n "$instance" ] && json_add_string instance "$instance"
343         _procd_ubus_call delete
344 }
345
346 procd_open_data() {
347         local name="$1"
348         json_set_namespace procd __procd_old_cb
349         json_add_object data
350 }
351
352 procd_close_data() {
353         json_close_object
354         json_set_namespace $__procd_old_cb
355 }
356
357 _procd_set_config_changed() {
358         local package="$1"
359
360         json_init
361         json_add_string type config.change
362         json_add_object data
363         json_add_string package "$package"
364         json_close_object
365
366         ubus call service event "$(json_dump)"
367 }
368
369 procd_add_mdns_service() {
370         local service proto port
371         service=$1; shift
372         proto=$1; shift
373         port=$1; shift
374         json_add_object "${service}_$port"
375         json_add_string "service" "_$service._$proto.local"
376         json_add_int port "$port"
377         [ -n "$1" ] && {
378                 json_add_array txt
379                 for txt in $@; do json_add_string "" $txt; done
380                 json_select ..
381         }
382         json_select ..
383 }
384
385 procd_add_mdns() {
386         procd_open_data
387         json_add_object "mdns"
388         procd_add_mdns_service $@
389         json_close_object
390         procd_close_data
391 }
392
393 uci_validate_section()
394 {
395         local _package="$1"
396         local _type="$2"
397         local _name="$3"
398         local _result
399         local _error
400         shift; shift; shift
401         _result=`/sbin/validate_data "$_package" "$_type" "$_name" "$@" 2> /dev/null`
402         _error=$?
403         eval "$_result"
404         [ "$_error" = "0" ] || `/sbin/validate_data "$_package" "$_type" "$_name" "$@" 1> /dev/null`
405         return $_error
406 }
407
408 _procd_wrapper \
409         procd_open_service \
410         procd_close_service \
411         procd_add_instance \
412         procd_add_raw_trigger \
413         procd_add_config_trigger \
414         procd_add_interface_trigger \
415         procd_add_reload_trigger \
416         procd_add_reload_interface_trigger \
417         procd_open_trigger \
418         procd_close_trigger \
419         procd_open_instance \
420         procd_close_instance \
421         procd_open_validate \
422         procd_close_validate \
423         procd_add_jail \
424         procd_add_jail_mount \
425         procd_add_jail_mount_rw \
426         procd_set_param \
427         procd_append_param \
428         procd_add_validation \
429         procd_set_config_changed \
430         procd_kill