2 * Copyright (c) 2002-2010 M. Warner Losh.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * my_system is a variation on lib/libc/stdlib/system.c:
28 * Copyright (c) 1988, 1993
29 * The Regents of the University of California. All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
34 * 1. Redistributions of source code must retain the above copyright
35 * notice, this list of conditions and the following disclaimer.
36 * 2. Redistributions in binary form must reproduce the above copyright
37 * notice, this list of conditions and the following disclaimer in the
38 * documentation and/or other materials provided with the distribution.
39 * 4. Neither the name of the University nor the names of its contributors
40 * may be used to endorse or promote products derived from this software
41 * without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57 * DEVD control daemon.
61 // o devd.conf and devd man pages need a lot of help:
62 // - devd needs to document the unix domain socket
63 // - devd.conf needs more details on the supported statements.
65 #include <sys/cdefs.h>
66 __FBSDID("$FreeBSD$");
68 #include <sys/param.h>
69 #include <sys/socket.h>
71 #include <sys/sysctl.h>
72 #include <sys/types.h>
100 #include "devd.h" /* C compatible definitions */
101 #include "devd.hh" /* C++ class definitions */
103 #define PIPE "/var/run/devd.pipe"
104 #define CF "/etc/devd.conf"
105 #define SYSCTL "hw.bus.devctl_disable"
108 * Since the client socket is nonblocking, we must increase its send buffer to
109 * handle brief event storms. On FreeBSD, AF_UNIX sockets don't have a receive
110 * buffer, so the client can't increate the buffersize by itself.
112 * For example, when creating a ZFS pool, devd emits one 165 character
113 * resource.fs.zfs.statechange message for each vdev in the pool. A 64k
114 * buffer has enough space for almost 400 drives, which would be very large but
115 * not impossibly large pool. A 128k buffer has enough space for 794 drives,
116 * which is more than can fit in a rack with modern technology.
118 #define CLIENT_BUFSIZE 131072
125 static const char notify = '!';
126 static const char nomatch = '?';
127 static const char attach = '+';
128 static const char detach = '-';
130 static struct pidfh *pfh;
134 static unsigned total_events = 0;
135 static volatile sig_atomic_t got_siginfo = 0;
136 static volatile sig_atomic_t romeo_must_die = 0;
138 static const char *configfile = CF;
140 static void devdlog(int priority, const char* message, ...)
142 static void event_loop(void);
143 static void usage(void);
145 template <class T> void
146 delete_and_clear(vector<T *> &v)
148 typename vector<T *>::const_iterator i;
150 for (i = v.begin(); i != v.end(); ++i)
157 event_proc::event_proc() : _prio(-1)
162 event_proc::~event_proc()
164 delete_and_clear(_epsvec);
168 event_proc::add(eps *eps)
170 _epsvec.push_back(eps);
174 event_proc::matches(config &c) const
176 vector<eps *>::const_iterator i;
178 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
179 if (!(*i)->do_match(c))
185 event_proc::run(config &c) const
187 vector<eps *>::const_iterator i;
189 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
190 if (!(*i)->do_action(c))
195 action::action(const char *cmd)
207 my_system(const char *command)
211 struct sigaction ign, intact, quitact;
212 sigset_t newsigblock, oldsigblock;
214 if (!command) /* just checking... */
218 * Ignore SIGINT and SIGQUIT, block SIGCHLD. Remember to save
219 * existing signal dispositions.
221 ign.sa_handler = SIG_IGN;
222 ::sigemptyset(&ign.sa_mask);
224 ::sigaction(SIGINT, &ign, &intact);
225 ::sigaction(SIGQUIT, &ign, &quitact);
226 ::sigemptyset(&newsigblock);
227 ::sigaddset(&newsigblock, SIGCHLD);
228 ::sigprocmask(SIG_BLOCK, &newsigblock, &oldsigblock);
229 switch (pid = ::fork()) {
234 * Restore original signal dispositions and exec the command.
236 ::sigaction(SIGINT, &intact, NULL);
237 ::sigaction(SIGQUIT, &quitact, NULL);
238 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
240 * Close the PID file, and all other open descriptors.
241 * Inherit std{in,out,err} only.
245 ::execl(_PATH_BSHELL, "sh", "-c", command, (char *)NULL);
247 default: /* parent */
250 pid = ::wait4(savedpid, &pstat, 0, (struct rusage *)0);
251 } while (pid == -1 && errno == EINTR);
254 ::sigaction(SIGINT, &intact, NULL);
255 ::sigaction(SIGQUIT, &quitact, NULL);
256 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
257 return (pid == -1 ? -1 : pstat);
261 action::do_action(config &c)
263 string s = c.expand_string(_cmd.c_str());
264 devdlog(LOG_NOTICE, "Executing '%s'\n", s.c_str());
265 my_system(s.c_str());
269 match::match(config &c, const char *var, const char *re) :
272 _re(c.expand_string(_inv ? re + 1 : re, "^", "$"))
274 regcomp(&_regex, _re.c_str(), REG_EXTENDED | REG_NOSUB | REG_ICASE);
283 match::do_match(config &c)
285 const string &value = c.get_variable(_var);
289 * This function gets called WAY too often to justify calling syslog()
290 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
291 * can consume excessive amounts of systime inside of connect(). Only
292 * log when we're in -d mode.
295 devdlog(LOG_DEBUG, "Testing %s=%s against %s, invert=%d\n",
296 _var.c_str(), value.c_str(), _re.c_str(), _inv);
299 retval = (regexec(&_regex, value.c_str(), 0, NULL, 0) == 0);
301 retval = (retval == 0) ? 1 : 0;
306 #include <sys/sockio.h>
308 #include <net/if_media.h>
310 media::media(config &, const char *var, const char *type)
311 : _var(var), _type(-1)
313 static struct ifmedia_description media_types[] = {
314 { IFM_ETHER, "Ethernet" },
315 { IFM_TOKEN, "Tokenring" },
316 { IFM_FDDI, "FDDI" },
317 { IFM_IEEE80211, "802.11" },
322 for (int i = 0; media_types[i].ifmt_string != NULL; ++i)
323 if (strcasecmp(type, media_types[i].ifmt_string) == 0) {
324 _type = media_types[i].ifmt_word;
334 media::do_match(config &c)
337 struct ifmediareq ifmr;
341 // Since we can be called from both a device attach/detach
342 // context where device-name is defined and what we want,
343 // as well as from a link status context, where subsystem is
344 // the name of interest, first try device-name and fall back
345 // to subsystem if none exists.
346 value = c.get_variable("device-name");
348 value = c.get_variable("subsystem");
349 devdlog(LOG_DEBUG, "Testing media type of %s against 0x%x\n",
350 value.c_str(), _type);
354 s = socket(PF_INET, SOCK_DGRAM, 0);
356 memset(&ifmr, 0, sizeof(ifmr));
357 strncpy(ifmr.ifm_name, value.c_str(), sizeof(ifmr.ifm_name));
359 if (ioctl(s, SIOCGIFMEDIA, (caddr_t)&ifmr) >= 0 &&
360 ifmr.ifm_status & IFM_AVALID) {
361 devdlog(LOG_DEBUG, "%s has media type 0x%x\n",
362 value.c_str(), IFM_TYPE(ifmr.ifm_active));
363 retval = (IFM_TYPE(ifmr.ifm_active) == _type);
364 } else if (_type == -1) {
365 devdlog(LOG_DEBUG, "%s has unknown media type\n",
375 const string var_list::bogus = "_$_$_$_$_B_O_G_U_S_$_$_$_$_";
376 const string var_list::nothing = "";
379 var_list::get_variable(const string &var) const
381 map<string, string>::const_iterator i;
384 if (i == _vars.end())
385 return (var_list::bogus);
390 var_list::is_set(const string &var) const
392 return (_vars.find(var) != _vars.end());
396 var_list::set_variable(const string &var, const string &val)
399 * This function gets called WAY too often to justify calling syslog()
400 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
401 * can consume excessive amounts of systime inside of connect(). Only
402 * log when we're in -d mode.
405 devdlog(LOG_DEBUG, "setting %s=%s\n", var.c_str(), val.c_str());
413 delete_and_clear(_var_list_table);
414 delete_and_clear(_attach_list);
415 delete_and_clear(_detach_list);
416 delete_and_clear(_nomatch_list);
417 delete_and_clear(_notify_list);
421 config::parse_one_file(const char *fn)
423 devdlog(LOG_DEBUG, "Parsing %s\n", fn);
424 yyin = fopen(fn, "r");
426 err(1, "Cannot open config file %s", fn);
429 errx(1, "Cannot parse %s at line %d", fn, lineno);
434 config::parse_files_in_dir(const char *dirname)
440 devdlog(LOG_DEBUG, "Parsing files in %s\n", dirname);
441 dirp = opendir(dirname);
444 readdir(dirp); /* Skip . */
445 readdir(dirp); /* Skip .. */
446 while ((dp = readdir(dirp)) != NULL) {
447 if (strcmp(dp->d_name + dp->d_namlen - 5, ".conf") == 0) {
448 snprintf(path, sizeof(path), "%s/%s",
449 dirname, dp->d_name);
450 parse_one_file(path);
458 int operator()(event_proc *const&l1, event_proc *const&l2) const
460 return (l1->get_priority() > l2->get_priority());
465 config::sort_vector(vector<event_proc *> &v)
467 stable_sort(v.begin(), v.end(), epv_greater());
473 vector<string>::const_iterator i;
475 parse_one_file(configfile);
476 for (i = _dir_list.begin(); i != _dir_list.end(); ++i)
477 parse_files_in_dir((*i).c_str());
478 sort_vector(_attach_list);
479 sort_vector(_detach_list);
480 sort_vector(_nomatch_list);
481 sort_vector(_notify_list);
485 config::open_pidfile()
489 if (_pidfile.empty())
491 pfh = pidfile_open(_pidfile.c_str(), 0600, &otherpid);
494 errx(1, "devd already running, pid: %d", (int)otherpid);
495 warn("cannot open pid file");
500 config::write_pidfile()
507 config::close_pidfile()
514 config::remove_pidfile()
521 config::add_attach(int prio, event_proc *p)
523 p->set_priority(prio);
524 _attach_list.push_back(p);
528 config::add_detach(int prio, event_proc *p)
530 p->set_priority(prio);
531 _detach_list.push_back(p);
535 config::add_directory(const char *dir)
537 _dir_list.push_back(string(dir));
541 config::add_nomatch(int prio, event_proc *p)
543 p->set_priority(prio);
544 _nomatch_list.push_back(p);
548 config::add_notify(int prio, event_proc *p)
550 p->set_priority(prio);
551 _notify_list.push_back(p);
555 config::set_pidfile(const char *fn)
561 config::push_var_table()
566 _var_list_table.push_back(vl);
567 devdlog(LOG_DEBUG, "Pushing table\n");
571 config::pop_var_table()
573 delete _var_list_table.back();
574 _var_list_table.pop_back();
575 devdlog(LOG_DEBUG, "Popping table\n");
579 config::set_variable(const char *var, const char *val)
581 _var_list_table.back()->set_variable(var, val);
585 config::get_variable(const string &var)
587 vector<var_list *>::reverse_iterator i;
589 for (i = _var_list_table.rbegin(); i != _var_list_table.rend(); ++i) {
590 if ((*i)->is_set(var))
591 return ((*i)->get_variable(var));
593 return (var_list::nothing);
597 config::is_id_char(char ch) const
599 return (ch != '\0' && (isalpha(ch) || isdigit(ch) || ch == '_' ||
604 config::expand_one(const char *&src, string &dst)
617 // Not sure if I want to support this or not, so for now we just pass
622 /* If the string ends before ) is matched , return. */
623 while (count > 0 && *src) {
626 else if (*src == '(')
634 if (!isalpha(*src)) {
640 // $var -> replace with value
643 } while (is_id_char(*src));
644 dst.append(get_variable(buffer));
648 config::expand_string(const char *src, const char *prepend, const char *append)
654 * 128 bytes is enough for 2427 of 2438 expansions that happen
655 * while parsing config files, as tested on 2013-01-30.
663 var_at = strchr(src, '$');
664 if (var_at == NULL) {
668 dst.append(src, var_at - src);
670 expand_one(src, dst);
680 config::chop_var(char *&buffer, char *&lhs, char *&rhs) const
686 walker = lhs = buffer;
687 while (is_id_char(*walker))
692 if (*walker == '"') {
695 while (*walker && *walker != '"')
703 while (*walker && !isspace(*walker))
709 while (isspace(*walker))
717 config::set_vars(char *buffer)
723 if (!chop_var(buffer, lhs, rhs))
725 set_variable(lhs, rhs);
731 config::find_and_execute(char type)
733 vector<event_proc *> *l;
734 vector<event_proc *>::const_iterator i;
757 devdlog(LOG_DEBUG, "Processing %s event\n", s);
758 for (i = l->begin(); i != l->end(); ++i) {
759 if ((*i)->matches(*this)) {
769 process_event(char *buffer)
775 devdlog(LOG_INFO, "Processing event '%s'\n", buffer);
777 cfg.push_var_table();
778 // No match doesn't have a device, and the format is a little
779 // different, so handle it separately.
782 sp = cfg.set_vars(sp);
785 //? at location pnp-info on bus
786 sp = strchr(sp, ' ');
788 return; /* Can't happen? */
792 if (strncmp(sp, "at ", 3) == 0)
794 sp = cfg.set_vars(sp);
797 if (strncmp(sp, "on ", 3) == 0)
798 cfg.set_variable("bus", sp + 3);
800 case attach: /*FALLTHROUGH*/
802 sp = strchr(sp, ' ');
804 return; /* Can't happen? */
806 cfg.set_variable("device-name", buffer);
809 if (strncmp(sp, "at ", 3) == 0)
811 sp = cfg.set_vars(sp);
814 if (strncmp(sp, "on ", 3) == 0)
815 cfg.set_variable("bus", sp + 3);
819 cfg.find_and_execute(type);
824 create_socket(const char *name)
827 struct sockaddr_un sun;
829 if ((fd = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0)
831 bzero(&sun, sizeof(sun));
832 sun.sun_family = AF_UNIX;
833 strlcpy(sun.sun_path, name, sizeof(sun.sun_path));
834 slen = SUN_LEN(&sun);
836 if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0)
838 if (::bind(fd, (struct sockaddr *) & sun, slen) < 0)
841 chown(name, 0, 0); /* XXX - root.wheel */
846 unsigned int max_clients = 10; /* Default, can be overriden on cmdline. */
847 unsigned int num_clients;
851 notify_clients(const char *data, int len)
853 list<int>::iterator i;
856 * Deliver the data to all clients. Throw clients overboard at the
857 * first sign of trouble. This reaps clients who've died or closed
858 * their sockets, and also clients who are alive but failing to keep up
859 * (or who are maliciously not reading, to consume buffer space in
860 * kernel memory or tie up the limited number of available connections).
862 for (i = clients.begin(); i != clients.end(); ) {
863 if (write(*i, data, len) != len) {
866 i = clients.erase(i);
867 devdlog(LOG_WARNING, "notify_clients: write() failed; "
868 "dropping unresponsive client\n");
879 list<int>::iterator i;
882 * Check all existing clients to see if any of them have disappeared.
883 * Normally we reap clients when we get an error trying to send them an
884 * event. This check eliminates the problem of an ever-growing list of
885 * zombie clients because we're never writing to them on a system
886 * without frequent device-change activity.
889 for (i = clients.begin(); i != clients.end(); ) {
891 s = poll(&pfd, 1, 0);
892 if ((s < 0 && s != EINTR ) ||
893 (s > 0 && (pfd.revents & POLLHUP))) {
896 i = clients.erase(i);
897 devdlog(LOG_NOTICE, "check_clients: "
898 "dropping disconnected client\n");
911 * First go reap any zombie clients, then accept the connection, and
912 * shut down the read side to stop clients from consuming kernel memory
913 * by sending large buffers full of data we'll never read.
916 s = accept(fd, NULL, NULL);
918 sndbuf_size = CLIENT_BUFSIZE;
919 if (setsockopt(s, SOL_SOCKET, SO_SNDBUF, &sndbuf_size,
920 sizeof(sndbuf_size)))
921 err(1, "setsockopt");
922 shutdown(s, SHUT_RD);
923 clients.push_back(s);
934 char buffer[DEVCTL_MAXBUF];
936 int server_fd, max_fd;
941 fd = open(PATH_DEVCTL, O_RDONLY | O_CLOEXEC);
943 err(1, "Can't open devctl device %s", PATH_DEVCTL);
944 server_fd = create_socket(PIPE);
946 max_fd = max(fd, server_fd) + 1;
947 while (!romeo_must_die) {
948 if (!once && !dflag && !nflag) {
949 // Check to see if we have any events pending.
954 rv = select(fd + 1, &fds, &fds, &fds, &tv);
955 // No events -> we've processed all pending events
957 devdlog(LOG_DEBUG, "Calling daemon\n");
958 cfg.remove_pidfile();
966 * When we've already got the max number of clients, stop
967 * accepting new connections (don't put server_fd in the set),
968 * shrink the accept() queue to reject connections quickly, and
969 * poll the existing clients more often, so that we notice more
970 * quickly when any of them disappear to free up client slots.
974 if (num_clients < max_clients) {
976 listen(server_fd, max_clients);
979 FD_SET(server_fd, &fds);
984 listen(server_fd, 0);
990 rv = select(max_fd, &fds, NULL, NULL, &tv);
992 devdlog(LOG_NOTICE, "Events received so far=%u\n",
1002 if (FD_ISSET(fd, &fds)) {
1003 rv = read(fd, buffer, sizeof(buffer) - 1);
1006 if (rv == sizeof(buffer) - 1) {
1007 devdlog(LOG_WARNING, "Warning: "
1008 "available event data exceeded "
1011 notify_clients(buffer, rv);
1013 while (buffer[--rv] == '\n')
1015 process_event(buffer);
1016 } else if (rv < 0) {
1024 if (FD_ISSET(server_fd, &fds))
1025 new_client(server_fd);
1031 * functions that the parser uses.
1034 add_attach(int prio, event_proc *p)
1036 cfg.add_attach(prio, p);
1040 add_detach(int prio, event_proc *p)
1042 cfg.add_detach(prio, p);
1046 add_directory(const char *dir)
1048 cfg.add_directory(dir);
1049 free(const_cast<char *>(dir));
1053 add_nomatch(int prio, event_proc *p)
1055 cfg.add_nomatch(prio, p);
1059 add_notify(int prio, event_proc *p)
1061 cfg.add_notify(prio, p);
1065 add_to_event_proc(event_proc *ep, eps *eps)
1068 ep = new event_proc();
1074 new_action(const char *cmd)
1076 eps *e = new action(cmd);
1077 free(const_cast<char *>(cmd));
1082 new_match(const char *var, const char *re)
1084 eps *e = new match(cfg, var, re);
1085 free(const_cast<char *>(var));
1086 free(const_cast<char *>(re));
1091 new_media(const char *var, const char *re)
1093 eps *e = new media(cfg, var, re);
1094 free(const_cast<char *>(var));
1095 free(const_cast<char *>(re));
1100 set_pidfile(const char *name)
1102 cfg.set_pidfile(name);
1103 free(const_cast<char *>(name));
1107 set_variable(const char *var, const char *val)
1109 cfg.set_variable(var, val);
1110 free(const_cast<char *>(var));
1111 free(const_cast<char *>(val));
1123 * SIGINFO handler. Will print useful statistics to the syslog or stderr
1133 * Local logging function. Prints to syslog if we're daemonized; syslog
1137 devdlog(int priority, const char* fmt, ...)
1141 va_start(argp, fmt);
1143 vfprintf(stderr, fmt, argp);
1145 vsyslog(priority, fmt, argp);
1152 fprintf(stderr, "usage: %s [-dn] [-l connlimit] [-f file]\n",
1158 check_devd_enabled()
1164 if (sysctlbyname(SYSCTL, &val, &len, NULL, 0) != 0)
1165 errx(1, "devctl sysctl missing from kernel!");
1167 warnx("Setting " SYSCTL " to 0");
1169 sysctlbyname(SYSCTL, NULL, NULL, &val, sizeof(val));
1177 main(int argc, char **argv)
1181 check_devd_enabled();
1182 while ((ch = getopt(argc, argv, "df:l:n")) != -1) {
1188 configfile = optarg;
1191 max_clients = MAX(1, strtoul(optarg, NULL, 0));
1202 if (!dflag && nflag) {
1205 cfg.write_pidfile();
1207 signal(SIGPIPE, SIG_IGN);
1208 signal(SIGHUP, gensighand);
1209 signal(SIGINT, gensighand);
1210 signal(SIGTERM, gensighand);
1211 signal(SIGINFO, siginfohand);