gvpe/src/iom.h

/*
    iom.h -- generic I/O multiplexer
    Copyright (C) 2003-2006 Marc Lehmann <gvpe@schmorp.de>
 
    This file is part of GVPE.

    GVPE is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with gvpe; if not, write to the Free Software
    Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef IOM_H__
#define IOM_H__

// required:
// - a vector template like simplevec or stl's vector
// - defines for all watcher types required in your app
// edit iom_conf.h as appropriate.
#include "iom_conf.h"

#if IOM_CHILD
# undef IOM_SIG
# define IOM_SIG 1
#endif

#include "callback.h"

typedef double tstamp;
extern tstamp NOW;

// TSTAMP_MAX must still fit into a positive struct timeval
#define TSTAMP_MAX (double)(1UL<<31)

struct watcher;
#if IOM_IO
struct io_watcher;
#endif
#if IOM_TIME
struct time_watcher;
#endif
#if IOM_CHECK
struct check_watcher;
#endif
#if IOM_IDLE
struct idle_watcher;
#endif
#if IOM_SIG
struct sig_watcher;
#endif
#if IOM_CHILD
struct child_watcher;
#endif

template<class watcher>
struct io_manager_vec : vector<watcher *> {
  void erase_unordered (unsigned int pos)
  {
    watcher *w = (*this)[this->size () - 1];
    this->pop_back ();

    if (!this->empty ())
      if (((*this)[pos] = w)) // '=' is correct!
        w->active = pos + 1;
  }
};

// only used as a namespace, and for initialisation purposes
class io_manager {
  template<class watcher>
  static void reg (watcher &w, io_manager_vec<watcher> &queue);

  template<class watcher>
  static void unreg (watcher &w, io_manager_vec<watcher> &queue);

public:
#if IOM_TIME
  // fetch time only
  static tstamp now ();

  // set NOW
  static void set_now ();
#endif

  // register a watcher
#if IOM_IO
  static void reg (io_watcher    &w); static void unreg (io_watcher    &w);
#endif
#if IOM_TIME
  static void reg (time_watcher  &w); static void unreg (time_watcher  &w);
#endif
#if IOM_CHECK
  static void reg (check_watcher &w); static void unreg (check_watcher &w);
#endif
#if IOM_IDLE
  static void reg (idle_watcher  &w); static void unreg (idle_watcher  &w);
#endif
#if IOM_SIG
  static void reg (sig_watcher   &w); static void unreg (sig_watcher   &w);
#endif
#if IOM_CHILD
  static void reg (child_watcher &w); static void unreg (child_watcher &w);
#endif
  
  static void loop ();
};

struct watcher {
  int active; /* 0 == inactive, else index into respective vector */

  bool is_active () { return active; }

  watcher () : active (0) { }
};

#if IOM_IO
enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 };

struct io_watcher : watcher, callback2<void, io_watcher &, short> {
  int fd;
  short events;

  void set (int fd_, short events_) { fd = fd_; events = events_; }

  void set (short events_) { set (fd, events_); }
  void start () { io_manager::reg (*this); }
  void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  io_watcher (O1 *object, void (O2::*method) (io_watcher &, short))
  : callback2<void, io_watcher &, short> (object, method)
  { }
  ~io_watcher () { stop (); }
};
#endif

#if IOM_TIME
struct time_watcher : watcher, callback1<void, time_watcher &> {
  tstamp at;

  void trigger ();

  void set (tstamp when) { at = when; }
  void operator () () { trigger (); }
  void start () { io_manager::reg (*this); }
  void start (tstamp when) { set (when); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  time_watcher (O1 *object, void (O2::*method) (time_watcher &))
  : callback1<void, time_watcher &> (object, method), at (0)
  { }
  ~time_watcher () { stop (); }
};
#endif

#if IOM_CHECK
// run before checking for new events
struct check_watcher : watcher, callback1<void, check_watcher &> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  check_watcher (O1 *object, void (O2::*method) (check_watcher &))
  : callback1<void, check_watcher &> (object, method)
  { }
  ~check_watcher () { stop (); }
};
#endif

#if IOM_IDLE
// run after checking for any i/o, but before waiting
struct idle_watcher : watcher, callback1<void, idle_watcher &> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  idle_watcher (O1 *object, void (O2::*method) (idle_watcher &))
    : callback1<void, idle_watcher &> (object, method)
    { }
  ~idle_watcher () { stop (); }
};
#endif

#if IOM_SIG
struct sig_watcher : watcher, callback1<void, sig_watcher &> {
  int signum;

  void start (int signum);
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  sig_watcher (O1 *object, void (O2::*method) (sig_watcher &))
  : callback1<void, sig_watcher &> (object, method), signum (0)
  { }
  ~sig_watcher () { stop (); }
};
#endif

