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