sbin/devd/devd.conf.5

   1 .\"
   2 .\" Copyright (c) 2002 M. Warner Losh
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .\" The section on comments was taken from named.conf.5, which has the
  28 .\" following copyright:
  29 .\" Copyright (c) 1999-2000 by Internet Software Consortium
  30 .\"
  31 .\" Permission to use, copy, modify, and distribute this software for any
  32 .\" purpose with or without fee is hereby granted, provided that the above
  33 .\" copyright notice and this permission notice appear in all copies.
  34 .\"
  35 .\" THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
  36 .\" ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
  37 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
  38 .\" CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  39 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  40 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  41 .\" ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  42 .\" SOFTWARE.
  43 .\"
  44 .Dd August 18, 2020
  45 .Dt DEVD.CONF 5
  46 .Os
  47 .Sh NAME
  48 .Nm devd.conf
  49 .Nd configuration file for
  50 .Xr devd 8
  51 .Sh DESCRIPTION
  52 .Ss General Syntax
  53 A
  54 .Xr devd 8
  55 configuration consists of two general features, statements
  56 and comments.
  57 All statements end with a semicolon.
  58 Many statements can contain substatements, which are also
  59 terminated with a semicolon.
  60 .Pp
  61 The following statements are supported:
  62 .Bl -tag -width ".Ic options"
  63 .It Ic attach
  64 Specifies various matching criteria and actions to perform when
  65 a newly attached device matches said criteria.
  66 .It Ic detach
  67 Specifies various matching criteria and actions to perform when
  68 a newly detached device matches said criteria.
  69 .It Ic nomatch
  70 Specifies various matching criteria and actions to perform when
  71 no device driver currently loaded in the kernel claims a (new)
  72 device.
  73 .It Ic notify
  74 Specifies various matching criteria and actions to perform when the kernel
  75 sends an event notification to userland.
  76 .It Ic options
  77 Specifies various options and parameters for the operation of
  78 .Xr devd 8 .
  79 .El
  80 .Pp
  81 Statements may occur in any order in the configuration file, and may be
  82 repeated as often as required.
  83 Further details on the syntax and meaning of each statement and their
  84 substatements are explained below.
  85 .Pp
  86 Each statement, except
  87 .Ic options
  88 has a priority (an arbitrary number) associated with it, where
  89 .Ql 0
  90 is defined as the lowest priority.
  91 If two statements match the same event, only the action of the statement with
  92 highest priority will be executed.
  93 In this way generic statements can be overridden for devices or
  94 notifications that require special attention.
  95 .Pp
  96 The general syntax of a statement is:
  97 .Bd -literal -offset indent
  98 statement priority {
  99         substatement "value";
 100         ...
 101         substatement "value";
 102 };
 103 .Ed
 104 .Ss Sub-statements
 105 The following sub-statements are supported within the
 106 .Ic options
 107 statement.
 108 .Bl -tag -width ".Ic directory"
 109 .It Ic directory Qq Ar /some/path ;
 110 Adds the given directory to the list of directories from which
 111 .Xr devd 8
 112 will read all files named "*.conf" as further
 113 configuration files.
 114 Any number of
 115 .Ic directory
 116 statements can be used.
 117 .It Ic pid-file Qq Pa /var/run/devd.pid ;
 118 Specifies PID file.
 119 .It Ic set Ar regexp-name Qq Ar (some|regexp) ;
 120 Creates a regular expression and assigns it to the variable
 121 .Ar regexp-name .
 122 The variable is available throughout the rest of
 123 the configuration file.
 124 If the string begins with
 125 .Ql \&! ,
 126 it matches if the regular expression formed by the rest of the string
 127 does not match.
 128 All regular expressions have an implicit
 129 .Ql ^$
 130 around them.
 131 .El
 132 .Pp
 133 The following sub-statements are supported within the
 134 .Ic attach
 135 and
 136 .Ic detach
 137 statements.
 138 .Bl -tag -width ".Ic directory"
 139 .It Ic action Qq Ar command ;
 140 Command to execute upon a successful match.
 141 Example
 142 .Dq Li "/etc/pccard_ether $device-name start" .
 143 .It Ic class Qq Ar string ;
 144 This is shorthand for
 145 .Dq Ic match Qo Li class Qc Qq Ar string .
 146 .It Ic device-name Qq string ;
 147 This is shorthand for
 148 .Dq Ic match Qo Li device-name Qc Qq Ar string .
 149 This matches a device named
 150 .Ar string ,
 151 which is allowed to be a regular expression or a variable previously created
 152 containing a regular expression.
 153 The
 154 .Dq Li device-name
 155 variable
 156 is available for later use with the
 157 .Ic action
 158 statement.
 159 .It Ic match Qo Ar variable Qc Qq Ar value ;
 160 Matches the content of
 161 .Ar value
 162 against
 163 .Ar variable ;
 164 the content of
 165 .Ar value
 166 may be a regular expression.
 167 Not required during
 168 .Ic attach
 169 nor
 170 .Ic detach
 171 events since the
 172 .Ic device-name
 173 statement takes care of all device matching.
 174 For a partial list of variables, see below.
 175 .It Ic media-type Qq Ar string ;
 176 For network devices,
 177 .Ic media-type
 178 will match devices that have the given media type.
 179 Valid media types are:
 180 .Dq Li Ethernet ,
 181 .Dq Li Tokenring ,
 182 .Dq Li FDDI ,
 183 .Dq Li 802.11 ,
 184 and
 185 .Dq Li ATM .
 186 .It Ic subdevice Qq Ar string ;
 187 This is shorthand for
 188 .Dq Ic match Qo Li subdevice Qc Qq Ar string .
 189 .El
 190 .Pp
 191 The following sub-statements are supported within the
 192 .Ic nomatch
 193 statement.
 194 .Bl -tag -width ".Ic directory"
 195 .It Ic action Qq Ar command ;
 196 Same as above.
 197 .It Ic match Qo Ar variable Qc Qq Ar value ;
 198 Matches the content of
 199 .Ar value
 200 against
 201 .Ar variable ;
 202 the content of
 203 .Ar value
 204 may be a regular expression.
 205 For a partial list of variables, see below.
 206 .El
 207 .Pp
 208 The following sub-statements are supported within the
 209 .Ic notify
 210 statement.
 211 The
 212 .Dq Li notify
 213 variable is available inside this statement and contains, a value, depending
 214 on which system and subsystem that delivered the event.
 215 .Bl -tag -width ".Ic directory"
 216 .It Ic action Qq Ar command ;
 217 Command to execute upon a successful match.
 218 Example
 219 .Dq Li "/etc/rc.d/power_profile $notify" .
 220 .It Ic match Qo Ar system | subsystem | type | notify Qc Qq Ar value ;
 221 Any number of
 222 .Ic match
 223 statements can exist within a
 224 .Ic notify
 225 statement;
 226 .Ar value
 227 can be either a fixed string or a regular expression.
 228 Below is a list of available systems, subsystems, and types.
 229 .It Ic media-type Qq Ar string ;
 230 See above.
 231 .El
 232 .Ss Variables that can be used with the match statement
 233 A partial list of variables and their possible values that can be used together
 234 with the
 235 .Ic match
 236 statement.
 237 The variables are published by the bus based on characteristics of the device
 238 that generated the event (for device events).
 239 Variables for other classes of events are dependent on those events.
 240 .Pp
 241 .Bl -tag -width ".Li manufacturer" -compact
 242 .It Ic Variable
 243 .Ic Description
 244 .It Li *
 245 The entire message from the current event.
 246 .It Li _
 247 The entire message from the current event, after the initial type character.
 248 .It Li timestamp
 249 The time this event was processed, in seconds since 1970 dot fraction.
 250 .It Li bus
 251 Device name of parent bus.
 252 .It Li cdev
 253 Device node path if one is created by the
 254 .Xr devfs 5
 255 filesystem.
 256 .It Li class
 257 Device class.
 258 .It Li comm
 259 Executable name (kernel).
 260 .It Li core
 261 Path to core file (kernel).
 262 .It Li device
 263 Device ID.
 264 .It Li devclass
 265 Device Class (USB).
 266 .It Li devsubclass
 267 Device Sub-class (USB).
 268 .It Li device-name
 269 Name of attached/detached device.
 270 .It Li endpoints
 271 Endpoint count (USB).
 272 .It Li function
 273 Card functions.
 274 .It Li interface
 275 Interface ID (USB).
 276 .It Li intclass
 277 Interface Class (USB).
 278 .It Li intprotocol
 279 Interface Protocol (USB).
 280 .It Li intsubclass
 281 Interface Sub-class (USB).
 282 .It Li jail
 283 Jail name for the process triggering the rule (RCTL).
 284 .It Li mode
 285 Peripheral mode (USB).
 286 .It Li notify
 287 Match the value of the
 288 .Dq Li notify
 289 variable.
 290 .It Li parent
 291 Parent device.
 292 .It Li pid
 293 PID of the process triggering the rule (RCTL).
 294 .It Li port
 295 Hub port number (USB).
 296 .It Li product
 297 Product ID (USB).
 298 .It Li release
 299 Hardware revision (USB).
 300 .It Li ruid
 301 Real UID of the process triggering the rule (RCTL).
 302 .It Li rule
 303 Rule (RCTL).
 304 .It Li sernum
 305 Serial Number (USB).
 306 .It Li slot
 307 Card slot.
 308 .It Li subvendor
 309 Sub-vendor ID (PCI).
 310 .It Li subdevice
 311 Sub-device ID (PCI).
 312 .It Li subsystem
 313 Matches a subsystem of a system, see below.
 314 .It Li system
 315 Matches a system type, see below.
 316 .It Li type
 317 Type of notification, see below.
 318 .It Li vendor
 319 Vendor ID.
 320 .El
 321 .Ss Notify matching
 322 A partial list of systems, subsystems, and types used within the
 323 .Ic notify
 324 mechanism.
 325 .Pp
 326 .Bl -tag -width ".Li coretemp" -compact
 327 .It Sy System
 328 .It Li ACPI
 329 Events related to the ACPI subsystem.
 330 .Bl -tag -width ".Sy Subsystem" -compact
 331 .It Sy Subsystem
 332 .It Li ACAD
 333 AC line state ($notify=0x00 is offline, 0x01 is online).
 334 .It Li Button
 335 Button state ($notify=0x00 is power, 0x01 is sleep).
 336 .It Li CMBAT
 337 Battery events.
 338 .It Li Dock
 339 Dock state ($notify=0x00 is undocked, 0x01 is docked).
 340 .It Li Lid
 341 Lid state ($notify=0x00 is closed, 0x01 is open).
 342 .It Li PROCESSOR
 343 Processor state/configuration ($notify=0x81 is a change in available Cx states).
 344 .It Li Resume
 345 Resume notification.
 346 .It Li Suspend
 347 Suspend notification.
 348 .It Li Thermal
 349 Thermal zone events.
 350 .El
 351 .Pp
 352 .It Li CARP
 353 Events related to the
 354 .Xr carp 4
 355 protocol.
 356 .Bl -tag -width ".Sy Subsystem" -compact
 357 .It Sy Subsystem
 358 .It Ar vhid@interface
 359 The
 360 .Dq subsystem
 361 contains the actual CARP vhid and the name of the network interface
 362 on which the event took place.
 363 .Bl -tag -width ".Li MASTER" -compact
 364 .It Sy Type
 365 .It Li MASTER
 366 Node become the master for a virtual host.
 367 .It Li BACKUP
 368 Node become the backup for a virtual host.
 369 .El
 370 .El
 371 .Pp
 372 .It Li IFNET
 373 Events related to the network subsystem.
 374 .Bl -tag -width ".Sy Subsystem" -compact
 375 .It Sy Subsystem
 376 .It Ar interface
 377 The
 378 .Dq subsystem
 379 is the actual name of the network interface on which the event
 380 took place.
 381 .Bl -tag -width ".Li LINK_DOWN" -compact
 382 .It Sy Type
 383 .It Li LINK_UP
 384 Carrier status changed to UP.
 385 .It Li LINK_DOWN
 386 Carrier status changed to DOWN.
 387 .It Li ATTACH
 388 The network interface is attached to the system.
 389 .It Li DETACH
 390 The network interface is detached from the system.
 391 .El
 392 .El
 393 .Pp
 394 .It Li DEVFS
 395 Events related to the
 396 .Xr devfs 5
 397 filesystem.
 398 .Bl -tag -width ".Sy Subsystem" -compact
 399 .It Sy Subsystem
 400 .It Li CDEV
 401 .Bl -tag -width ".Li DESTROY" -compact
 402 .It Sy Type
 403 .It Li CREATE
 404 The
 405 .Xr devfs 5
 406 node is created.
 407 .It Li DESTROY
 408 The
 409 .Xr devfs 5
 410 node is destroyed.
 411 .El
 412 .El
 413 .Pp
 414 .It Li GEOM
 415 Events related to the
 416 .Xr geom 4
 417 framework.
 418 The difference compared to
 419 .Li DEVFS
 420 is that
 421 .Li GEOM
 422 only includes disk-like devices.
 423 .Bl -tag -width ".Sy Subsystem" -compact
 424 .It Sy Subsystem
 425 .It Li DEV
 426 .Bl -tag -width ".Li MEDIACHANGE" -compact
 427 .It Sy Type
 428 .It Li CREATE
 429 A
 430 .Xr geom 4
 431 device node is created.
 432 .It Li DESTROY
 433 A
 434 .Xr geom 4
 435 device node is destroyed.
 436 .It Li GEOM::physpath
 437 The physical path of a device has changed.
 438 .It Li MEDIACHANGE
 439 Physical media has changed.
 440 .El
 441 .El
 442 .Pp
 443 .It Li RCTL
 444 Events related to the
 445 .Xr rctl 8
 446 framework.
 447 .Bl -tag -width ".Sy Subsystem" -compact
 448 .It Sy Subsystem
 449 .It Li rule
 450 .Bl -tag -width ".Li matched" -compact
 451 .It Sy Type
 452 .It Li matched
 453 A rule with action specified as "devctl" was triggered.
 454 .El
 455 .El
 456 .Pp
 457 .It Li USB
 458 Events related to the USB subsystem.
 459 .Bl -tag -width ".Sy Subsystem" -compact
 460 .It Sy Subsystem
 461 .It Li DEVICE
 462 .Bl -tag -width ".Li DETACH" -compact
 463 .It Sy Type
 464 .It Li ATTACH
 465 USB device is attached to the system.
 466 .It Li DETACH
 467 USB device is detached from the system.
 468 .El
 469 .It Li INTERFACE
 470 .Bl -tag -width ".Li DETACH" -compact
 471 .It Sy Type
 472 .It Li ATTACH
 473 USB interface is attached to a device.
 474 .It Li DETACH
 475 USB interface is detached from a device.
 476 .El
 477 .El
 478 .Pp
 479 .It Li coretemp
 480 Events related to the
 481 .Xr coretemp 4
 482 device.
 483 .Bl -tag -width ".Sy Subsystem" -compact
 484 .It Sy Subsystem
 485 .It Li Thermal
 486 Notification that the CPU core has reached critical temperature.
 487 .Bl -tag -width ".Ar temperature" -compact
 488 .It Sy Type
 489 .It Ar temperature
 490 String containing the temperature of the core that has become too hot.
 491 .El
 492 .El
 493 .Pp
 494 .It Li kern
 495 Events related to the kernel.
 496 .Bl -tag -width ".Sy Subsystem" -compact
 497 .It Sy Subsystem
 498 .It Li power
 499 .Bl -tag -width ".li resume" -compact
 500 .It Sy Type
 501 .It Li resume
 502 Notification that the system has woken from the suspended state.
 503 .El
 504 .El
 505 .Pp
 506 .It Li kernel
 507 More events related to the kernel.
 508 .Bl -tag -width ".Sy Subsystem" -compact
 509 .It Sy Subsystem
 510 .It Li signal
 511 .Bl -tag -width ".li resume" -compact
 512 .It Sy Type
 513 .It Li coredump
 514 Notification that a process has crashed and dumped core.
 515 .El
 516 .El
 517 .Pp
 518 .It Li CAM
 519 Events related to the
 520 .Xr cam 4
 521 system.
 522 .Bl -tag -width ".Sy Subsystem" -compact
 523 .It Sy Subsystem
 524 .It Li periph
 525 Events related to peripheral devices.
 526 .Bl -tag -width ".li timeout" -compact
 527 .It Sy Type
 528 .It Li error
 529 Generic errors.
 530 .It Li timeout
 531 Command timeouts.
 532 .El
 533 .El
 534 .El
 535 .Pp
 536 A link state change to UP on the interface
 537 .Dq Li fxp0
 538 would result in the following notify event:
 539 .Bd -literal -offset indent
 540 system=IFNET, subsystem=fxp0, type=LINK_UP
 541 .Ed
 542 .Pp
 543 An AC line state change to
 544 .Dq offline
 545 would result in the following event:
 546 .Bd -literal -offset indent
 547 system=ACPI, subsystem=ACAD, notify=0x00
 548 .Ed
 549 .Ss Comments
 550 Comments may appear anywhere that whitespace may appear in a
 551 configuration file.
 552 To appeal to programmers of all kinds, they can
 553 be written in C, C++, or shell/Perl constructs.
 554 .Pp
 555 C-style comments start with the two characters
 556 .Ql /*
 557 (slash, star) and end with
 558 .Ql */
 559 (star, slash).
 560 Because they are completely delimited with these characters,
 561 they can be used to comment only a portion of a line or to span
 562 multiple lines.
 563 .Pp
 564 C-style comments cannot be nested.
 565 For example, the following is
 566 not valid because the entire comment ends with the first
 567 .Ql */ :
 568 .Bd -literal -offset indent
 569 /* This is the start of a comment.
 570    This is still part of the comment.
 571 /* This is an incorrect attempt at nesting a comment. */
 572    This is no longer in any comment. */
 573 .Ed
 574 .Pp
 575 C++-style comments start with the two characters
 576 .Ql //
 577 (slash, slash) and continue to the end of the physical line.
 578 They cannot be continued across multiple physical lines; to have
 579 one logical comment span multiple lines, each line must use the
 580 .Ql //
 581 pair.
 582 For example:
 583 .Bd -literal -offset indent
 584 // This is the start of a comment.  The next line
 585 // is a new comment, even though it is logically
 586 // part of the previous comment.
 587 .Ed
 588 .Sh FILES
 589 .Bl -tag -width ".Pa /etc/devd.conf" -compact
 590 .It Pa /etc/devd.conf
 591 The
 592 .Xr devd 8
 593 configuration file.
 594 .El
 595 .Sh EXAMPLES
 596 .Bd -literal
 597 #
 598 # This will catch link down events on the interfaces fxp0 and ath0
 599 #
 600 notify 0 {
 601         match "system"                  "IFNET";
 602         match "subsystem"               "(fxp0|ath0)";
 603         match "type"                    "LINK_DOWN";
 604         action "logger $subsystem is DOWN";
 605 };
 606
 607 #
 608 # Match lid open/close events
 609 # These can be combined to a single event, by passing the
 610 # value of $notify to the external script.
 611 #
 612 notify 0 {
 613         match "system"                  "ACPI";
 614         match "subsystem"               "Lid";
 615         match "notify"                  "0x00";
 616         action "logger Lid closed, we can sleep now!";
 617 };
 618
 619 notify 0 {
 620         match "system"                  "ACPI";
 621         match "subsystem"               "Lid";
 622         match "notify"                  "0x01";
 623         action "logger Lid opened, the sleeper must awaken!";
 624 };
 625
 626 #
 627 # Match a USB device type
 628 #
 629 notify 0 {
 630         match "system"                  "USB";
 631         match "subsystem"               "INTERFACE";
 632         match "type"                    "ATTACH";
 633         match "intclass"                "0x0e";
 634         action "logger USB video device attached";
 635 };
 636
 637 #
 638 # Try to configure ath and iwn devices with pccard_ether
 639 # as they are attached.
 640 #
 641 attach 0 {
 642         device-name "(ath|iwn)[0-9]+";
 643         action "/etc/pccard_ether $device-name start";
 644 };
 645
 646 #
 647 # Stop ath and iwn devices as they are detached from
 648 # the system.
 649 #
 650 detach 0 {
 651         device-name "(ath|iwn)[0-9]+";
 652         action "/etc/pccard_ether $device-name stop";
 653 };
 654 .Ed
 655 .Pp
 656 The installed
 657 .Pa /etc/devd.conf
 658 has many additional examples.
 659 .Sh SEE ALSO
 660 .Xr cam 4 ,
 661 .Xr coretemp 4 ,
 662 .Xr devfs 5 ,
 663 .Xr re_format 7 ,
 664 .Xr devd 8