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