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 October 8, 2016
  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 .Pp
 238 .Bl -tag -width ".Li manufacturer" -compact
 239 .It Ic Variable
 240 .Ic Description
 241 .It Li bus
 242 Device name of parent bus.
 243 .It Li cdev
 244 Device node path if one is created by the
 245 .Xr devfs 5
 246 filesystem.
 247 .It Li cisproduct
 248 CIS-product.
 249 .It Li cisvendor
 250 CIS-vendor.
 251 .It Li class
 252 Device class.
 253 .It Li device
 254 Device ID.
 255 .It Li devclass
 256 Device Class (USB)
 257 .It Li devsubclass
 258 Device Sub-class (USB)
 259 .It Li device-name
 260 Name of attached/detached device.
 261 .It Li endpoints
 262 Endpoint count (USB)
 263 .It Li function
 264 Card functions.
 265 .It Li interface
 266 Interface ID (USB)
 267 .It Li intclass
 268 Interface Class (USB)
 269 .It Li intprotocol
 270 Interface Protocol  (USB)
 271 .It Li intsubclass
 272 Interface Sub-class (USB)
 273 .It Li jail
 274 Jail name for the process triggering the rule (RCTL)
 275 .It Li manufacturer
 276 Manufacturer ID (pccard).
 277 .It Li mode
 278 Peripheral mode (USB)
 279 .It Li notify
 280 Match the value of the
 281 .Dq Li notify
 282 variable.
 283 .It Li parent
 284 Parent device
 285 .It Li pid
 286 PID of the process triggering the rule (RCTL)
 287 .It Li port
 288 Hub port number (USB)
 289 .It Li product
 290 Product ID (pccard/USB).
 291 .It Li release
 292 Hardware revision (USB)
 293 .It Li ruid
 294 Real UID of the process triggering the rule (RCTL)
 295 .It Li rule
 296 Rule (RCTL)
 297 .It Li sernum
 298 Serial Number (USB).
 299 .It Li slot
 300 Card slot.
 301 .It Li subvendor
 302 Sub-vendor ID.
 303 .It Li subdevice
 304 Sub-device ID.
 305 .It Li subsystem
 306 Matches a subsystem of a system, see below.
 307 .It Li system
 308 Matches a system type, see below.
 309 .It Li type
 310 Type of notification, see below.
 311 .It Li vendor
 312 Vendor ID.
 313 .El
 314 .Ss Notify matching
 315 A partial list of systems, subsystems, and types used within the
 316 .Ic notify
 317 mechanism.
 318 .Pp
 319 .Bl -tag -width ".Li coretemp" -compact
 320 .It Sy System
 321 .It Li ACPI
 322 Events related to the ACPI subsystem.
 323 .Bl -tag -width ".Sy Subsystem" -compact
 324 .It Sy Subsystem
 325 .It Li ACAD
 326 AC line state ($notify=0x00 is offline, 0x01 is online).
 327 .It Li Button
 328 Button state ($notify=0x00 is power, 0x01 is sleep).
 329 .It Li CMBAT
 330 Battery events.
 331 .It Li Lid
 332 Lid state ($notify=0x00 is closed, 0x01 is open).
 333 .It Li PROCESSOR
 334 Processor state/configuration ($notify=0x81 is a change in available Cx states).
 335 .It Li Resume
 336 Resume notification.
 337 .It Li Suspend
 338 Suspend notification.
 339 .It Li Thermal
 340 Thermal zone events.
 341 .El
 342 .Pp
 343 .It Li CARP
 344 Events related to the
 345 .Xr carp 8
 346 protocol.
 347 .Bl -tag -width ".Sy Subsystem" -compact
 348 .It Sy Subsystem
 349 .It Ar vhid@interface
 350 The
 351 .Dq subsystem
 352 contains the actual CARP vhid and the name of the network interface
 353 on which the event took place.
 354 .Bl -tag -width ".Li MASTER" -compact
 355 .It Sy Type
 356 .It Li MASTER
 357 Node become the master for a virtual host.
 358 .It Li BACKUP
 359 Node become the backup for a virtual host.
 360 .El
 361 .El
 362 .Pp
 363 .It Li IFNET
 364 Events related to the network subsystem.
 365 .Bl -tag -width ".Sy Subsystem" -compact
 366 .It Sy Subsystem
 367 .It Ar interface
 368 The
 369 .Dq subsystem
 370 is the actual name of the network interface on which the event
 371 took place.
 372 .Bl -tag -width ".Li LINK_DOWN" -compact
 373 .It Sy Type
 374 .It Li LINK_UP
 375 Carrier status changed to UP.
 376 .It Li LINK_DOWN
 377 Carrier status changed to DOWN.
 378 .It Li ATTACH
 379 The network interface is attached to the system.
 380 .It Li DETACH
 381 The network interface is detached from the system.
 382 .El
 383 .El
 384 .Pp
 385 .It Li DEVFS
 386 Events related to the
 387 .Xr devfs 5
 388 filesystem.
 389 .Bl -tag -width ".Sy Subsystem" -compact
 390 .It Sy Subsystem
 391 .It Li CDEV
 392 .Bl -tag -width ".Li DESTROY" -compact
 393 .It Sy Type
 394 .It Li CREATE
 395 The
 396 .Xr devfs 5
 397 node is created.
 398 .It Li DESTROY
 399 The
 400 .Xr devfs 5
 401 node is destroyed.
 402 .El
 403 .El
 404 .Pp
 405 .It Li GEOM
 406 Events related to the
 407 .Xr geom 4
 408 framework.
 409 The difference compared to
 410 .Li DEVFS
 411 is that
 412 .Li GEOM
 413 only includes disk-like devices.
 414 .Bl -tag -width ".Sy Subsystem" -compact
 415 .It Sy Subsystem
 416 .It Li DEV
 417 .Bl -tag -width ".Li MEDIACHANGE" -compact
 418 .It Sy Type
 419 .It Li CREATE
 420 A
 421 .Xr geom 4
 422 device node is created.
 423 .It Li DESTROY
 424 A
 425 .Xr geom 4
 426 device node is destroyed.
 427 .It Li GEOM::physpath
 428 The physical path of a device has changed.
 429 .It Li MEDIACHANGE
 430 Physical media has changed.
 431 .El
 432 .El
 433 .Pp
 434 .It Li RCTL
 435 Events related to the
 436 .Xr rctl 8
 437 framework.
 438 .Bl -tag -width ".Sy Subsystem" -compact
 439 .It Sy Subsystem
 440 .It Li rule
 441 .Bl -tag -width ".Li matched" -compact
 442 .It Sy Type
 443 .It Li matched
 444 A rule with action specified as "devctl" was triggered.
 445 .El
 446 .El
 447 .Pp
 448 .It Li USB
 449 Events related to the USB subsystem.
 450 .Bl -tag -width ".Sy Subsystem" -compact
 451 .It Sy Subsystem
 452 .It Li DEVICE
 453 .Bl -tag -width ".Li DETACH" -compact
 454 .It Sy Type
 455 .It Li ATTACH
 456 USB device is attached to the system.
 457 .It Li DETACH
 458 USB device is detached from the system.
 459 .El
 460 .It Li INTERFACE
 461 .Bl -tag -width ".Li DETACH" -compact
 462 .It Sy Type
 463 .It Li ATTACH
 464 USB interface is attached to a device.
 465 .It Li DETACH
 466 USB interface is detached from a device.
 467 .El
 468 .El
 469 .Pp
 470 .It Li coretemp
 471 Events related to the
 472 .Xr coretemp 4
 473 device.
 474 .Bl -tag -width ".Sy Subsystem" -compact
 475 .It Sy Subsystem
 476 .It Li Thermal
 477 Notification that the CPU core has reached critical temperature.
 478 .Bl -tag -width ".Ar temperature" -compact
 479 .It Sy Type
 480 .It Ar temperature
 481 String containing the temperature of the core that has become too hot.
 482 .El
 483 .El
 484 .Pp
 485 .It Li kern
 486 Events related to the kernel.
 487 .Bl -tag -width ".Sy Subsystem" -compact
 488 .It Sy Subsystem
 489 .It Li power
 490 Information about the state of the system.
 491 .Bl -tag -width ".li resume" -compact
 492 .It Sy Type
 493 .It Li resume
 494 Notification that the system has woken from the suspended state.
 495 .El
 496 .El
 497 .Pp
 498 .It Li CAM
 499 Events related to the
 500 .Xr cam 4
 501 system.
 502 .Bl -tag -width ".Sy Subsystem" -compact
 503 .It Sy Subsystem
 504 .It Li periph
 505 Events related to peripheral devices.
 506 .Bl -tag -width ".li timeout" -compact
 507 .It Sy Type
 508 .It Li error
 509 Generic errors.
 510 .It Li timeout
 511 Command timeouts.
 512 .El
 513 .El
 514 .El
 515 .Pp
 516 A link state change to UP on the interface
 517 .Dq Li fxp0
 518 would result in the following notify event:
 519 .Bd -literal -offset indent
 520 system=IFNET, subsystem=fxp0, type=LINK_UP
 521 .Ed
 522 .Pp
 523 An AC line state change to
 524 .Dq offline
 525 would result in the following event:
 526 .Bd -literal -offset indent
 527 system=ACPI, subsystem=ACAD, notify=0x00
 528 .Ed
 529 .Ss Comments
 530 Comments may appear anywhere that whitespace may appear in a
 531 configuration file.
 532 To appeal to programmers of all kinds, they can
 533 be written in C, C++, or shell/Perl constructs.
 534 .Pp
 535 C-style comments start with the two characters
 536 .Ql /*
 537 (slash, star) and end with
 538 .Ql */
 539 (star, slash).
 540 Because they are completely delimited with these characters,
 541 they can be used to comment only a portion of a line or to span
 542 multiple lines.
 543 .Pp
 544 C-style comments cannot be nested.
 545 For example, the following is
 546 not valid because the entire comment ends with the first
 547 .Ql */ :
 548 .Bd -literal -offset indent
 549 /* This is the start of a comment.
 550    This is still part of the comment.
 551 /* This is an incorrect attempt at nesting a comment. */
 552    This is no longer in any comment. */
 553 .Ed
 554 .Pp
 555 C++-style comments start with the two characters
 556 .Ql //
 557 (slash, slash) and continue to the end of the physical line.
 558 They cannot be continued across multiple physical lines; to have
 559 one logical comment span multiple lines, each line must use the
 560 .Ql //
 561 pair.
 562 For example:
 563 .Bd -literal -offset indent
 564 // This is the start of a comment.  The next line
 565 // is a new comment, even though it is logically
 566 // part of the previous comment.
 567 .Ed
 568 .Sh FILES
 569 .Bl -tag -width ".Pa /etc/devd.conf" -compact
 570 .It Pa /etc/devd.conf
 571 The
 572 .Xr devd 8
 573 configuration file.
 574 .El
 575 .Sh EXAMPLES
 576 .Bd -literal
 577 #
 578 # This will catch link down events on the interfaces fxp0 and ath0
 579 #
 580 notify 0 {
 581         match "system"                  "IFNET";
 582         match "subsystem"               "(fxp0|ath0)";
 583         match "type"                    "LINK_DOWN";
 584         action "logger $subsystem is DOWN";
 585 };
 586
 587 #
 588 # Match lid open/close events
 589 # These can be combined to a single event, by passing the
 590 # value of $notify to the external script.
 591 #
 592 notify 0 {
 593         match "system"                  "ACPI";
 594         match "subsystem"               "Lid";
 595         match "notify"                  "0x00";
 596         action "logger Lid closed, we can sleep now!";
 597 };
 598
 599 notify 0 {
 600         match "system"                  "ACPI";
 601         match "subsystem"               "Lid";
 602         match "notify"                  "0x01";
 603         action "logger Lid opened, the sleeper must awaken!";
 604 };
 605
 606 #
 607 # Match a USB device type
 608 #
 609 notify 0 {
 610         match "system"                  "USB";
 611         match "subsystem"               "INTERFACE";
 612         match "type"                    "ATTACH";
 613         match "intclass"                "0x0e";
 614         action "logger USB video device attached";
 615 };
 616
 617 #
 618 # Try to configure ath and wi devices with pccard_ether
 619 # as they are attached.
 620 #
 621 attach 0 {
 622         device-name "(ath|wi)[0-9]+";
 623         action "/etc/pccard_ether $device-name start";
 624 };
 625
 626 #
 627 # Stop ath and wi devices as they are detached from
 628 # the system.
 629 #
 630 detach 0 {
 631         device-name "(ath|wi)[0-9]+";
 632         action "/etc/pccard_ether $device-name stop";
 633 };
 634 .Ed
 635 .Pp
 636 The installed
 637 .Pa /etc/devd.conf
 638 has many additional examples.
 639 .Sh SEE ALSO
 640 .Xr cam 4 ,
 641 .Xr coretemp 4 ,
 642 .Xr devfs 5 ,
 643 .Xr re_format 7 ,
 644 .Xr devd 8