#if IOM_CHILD
struct child_watcher : watcher, callback2<void, child_watcher &, int> {
  int /*pid_t*/ pid;

  void start (int pid) { this->pid = pid; io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  child_watcher (O1 *object, void (O2::*method) (child_watcher &, int status))
  : callback2<void, child_watcher &, int> (object, method), pid (0)
  { }
  ~child_watcher () { stop (); }
};
#endif

#endif

Revision:	1.31
Committed:	Thu Jan 19 20:16:06 2006 UTC (18 years, 4 months ago) by pcg
Content type:	text/plain
Branch:	MAIN
Changes since 1.30:	+34 -22 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2	pcg	1.24	iom.h -- generic I/O multiplexer
3	pcg	1.31	Copyright (C) 2003-2006 Marc Lehmann <gvpe@schmorp.de>
4	pcg	1.1
5	pcg	1.27	This file is part of GVPE.
6
7			GVPE is free software; you can redistribute it and/or modify
8	pcg	1.1	it under the terms of the GNU General Public License as published by
9			the Free Software Foundation; either version 2 of the License, or
10			(at your option) any later version.
11
12			This program is distributed in the hope that it will be useful,
13			but WITHOUT ANY WARRANTY; without even the implied warranty of
14			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			GNU General Public License for more details.
16
17			You should have received a copy of the GNU General Public License
18	pcg	1.27	along with gvpe; if not, write to the Free Software
19	pcg	1.29	Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20	pcg	1.1	*/
21
22	pcg	1.15	#ifndef IOM_H__
23			#define IOM_H__
24	pcg	1.1
25	pcg	1.15	// required:
26			// - a vector template like simplevec or stl's vector
27			// - defines for all watcher types required in your app
28			// edit iom_conf.h as appropriate.
29			#include "iom_conf.h"
30	pcg	1.1
31	pcg	1.31	#if IOM_CHILD
32			# undef IOM_SIG
33			# define IOM_SIG 1
34			#endif
35
36	pcg	1.15	#include "callback.h"
37	pcg	1.1
38	pcg	1.2	typedef double tstamp;
39			extern tstamp NOW;
40	pcg	1.1
41	pcg	1.28	// TSTAMP_MAX must still fit into a positive struct timeval
42			#define TSTAMP_MAX (double)(1UL<<31)
43
44	pcg	1.15	struct watcher;
45			#if IOM_IO
46	pcg	1.1	struct io_watcher;
47	pcg	1.15	#endif
48			#if IOM_TIME
49	pcg	1.1	struct time_watcher;
50	pcg	1.15	#endif
51			#if IOM_CHECK
52			struct check_watcher;
53			#endif
54			#if IOM_IDLE
55			struct idle_watcher;
56			#endif
57	pcg	1.19	#if IOM_SIG
58			struct sig_watcher;
59			#endif
60	pcg	1.31	#if IOM_CHILD
61			struct child_watcher;
62			#endif
63	pcg	1.15
64			template<class watcher>
65	pcg	1.18	struct io_manager_vec : vector<watcher *> {
66	pcg	1.15	void erase_unordered (unsigned int pos)
67			{
68	pcg	1.20	watcher w = (this)[this->size () - 1];
69			this->pop_back ();
70	pcg	1.15
71	pcg	1.23	if (!this->empty ())
72	pcg	1.22	if (((*this)[pos] = w)) // '=' is correct!
73	pcg	1.15	w->active = pos + 1;
74			}
75			};
76	pcg	1.1
77	pcg	1.21	// only used as a namespace, and for initialisation purposes
78	pcg	1.1	class io_manager {
79	pcg	1.15	template<class watcher>
80	pcg	1.21	static void reg (watcher &w, io_manager_vec<watcher> &queue);
81	pcg	1.1
82	pcg	1.15	template<class watcher>
83	pcg	1.21	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
84	pcg	1.6
85	pcg	1.15	public:
86	pcg	1.26	#if IOM_TIME
87			// fetch time only
88			static tstamp now ();
89
90			// set NOW
91			static void set_now ();
92			#endif
93
94	pcg	1.1	// register a watcher
95	pcg	1.15	#if IOM_IO
96	pcg	1.21	static void reg (io_watcher &w); static void unreg (io_watcher &w);
97	pcg	1.15	#endif
98			#if IOM_TIME
99	pcg	1.21	static void reg (time_watcher &w); static void unreg (time_watcher &w);
100	pcg	1.15	#endif
101			#if IOM_CHECK
102	pcg	1.21	static void reg (check_watcher &w); static void unreg (check_watcher &w);
103	pcg	1.15	#endif
104			#if IOM_IDLE
105	pcg	1.21	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
106	pcg	1.15	#endif
107	pcg	1.19	#if IOM_SIG
108	pcg	1.21	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
109	pcg	1.19	#endif
110	pcg	1.31	#if IOM_CHILD
111			static void reg (child_watcher &w); static void unreg (child_watcher &w);
112			#endif
113	pcg	1.1
114	pcg	1.21	static void loop ();
115	pcg	1.1	};
116
117	pcg	1.15	struct watcher {
118			int active; /* 0 == inactive, else index into respective vector */
119
120	pcg	1.31	bool is_active () { return active; }
121
122	pcg	1.19	watcher () : active (0) { }
123	pcg	1.15	};
124
125			#if IOM_IO
126	pcg	1.30	enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 };
127	pcg	1.15
128			struct io_watcher : watcher, callback2<void, io_watcher &, short> {
129	pcg	1.12	int fd;
130			short events;
131	pcg	1.10
132	pcg	1.15	void set (int fd_, short events_) { fd = fd_; events = events_; }
133
134			void set (short events_) { set (fd, events_); }
135	pcg	1.21	void start () { io_manager::reg (*this); }
136			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
137			void stop () { io_manager::unreg (*this); }
138	pcg	1.15
139	pcg	1.1	template<class O1, class O2>
140	pcg	1.19	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
141	pcg	1.31	: callback2<void, io_watcher &, short> (object, method)
142	pcg	1.15	{ }
143			~io_watcher () { stop (); }
144			};
145			#endif
146
147			#if IOM_TIME
148			struct time_watcher : watcher, callback1<void, time_watcher &> {
149			tstamp at;
150	pcg	1.2
151	pcg	1.15	void trigger ();
152	pcg	1.11
153	pcg	1.15	void set (tstamp when) { at = when; }
154	pcg	1.19	void operator () () { trigger (); }
155	pcg	1.21	void start () { io_manager::reg (*this); }
156			void start (tstamp when) { set (when); io_manager::reg (*this); }
157			void stop () { io_manager::unreg (*this); }
158	pcg	1.6
159	pcg	1.15	template<class O1, class O2>
160	pcg	1.19	time_watcher (O1 object, void (O2::method) (time_watcher &))
161	pcg	1.31	: callback1<void, time_watcher &> (object, method), at (0)
162	pcg	1.15	{ }
163			~time_watcher () { stop (); }
164			};
165			#endif
166	pcg	1.11
167	pcg	1.15	#if IOM_CHECK
168			// run before checking for new events
169			struct check_watcher : watcher, callback1<void, check_watcher &> {
170	pcg	1.21	void start () { io_manager::reg (*this); }
171			void stop () { io_manager::unreg (*this); }
172	pcg	1.1
173	pcg	1.15	template<class O1, class O2>
174	pcg	1.19	check_watcher (O1 object, void (O2::method) (check_watcher &))
175	pcg	1.31	: callback1<void, check_watcher &> (object, method)
176	pcg	1.15	{ }
177			~check_watcher () { stop (); }
178	pcg	1.1	};
179	pcg	1.15	#endif
180	pcg	1.1
181	pcg	1.15	#if IOM_IDLE
182			// run after checking for any i/o, but before waiting
183			struct idle_watcher : watcher, callback1<void, idle_watcher &> {
184	pcg	1.21	void start () { io_manager::reg (*this); }
185			void stop () { io_manager::unreg (*this); }
186	pcg	1.2
187			template<class O1, class O2>
188	pcg	1.19	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
189	pcg	1.31	: callback1<void, idle_watcher &> (object, method)
190	pcg	1.2	{ }
191	pcg	1.15	~idle_watcher () { stop (); }
192	pcg	1.19	};
193			#endif
194
195			#if IOM_SIG
196			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
197			int signum;
198
199			void start (int signum);
200	pcg	1.21	void stop () { io_manager::unreg (*this); }
201	pcg	1.19
202			template<class O1, class O2>
203			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
204	pcg	1.31	: callback1<void, sig_watcher &> (object, method), signum (0)
205	pcg	1.19	{ }
206			~sig_watcher () { stop (); }
207	pcg	1.1	};
208	pcg	1.15	#endif
209	pcg	1.1
210	pcg	1.31	#if IOM_CHILD
211			struct child_watcher : watcher, callback2<void, child_watcher &, int> {
212			int /pid_t/ pid;
213
214			void start (int pid) { this->pid = pid; io_manager::reg (*this); }
215			void stop () { io_manager::unreg (*this); }
216
217			template<class O1, class O2>
218			child_watcher (O1 object, void (O2::method) (child_watcher &, int status))
219			: callback2<void, child_watcher &, int> (object, method), pid (0)
220			{ }
221			~child_watcher () { stop (); }
222			};
223			#endif
224
225	pcg	1.1	#endif
226