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 * $FreeBSD: src/sbin/devd/devd.cc,v 1.33 2006/09/17 22:49:26 ru Exp $
31 * DEVD control daemon.
35 // o devd.conf and devd man pages need a lot of help:
36 // - devd needs to document the unix domain socket
37 // - devd.conf needs more details on the supported statements.
39 #include <sys/param.h>
40 #include <sys/socket.h>
42 #include <sys/sysctl.h>
43 #include <sys/types.h>
66 #include "devd.h" /* C compatible definitions */
67 #include "devd.hh" /* C++ class definitions */
69 #define PIPE "/var/run/devd.pipe"
70 #define CF "/etc/devd.conf"
71 #define SYSCTL "hw.bus.devctl_disable"
78 static const char notify = '!';
79 static const char nomatch = '?';
80 static const char attach = '+';
81 static const char detach = '-';
83 static struct pidfh *pfh;
87 static volatile sig_atomic_t romeo_must_die = 0;
89 static const char *configfile = CF;
91 static void event_loop(void);
92 static void usage(void);
94 template <class T> void
95 delete_and_clear(vector<T *> &v)
97 typename vector<T *>::const_iterator i;
99 for (i = v.begin(); i != v.end(); ++i)
106 event_proc::event_proc() : _prio(-1)
111 event_proc::~event_proc()
113 delete_and_clear(_epsvec);
117 event_proc::add(eps *eps)
119 _epsvec.push_back(eps);
123 event_proc::matches(config &c) const
125 vector<eps *>::const_iterator i;
127 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
128 if (!(*i)->do_match(c))
134 event_proc::run(config &c) const
136 vector<eps *>::const_iterator i;
138 for (i = _epsvec.begin(); i != _epsvec.end(); ++i)
139 if (!(*i)->do_action(c))
144 action::action(const char *cmd)
156 action::do_action(config &c)
158 string s = c.expand_string(_cmd.c_str());
160 fprintf(stderr, "Executing '%s'\n", s.c_str());
165 match::match(config &c, const char *var, const char *re) :
168 _re(c.expand_string(_inv ? re + 1 : re, "^", "$"))
170 regcomp(&_regex, _re.c_str(), REG_EXTENDED | REG_NOSUB | REG_ICASE);
179 match::do_match(config &c)
181 const string &value = c.get_variable(_var);
185 * This function gets called WAY too often to justify calling syslog()
186 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
187 * can consume excessive amounts of systime inside of connect(). Only
188 * log when we're in -d mode.
191 fprintf(stderr, "Testing %s=%s against %s\n", _var.c_str(),
192 value.c_str(), _re.c_str());
194 retval = (regexec(&_regex, value.c_str(), 0, NULL, 0) == 0);
196 retval = (retval == 0) ? 1 : 0;
201 #include <sys/sockio.h>
203 #include <net/if_media.h>
205 media::media(config &, const char *var, const char *type)
206 : _var(var), _type(-1)
208 static struct ifmedia_description media_types[] = {
209 { IFM_ETHER, "Ethernet" },
210 { IFM_IEEE80211, "802.11" },
212 { IFM_CARP, "CARP" },
216 for (int i = 0; media_types[i].ifmt_string != NULL; ++i)
217 if (strcasecmp(type, media_types[i].ifmt_string) == 0) {
218 _type = media_types[i].ifmt_word;
228 media::do_match(config &c)
231 struct ifmediareq ifmr;
235 // Since we can be called from both a device attach/detach
236 // context where device-name is defined and what we want,
237 // as well as from a link status context, where subsystem is
238 // the name of interest, first try device-name and fall back
239 // to subsystem if none exists.
240 value = c.get_variable("device-name");
242 value = c.get_variable("subsystem");
244 fprintf(stderr, "Testing media type of %s against 0x%x\n",
245 value.c_str(), _type);
249 s = socket(PF_INET, SOCK_DGRAM, 0);
251 memset(&ifmr, 0, sizeof(ifmr));
252 strncpy(ifmr.ifm_name, value.c_str(), sizeof(ifmr.ifm_name));
254 if (ioctl(s, SIOCGIFMEDIA, (caddr_t)&ifmr) >= 0 &&
255 ifmr.ifm_status & IFM_AVALID) {
257 fprintf(stderr, "%s has media type 0x%x\n",
258 value.c_str(), IFM_TYPE(ifmr.ifm_active));
259 retval = (IFM_TYPE(ifmr.ifm_active) == _type);
260 } else if (_type == -1) {
262 fprintf(stderr, "%s has unknown media type\n",
272 const string var_list::bogus = "_$_$_$_$_B_O_G_U_S_$_$_$_$_";
273 const string var_list::nothing = "";
276 var_list::get_variable(const string &var) const
278 map<string, string>::const_iterator i;
281 if (i == _vars.end())
282 return (var_list::bogus);
287 var_list::is_set(const string &var) const
289 return (_vars.find(var) != _vars.end());
293 var_list::set_variable(const string &var, const string &val)
296 * This function gets called WAY too often to justify calling syslog()
297 * each time, even at LOG_DEBUG. Because if syslogd isn't running, it
298 * can consume excessive amounts of systime inside of connect(). Only
299 * log when we're in -d mode.
302 fprintf(stderr, "setting %s=%s\n", var.c_str(), val.c_str());
310 delete_and_clear(_var_list_table);
311 delete_and_clear(_attach_list);
312 delete_and_clear(_detach_list);
313 delete_and_clear(_nomatch_list);
314 delete_and_clear(_notify_list);
318 config::parse_one_file(const char *fn)
321 fprintf(stderr, "Parsing %s\n", fn);
322 yyin = fopen(fn, "r");
324 err(1, "Cannot open config file %s", fn);
327 errx(1, "Cannot parse %s at line %d", fn, lineno);
332 config::parse_files_in_dir(const char *dirname)
339 fprintf(stderr, "Parsing files in %s\n", dirname);
340 dirp = opendir(dirname);
343 readdir(dirp); /* Skip . */
344 readdir(dirp); /* Skip .. */
345 while ((dp = readdir(dirp)) != NULL) {
346 if (strcmp(dp->d_name + dp->d_namlen - 5, ".conf") == 0) {
347 snprintf(path, sizeof(path), "%s/%s",
348 dirname, dp->d_name);
349 parse_one_file(path);
357 int operator()(event_proc *const&l1, event_proc *const&l2) const
359 return (l1->get_priority() > l2->get_priority());
364 config::sort_vector(vector<event_proc *> &v)
366 sort(v.begin(), v.end(), epv_greater());
372 vector<string>::const_iterator i;
374 parse_one_file(configfile);
375 for (i = _dir_list.begin(); i != _dir_list.end(); ++i)
376 parse_files_in_dir((*i).c_str());
377 sort_vector(_attach_list);
378 sort_vector(_detach_list);
379 sort_vector(_nomatch_list);
380 sort_vector(_notify_list);
384 config::open_pidfile()
388 if (_pidfile.empty())
390 pfh = pidfile_open(_pidfile.c_str(), 0600, &otherpid);
393 errx(1, "devd already running, pid: %d", (int)otherpid);
394 warn("cannot open pid file");
399 config::write_pidfile()
406 config::close_pidfile()
413 config::remove_pidfile()
420 config::add_attach(int prio, event_proc *p)
422 p->set_priority(prio);
423 _attach_list.push_back(p);
427 config::add_detach(int prio, event_proc *p)
429 p->set_priority(prio);
430 _detach_list.push_back(p);
434 config::add_directory(const char *dir)
436 _dir_list.push_back(string(dir));
440 config::add_nomatch(int prio, event_proc *p)
442 p->set_priority(prio);
443 _nomatch_list.push_back(p);
447 config::add_notify(int prio, event_proc *p)
449 p->set_priority(prio);
450 _notify_list.push_back(p);
454 config::set_pidfile(const char *fn)
460 config::push_var_table()
465 _var_list_table.push_back(vl);
467 fprintf(stderr, "Pushing table\n");
471 config::pop_var_table()
473 delete _var_list_table.back();
474 _var_list_table.pop_back();
476 fprintf(stderr, "Popping table\n");
480 config::set_variable(const char *var, const char *val)
482 _var_list_table.back()->set_variable(var, val);
486 config::get_variable(const string &var)
488 vector<var_list *>::reverse_iterator i;
490 for (i = _var_list_table.rbegin(); i != _var_list_table.rend(); ++i) {
491 if ((*i)->is_set(var))
492 return ((*i)->get_variable(var));
494 return (var_list::nothing);
498 config::is_id_char(char ch) const
500 return (ch != '\0' && (isalpha(ch) || isdigit(ch) || ch == '_' ||
505 config::expand_one(const char *&src, string &dst)
518 // Not sure if I want to support this or not, so for now we just pass
523 /* If the string ends before ) is matched , return. */
524 while (count > 0 && *src) {
527 else if (*src == '(')
535 if (!isalpha(*src)) {
541 // $var -> replace with value
544 } while (is_id_char(*src));
545 dst.append(get_variable(buffer));
549 config::expand_string(const char *src, const char *prepend, const char *append)
555 * 128 bytes is enough for 2427 of 2438 expansions that happen
556 * while parsing config files, as tested on 2013-01-30.
564 var_at = strchr(src, '$');
565 if (var_at == NULL) {
569 dst.append(src, var_at - src);
571 expand_one(src, dst);
581 config::chop_var(char *&buffer, char *&lhs, char *&rhs) const
587 walker = lhs = buffer;
588 while (is_id_char(*walker))
593 if (*walker == '"') {
596 while (*walker && *walker != '"')
604 while (*walker && !isspace(*walker))
610 while (isspace(*walker))
618 config::set_vars(char *buffer)
624 if (!chop_var(buffer, lhs, rhs))
626 set_variable(lhs, rhs);
632 config::find_and_execute(char type)
634 vector<event_proc *> *l;
635 vector<event_proc *>::const_iterator i;
659 fprintf(stderr, "Processing %s event\n", s);
660 for (i = l->begin(); i != l->end(); ++i) {
661 if ((*i)->matches(*this)) {
671 process_event(char *buffer)
678 fprintf(stderr, "Processing event '%s'\n", buffer);
680 cfg.push_var_table();
681 // No match doesn't have a device, and the format is a little
682 // different, so handle it separately.
685 sp = cfg.set_vars(sp);
688 //? at location pnp-info on bus
689 sp = strchr(sp, ' ');
691 return; /* Can't happen? */
695 if (strncmp(sp, "at ", 3) == 0)
697 sp = cfg.set_vars(sp);
700 if (strncmp(sp, "on ", 3) == 0)
701 cfg.set_variable("bus", sp + 3);
703 case attach: /*FALLTHROUGH*/
705 sp = strchr(sp, ' ');
707 return; /* Can't happen? */
709 cfg.set_variable("device-name", buffer);
712 if (strncmp(sp, "at ", 3) == 0)
714 sp = cfg.set_vars(sp);
717 if (strncmp(sp, "on ", 3) == 0)
718 cfg.set_variable("bus", sp + 3);
722 cfg.find_and_execute(type);
727 create_socket(const char *name)
730 struct sockaddr_un sun;
732 if ((fd = socket(PF_LOCAL, SOCK_STREAM, 0)) < 0)
734 bzero(&sun, sizeof(sun));
735 sun.sun_family = AF_UNIX;
736 strlcpy(sun.sun_path, name, sizeof(sun.sun_path));
737 slen = SUN_LEN(&sun);
739 if (fcntl(fd, F_SETFL, O_NONBLOCK) < 0)
741 if (::bind(fd, (struct sockaddr *) & sun, slen) < 0)
744 chown(name, 0, 0); /* XXX - root.wheel */
752 notify_clients(const char *data, int len)
755 list<int>::const_iterator i;
757 for (i = clients.begin(); i != clients.end(); ++i) {
758 if (write(*i, data, len) <= 0) {
764 for (i = bad.begin(); i != bad.end(); ++i)
765 clients.erase(find(clients.begin(), clients.end(), *i));
773 s = accept(fd, NULL, NULL);
775 clients.push_back(s);
783 char buffer[DEVCTL_MAXBUF];
785 int server_fd, max_fd;
789 fd = open(PATH_DEVCTL, O_RDONLY);
791 err(1, "Can't open devctl device %s", PATH_DEVCTL);
792 if (fcntl(fd, F_SETFD, FD_CLOEXEC) != 0)
793 err(1, "Can't set close-on-exec flag on devctl");
794 server_fd = create_socket(PIPE);
795 max_fd = max(fd, server_fd) + 1;
796 while (!romeo_must_die) {
797 if (!once && !dflag && !nflag) {
798 // Check to see if we have any events pending.
803 rv = select(fd + 1, &fds, NULL, NULL, &tv);
804 // No events -> we've processed all pending events
807 fprintf(stderr, "Calling daemon\n");
808 cfg.remove_pidfile();
817 FD_SET(server_fd, &fds);
818 rv = select(max_fd, &fds, NULL, NULL, NULL);
824 if (FD_ISSET(fd, &fds)) {
825 rv = read(fd, buffer, sizeof(buffer) - 1);
827 notify_clients(buffer, rv);
829 while (buffer[--rv] == '\n')
831 process_event(buffer);
840 if (FD_ISSET(server_fd, &fds))
841 new_client(server_fd);
847 * functions that the parser uses.
850 add_attach(int prio, event_proc *p)
852 cfg.add_attach(prio, p);
856 add_detach(int prio, event_proc *p)
858 cfg.add_detach(prio, p);
862 add_directory(const char *dir)
864 cfg.add_directory(dir);
865 free(const_cast<char *>(dir));
869 add_nomatch(int prio, event_proc *p)
871 cfg.add_nomatch(prio, p);
875 add_notify(int prio, event_proc *p)
877 cfg.add_notify(prio, p);
881 add_to_event_proc(event_proc *ep, eps *eps)
884 ep = new event_proc();
890 new_action(const char *cmd)
892 eps *e = new action(cmd);
893 free(const_cast<char *>(cmd));
898 new_match(const char *var, const char *re)
900 eps *e = new match(cfg, var, re);
901 free(const_cast<char *>(var));
902 free(const_cast<char *>(re));
907 new_media(const char *var, const char *re)
909 eps *e = new media(cfg, var, re);
910 free(const_cast<char *>(var));
911 free(const_cast<char *>(re));
916 set_pidfile(const char *name)
918 cfg.set_pidfile(name);
919 free(const_cast<char *>(name));
923 set_variable(const char *var, const char *val)
925 cfg.set_variable(var, val);
926 free(const_cast<char *>(var));
927 free(const_cast<char *>(val));
936 unlink("/var/run/devd.pid"); /* XXX */
942 fprintf(stderr, "usage: %s [-Ddn] [-f file]\n", getprogname());
953 if (sysctlbyname(SYSCTL, &val, &len, NULL, 0) != 0)
954 errx(1, "devctl sysctl missing from kernel!");
956 warnx("Setting " SYSCTL " to 0");
958 sysctlbyname(SYSCTL, NULL, NULL, &val, sizeof(val));
966 main(int argc, char **argv)
970 check_devd_enabled();
971 while ((ch = getopt(argc, argv, "Ddf:n")) != -1) {
991 if (!dflag && nflag) {
996 signal(SIGPIPE, SIG_IGN);
997 signal(SIGHUP, gensighand);
998 signal(SIGINT, gensighand);
999 signal(SIGTERM, gensighand);