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 $fail_threshold $restart_timeout $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: $username to run service as
  22 #     group: $groupname to run service as
  23 #     pidfile: file name to write pid into
  24 #     stdout: boolean whether to redirect commands stdout to syslog (default: 0)
  25 #     stderr: boolean whether to redirect commands stderr to syslog (default: 0)
  26 #     facility: syslog facility used when logging to syslog (default: daemon)
  27 #
  28 #   No space separation is done for arrays/tables - use one function argument per command line argument
  29 #
  30 # procd_close_instance():
  31 #   Complete the instance being prepared
  32 #
  33 # procd_running(service, [instance]):
  34 #   Checks if service/instance is currently running
  35 #
  36 # procd_kill(service, [instance]):
  37 #   Kill a service instance (or all instances)
  38 #
  39 # procd_send_signal(service, [instance], [signal])
  40 #   Send a signal to a service instance (or all instances)
  41 #
  42
  43 . "$IPKG_INSTROOT/usr/share/libubox/jshn.sh"
  44
  45 PROCD_RELOAD_DELAY=1000
  46 _PROCD_SERVICE=
  47
  48 procd_lock() {
  49         local basescript=$(readlink "$initscript")
  50         local service_name="$(basename ${basescript:-$initscript})"
  51
  52         flock -n 1000 &> /dev/null
  53         if [ "$?" != "0" ]; then
  54                 exec 1000>"$IPKG_INSTROOT/var/lock/procd_${service_name}.lock"
  55                 flock 1000
  56                 if [ "$?" != "0" ]; then
  57                         logger "warning: procd flock for $service_name failed"
  58                 fi
  59         fi
  60 }
  61
  62 _procd_call() {
  63         local old_cb
  64
  65         json_set_namespace procd old_cb
  66         "$@"
  67         json_set_namespace $old_cb
  68 }
  69
  70 _procd_wrapper() {
  71         procd_lock
  72         while [ -n "$1" ]; do
  73                 eval "$1() { _procd_call _$1 \"\$@\"; }"
  74                 shift
  75         done
  76 }
  77
  78 _procd_ubus_call() {
  79         local cmd="$1"
  80
  81         [ -n "$PROCD_DEBUG" ] && json_dump >&2
  82         ubus call service "$cmd" "$(json_dump)"
  83         json_cleanup
  84 }
  85
  86 _procd_open_service() {
  87         local name="$1"
  88         local script="$2"
  89
  90         _PROCD_SERVICE="$name"
  91         _PROCD_INSTANCE_SEQ=0
  92
  93         json_init
  94         json_add_string name "$name"
  95         [ -n "$script" ] && json_add_string script "$script"
  96         json_add_object instances
  97 }
  98
  99 _procd_close_service() {
 100         json_close_object
 101         _procd_open_trigger
 102         service_triggers
 103         _procd_close_trigger
 104         _procd_open_data
 105         service_data
 106         _procd_close_data
 107         _procd_ubus_call ${1:-set}
 108 }
 109
 110 _procd_add_array_data() {
 111         while [ "$#" -gt 0 ]; do
 112                 json_add_string "" "$1"
 113                 shift
 114         done
 115 }
 116
 117 _procd_add_array() {
 118         json_add_array "$1"
 119         shift
 120         _procd_add_array_data "$@"
 121         json_close_array
 122 }
 123
 124 _procd_add_table_data() {
 125         while [ -n "$1" ]; do
 126                 local var="${1%%=*}"
 127                 local val="${1#*=}"
 128                 [ "$1" = "$val" ] && val=
 129                 json_add_string "$var" "$val"
 130                 shift
 131         done
 132 }
 133
 134 _procd_add_table() {
 135         json_add_object "$1"
 136         shift
 137         _procd_add_table_data "$@"
 138         json_close_object
 139 }
 140
 141 _procd_open_instance() {
 142         local name="$1"; shift
 143
 144         _PROCD_INSTANCE_SEQ="$(($_PROCD_INSTANCE_SEQ + 1))"
 145         name="${name:-instance$_PROCD_INSTANCE_SEQ}"
 146         json_add_object "$name"
 147         [ -n "$TRACE_SYSCALLS" ] && json_add_boolean trace "1"
 148 }
 149
 150 _procd_open_trigger() {
 151         let '_procd_trigger_open = _procd_trigger_open + 1'
 152         [ "$_procd_trigger_open" -gt 1 ] && return
 153         json_add_array "triggers"
 154 }
 155
 156 _procd_close_trigger() {
 157         let '_procd_trigger_open = _procd_trigger_open - 1'
 158         [ "$_procd_trigger_open" -lt 1 ] || return
 159         json_close_array
 160 }
 161
 162 _procd_open_data() {
 163         let '_procd_data_open = _procd_data_open + 1'
 164         [ "$_procd_data_open" -gt 1 ] && return
 165         json_add_object "data"
 166 }
 167
 168 _procd_close_data() {
 169         let '_procd_data_open = _procd_data_open - 1'
 170         [ "$_procd_data_open" -lt 1 ] || return
 171         json_close_object
 172 }
 173
 174 _procd_open_validate() {
 175         json_select ..
 176         json_add_array "validate"
 177 }
 178
 179 _procd_close_validate() {
 180         json_close_array
 181         json_select triggers
 182 }
 183
 184 _procd_add_jail() {
 185         json_add_object "jail"
 186         json_add_string name "$1"
 187
 188         shift
 189
 190         for a in $@; do
 191                 case $a in
 192                 log)    json_add_boolean "log" "1";;
 193                 ubus)   json_add_boolean "ubus" "1";;
 194                 procfs) json_add_boolean "procfs" "1";;
 195                 sysfs)  json_add_boolean "sysfs" "1";;
 196                 ronly)  json_add_boolean "ronly" "1";;
 197                 requirejail)    json_add_boolean "requirejail" "1";;
 198                 netns)  json_add_boolean "netns" "1";;
 199                 userns) json_add_boolean "userns" "1";;
 200                 cgroupsns)      json_add_boolean "cgroupsns" "1";;
 201                 esac
 202         done
 203         json_add_object "mount"
 204         json_close_object
 205         json_close_object
 206 }
 207
 208 _procd_add_jail_mount() {
 209         local _json_no_warning=1
 210
 211         json_select "jail"
 212         [ $? = 0 ] || return
 213         json_select "mount"
 214         [ $? = 0 ] || {
 215                 json_select ..
 216                 return
 217         }
 218         for a in $@; do
 219                 json_add_string "$a" "0"
 220         done
 221         json_select ..
 222         json_select ..
 223 }
 224
 225 _procd_add_jail_mount_rw() {
 226         local _json_no_warning=1
 227
 228         json_select "jail"
 229         [ $? = 0 ] || return
 230         json_select "mount"
 231         [ $? = 0 ] || {
 232                 json_select ..
 233                 return
 234         }
 235         for a in $@; do
 236                 json_add_string "$a" "1"
 237         done
 238         json_select ..
 239         json_select ..
 240 }
 241
 242 _procd_set_param() {
 243         local type="$1"; shift
 244
 245         case "$type" in
 246                 env|data|limits)
 247                         _procd_add_table "$type" "$@"
 248                 ;;
 249                 command|netdev|file|respawn|watch)
 250                         _procd_add_array "$type" "$@"
 251                 ;;
 252                 error)
 253                         json_add_array "$type"
 254                         json_add_string "" "$@"
 255                         json_close_array
 256                 ;;
 257                 nice|term_timeout)
 258                         json_add_int "$type" "$1"
 259                 ;;
 260                 reload_signal)
 261                         json_add_int "$type" $(kill -l "$1")
 262                 ;;
 263                 pidfile|user|group|seccomp|capabilities|facility|\
 264                 extroot|overlaydir|tmpoverlaysize)
 265                         json_add_string "$type" "$1"
 266                 ;;
 267                 stdout|stderr|no_new_privs)
 268                         json_add_boolean "$type" "$1"
 269                 ;;
 270         esac
 271 }
 272
 273 _procd_add_timeout() {
 274         [ "$PROCD_RELOAD_DELAY" -gt 0 ] && json_add_int "" "$PROCD_RELOAD_DELAY"
 275         return 0
 276 }
 277
 278 _procd_add_interface_trigger() {
 279         json_add_array
 280         _procd_add_array_data "$1"
 281         shift
 282
 283         json_add_array
 284         _procd_add_array_data "if"
 285
 286         json_add_array
 287         _procd_add_array_data "eq" "interface" "$1"
 288         shift
 289         json_close_array
 290
 291         json_add_array
 292         _procd_add_array_data "run_script" "$@"
 293         json_close_array
 294
 295         json_close_array
 296         _procd_add_timeout
 297         json_close_array
 298 }
 299
 300 _procd_add_reload_interface_trigger() {
 301         local script=$(readlink "$initscript")
 302         local name=$(basename ${script:-$initscript})
 303
 304         _procd_open_trigger
 305         _procd_add_interface_trigger "interface.*" $1 /etc/init.d/$name reload
 306         _procd_close_trigger
 307 }
 308
 309 _procd_add_config_trigger() {
 310         json_add_array
 311         _procd_add_array_data "$1"
 312         shift
 313
 314         json_add_array
 315         _procd_add_array_data "if"
 316
 317         json_add_array
 318         _procd_add_array_data "eq" "package" "$1"
 319         shift
 320         json_close_array
 321
 322         json_add_array
 323         _procd_add_array_data "run_script" "$@"
 324         json_close_array
 325
 326         json_close_array
 327         _procd_add_timeout
 328         json_close_array
 329 }
 330
 331 _procd_add_raw_trigger() {
 332         json_add_array
 333         _procd_add_array_data "$1"
 334         shift
 335         local timeout=$1
 336         shift
 337
 338         json_add_array
 339         json_add_array
 340         _procd_add_array_data "run_script" "$@"
 341         json_close_array
 342         json_close_array
 343
 344         json_add_int "" "$timeout"
 345
 346         json_close_array
 347 }
 348
 349 _procd_add_reload_trigger() {
 350         local script=$(readlink "$initscript")
 351         local name=$(basename ${script:-$initscript})
 352         local file
 353
 354         _procd_open_trigger
 355         for file in "$@"; do
 356                 _procd_add_config_trigger "config.change" "$file" /etc/init.d/$name reload
 357         done
 358         _procd_close_trigger
 359 }
 360
 361 _procd_add_validation() {
 362         _procd_open_validate
 363         $@
 364         _procd_close_validate
 365 }
 366
 367 _procd_append_param() {
 368         local type="$1"; shift
 369         local _json_no_warning=1
 370
 371         json_select "$type"
 372         [ $? = 0 ] || {
 373                 _procd_set_param "$type" "$@"
 374                 return
 375         }
 376         case "$type" in
 377                 env|data|limits)
 378                         _procd_add_table_data "$@"
 379                 ;;
 380                 command|netdev|file|respawn|watch)
 381                         _procd_add_array_data "$@"
 382                 ;;
 383                 error)
 384                         json_add_string "" "$@"
 385                 ;;
 386         esac
 387         json_select ..
 388 }
 389
 390 _procd_close_instance() {
 391         local respawn_vals
 392         _json_no_warning=1
 393         if json_select respawn ; then
 394                 json_get_values respawn_vals
 395                 if [ -z "$respawn_vals" ]; then
 396                         local respawn_threshold=$(uci_get system.@service[0].respawn_threshold)
 397                         local respawn_timeout=$(uci_get system.@service[0].respawn_timeout)
 398                         local respawn_retry=$(uci_get system.@service[0].respawn_retry)
 399                         _procd_add_array_data ${respawn_threshold:-3600} ${respawn_timeout:-5} ${respawn_retry:-5}
 400                 fi
 401                 json_select ..
 402         fi
 403
 404         json_close_object
 405 }
 406
 407 _procd_add_instance() {
 408         _procd_open_instance
 409         _procd_set_param command "$@"
 410         _procd_close_instance
 411 }
 412
 413 procd_running() {
 414         local service="$1"
 415         local instance="${2:-*}"
 416         [ "$instance" = "*" ] || instance="'$instance'"
 417
 418         json_init
 419         json_add_string name "$service"
 420         local running=$(_procd_ubus_call list | jsonfilter -l 1 -e "@['$service'].instances[$instance].running")
 421
 422         [ "$running" = "true" ]
 423 }
 424
 425 _procd_kill() {
 426         local service="$1"
 427         local instance="$2"
 428
 429         json_init
 430         [ -n "$service" ] && json_add_string name "$service"
 431         [ -n "$instance" ] && json_add_string instance "$instance"
 432         _procd_ubus_call delete
 433 }
 434
 435 _procd_send_signal() {
 436         local service="$1"
 437         local instance="$2"
 438         local signal="$3"
 439
 440         case "$signal" in
 441                 [A-Z]*) signal="$(kill -l "$signal" 2>/dev/null)" || return 1;;
 442         esac
 443
 444         json_init
 445         json_add_string name "$service"
 446         [ -n "$instance" -a "$instance" != "*" ] && json_add_string instance "$instance"
 447         [ -n "$signal" ] && json_add_int signal "$signal"
 448         _procd_ubus_call signal
 449 }
 450
 451 _procd_status() {
 452         local service="$1"
 453         local instance="$2"
 454         local data
 455
 456         json_init
 457         [ -n "$service" ] && json_add_string name "$service"
 458
 459         data=$(_procd_ubus_call list | jsonfilter -e '@["'"$service"'"]')
 460         [ -z "$data" ] && { echo "inactive"; return 3; }
 461
 462         data=$(echo "$data" | jsonfilter -e '$.instances')
 463         if [ -z "$data" ]; then
 464                 [ -z "$instance" ] && { echo "active with no instances"; return 0; }
 465                 data="[]"
 466         fi
 467
 468         [ -n "$instance" ] && instance="\"$instance\"" || instance='*'
 469         if [ -z "$(echo "$data" | jsonfilter -e '$['"$instance"']')" ]; then
 470                 echo "unknown instance $instance"; return 4
 471         else
 472                 echo "running"; return 0
 473         fi
 474 }
 475
 476 procd_open_data() {
 477         local name="$1"
 478         json_set_namespace procd __procd_old_cb
 479         json_add_object data
 480 }
 481
 482 procd_close_data() {
 483         json_close_object
 484         json_set_namespace $__procd_old_cb
 485 }
 486
 487 _procd_set_config_changed() {
 488         local package="$1"
 489
 490         json_init
 491         json_add_string type config.change
 492         json_add_object data
 493         json_add_string package "$package"
 494         json_close_object
 495
 496         ubus call service event "$(json_dump)"
 497 }
 498
 499 procd_add_mdns_service() {
 500         local service proto port
 501         service=$1; shift
 502         proto=$1; shift
 503         port=$1; shift
 504         json_add_object "${service}_$port"
 505         json_add_string "service" "_$service._$proto.local"
 506         json_add_int port "$port"
 507         [ -n "$1" ] && {
 508                 json_add_array txt
 509                 for txt in "$@"; do json_add_string "" "$txt"; done
 510                 json_select ..
 511         }
 512         json_select ..
 513 }
 514
 515 procd_add_mdns() {
 516         procd_open_data
 517         json_add_object "mdns"
 518         procd_add_mdns_service "$@"
 519         json_close_object
 520         procd_close_data
 521 }
 522
 523 uci_validate_section()
 524 {
 525         local _package="$1"
 526         local _type="$2"
 527         local _name="$3"
 528         local _result
 529         local _error
 530         shift; shift; shift
 531         _result=`/sbin/validate_data "$_package" "$_type" "$_name" "$@" 2> /dev/null`
 532         _error=$?
 533         eval "$_result"
 534         [ "$_error" = "0" ] || `/sbin/validate_data "$_package" "$_type" "$_name" "$@" 1> /dev/null`
 535         return $_error
 536 }
 537
 538 uci_load_validate() {
 539         local _package="$1"
 540         local _type="$2"
 541         local _name="$3"
 542         local _function="$4"
 543         local _option
 544         local _result
 545         shift; shift; shift; shift
 546         for _option in "$@"; do
 547                 eval "local ${_option%%:*}"
 548         done
 549         uci_validate_section "$_package" "$_type" "$_name" "$@"
 550         _result=$?
 551         [ -n "$_function" ] || return $_result
 552         eval "$_function \"\$_name\" \"\$_result\""
 553 }
 554
 555 _procd_wrapper \
 556         procd_open_service \
 557         procd_close_service \
 558         procd_add_instance \
 559         procd_add_raw_trigger \
 560         procd_add_config_trigger \
 561         procd_add_interface_trigger \
 562         procd_add_reload_trigger \
 563         procd_add_reload_interface_trigger \
 564         procd_open_trigger \
 565         procd_close_trigger \
 566         procd_open_instance \
 567         procd_close_instance \
 568         procd_open_validate \
 569         procd_close_validate \
 570         procd_add_jail \
 571         procd_add_jail_mount \
 572         procd_add_jail_mount_rw \
 573         procd_set_param \
 574         procd_append_param \
 575         procd_add_validation \
 576         procd_set_config_changed \
 577         procd_kill \
 578         procd_send_signal