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>
97 #include "devd.h" /* C compatible definitions */
98 #include "devd.hh" /* C++ class definitions */
100 #define PIPE "/var/run/devd.pipe"
101 #define CF "/etc/devd.conf"
102 #define SYSCTL "hw.bus.devctl_disable"
109 static const char notify = '!';
110 static const char nomatch = '?';
111 static const char attach = '+';
112 static const char detach = '-';
114 static struct pidfh *pfh;
119 int romeo_must_die = 0;
121 static const char *configfile = CF;
123 static void event_loop(void);
124 static void usage(void);
126 template <class T> void
127 delete_and_clear(vector<T *> &v)
129 typename vector<T *>::const_iterator i;
131 for (i = v.begin(); i != v.end(); ++i)
138 event_proc::event_proc() : _prio(-1)
143 event_proc::~event_proc()
145 delete_and_clear(_epsvec);
149 event_proc::add(eps *eps)
151 _epsvec.push_back(eps);
155 event_proc::matches(config &c) const
157 vector<eps *>::const_iterator i;
159 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
160 if (!(*i)->do_match(c))
166 event_proc::run(config &c) const
168 vector<eps *>::const_iterator i;
170 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
171 if (!(*i)->do_action(c))
176 action::action(const char *cmd)
188 my_system(const char *command)
192 struct sigaction ign, intact, quitact;
193 sigset_t newsigblock, oldsigblock;
195 if (!command) /* just checking... */
199 * Ignore SIGINT and SIGQUIT, block SIGCHLD. Remember to save
200 * existing signal dispositions.
202 ign.sa_handler = SIG_IGN;
203 ::sigemptyset(&ign.sa_mask);
205 ::sigaction(SIGINT, &ign, &intact);
206 ::sigaction(SIGQUIT, &ign, &quitact);
207 ::sigemptyset(&newsigblock);
208 ::sigaddset(&newsigblock, SIGCHLD);
209 ::sigprocmask(SIG_BLOCK, &newsigblock, &oldsigblock);
210 switch (pid = ::fork()) {
215 * Restore original signal dispositions and exec the command.
217 ::sigaction(SIGINT, &intact, NULL);
218 ::sigaction(SIGQUIT, &quitact, NULL);
219 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
221 * Close the PID file, and all other open descriptors.
222 * Inherit std{in,out,err} only.
226 ::execl(_PATH_BSHELL, "sh", "-c", command, (char *)NULL);
228 default: /* parent */
231 pid = ::wait4(savedpid, &pstat, 0, (struct rusage *)0);
232 } while (pid == -1 && errno == EINTR);
235 ::sigaction(SIGINT, &intact, NULL);
236 ::sigaction(SIGQUIT, &quitact, NULL);
237 ::sigprocmask(SIG_SETMASK, &oldsigblock, NULL);
238 return (pid == -1 ? -1 : pstat);
242 action::do_action(config &c)
244 string s = c.expand_string(_cmd);
246 fprintf(stderr, "Executing '%s'\n", s.c_str());
247 my_system(s.c_str());
251 match::match(config &c, const char *var, const char *re)
256 if (!c.expand_string(string(re)).empty() &&
257 c.expand_string(string(re)).at(0) == '!') {
258 _re.append(c.expand_string(string(re)).substr(1));
261 _re.append(c.expand_string(string(re)));
265 regcomp(&_regex, _re.c_str(), REG_EXTENDED | REG_NOSUB | REG_ICASE);
274 match::do_match(config &c)
276 string value = c.get_variable(_var);
280 fprintf(stderr, "Testing %s=%s against %s, invert=%d\n",
281 _var.c_str(), value.c_str(), _re.c_str(), _inv);
283 retval = (regexec(&_regex, value.c_str(), 0, NULL, 0) == 0);
285 retval = (retval == 0) ? 1 : 0;
290 #include <sys/sockio.h>
292 #include <net/if_media.h>
294 media::media(config &, const char *var, const char *type)
295 : _var(var), _type(-1)
297 static struct ifmedia_description media_types[] = {
298 { IFM_ETHER, "Ethernet" },
299 { IFM_TOKEN, "Tokenring" },
300 { IFM_FDDI, "FDDI" },
301 { IFM_IEEE80211, "802.11" },
303 { IFM_CARP, "CARP" },
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");
332 if (value.length() == 0)
333 value = c.get_variable("subsystem");
335 fprintf(stderr, "Testing media type of %s against 0x%x\n",
336 value.c_str(), _type);
340 s = socket(PF_INET, SOCK_DGRAM, 0);
342 memset(&ifmr, 0, sizeof(ifmr));
343 strncpy(ifmr.ifm_name, value.c_str(), sizeof(ifmr.ifm_name));
345 if (ioctl(s, SIOCGIFMEDIA, (caddr_t)&ifmr) >= 0 &&
346 ifmr.ifm_status & IFM_AVALID) {
348 fprintf(stderr, "%s has media type 0x%x\n",
349 value.c_str(), IFM_TYPE(ifmr.ifm_active));
350 retval = (IFM_TYPE(ifmr.ifm_active) == _type);
351 } else if (_type == -1) {
353 fprintf(stderr, "%s has unknown media type\n",
363 const string var_list::bogus = "_$_$_$_$_B_O_G_U_S_$_$_$_$_";
364 const string var_list::nothing = "";
367 var_list::get_variable(const string &var) const
369 map<string, string>::const_iterator i;
372 if (i == _vars.end())
373 return (var_list::bogus);
378 var_list::is_set(const string &var) const
380 return (_vars.find(var) != _vars.end());
384 var_list::set_variable(const string &var, const string &val)
387 fprintf(stderr, "setting %s=%s\n", var.c_str(), val.c_str());
395 delete_and_clear(_var_list_table);
396 delete_and_clear(_attach_list);
397 delete_and_clear(_detach_list);
398 delete_and_clear(_nomatch_list);
399 delete_and_clear(_notify_list);
403 config::parse_one_file(const char *fn)
406 fprintf(stderr, "Parsing %s\n", fn);
407 yyin = fopen(fn, "r");
409 err(1, "Cannot open config file %s", fn);
412 errx(1, "Cannot parse %s at line %d", fn, lineno);
417 config::parse_files_in_dir(const char *dirname)
424 fprintf(stderr, "Parsing files in %s\n", dirname);
425 dirp = opendir(dirname);
428 readdir(dirp); /* Skip . */
429 readdir(dirp); /* Skip .. */
430 while ((dp = readdir(dirp)) != NULL) {
431 if (strcmp(dp->d_name + dp->d_namlen - 5, ".conf") == 0) {
432 snprintf(path, sizeof(path), "%s/%s",
433 dirname, dp->d_name);
434 parse_one_file(path);
442 int operator()(event_proc *const&l1, event_proc *const&l2) const
444 return (l1->get_priority() > l2->get_priority());
449 config::sort_vector(vector<event_proc *> &v)
451 stable_sort(v.begin(), v.end(), epv_greater());
457 vector<string>::const_iterator i;
459 parse_one_file(configfile);
460 for (i = _dir_list.begin(); i != _dir_list.end(); ++i)
461 parse_files_in_dir((*i).c_str());
462 sort_vector(_attach_list);
463 sort_vector(_detach_list);
464 sort_vector(_nomatch_list);
465 sort_vector(_notify_list);
469 config::open_pidfile()
475 pfh = pidfile_open(_pidfile.c_str(), 0600, &otherpid);
478 errx(1, "devd already running, pid: %d", (int)otherpid);
479 warn("cannot open pid file");
484 config::write_pidfile()
491 config::close_pidfile()
498 config::remove_pidfile()
505 config::add_attach(int prio, event_proc *p)
507 p->set_priority(prio);
508 _attach_list.push_back(p);
512 config::add_detach(int prio, event_proc *p)
514 p->set_priority(prio);
515 _detach_list.push_back(p);
519 config::add_directory(const char *dir)
521 _dir_list.push_back(string(dir));
525 config::add_nomatch(int prio, event_proc *p)
527 p->set_priority(prio);
528 _nomatch_list.push_back(p);
532 config::add_notify(int prio, event_proc *p)
534 p->set_priority(prio);
535 _notify_list.push_back(p);
539 config::set_pidfile(const char *fn)
541 _pidfile = string(fn);
545 config::push_var_table()
550 _var_list_table.push_back(vl);
552 fprintf(stderr, "Pushing table\n");
556 config::pop_var_table()
558 delete _var_list_table.back();
559 _var_list_table.pop_back();
561 fprintf(stderr, "Popping table\n");
565 config::set_variable(const char *var, const char *val)
567 _var_list_table.back()->set_variable(var, val);
571 config::get_variable(const string &var)
573 vector<var_list *>::reverse_iterator i;
575 for (i = _var_list_table.rbegin(); i != _var_list_table.rend(); ++i) {
576 if ((*i)->is_set(var))
577 return ((*i)->get_variable(var));
579 return (var_list::nothing);
583 config::is_id_char(char ch) const
585 return (ch != '\0' && (isalpha(ch) || isdigit(ch) || ch == '_' ||
590 config::expand_one(const char *&src, string &dst)
593 string buffer, varstr;
598 dst.append(src++, 1);
603 // Not sure if I want to support this or not, so for now we just pass
608 /* If the string ends before ) is matched , return. */
609 while (count > 0 && *src) {
612 else if (*src == '(')
614 dst.append(src++, 1);
620 if (!isalpha(*src)) {
622 dst.append(src++, 1);
626 // $var -> replace with value
628 buffer.append(src++, 1);
629 } while (is_id_char(*src));
630 buffer.append("", 1);
631 varstr = get_variable(buffer.c_str());
636 config::expand_string(const string &s)
644 expand_one(src, dst);
646 dst.append(src++, 1);
654 config::chop_var(char *&buffer, char *&lhs, char *&rhs)
660 walker = lhs = buffer;
661 while (is_id_char(*walker))
666 if (*walker == '"') {
669 while (*walker && *walker != '"')
677 while (*walker && !isspace(*walker))
683 while (isspace(*walker))
691 config::set_vars(char *buffer)
697 if (!chop_var(buffer, lhs, rhs))
699 set_variable(lhs, rhs);
705 config::find_and_execute(char type)
707 vector<event_proc *> *l;
708 vector<event_proc *>::const_iterator i;
732 fprintf(stderr, "Processing %s event\n", s);
733 for (i = l->begin(); i != l->end(); ++i) {
734 if ((*i)->matches(*this)) {
744 process_event(char *buffer)
751 fprintf(stderr, "Processing event '%s'\n", buffer);
753 cfg.push_var_table();
754 // No match doesn't have a device, and the format is a little
755 // different, so handle it separately.
758 sp = cfg.set_vars(sp);
761 //? at location pnp-info on bus
762 sp = strchr(sp, ' ');
764 return; /* Can't happen? */
766 if (strncmp(sp, "at ", 3) == 0)
768 sp = cfg.set_vars(sp);
769 if (strncmp(sp, "on ", 3) == 0)
770 cfg.set_variable("bus", sp + 3);
772 case attach: /*FALLTHROUGH*/
774 sp = strchr(sp, ' ');
776 return; /* Can't happen? */
778 cfg.set_variable("device-name", buffer);
779 if (strncmp(sp, "at ", 3) == 0)
781 sp = cfg.set_vars(sp);
782 if (strncmp(sp, "on ", 3) == 0)
783 cfg.set_variable("bus", sp + 3);
787 cfg.find_and_execute(type);
792 create_socket(const char *name)
795 struct sockaddr_un sun;
797 if ((fd = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0)
799 bzero(&sun, sizeof(sun));
800 sun.sun_family = AF_UNIX;
801 strlcpy(sun.sun_path, name, sizeof(sun.sun_path));
802 slen = SUN_LEN(&sun);
804 if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0)
806 if (bind(fd, (struct sockaddr *) & sun, slen) < 0)
809 chown(name, 0, 0); /* XXX - root.wheel */
814 unsigned int max_clients = 10; /* Default, can be overriden on cmdline. */
815 unsigned int num_clients;
819 notify_clients(const char *data, int len)
821 list<int>::iterator i;
824 * Deliver the data to all clients. Throw clients overboard at the
825 * first sign of trouble. This reaps clients who've died or closed
826 * their sockets, and also clients who are alive but failing to keep up
827 * (or who are maliciously not reading, to consume buffer space in
828 * kernel memory or tie up the limited number of available connections).
830 for (i = clients.begin(); i != clients.end(); ) {
831 if (write(*i, data, len) != len) {
834 i = clients.erase(i);
845 list<int>::iterator i;
848 * Check all existing clients to see if any of them have disappeared.
849 * Normally we reap clients when we get an error trying to send them an
850 * event. This check eliminates the problem of an ever-growing list of
851 * zombie clients because we're never writing to them on a system
852 * without frequent device-change activity.
855 for (i = clients.begin(); i != clients.end(); ) {
857 s = poll(&pfd, 1, 0);
858 if ((s < 0 && s != EINTR ) ||
859 (s > 0 && (pfd.revents & POLLHUP))) {
862 i = clients.erase(i);
874 * First go reap any zombie clients, then accept the connection, and
875 * shut down the read side to stop clients from consuming kernel memory
876 * by sending large buffers full of data we'll never read.
879 s = accept(fd, NULL, NULL);
881 shutdown(s, SHUT_RD);
882 clients.push_back(s);
892 char buffer[DEVCTL_MAXBUF];
894 int server_fd, max_fd;
899 fd = open(PATH_DEVCTL, O_RDONLY);
901 err(1, "Can't open devctl device %s", PATH_DEVCTL);
902 if (fcntl(fd, F_SETFD, FD_CLOEXEC) != 0)
903 err(1, "Can't set close-on-exec flag on devctl");
904 server_fd = create_socket(PIPE);
906 max_fd = max(fd, server_fd) + 1;
910 if (!once && !dflag && !nflag) {
911 // Check to see if we have any events pending.
916 rv = select(fd + 1, &fds, &fds, &fds, &tv);
917 // No events -> we've processed all pending events
920 fprintf(stderr, "Calling daemon\n");
921 cfg.remove_pidfile();
929 * When we've already got the max number of clients, stop
930 * accepting new connections (don't put server_fd in the set),
931 * shrink the accept() queue to reject connections quickly, and
932 * poll the existing clients more often, so that we notice more
933 * quickly when any of them disappear to free up client slots.
937 if (num_clients < max_clients) {
939 listen(server_fd, max_clients);
942 FD_SET(server_fd, &fds);
947 listen(server_fd, 0);
953 rv = select(max_fd, &fds, NULL, NULL, &tv);
960 if (FD_ISSET(fd, &fds)) {
961 rv = read(fd, buffer, sizeof(buffer) - 1);
963 notify_clients(buffer, rv);
965 while (buffer[--rv] == '\n')
967 process_event(buffer);
976 if (FD_ISSET(server_fd, &fds))
977 new_client(server_fd);
983 * functions that the parser uses.
986 add_attach(int prio, event_proc *p)
988 cfg.add_attach(prio, p);
992 add_detach(int prio, event_proc *p)
994 cfg.add_detach(prio, p);
998 add_directory(const char *dir)
1000 cfg.add_directory(dir);
1001 free(const_cast<char *>(dir));
1005 add_nomatch(int prio, event_proc *p)
1007 cfg.add_nomatch(prio, p);
1011 add_notify(int prio, event_proc *p)
1013 cfg.add_notify(prio, p);
1017 add_to_event_proc(event_proc *ep, eps *eps)
1020 ep = new event_proc();
1026 new_action(const char *cmd)
1028 eps *e = new action(cmd);
1029 free(const_cast<char *>(cmd));
1034 new_match(const char *var, const char *re)
1036 eps *e = new match(cfg, var, re);
1037 free(const_cast<char *>(var));
1038 free(const_cast<char *>(re));
1043 new_media(const char *var, const char *re)
1045 eps *e = new media(cfg, var, re);
1046 free(const_cast<char *>(var));
1047 free(const_cast<char *>(re));
1052 set_pidfile(const char *name)
1054 cfg.set_pidfile(name);
1055 free(const_cast<char *>(name));
1059 set_variable(const char *var, const char *val)
1061 cfg.set_variable(var, val);
1062 free(const_cast<char *>(var));
1063 free(const_cast<char *>(val));
1078 fprintf(stderr, "usage: %s [-Ddn] [-l connlimit] [-f file]\n",
1084 check_devd_enabled()
1090 if (sysctlbyname(SYSCTL, &val, &len, NULL, 0) != 0)
1091 errx(1, "devctl sysctl missing from kernel!");
1093 warnx("Setting " SYSCTL " to 0");
1095 sysctlbyname(SYSCTL, NULL, NULL, &val, sizeof(val));
1103 main(int argc, char **argv)
1107 check_devd_enabled();
1108 while ((ch = getopt(argc, argv, "Ddf:l:n")) != -1) {
1117 configfile = optarg;
1120 max_clients = MAX(1, strtoul(optarg, NULL, 0));
1131 if (!dflag && nflag) {
1134 cfg.write_pidfile();
1136 signal(SIGPIPE, SIG_IGN);
1137 signal(SIGHUP, gensighand);
1138 signal(SIGINT, gensighand);
1139 signal(SIGTERM, gensighand);