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>
99 #include "devd.h" /* C compatible definitions */
100 #include "devd.hh" /* C++ class definitions */
102 #define PIPE "/var/run/devd.pipe"
103 #define CF "/etc/devd.conf"
104 #define SYSCTL "hw.bus.devctl_disable"
111 static const char notify = '!';
112 static const char nomatch = '?';
113 static const char attach = '+';
114 static const char detach = '-';
116 static struct pidfh *pfh;
120 static unsigned total_events = 0;
121 static volatile sig_atomic_t got_siginfo = 0;
122 static volatile sig_atomic_t romeo_must_die = 0;
124 static const char *configfile = CF;
126 static void devdlog(int priority, const char* message, ...);
127 static void event_loop(void);
128 static void usage(void);
130 template <class T> void
131 delete_and_clear(vector<T *> &v)
133 typename vector<T *>::const_iterator i;
135 for (i = v.begin(); i != v.end(); ++i)
142 event_proc::event_proc() : _prio(-1)
147 event_proc::~event_proc()
149 delete_and_clear(_epsvec);
153 event_proc::add(eps *eps)
155 _epsvec.push_back(eps);
159 event_proc::matches(config &c) const
161 vector<eps *>::const_iterator i;
163 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
164 if (!(*i)->do_match(c))
170 event_proc::run(config &c) const
172 vector<eps *>::const_iterator i;
174 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
175 if (!(*i)->do_action(c))
180 action::action(const char *cmd)
192 my_system(const char *command)
196 struct sigaction ign, intact, quitact;
197 sigset_t newsigblock, oldsigblock;
199 if (!command) /* just checking... */
203 * Ignore SIGINT and SIGQUIT, block SIGCHLD. Remember to save
204 * existing signal dispositions.
206 ign.sa_handler = SIG_IGN;
207 ::sigemptyset(&ign.sa_mask);
209 ::sigaction(SIGINT, &ign, &intact);
210 ::sigaction(SIGQUIT, &ign, &quitact);
211 ::sigemptyset(&newsigblock);
212 ::sigaddset(&newsigblock, SIGCHLD);
213 ::sigprocmask(SIG_BLOCK, &newsigblock, &oldsigblock);
214 switch (pid = ::fork()) {
219 * Restore original signal dispositions and exec the command.
221 ::sigaction(SIGINT, &intact, NULL);
222 ::sigaction(SIGQUIT, &quitact, NULL);
223 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
225 * Close the PID file, and all other open descriptors.
226 * Inherit std{in,out,err} only.
230 ::execl(_PATH_BSHELL, "sh", "-c", command, (char *)NULL);
232 default: /* parent */
235 pid = ::wait4(savedpid, &pstat, 0, (struct rusage *)0);
236 } while (pid == -1 && errno == EINTR);
239 ::sigaction(SIGINT, &intact, NULL);
240 ::sigaction(SIGQUIT, &quitact, NULL);
241 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
242 return (pid == -1 ? -1 : pstat);
246 action::do_action(config &c)
248 string s = c.expand_string(_cmd.c_str());
249 devdlog(LOG_NOTICE, "Executing '%s'\n", s.c_str());
250 my_system(s.c_str());
254 match::match(config &c, const char *var, const char *re) :
257 _re(c.expand_string(_inv ? re + 1 : re, "^", "$"))
259 regcomp(&_regex, _re.c_str(), REG_EXTENDED | REG_NOSUB | REG_ICASE);
268 match::do_match(config &c)
270 const string &value = c.get_variable(_var);
274 * This function gets called WAY too often to justify calling syslog()
275 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
276 * can consume excessive amounts of systime inside of connect(). Only
277 * log when we're in -d mode.
280 devdlog(LOG_DEBUG, "Testing %s=%s against %s, invert=%d\n",
281 _var.c_str(), value.c_str(), _re.c_str(), _inv);
284 retval = (regexec(&_regex, value.c_str(), 0, NULL, 0) == 0);
286 retval = (retval == 0) ? 1 : 0;
291 #include <sys/sockio.h>
293 #include <net/if_media.h>
295 media::media(config &, const char *var, const char *type)
296 : _var(var), _type(-1)
298 static struct ifmedia_description media_types[] = {
299 { IFM_ETHER, "Ethernet" },
300 { IFM_TOKEN, "Tokenring" },
301 { IFM_FDDI, "FDDI" },
302 { IFM_IEEE80211, "802.11" },
307 for (int i = 0; media_types[i].ifmt_string != NULL; ++i)
308 if (strcasecmp(type, media_types[i].ifmt_string) == 0) {
309 _type = media_types[i].ifmt_word;
319 media::do_match(config &c)
322 struct ifmediareq ifmr;
326 // Since we can be called from both a device attach/detach
327 // context where device-name is defined and what we want,
328 // as well as from a link status context, where subsystem is
329 // the name of interest, first try device-name and fall back
330 // to subsystem if none exists.
331 value = c.get_variable("device-name");
333 value = c.get_variable("subsystem");
334 devdlog(LOG_DEBUG, "Testing media type of %s against 0x%x\n",
335 value.c_str(), _type);
339 s = socket(PF_INET, SOCK_DGRAM, 0);
341 memset(&ifmr, 0, sizeof(ifmr));
342 strncpy(ifmr.ifm_name, value.c_str(), sizeof(ifmr.ifm_name));
344 if (ioctl(s, SIOCGIFMEDIA, (caddr_t)&ifmr) >= 0 &&
345 ifmr.ifm_status & IFM_AVALID) {
346 devdlog(LOG_DEBUG, "%s has media type 0x%x\n",
347 value.c_str(), IFM_TYPE(ifmr.ifm_active));
348 retval = (IFM_TYPE(ifmr.ifm_active) == _type);
349 } else if (_type == -1) {
350 devdlog(LOG_DEBUG, "%s has unknown media type\n",
360 const string var_list::bogus = "_$_$_$_$_B_O_G_U_S_$_$_$_$_";
361 const string var_list::nothing = "";
364 var_list::get_variable(const string &var) const
366 map<string, string>::const_iterator i;
369 if (i == _vars.end())
370 return (var_list::bogus);
375 var_list::is_set(const string &var) const
377 return (_vars.find(var) != _vars.end());
381 var_list::set_variable(const string &var, const string &val)
384 * This function gets called WAY too often to justify calling syslog()
385 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
386 * can consume excessive amounts of systime inside of connect(). Only
387 * log when we're in -d mode.
390 devdlog(LOG_DEBUG, "setting %s=%s\n", var.c_str(), val.c_str());
398 delete_and_clear(_var_list_table);
399 delete_and_clear(_attach_list);
400 delete_and_clear(_detach_list);
401 delete_and_clear(_nomatch_list);
402 delete_and_clear(_notify_list);
406 config::parse_one_file(const char *fn)
408 devdlog(LOG_DEBUG, "Parsing %s\n", fn);
409 yyin = fopen(fn, "r");
411 err(1, "Cannot open config file %s", fn);
414 errx(1, "Cannot parse %s at line %d", fn, lineno);
419 config::parse_files_in_dir(const char *dirname)
425 devdlog(LOG_DEBUG, "Parsing files in %s\n", dirname);
426 dirp = opendir(dirname);
429 readdir(dirp); /* Skip . */
430 readdir(dirp); /* Skip .. */
431 while ((dp = readdir(dirp)) != NULL) {
432 if (strcmp(dp->d_name + dp->d_namlen - 5, ".conf") == 0) {
433 snprintf(path, sizeof(path), "%s/%s",
434 dirname, dp->d_name);
435 parse_one_file(path);
443 int operator()(event_proc *const&l1, event_proc *const&l2) const
445 return (l1->get_priority() > l2->get_priority());
450 config::sort_vector(vector<event_proc *> &v)
452 stable_sort(v.begin(), v.end(), epv_greater());
458 vector<string>::const_iterator i;
460 parse_one_file(configfile);
461 for (i = _dir_list.begin(); i != _dir_list.end(); ++i)
462 parse_files_in_dir((*i).c_str());
463 sort_vector(_attach_list);
464 sort_vector(_detach_list);
465 sort_vector(_nomatch_list);
466 sort_vector(_notify_list);
470 config::open_pidfile()
474 if (_pidfile.empty())
476 pfh = pidfile_open(_pidfile.c_str(), 0600, &otherpid);
479 errx(1, "devd already running, pid: %d", (int)otherpid);
480 warn("cannot open pid file");
485 config::write_pidfile()
492 config::close_pidfile()
499 config::remove_pidfile()
506 config::add_attach(int prio, event_proc *p)
508 p->set_priority(prio);
509 _attach_list.push_back(p);
513 config::add_detach(int prio, event_proc *p)
515 p->set_priority(prio);
516 _detach_list.push_back(p);
520 config::add_directory(const char *dir)
522 _dir_list.push_back(string(dir));
526 config::add_nomatch(int prio, event_proc *p)
528 p->set_priority(prio);
529 _nomatch_list.push_back(p);
533 config::add_notify(int prio, event_proc *p)
535 p->set_priority(prio);
536 _notify_list.push_back(p);
540 config::set_pidfile(const char *fn)
546 config::push_var_table()
551 _var_list_table.push_back(vl);
552 devdlog(LOG_DEBUG, "Pushing table\n");
556 config::pop_var_table()
558 delete _var_list_table.back();
559 _var_list_table.pop_back();
560 devdlog(LOG_DEBUG, "Popping table\n");
564 config::set_variable(const char *var, const char *val)
566 _var_list_table.back()->set_variable(var, val);
570 config::get_variable(const string &var)
572 vector<var_list *>::reverse_iterator i;
574 for (i = _var_list_table.rbegin(); i != _var_list_table.rend(); ++i) {
575 if ((*i)->is_set(var))
576 return ((*i)->get_variable(var));
578 return (var_list::nothing);
582 config::is_id_char(char ch) const
584 return (ch != '\0' && (isalpha(ch) || isdigit(ch) || ch == '_' ||
589 config::expand_one(const char *&src, string &dst)
602 // Not sure if I want to support this or not, so for now we just pass
607 /* If the string ends before ) is matched , return. */
608 while (count > 0 && *src) {
611 else if (*src == '(')
619 if (!isalpha(*src)) {
625 // $var -> replace with value
628 } while (is_id_char(*src));
629 dst.append(get_variable(buffer));
633 config::expand_string(const char *src, const char *prepend, const char *append)
639 * 128 bytes is enough for 2427 of 2438 expansions that happen
640 * while parsing config files, as tested on 2013-01-30.
648 var_at = strchr(src, '$');
649 if (var_at == NULL) {
653 dst.append(src, var_at - src);
655 expand_one(src, dst);
665 config::chop_var(char *&buffer, char *&lhs, char *&rhs) const
671 walker = lhs = buffer;
672 while (is_id_char(*walker))
677 if (*walker == '"') {
680 while (*walker && *walker != '"')
688 while (*walker && !isspace(*walker))
694 while (isspace(*walker))
702 config::set_vars(char *buffer)
708 if (!chop_var(buffer, lhs, rhs))
710 set_variable(lhs, rhs);
716 config::find_and_execute(char type)
718 vector<event_proc *> *l;
719 vector<event_proc *>::const_iterator i;
742 devdlog(LOG_DEBUG, "Processing %s event\n", s);
743 for (i = l->begin(); i != l->end(); ++i) {
744 if ((*i)->matches(*this)) {
754 process_event(char *buffer)
760 devdlog(LOG_DEBUG, "Processing event '%s'\n", buffer);
762 cfg.push_var_table();
763 // No match doesn't have a device, and the format is a little
764 // different, so handle it separately.
767 sp = cfg.set_vars(sp);
770 //? at location pnp-info on bus
771 sp = strchr(sp, ' ');
773 return; /* Can't happen? */
777 if (strncmp(sp, "at ", 3) == 0)
779 sp = cfg.set_vars(sp);
782 if (strncmp(sp, "on ", 3) == 0)
783 cfg.set_variable("bus", sp + 3);
785 case attach: /*FALLTHROUGH*/
787 sp = strchr(sp, ' ');
789 return; /* Can't happen? */
791 cfg.set_variable("device-name", buffer);
794 if (strncmp(sp, "at ", 3) == 0)
796 sp = cfg.set_vars(sp);
799 if (strncmp(sp, "on ", 3) == 0)
800 cfg.set_variable("bus", sp + 3);
804 cfg.find_and_execute(type);
809 create_socket(const char *name)
812 struct sockaddr_un sun;
814 if ((fd = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0)
816 bzero(&sun, sizeof(sun));
817 sun.sun_family = AF_UNIX;
818 strlcpy(sun.sun_path, name, sizeof(sun.sun_path));
819 slen = SUN_LEN(&sun);
821 if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0)
823 if (::bind(fd, (struct sockaddr *) & sun, slen) < 0)
826 chown(name, 0, 0); /* XXX - root.wheel */
831 unsigned int max_clients = 10; /* Default, can be overriden on cmdline. */
832 unsigned int num_clients;
836 notify_clients(const char *data, int len)
838 list<int>::iterator i;
841 * Deliver the data to all clients. Throw clients overboard at the
842 * first sign of trouble. This reaps clients who've died or closed
843 * their sockets, and also clients who are alive but failing to keep up
844 * (or who are maliciously not reading, to consume buffer space in
845 * kernel memory or tie up the limited number of available connections).
847 for (i = clients.begin(); i != clients.end(); ) {
848 if (write(*i, data, len) != len) {
851 i = clients.erase(i);
852 devdlog(LOG_WARNING, "notify_clients: write() failed; "
853 "dropping unresponsive client\n");
864 list<int>::iterator i;
867 * Check all existing clients to see if any of them have disappeared.
868 * Normally we reap clients when we get an error trying to send them an
869 * event. This check eliminates the problem of an ever-growing list of
870 * zombie clients because we're never writing to them on a system
871 * without frequent device-change activity.
874 for (i = clients.begin(); i != clients.end(); ) {
876 s = poll(&pfd, 1, 0);
877 if ((s < 0 && s != EINTR ) ||
878 (s > 0 && (pfd.revents & POLLHUP))) {
881 i = clients.erase(i);
882 devdlog(LOG_NOTICE, "check_clients: "
883 "dropping disconnected client\n");
895 * First go reap any zombie clients, then accept the connection, and
896 * shut down the read side to stop clients from consuming kernel memory
897 * by sending large buffers full of data we'll never read.
900 s = accept(fd, NULL, NULL);
902 shutdown(s, SHUT_RD);
903 clients.push_back(s);
913 char buffer[DEVCTL_MAXBUF];
915 int server_fd, max_fd;
920 fd = open(PATH_DEVCTL, O_RDONLY | O_CLOEXEC);
922 err(1, "Can't open devctl device %s", PATH_DEVCTL);
923 server_fd = create_socket(PIPE);
925 max_fd = max(fd, server_fd) + 1;
926 while (!romeo_must_die) {
927 if (!once && !dflag && !nflag) {
928 // Check to see if we have any events pending.
933 rv = select(fd + 1, &fds, &fds, &fds, &tv);
934 // No events -> we've processed all pending events
936 devdlog(LOG_DEBUG, "Calling daemon\n");
937 cfg.remove_pidfile();
945 * When we've already got the max number of clients, stop
946 * accepting new connections (don't put server_fd in the set),
947 * shrink the accept() queue to reject connections quickly, and
948 * poll the existing clients more often, so that we notice more
949 * quickly when any of them disappear to free up client slots.
953 if (num_clients < max_clients) {
955 listen(server_fd, max_clients);
958 FD_SET(server_fd, &fds);
963 listen(server_fd, 0);
969 rv = select(max_fd, &fds, NULL, NULL, &tv);
971 devdlog(LOG_INFO, "Events received so far=%ld\n",
981 if (FD_ISSET(fd, &fds)) {
982 rv = read(fd, buffer, sizeof(buffer) - 1);
985 if (rv == sizeof(buffer) - 1) {
986 devdlog(LOG_WARNING, "Warning: "
987 "available event data exceeded "
990 notify_clients(buffer, rv);
992 while (buffer[--rv] == '\n')
994 process_event(buffer);
1003 if (FD_ISSET(server_fd, &fds))
1004 new_client(server_fd);
1010 * functions that the parser uses.
1013 add_attach(int prio, event_proc *p)
1015 cfg.add_attach(prio, p);
1019 add_detach(int prio, event_proc *p)
1021 cfg.add_detach(prio, p);
1025 add_directory(const char *dir)
1027 cfg.add_directory(dir);
1028 free(const_cast<char *>(dir));
1032 add_nomatch(int prio, event_proc *p)
1034 cfg.add_nomatch(prio, p);
1038 add_notify(int prio, event_proc *p)
1040 cfg.add_notify(prio, p);
1044 add_to_event_proc(event_proc *ep, eps *eps)
1047 ep = new event_proc();
1053 new_action(const char *cmd)
1055 eps *e = new action(cmd);
1056 free(const_cast<char *>(cmd));
1061 new_match(const char *var, const char *re)
1063 eps *e = new match(cfg, var, re);
1064 free(const_cast<char *>(var));
1065 free(const_cast<char *>(re));
1070 new_media(const char *var, const char *re)
1072 eps *e = new media(cfg, var, re);
1073 free(const_cast<char *>(var));
1074 free(const_cast<char *>(re));
1079 set_pidfile(const char *name)
1081 cfg.set_pidfile(name);
1082 free(const_cast<char *>(name));
1086 set_variable(const char *var, const char *val)
1088 cfg.set_variable(var, val);
1089 free(const_cast<char *>(var));
1090 free(const_cast<char *>(val));
1102 * SIGINFO handler. Will print useful statistics to the syslog or stderr
1112 * Local logging function. Prints to syslog if we're daemonized; syslog
1116 devdlog(int priority, const char* fmt, ...)
1120 va_start(argp, fmt);
1122 vfprintf(stderr, fmt, argp);
1124 vsyslog(priority, fmt, argp);
1131 fprintf(stderr, "usage: %s [-dn] [-l connlimit] [-f file]\n",
1137 check_devd_enabled()
1143 if (sysctlbyname(SYSCTL, &val, &len, NULL, 0) != 0)
1144 errx(1, "devctl sysctl missing from kernel!");
1146 warnx("Setting " SYSCTL " to 0");
1148 sysctlbyname(SYSCTL, NULL, NULL, &val, sizeof(val));
1156 main(int argc, char **argv)
1160 check_devd_enabled();
1161 while ((ch = getopt(argc, argv, "df:l:n")) != -1) {
1167 configfile = optarg;
1170 max_clients = MAX(1, strtoul(optarg, NULL, 0));
1181 if (!dflag && nflag) {
1184 cfg.write_pidfile();
1186 signal(SIGPIPE, SIG_IGN);
1187 signal(SIGHUP, gensighand);
1188 signal(SIGINT, gensighand);
1189 signal(SIGTERM, gensighand);
1190 signal(SIGINFO, siginfohand);