1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2002-2003 M. Warner Losh.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: stable/11/sbin/devd/devd.hh 330449 2018-03-05 07:26:05Z eadler $
29 */
30
31#ifndef DEVD_HH
32#define DEVD_HH
33
34class config;
35
36/**
37 * var_list is a collection of variables.  These collections of variables
38 * are stacked up and popped down for each event that we have to process.
39 * We have multiple levels so that we can push variables that are unique
40 * to the event in question, in addition to having global variables.  This
41 * allows for future flexibility.
42 */
43class var_list
44{
45public:
46	/** Set a variable in this var list.
47	 */
48	void set_variable(const std::string &var, const std::string &val);
49	/** Get the variable out of this, and no other, var_list.  If
50	 * no variable of %var is set, then %bogus will be returned.
51	 */
52	const std::string &get_variable(const std::string &var) const;
53	/** Is there a variable of %var set in thi stable?
54	 */
55	bool is_set(const std::string &var) const;
56	/** A completely bogus string.
57	 */
58	static const std::string bogus;
59	static const std::string nothing;
60private:
61	std::map<std::string, std::string> _vars;
62};
63
64/**
65 * eps is short for event_proc_single.  It is a single entry in an
66 * event_proc.  Each keyword needs its own subclass from eps.
67 */
68struct eps
69{
70public:
71	virtual ~eps() {}
72	/** Does this eps match the current config?
73	 */
74	virtual bool do_match(config &) = 0;
75	/** Perform some action for this eps.
76	 */
77	virtual bool do_action(config &) = 0;
78};
79
80/**
81 * match is the subclass used to match an individual variable.  Its
82 * actions are nops.
83 */
84class match : public eps
85{
86public:
87	match(config &, const char *var, const char *re);
88	virtual ~match();
89	virtual bool do_match(config &);
90	virtual bool do_action(config &) { return true; }
91private:
92	bool _inv;
93	std::string _var;
94	std::string _re;
95	regex_t _regex;
96};
97
98/**
99 * media is the subclass used to match an individual variable.  Its
100 * actions are nops.
101 */
102class media : public eps
103{
104public:
105	media(config &, const char *var, const char *type);
106	virtual ~media();
107	virtual bool do_match(config &);
108	virtual bool do_action(config &) { return true; }
109private:
110	std::string _var;
111	int _type;
112};
113
114/**
115 * action is used to fork a process.  It matches everything.
116 */
117class action : public eps
118{
119public:
120	action(const char *cmd);
121	virtual ~action();
122	virtual bool do_match(config &) { return true; }
123	virtual bool do_action(config &);
124private:
125	std::string _cmd;
126};
127
128struct event_proc
129{
130public:
131	event_proc();
132	virtual ~event_proc();
133	int get_priority() const { return (_prio); }
134	void set_priority(int prio) { _prio = prio; }
135	void add(eps *);
136	bool matches(config &) const;
137	bool run(config &) const;
138private:
139	int _prio;
140	std::vector<eps *> _epsvec;
141};
142
143class config
144{
145public:
146	config() { push_var_table(); }
147	virtual ~config() { reset(); }
148	void add_attach(int, event_proc *);
149	void add_detach(int, event_proc *);
150	void add_directory(const char *);
151	void add_nomatch(int, event_proc *);
152	void add_notify(int, event_proc *);
153	void set_pidfile(const char *);
154	void reset();
155	void parse();
156	void close_pidfile();
157	void open_pidfile();
158	void write_pidfile();
159	void remove_pidfile();
160	void push_var_table();
161	void pop_var_table();
162	void set_variable(const char *var, const char *val);
163	const std::string &get_variable(const std::string &var);
164	const std::string expand_string(const char * var,
165	    const char * prepend = NULL, const char * append = NULL);
166	char *set_vars(char *);
167	void find_and_execute(char);
168protected:
169	void sort_vector(std::vector<event_proc *> &);
170	void parse_one_file(const char *fn);
171	void parse_files_in_dir(const char *dirname);
172	void expand_one(const char *&src, std::string &dst);
173	bool is_id_char(char) const;
174	bool chop_var(char *&buffer, char *&lhs, char *&rhs) const;
175private:
176	std::vector<std::string> _dir_list;
177	std::string _pidfile;
178	std::vector<var_list *> _var_list_table;
179	std::vector<event_proc *> _attach_list;
180	std::vector<event_proc *> _detach_list;
181	std::vector<event_proc *> _nomatch_list;
182	std::vector<event_proc *> _notify_list;
183};
184
185#endif /* DEVD_HH */
186