1 |
use strict qw(vars subs); |
2 |
use Canary::Stability EV => 1, 5.008002; |
3 |
use Config; |
4 |
use ExtUtils::MakeMaker; |
5 |
|
6 |
sub have_inc($) { |
7 |
scalar grep -r "$_/$_[0]", $Config{usrinc}, split / /, $Config{incpth} |
8 |
} |
9 |
|
10 |
my $DEFINE; |
11 |
|
12 |
unless (-e "libev/ev_linuxaio.c") { |
13 |
print <<EOF; |
14 |
|
15 |
*** |
16 |
*** ERROR: libev is missing or damaged. If you used a CVS check-out of EV, |
17 |
*** you also have to check-out the "libev" module from the same CVS |
18 |
*** repository into the EV dir (i.e. EV/libev from outside). |
19 |
*** |
20 |
|
21 |
EOF |
22 |
exit 1; |
23 |
} |
24 |
|
25 |
print <<EOF; |
26 |
|
27 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
28 |
|
29 |
|
30 |
Welcome to EV configuration. If you are in a hurry, just press return here |
31 |
and hope for the best. The defaults should usually do. |
32 |
|
33 |
EOF |
34 |
|
35 |
if (prompt ("Skip further questions and use defaults (y/n)?", "y") =~ /[yY]/) { |
36 |
$ENV{PERL_MM_USE_DEFAULT} = 1; |
37 |
} |
38 |
|
39 |
print <<EOF; |
40 |
|
41 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
42 |
|
43 |
|
44 |
POSIX optionally offers support for a monotonic clock source. EV |
45 |
can take advantage of this clock source to detect time jumps more |
46 |
reliably. Unfortunately, some systems are bound to be broken, so you can |
47 |
disable this here: you can completely disable the detection and use of |
48 |
the monotonic clock by answering 'n' here. Support for this clock type |
49 |
will otherwise be autodetected at both compile- and runtime. (this setting |
50 |
currently affects the use of nanosleep over select as well). |
51 |
|
52 |
EOF |
53 |
|
54 |
unless (prompt ("Enable optional support for CLOCK_MONOTONIC (y/n)?", "y") =~ /[yY]/) { |
55 |
$DEFINE .= " -DEV_USE_MONOTONIC=0"; |
56 |
} |
57 |
|
58 |
print <<EOF; |
59 |
|
60 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
61 |
|
62 |
|
63 |
POSIX optionally offers support for a (potentially) high-resolution |
64 |
realtime clock interface. In a good implementation, using it is faster |
65 |
than the normal method of using gettimeofday. Unfortunately, this option |
66 |
is also bound to be broken on some systems, and current EV versions do not |
67 |
actually call gettimeofday very often, so it defaults to no. |
68 |
|
69 |
EOF |
70 |
|
71 |
$DEFINE .= " -DEV_USE_REALTIME=" . (0 + (prompt ("Prefer clock_gettime (CLOCK_REALTIME) over gettimeofday (y/n)?", "n") =~ /[yY]/)); |
72 |
|
73 |
print <<EOF; |
74 |
|
75 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
76 |
|
77 |
|
78 |
EV can use various backends with various portability issues. The select |
79 |
backend is the most portable and makes for a good fallback, but it can be |
80 |
limited to a low number of file descriptors and/or might not compile. If |
81 |
you have problems with compiling ev_select.c, you might try to play around |
82 |
with disabling it here, or forcing it to use the fd_set provided by your |
83 |
OS, via the next question. I highly recommend keeping it in. |
84 |
|
85 |
EOF |
86 |
|
87 |
if (prompt ("Enable select backend (y/n)?", "y") =~ /[yY]/) { |
88 |
$DEFINE .= " -DEV_USE_SELECT=1"; |
89 |
|
90 |
print <<EOF; |
91 |
|
92 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
93 |
|
94 |
|
95 |
The select backend can operate in two modes. One uses the system-provided |
96 |
fd_set and is usually limited to 1024 file descriptors (64 on windows), |
97 |
the other requires your header files to define NFDBITS and declare a |
98 |
suitable fd_mask type. If you run into problems compiling ev_select.c, you |
99 |
can try forcing the use of the system fd_set here. |
100 |
|
101 |
EOF |
102 |
|
103 |
if (prompt ("Force use of system fd_set for select backend (y/n)?", "n") =~ /[yY]/) { |
104 |
$DEFINE .= " -DEV_SELECT_USE_FD_SET"; |
105 |
} |
106 |
} else { |
107 |
$DEFINE .= " -DEV_USE_SELECT=0"; |
108 |
} |
109 |
|
110 |
print <<EOF; |
111 |
|
112 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
113 |
|
114 |
|
115 |
The second very portable backend is poll(2). It does not exist on windows |
116 |
and various versions of Mac OS X (and on the other versions it simply |
117 |
doesn't work), but works basically everywhere else. It is recommended to use |
118 |
the default here unless you run into compile problems in ev_poll.c. |
119 |
|
120 |
EOF |
121 |
|
122 |
$DEFINE .= " -DEV_USE_POLL=" . (0 + (prompt ("Enable poll backend (y/n)?", (have_inc "poll.h") ? "y" : "n") =~ /[yY]/)); |
123 |
|
124 |
print <<EOF; |
125 |
|
126 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
127 |
|
128 |
|
129 |
Select and poll make it hard to write efficient servers, especially if the |
130 |
number of active connections is much lower than the watched ones. GNU/Linux |
131 |
systems have a more scalable method called "epoll", which EV can use. For |
132 |
this to work, both your kernel and glibc have to support epoll, but if you |
133 |
can compile it, the detection will be done at runtime, and EV will safely |
134 |
fall back to using select when epoll isn't available. If unsure, accept |
135 |
the default. |
136 |
|
137 |
EOF |
138 |
|
139 |
my $can_epoll = have_inc "sys/epoll.h"; |
140 |
$can_epoll = $ENV{EV_EPOLL} if exists $ENV{EV_EPOLL}; |
141 |
$DEFINE .= " -DEV_USE_EPOLL=" . (0 + (prompt ("Enable epoll backend (y/n)?", $can_epoll ? "y" : "n") =~ /[yY]/)); |
142 |
|
143 |
print <<EOF; |
144 |
|
145 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
146 |
|
147 |
|
148 |
Linux 4.18 introduced another event polling interface, this time using |
149 |
the Linux AIO API. While this API is far superior to epoll and almost |
150 |
rivals kqueue, it also suffers from the same issues as kqueue typically |
151 |
does: only a subset of file types are supported (as of 4.19, I have seen |
152 |
eventfd, pipes, sockets files and some devices, but no ttys). It also |
153 |
is subject arbitrary system-wide limits imposed on it. Therefore, this |
154 |
backend is not used by default, even when it is compiled in, and you have |
155 |
to request it explicitly, e.g. with LIBEV_FLAGS=64. If unsure, accept the |
156 |
default. |
157 |
|
158 |
EOF |
159 |
|
160 |
my $can_linuxaio = have_inc "linux/aio_abi.h"; |
161 |
$can_linuxaio = $ENV{EV_LINUXAIO} if exists $ENV{EV_LINUXAIO}; |
162 |
$can_linuxaio = 0 + (prompt ("Enable linux aio backend (y/n)?", $can_linuxaio ? "y" : "n") =~ /[yY]/); |
163 |
$DEFINE .= " -DEV_USE_LINUXAIO=$can_linuxaio"; |
164 |
|
165 |
if ($can_linuxaio) { |
166 |
print <<EOF; |
167 |
|
168 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
169 |
|
170 |
|
171 |
The previously mentioned Linux AIO backend is experimental and will not |
172 |
be used unless requested explicitly. You can, howeer, choose to make ti a |
173 |
recommended basckend, which means it will be chosen if available even when |
174 |
not explicitly asked for, in preference to epoll on GNU/Linux. This option |
175 |
is likely temporary. When unsure, accept the default. |
176 |
|
177 |
EOF |
178 |
|
179 |
my $recommend_linuxaio = 0; |
180 |
$recommend_linuxaio = $ENV{EV_RECOMMEND_LINUXAIO} if exists $ENV{EV_RECOMMEND_LINUXAIO}; |
181 |
$recommend_linuxaio = 0 + (prompt ("Treat linux aio as a recommended backend (y/n)?", $recommend_linuxaio ? "y" : "n") =~ /[yY]/); |
182 |
$DEFINE .= " -DEV_RECOMMEND_LINUXAIO=$recommend_linuxaio"; |
183 |
} |
184 |
|
185 |
print <<EOF; |
186 |
|
187 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
188 |
|
189 |
|
190 |
Similarly to the epoll backend above, EV can take advantage of kqueue on |
191 |
many BSD systems. Support for kqueue will be detected at runtime, with a |
192 |
safe fallback to other methods when it cannot be used. |
193 |
|
194 |
Note that kqueue is broken on most operating systems, so by default it |
195 |
won't be used on many platforms, but you can still create your own event |
196 |
loop with kqueue backend if you ask specifically for it. |
197 |
|
198 |
Here is what we know: |
199 |
|
200 |
NetBSD: partially working in at least 3.1 and later. Yeah! :) |
201 |
FreeBSD: broken on at least 6.2-STABLE, spotty in later versions, |
202 |
sockets *likely* work, ptys definitely don't. |
203 |
OpenBSD: reports indicate that it likely doesn't work |
204 |
(similar problems as on FreeBSD). |
205 |
OS X: completely, utterly broken on at least <= 10.6. |
206 |
|
207 |
EOF |
208 |
|
209 |
my $can_kqueue = have_inc "sys/event.h"; |
210 |
$can_kqueue = $ENV{EV_KQUEUE} if exists $ENV{EV_KQUEUE}; |
211 |
$DEFINE .= " -DEV_USE_KQUEUE=" . (0 + (prompt ("Enable kqueue backend (y/n)?", $can_kqueue ? "y" : "n") =~ /[yY]/)); |
212 |
|
213 |
print <<EOF; |
214 |
|
215 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
216 |
|
217 |
|
218 |
Similarly to the kqueue backend above, EV can take advantage of the |
219 |
solaris 10 event port interface. Support for event ports will be detected |
220 |
at runtime, with a safe fallback to other methods when it cannot be used. |
221 |
|
222 |
EOF |
223 |
|
224 |
$DEFINE .= " -DEV_USE_PORT=" . (0 + (prompt ("Enable event port backend (y/n)?", (have_inc "sys/port.h") ? "y" : "n") =~ /[yY]/)); |
225 |
|
226 |
print <<EOF; |
227 |
|
228 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
229 |
|
230 |
|
231 |
EV needs the functions pthread_atfork and clock_gettime. On most systems |
232 |
you need some special libraries for this (such as -lrt and -lpthread). You |
233 |
can specify additional libraries to provide these calls (and any other |
234 |
required by EV) now, or accept the default. |
235 |
|
236 |
On GNU/Linux systems, EV uses the LSB 3.1 __register_atfork function |
237 |
to avoid the dependency on libpthread, and directly uses the clock_gettime |
238 |
syscall to avoid a dependency on librt. |
239 |
|
240 |
EOF |
241 |
|
242 |
my $solaris_libs = $^O =~ /solaris/i ? "-lsocket -lnsl" : ""; |
243 |
my $librt = $^O =~ /linux/i ? "" : "-lpthread -lrt"; |
244 |
my $LIBS = exists $ENV{EV_LIBS} ? $ENV{EV_LIBS} : "$librt $solaris_libs"; |
245 |
$LIBS = prompt "Extra libraries for pthread_atfork and clock_gettime?", $LIBS; |
246 |
|
247 |
|
248 |
print <<EOF; |
249 |
|
250 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
251 |
|
252 |
|
253 |
A backend of a different kind is the Linux inotify(7) interface, which can |
254 |
be used to speed up (and reduce resource consumption) of stat watchers. If |
255 |
you have the include file and libc support for it, it is usually a good |
256 |
idea to enable it, as kernel availability is detected at runtime. |
257 |
|
258 |
EOF |
259 |
|
260 |
my $can_inotify = have_inc "sys/inotify.h"; |
261 |
$can_inotify = $ENV{EV_INOTIFY} if exists $ENV{EV_INOTIFY}; |
262 |
$DEFINE .= " -DEV_USE_INOTIFY=" . (0 + (prompt ("Enable inotify support (y/n)?", $can_inotify ? "y" : "n") =~ /[yY]/)); |
263 |
|
264 |
print <<EOF; |
265 |
|
266 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
267 |
|
268 |
|
269 |
Another useful bit of functionality is the Linux eventfd, which is useful |
270 |
for faster signal handling (don't care) and intra-thread communications |
271 |
(more relevant). Kernel support for this will be probed at runtime, but |
272 |
your libc must contain the necessary wrapper. Glibc 2.7 and later should |
273 |
have this wrapper. |
274 |
|
275 |
EOF |
276 |
|
277 |
my $can_eventfd = have_inc "sys/eventfd.h"; |
278 |
$can_eventfd = $ENV{EV_EVENTFD} if exists $ENV{EV_EVENTFD}; |
279 |
$DEFINE .= " -DEV_USE_EVENTFD=" . (0 + (prompt ("Enable linux eventfd support (y/n)?", $can_eventfd ? "y" : "n") =~ /[yY]/)); |
280 |
|
281 |
print <<EOF; |
282 |
|
283 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
284 |
|
285 |
|
286 |
Another sometimes useful bit of functionality is the Linux signalfd, which |
287 |
is useful for faster signal handling (don't care). Kernel support for |
288 |
this will be probed at runtime, but your libc must contain the necessary |
289 |
wrapper. Glibc 2.7 and later should have this wrapper. |
290 |
|
291 |
EOF |
292 |
|
293 |
my $can_signalfd = have_inc "sys/signalfd.h"; |
294 |
$can_signalfd = $ENV{EV_SIGNALFD} if exists $ENV{EV_SIGNALFD}; |
295 |
$DEFINE .= " -DEV_USE_SIGNALFD=" . (0 + (prompt ("Enable linux signalfd support (y/n)?", $can_signalfd ? "y" : "n") =~ /[yY]/)); |
296 |
|
297 |
print <<EOF; |
298 |
|
299 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
300 |
|
301 |
|
302 |
Libev contains numerous internal assert() invocations to check for |
303 |
consistency and user errors. These are normally enabled, but most |
304 |
perl builds disable this error reporting mechanism by default. You |
305 |
can re-enable these asserts here. Enabling them might help you catch |
306 |
programming bugs earlier, but might cause a small slowdown. Also, failures |
307 |
will be reported by aboritng your program, instead of throwing a perl |
308 |
exception. |
309 |
|
310 |
If unsure, enable this if you only use this perl installation for |
311 |
development, and leave it off for use in production environments. |
312 |
|
313 |
EOF |
314 |
|
315 |
my $enable_assertions = 0; |
316 |
$enable_assertions = 0 + (prompt ("Make sure assertions are enabled? (y/n)?", $enable_assertions ? "y" : "n") =~ /[yY]/); |
317 |
$DEFINE .= " -DEV_ENABLE_ASERTIONS=1" if $enable_assertions; |
318 |
|
319 |
print <<EOF; |
320 |
|
321 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
322 |
|
323 |
|
324 |
Very rarely, people want to tweak EV even more, e.g. to exclude |
325 |
or include certain watcher types or backends. This can be done by adding |
326 |
extra -D options here, or via the EV_EXTRA_DEFS environment variable. |
327 |
|
328 |
For example, if you run into compile problems because of missing memory |
329 |
fences (or you just want extra performance), you can tell EV to not support |
330 |
smp and threads via -DEV_NO_THREADS. |
331 |
|
332 |
Normal persons just press enter. |
333 |
|
334 |
EOF |
335 |
|
336 |
$DEFINE .= " " . prompt "Any extra -D options?", "$ENV{EV_EXTRA_DEFS}"; |
337 |
|
338 |
print <<EOF; |
339 |
|
340 |
*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** |
341 |
|
342 |
|
343 |
EOF |
344 |
|
345 |
my @anyevent = eval { require AnyEvent; $AnyEvent::VERSION < 5.29 } ? (AnyEvent => 5.29) : (); |
346 |
|
347 |
WriteMakefile( |
348 |
dist => { |
349 |
PREOP => 'pod2text EV.pm | tee README >$(DISTVNAME)/README; chmod -R u=rwX,go=rX . ;', |
350 |
COMPRESS => 'gzip -9v', |
351 |
SUFFIX => '.gz', |
352 |
}, |
353 |
depend => { |
354 |
"EV.c" => "EV/EVAPI.h " |
355 |
. "libev/ev.c libev/ev.h libev/ev_epoll.c libev/ev_select.c libev/ev_kqueue.c libev/ev_poll.c libev/ev_linuxaio.c " |
356 |
. "libev/ev_vars.h libev/ev_wrap.h", |
357 |
}, |
358 |
INC => "-Ilibev", |
359 |
DEFINE => "$DEFINE", |
360 |
NAME => "EV", |
361 |
LIBS => [$LIBS], |
362 |
PREREQ_PM => { |
363 |
@anyevent, |
364 |
"common::sense" => 0, |
365 |
}, |
366 |
CONFIGURE_REQUIRES => { "ExtUtils::MakeMaker" => 6.52, "Canary::Stability" => 0 }, |
367 |
VERSION_FROM => "EV.pm", |
368 |
PM => { |
369 |
'EV.pm' => '$(INST_LIB)/EV.pm', |
370 |
'EV/EVAPI.h' => '$(INST_LIB)/EV/EVAPI.h', |
371 |
'EV/MakeMaker.pm' => '$(INST_LIB)/EV/MakeMaker.pm', |
372 |
'libev/ev.h' => '$(INST_LIB)/EV/ev.h', |
373 |
'libev/ev.pod' => '$(INST_LIB)/EV/libev.pod', |
374 |
}, |
375 |
MAN3PODS => { |
376 |
'EV.pm' => '$(INST_MAN3DIR)/EV.$(MAN3EXT)', |
377 |
'EV/MakeMaker.pm' => '$(INST_MAN3DIR)/EV::MakeMaker.$(MAN3EXT)', |
378 |
'libev/ev.pod' => '$(INST_MAN3DIR)/EV::libev.$(MAN3EXT)', |
379 |
}, |
380 |
); |
381 |
|