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                 esac
 199         done
 200         json_add_object "mount"
 201         json_close_object
 202         json_close_object
 203 }
 204
 205 _procd_add_jail_mount() {
 206         local _json_no_warning=1
 207
 208         json_select "jail"
 209         [ $? = 0 ] || return
 210         json_select "mount"
 211         [ $? = 0 ] || {
 212                 json_select ..
 213                 return
 214         }
 215         for a in $@; do
 216                 json_add_string "$a" "0"
 217         done
 218         json_select ..
 219         json_select ..
 220 }
 221
 222 _procd_add_jail_mount_rw() {
 223         local _json_no_warning=1
 224
 225         json_select "jail"
 226         [ $? = 0 ] || return
 227         json_select "mount"
 228         [ $? = 0 ] || {
 229                 json_select ..
 230                 return
 231         }
 232         for a in $@; do
 233                 json_add_string "$a" "1"
 234         done
 235         json_select ..
 236         json_select ..
 237 }
 238
 239 _procd_set_param() {
 240         local type="$1"; shift
 241
 242         case "$type" in
 243                 env|data|limits)
 244                         _procd_add_table "$type" "$@"
 245                 ;;
 246                 command|netdev|file|respawn|watch)
 247                         _procd_add_array "$type" "$@"
 248                 ;;
 249                 error)
 250                         json_add_array "$type"
 251                         json_add_string "" "$@"
 252                         json_close_array
 253                 ;;
 254                 nice|term_timeout)
 255                         json_add_int "$type" "$1"
 256                 ;;
 257                 reload_signal)
 258                         json_add_int "$type" $(kill -l "$1")
 259                 ;;
 260                 pidfile|user|group|seccomp|capabilities|facility)
 261                         json_add_string "$type" "$1"
 262                 ;;
 263                 stdout|stderr|no_new_privs)
 264                         json_add_boolean "$type" "$1"
 265                 ;;
 266         esac
 267 }
 268
 269 _procd_add_timeout() {
 270         [ "$PROCD_RELOAD_DELAY" -gt 0 ] && json_add_int "" "$PROCD_RELOAD_DELAY"
 271         return 0
 272 }
 273
 274 _procd_add_interface_trigger() {
 275         json_add_array
 276         _procd_add_array_data "$1"
 277         shift
 278
 279         json_add_array
 280         _procd_add_array_data "if"
 281
 282         json_add_array
 283         _procd_add_array_data "eq" "interface" "$1"
 284         shift
 285         json_close_array
 286
 287         json_add_array
 288         _procd_add_array_data "run_script" "$@"
 289         json_close_array
 290
 291         json_close_array
 292         _procd_add_timeout
 293         json_close_array
 294 }
 295
 296 _procd_add_reload_interface_trigger() {
 297         local script=$(readlink "$initscript")
 298         local name=$(basename ${script:-$initscript})
 299
 300         _procd_open_trigger
 301         _procd_add_interface_trigger "interface.*" $1 /etc/init.d/$name reload
 302         _procd_close_trigger
 303 }
 304
 305 _procd_add_config_trigger() {
 306         json_add_array
 307         _procd_add_array_data "$1"
 308         shift
 309
 310         json_add_array
 311         _procd_add_array_data "if"
 312
 313         json_add_array
 314         _procd_add_array_data "eq" "package" "$1"
 315         shift
 316         json_close_array
 317
 318         json_add_array
 319         _procd_add_array_data "run_script" "$@"
 320         json_close_array
 321
 322         json_close_array
 323         _procd_add_timeout
 324         json_close_array
 325 }
 326
 327 _procd_add_raw_trigger() {
 328         json_add_array
 329         _procd_add_array_data "$1"
 330         shift
 331         local timeout=$1
 332         shift
 333
 334         json_add_array
 335         json_add_array
 336         _procd_add_array_data "run_script" "$@"
 337         json_close_array
 338         json_close_array
 339
 340         json_add_int "" "$timeout"
 341
 342         json_close_array
 343 }
 344
 345 _procd_add_reload_trigger() {
 346         local script=$(readlink "$initscript")
 347         local name=$(basename ${script:-$initscript})
 348         local file
 349
 350         _procd_open_trigger
 351         for file in "$@"; do
 352                 _procd_add_config_trigger "config.change" "$file" /etc/init.d/$name reload
 353         done
 354         _procd_close_trigger
 355 }
 356
 357 _procd_add_validation() {
 358         _procd_open_validate
 359         $@
 360         _procd_close_validate
 361 }
 362
 363 _procd_append_param() {
 364         local type="$1"; shift
 365         local _json_no_warning=1
 366
 367         json_select "$type"
 368         [ $? = 0 ] || {
 369                 _procd_set_param "$type" "$@"
 370                 return
 371         }
 372         case "$type" in
 373                 env|data|limits)
 374                         _procd_add_table_data "$@"
 375                 ;;
 376                 command|netdev|file|respawn|watch)
 377                         _procd_add_array_data "$@"
 378                 ;;
 379                 error)
 380                         json_add_string "" "$@"
 381                 ;;
 382         esac
 383         json_select ..
 384 }
 385
 386 _procd_close_instance() {
 387         local respawn_vals
 388         _json_no_warning=1
 389         if json_select respawn ; then
 390                 json_get_values respawn_vals
 391                 if [ -z "$respawn_vals" ]; then
 392                         local respawn_threshold=$(uci_get system.@service[0].respawn_threshold)
 393                         local respawn_timeout=$(uci_get system.@service[0].respawn_timeout)
 394                         local respawn_retry=$(uci_get system.@service[0].respawn_retry)
 395                         _procd_add_array_data ${respawn_threshold:-3600} ${respawn_timeout:-5} ${respawn_retry:-5}
 396                 fi
 397                 json_select ..
 398         fi
 399
 400         json_close_object
 401 }
 402
 403 _procd_add_instance() {
 404         _procd_open_instance
 405         _procd_set_param command "$@"
 406         _procd_close_instance
 407 }
 408
 409 procd_running() {
 410         local service="$1"
 411         local instance="${2:-*}"
 412         [ "$instance" = "*" ] || instance="'$instance'"
 413
 414         json_init
 415         json_add_string name "$service"
 416         local running=$(_procd_ubus_call list | jsonfilter -l 1 -e "@['$service'].instances[$instance].running")
 417
 418         [ "$running" = "true" ]
 419 }
 420
 421 _procd_kill() {
 422         local service="$1"
 423         local instance="$2"
 424
 425         json_init
 426         [ -n "$service" ] && json_add_string name "$service"
 427         [ -n "$instance" ] && json_add_string instance "$instance"
 428         _procd_ubus_call delete
 429 }
 430
 431 _procd_send_signal() {
 432         local service="$1"
 433         local instance="$2"
 434         local signal="$3"
 435
 436         case "$signal" in
 437                 [A-Z]*) signal="$(kill -l "$signal" 2>/dev/null)" || return 1;;
 438         esac
 439
 440         json_init
 441         json_add_string name "$service"
 442         [ -n "$instance" -a "$instance" != "*" ] && json_add_string instance "$instance"
 443         [ -n "$signal" ] && json_add_int signal "$signal"
 444         _procd_ubus_call signal
 445 }
 446
 447 _procd_status() {
 448         local service="$1"
 449         local instance="$2"
 450         local data
 451
 452         json_init
 453         [ -n "$service" ] && json_add_string name "$service"
 454
 455         data=$(_procd_ubus_call list | jsonfilter -e '@["'"$service"'"]')
 456         [ -z "$data" ] && { echo "inactive"; return 3; }
 457
 458         data=$(echo "$data" | jsonfilter -e '$.instances')
 459         if [ -z "$data" ]; then
 460                 [ -z "$instance" ] && { echo "active with no instances"; return 0; }
 461                 data="[]"
 462         fi
 463
 464         [ -n "$instance" ] && instance="\"$instance\"" || instance='*'
 465         if [ -z "$(echo "$data" | jsonfilter -e '$['"$instance"']')" ]; then
 466                 echo "unknown instance $instance"; return 4
 467         else
 468                 echo "running"; return 0
 469         fi
 470 }
 471
 472 procd_open_data() {
 473         local name="$1"
 474         json_set_namespace procd __procd_old_cb
 475         json_add_object data
 476 }
 477
 478 procd_close_data() {
 479         json_close_object
 480         json_set_namespace $__procd_old_cb
 481 }
 482
 483 _procd_set_config_changed() {
 484         local package="$1"
 485
 486         json_init
 487         json_add_string type config.change
 488         json_add_object data
 489         json_add_string package "$package"
 490         json_close_object
 491
 492         ubus call service event "$(json_dump)"
 493 }
 494
 495 procd_add_mdns_service() {
 496         local service proto port
 497         service=$1; shift
 498         proto=$1; shift
 499         port=$1; shift
 500         json_add_object "${service}_$port"
 501         json_add_string "service" "_$service._$proto.local"
 502         json_add_int port "$port"
 503         [ -n "$1" ] && {
 504                 json_add_array txt
 505                 for txt in "$@"; do json_add_string "" "$txt"; done
 506                 json_select ..
 507         }
 508         json_select ..
 509 }
 510
 511 procd_add_mdns() {
 512         procd_open_data
 513         json_add_object "mdns"
 514         procd_add_mdns_service "$@"
 515         json_close_object
 516         procd_close_data
 517 }
 518
 519 uci_validate_section()
 520 {
 521         local _package="$1"
 522         local _type="$2"
 523         local _name="$3"
 524         local _result
 525         local _error
 526         shift; shift; shift
 527         _result=`/sbin/validate_data "$_package" "$_type" "$_name" "$@" 2> /dev/null`
 528         _error=$?
 529         eval "$_result"
 530         [ "$_error" = "0" ] || `/sbin/validate_data "$_package" "$_type" "$_name" "$@" 1> /dev/null`
 531         return $_error
 532 }
 533
 534 uci_load_validate() {
 535         local _package="$1"
 536         local _type="$2"
 537         local _name="$3"
 538         local _function="$4"
 539         local _option
 540         local _result
 541         shift; shift; shift; shift
 542         for _option in "$@"; do
 543                 eval "local ${_option%%:*}"
 544         done
 545         uci_validate_section "$_package" "$_type" "$_name" "$@"
 546         _result=$?
 547         [ -n "$_function" ] || return $_result
 548         eval "$_function \"\$_name\" \"\$_result\""
 549 }
 550
 551 _procd_wrapper \
 552         procd_open_service \
 553         procd_close_service \
 554         procd_add_instance \
 555         procd_add_raw_trigger \
 556         procd_add_config_trigger \
 557         procd_add_interface_trigger \
 558         procd_add_reload_trigger \
 559         procd_add_reload_interface_trigger \
 560         procd_open_trigger \
 561         procd_close_trigger \
 562         procd_open_instance \
 563         procd_close_instance \
 564         procd_open_validate \
 565         procd_close_validate \
 566         procd_add_jail \
 567         procd_add_jail_mount \
 568         procd_add_jail_mount_rw \
 569         procd_set_param \
 570         procd_append_param \
 571         procd_add_validation \
 572         procd_set_config_changed \
 573         procd_kill \
 574         procd_send_signal