d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
88640c0e8b
freebsd-skq/sbin/devd/devd.8

164 lines
4.5 KiB
Groff
Raw Normal View History

devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.\"
.\" Copyright (c) 2002 M. Warner Losh.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Add history section for devd(8) Move sentence to a new line as advised by igor PR: 212439 Approved by: bcr (mentor) MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D8104
2016-10-05 20:04:36 +00:00
.Dd October 5, 2016
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Dt DEVD 8
.Os
.Sh NAME
.Nm devd
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
.Nd "device state change daemon"
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Sh SYNOPSIS
.Nm
sbin/devd/devd.8 sbin/devd/devd.cc Add a -q flag to devd that will suppress syslog logging at LOG_NOTICE or below. Requested by: ian@ and imp@ MFC after: 3 weeks Sponsored by: Spectra Logic Corporation
2014-03-07 23:30:48 +00:00
.Op Fl dnq
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
.Op Fl f Ar file
Fix a descriptor leak in devd. Clients reading /var/run/devd.pipe can close their socket connection any time, and devd only notices that when it gets an error trying to write an event to the client. On a system with no device change activity, clients could connect and disappear repeatedly without devd noticing, leading to an ever-growing list of open socket descriptors in devd. Now devd uses poll(2) looking for POLLHUP on all existing clients every time a new client connection is established, and also periodically (once a minute) to proactively find zombie clients and reap the socket descriptors. It also now has a connection limit, configurable with a new -l <num> command line arg. When the maximum number of connections is reached it stops accepting new connections until some current clients drop off. Reviewed by: imp Approved by: cognet (mentor)
2013-01-30 15:21:18 +00:00
.Op Fl l Ar num
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Sh DESCRIPTION
The
.Nm
daemon provides a way to have userland programs run when certain
kernel events happen.
.Pp
The following options are accepted.
Add -f option to program's usage(), fix manpage's SYNOPSIS.
2006-09-17 22:49:26 +00:00
.Bl -tag -width ".Fl f Ar file"
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.It Fl d
Add syslog(3) support to devd(8). sbin/devd/devd.cc All output will now go to syslog(3) if devd is daemonized, or stderr if it's running in the foreground. sbin/devd/devd.8 Remove the "-D" flag. Filtering messages by priority now happens in the usual syslog way. For performance reasons, a few extra-verbose debugging statements are now conditional on the "-d" (do not daemonize) flag. etc/syslog.conf etc/newsyslog.conf Direct messages from devd(8) to /var/log/devd.log, but leave it disabled by default Reviewed by: eadler Approved by: gibbs (co-mentor) MFC after: never (removed a command-line option from devd)
2013-07-01 21:20:17 +00:00
Run in the foreground instead of becoming a daemon and log additional information for debugging.
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
.It Fl f Ar file
Use configuration file
.Ar file
instead of the default
.Pa /etc/devd.conf .
If option
.Fl f
is specified more than once, the last file specified is used.
Fix a descriptor leak in devd. Clients reading /var/run/devd.pipe can close their socket connection any time, and devd only notices that when it gets an error trying to write an event to the client. On a system with no device change activity, clients could connect and disappear repeatedly without devd noticing, leading to an ever-growing list of open socket descriptors in devd. Now devd uses poll(2) looking for POLLHUP on all existing clients every time a new client connection is established, and also periodically (once a minute) to proactively find zombie clients and reap the socket descriptors. It also now has a connection limit, configurable with a new -l <num> command line arg. When the maximum number of connections is reached it stops accepting new connections until some current clients drop off. Reviewed by: imp Approved by: cognet (mentor)
2013-01-30 15:21:18 +00:00
.It Fl l Ar num
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
Limit concurrent socket connections to
Fix a descriptor leak in devd. Clients reading /var/run/devd.pipe can close their socket connection any time, and devd only notices that when it gets an error trying to write an event to the client. On a system with no device change activity, clients could connect and disappear repeatedly without devd noticing, leading to an ever-growing list of open socket descriptors in devd. Now devd uses poll(2) looking for POLLHUP on all existing clients every time a new client connection is established, and also periodically (once a minute) to proactively find zombie clients and reap the socket descriptors. It also now has a connection limit, configurable with a new -l <num> command line arg. When the maximum number of connections is reached it stops accepting new connections until some current clients drop off. Reviewed by: imp Approved by: cognet (mentor)
2013-01-30 15:21:18 +00:00
.Ar num .
The default connection limit is 10.
Implement a two new flags, and change the meaning of another one. 'd': now means don't do daemon(). 'D': Debug 'n': Don't wait to process all pending events before calling daemon. In the past, devd would call daemon immediately. However, this causes a race. If anything in the boot process depends on configuring the devices configured by devd, maybe they would be configured in time, maybe not. Now we don't call daemon until all pending events are processed, unless -n is specified. # -n is actually the default for a while due to the select(2) bug in devctl # that I just fixed to give people a chance to upgrade.
2003-04-21 06:26:08 +00:00
.It Fl n
mdoc(7) fixes: Expand contraction.
2003-05-17 22:21:27 +00:00
Do not process all pending events before becoming a daemon.
fix typo: s/Instaed/Instead/
2003-09-26 12:24:16 +00:00
Instead, call daemon right away.
sbin/devd/devd.8 sbin/devd/devd.cc Add a -q flag to devd that will suppress syslog logging at LOG_NOTICE or below. Requested by: ian@ and imp@ MFC after: 3 weeks Sponsored by: Spectra Logic Corporation
2014-03-07 23:30:48 +00:00
.It Fl q
Add history section for devd(8) Move sentence to a new line as advised by igor PR: 212439 Approved by: bcr (mentor) MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D8104
2016-10-05 20:04:36 +00:00
Quiet mode.
Only log messages at priority LOG_WARNING or above.
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.El
.Sh IMPLEMENTATION NOTES
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
The
english(4) police.
2002-12-27 12:15:40 +00:00
.Nm
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
utility
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
is a system daemon that runs in the background all the time.
Whenever a device is added to or removed from the device tree,
.Nm
Try to reword things a bit more to make it clearer. Reviewed by: imp
2002-11-13 20:27:46 +00:00
will execute actions specified in
.Xr devd.conf 5 .
For example,
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
.Nm
Try to reword things a bit more to make it clearer. Reviewed by: imp
2002-11-13 20:27:46 +00:00
might execute
.Xr dhclient 8
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
when an Ethernet adapter is added to the system, and kill the
Try to reword things a bit more to make it clearer. Reviewed by: imp
2002-11-13 20:27:46 +00:00
.Xr dhclient 8
instance when the same adapter is removed.
Another example would be for
.Nm
to use a table to locate and load via
.Xr kldload 8
the proper driver for an unrecognized device that is added to the system.
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Pp
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
The
english(4) police.
2002-12-27 12:15:40 +00:00
.Nm
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
utility
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
hooks into the
.Xr devctl 4
device driver.
This device driver has hooks into the device configuration system.
When nodes are added or deleted from the tree, this device will
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
deliver information about the event to
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Nm .
english(4) police.
2002-12-27 12:15:40 +00:00
Once
.Nm
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
has parsed the message, it will search its action list for that kind
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
of event and perform the action with the highest matching value.
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
For most mundane uses, the default handlers are adequate.
However, for more advanced users, the power is present to tweak every
aspect of what happens.
.Pp
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
The
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
.Nm
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
utility
reads
.Pa /etc/devd.conf
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
or the alternate configuration file specified with a
.Fl f
option and uses that file to drive the rest of the process.
english(4) police.
2002-12-27 12:15:40 +00:00
While the format of this file is described in
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
.Xr devd.conf 5 ,
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
some basics are covered here.
mdoc(7) police: Revision.
2003-03-03 11:51:30 +00:00
In the
.Ic options
section, one can define multiple directories to search
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
for config files.
Scheduled mdoc(7) sweep.
2005-01-10 16:17:34 +00:00
All files in these directories whose names match the pattern
Clarify that devd will only parse files whose names end in .conf. Prompted by PR: docs/73668 Submitted by: Dan Pelleg MFC After: 3 days
2004-11-28 17:44:22 +00:00
.Pa *.conf
are parsed.
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
These files are intended to be installed by third party vendors that
- Fix some minor grammar and spelling nits. - Massage the wording in a few places. - Put .Nm on lines by itself so it renders correctly. Reviewed by: imp
2002-11-13 19:31:04 +00:00
wish to hook into the
.Nm
system without modifying the user's other
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
config files.
Create a unix domain socket and write to it all the events that come in over the socket.
2004-07-01 07:24:18 +00:00
.Pp
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
Since
.Xr devctl 4
allows only one active reader,
Create a unix domain socket and write to it all the events that come in over the socket.
2004-07-01 07:24:18 +00:00
.Nm
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
multiplexes it, forwarding all events to any number of connected clients.
Clients connect by opening the SOCK_SEQPACKET
mdoc(7) fixes.
2004-07-07 19:57:16 +00:00
.Ux
domain socket at
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
.Pa /var/run/devd.seqpacket.pipe .
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
.Sh FILES
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
.Bl -tag -width ".Pa /var/run/devd.seqpacket.pipe" -compact
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
.It Pa /etc/devd.conf
The default
.Nm
configuration file.
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
.It Pa /var/run/devd.seqpacket.pipe
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
The socket used by
.Nm
to communicate with its clients.
sbin/devd/devd.8 sbin/devd/devd.cc Create a new socket, of type SOCK_SEQPACKET, for communicating with clients. SOCK_SEQPACKET sockets preserve record boundaries, simplying code in the client. The old SOCK_STREAM socket is retained for backwards-compatibility with existing clients. Sponsored by: Spectra Logic
2014-05-21 23:04:47 +00:00
.It Pa /var/run/devd.pipe
sbin/devd/devd.8 Fix grammar bug. Reported by: ian Sponsored by: Spectra Logic Corporation
2014-08-14 18:39:13 +00:00
A deprecated socket retained for use with old clients.
Add a -f configfile option to devd(8), based on a patch submitted by Wojciech A. Koszek. Submitted by: Wojciech A. Koszek <dunstan@freebsd.czest.pl>
2005-11-24 14:39:41 +00:00
.El
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Sh SEE ALSO
.Xr devctl 4 ,
Xref re_format(7) in devd.conf(5), not in devd(8). Pointy hat to: glebius
2011-12-16 10:21:01 +00:00
.Xr devd.conf 5
Add history section for devd(8) Move sentence to a new line as advised by igor PR: 212439 Approved by: bcr (mentor) MFC after: 5 days Differential Revision: https://reviews.freebsd.org/D8104
2016-10-05 20:04:36 +00:00
.Sh HISTORY
The
.Nm
utility first appeared in
.Fx 5.0 .
devd. A daemon that hooks into the kernel's /dev/devctl to produce arbitrary commands when devices come and go in the device tree (which is different than the /dev directory). This is an initial version. Much of the planned power isn't here. Instead of doing the full matching, we always run /etc/devd-generic. /etc/devd.generic will go away at some point, I think. I'm committing it in this early state so I can start getting feedback from early adapters. Approved by: re
2002-10-20 22:15:17 +00:00
.Sh AUTHORS
.An M. Warner Losh
Reference in New Issue Copy Permalink