ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/Makefile.PL
(Generate patch)

Comparing EV/Makefile.PL (file contents):
Revision 1.16 by root, Tue Nov 6 17:20:42 2007 UTC vs.
Revision 1.67 by root, Fri Dec 20 21:05:49 2019 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines