ChangeLog revision 275970
1275970ScyChanges in version 2.1.4-beta (?? Dec 2013)
2275970Scy
3275970Scy (As of 735d838b0a537ae04f1e6a2e9cbc5f3f45ebb541)
4275970Scy
5275970Scy
6275970Scy Bugfixes (evdns)
7275970Scy   o Checking request nameserver for NULL, before using it. (5c710c0
8275970Scy     Belobrov Andrey)
9275970Scy   o Fix SEGFAULT after evdns_base_resume if no nameservers installed. (14971a8
10275970Scy     Azat Khuzhin)
11275970Scy   o Actually use the log facility for reporting evdns problems. (e1766a1)
12275970Scy   o Fix SEGFAULT after evdns_base_resume if no nameservers installed. (f8d7df8 Azat Khuzhin)
13275970Scy
14275970Scy Bugfixes (compilatin)
15275970Scy   o Fix test compilation with nmake: add the gdi.lib dependency (5ba8ab7)
16275970Scy   o Whoops. It is gdi.lib, not gdi32.lib. (github issue #61) (8ab612e)
17275970Scy   o Don't use return since return type is void and build error occurs using clang (838161d Makoto Kato)
18275970Scy   o Use void casts to suppress some "unchecked return value" warns (7080d55)
19275970Scy   o rpcgen: Generate regress.gen.[c,h] in build rather than src dir (243386c Ross Lagerwall)
20275970Scy   o Fix a compiler warning when checking for arc4random_buf linker breakage. (5cb3865)
21275970Scy
22275970Scy Bugfixes (locks, synchronization)
23275970Scy   o Missed lock acquire/release in event_base_cancel_single_callback_()
24275970Scy     (d3d999a Azat Khuzhin)
25275970Scy   o Fix locking in bufferevent_get_options_(). (dbc9cd4 Maxime Henrion)
26275970Scy
27275970Scy Bugfixes (leaks)
28275970Scy   o Avoid leaking segment mappings when offset is not a page multiple (d409514)
29275970Scy
30275970Scy Testing
31275970Scy   o Add tests for evdns_base_resume(). (1cd9ff5 Azat Khuzhin)
32275970Scy   o Fix dns/leak_resume_send_err test. (7e876df Azat Khuzhin)
33275970Scy   o Add checks for evhttp_connection_get_server() in unit tests. (fbc323b Maxime Henrion)
34275970Scy   o Fix a (failure-only) null dereference in the unit tests (1104d0b)
35275970Scy   o Fix a logic error in test_evbuffer_freeze (7765884)
36275970Scy   o Add missing check to test_evbuffer_file_segment_add_cleanup_cb (eba4506)
37275970Scy   o Fix some crash-on-fail cases in DNS regression tests (87cd6f0)
38275970Scy   o DNS tests: add a missing check (f314900)
39275970Scy   o Finalize tests: add a missing check (82b6956)
40275970Scy   o test_evutil_rtrim: add another missing check. (e193c95)
41275970Scy   o regress_main: logging all if env EVENT_DEBUG_LOGGING_ALL isset (611e28b Azat Khuzhin)
42275970Scy   o regress_http: add tests for evhttp_connection_get_addr() (4dd500c Azat Khuzhin)
43275970Scy
44275970Scy Bugfixes (core)
45275970Scy   o If evsel->del() fails, don't leave the evmap in an inconsistent state
46275970Scy     (9b5a527 Maxime Henrion)
47275970Scy   o Move event_debug_note_teardown_ before mm_free. (69b5c64)
48275970Scy   o Check CLOCK_MONOTONIC_* at runtime if needed. (911abf3)
49275970Scy   o Fix reinit of fds with EV_WRITE but not EV_READ. (ebfd8a8 maksqwe)
50275970Scy
51275970Scy Performance tweaks (core)
52275970Scy   o Avoid redundant syscall to make a nonblocking socket nonblocking
53275970Scy     (42c03da Maxime Henrion)
54275970Scy   o Avoid redundant syscall if making a socket cloexec twice (1f29b18)
55275970Scy   o Avoid redundant invocations of init_extension_functions for IOCP (3b77d62)
56275970Scy
57275970Scy Bugfixes (evhttp)
58275970Scy   o Fix a double close() bug in evhttp when the underlying bufferevent uses
59275970Scy     BEV_OPT_CLOSE_ON_FREE. (31db8a0 Maxime Henrion)
60275970Scy   o Fix an unlikely but possible error case for http connections (f22049e)
61275970Scy   o Avoid racy bufferevent activation (5eb1788 Nate Rosenblum)
62275970Scy
63275970Scy Bugfixes on 2.0 (Windows)
64275970Scy   o Use windows vsnprintf fixup logic on all windows environments (e826f19)
65275970Scy   o libevent/win32_dealloc() : fix sizeof(pointer) vs sizeof(*pointer) (b8f5980 Frank Denis)
66275970Scy
67275970Scy Bugfixes (evutil_secure_rng)
68275970Scy   o When we seed from /proc/sys/kernel/random/uuid, count it as success (e35b540)
69275970Scy   o We should return after arc4random_buf() (1ea1f26 Makoto Kato)
70275970Scy   o Avoid other RNG initialization FS reads when urandom file is specified (9695e9c)
71275970Scy   o Really remove RNG seeds from the stack (f5ced88)
72275970Scy   o Fix another arc4random_buf-related warning (e64a2b0)
73275970Scy
74275970Scy New APIs (core)
75275970Scy   o Added event_base_get_num_events() (0fa107d Mobai Zhang)
76275970Scy   o Add function to fetch underlying ratelimit cfg (4b3d5af Mark Ellzey)
77275970Scy   o Pass and return const for bufferevent_get_token_bucket_cfg (1c77fbb Mark Ellzey)
78275970Scy
79275970Scy New APIs (evhttp)
80275970Scy   o Add evhttp_connection_get_server(). (a7f82a3 Maxime Henrion)
81275970Scy   o add a http default content type option (5a5acd9 Nicolas Martyanoff)
82275970Scy   o http: implement new evhttp_connection_get_addr() api. (0c7f040 Azat Khuzhin)
83275970Scy
84275970Scy
85275970Scy Documentation
86275970Scy   o Document that arc4random is not a great cryptographic PRNG. (6e49696)
87275970Scy   o Small doxygen tweaks (6e67b51)
88275970Scy   o Try another doxygen tweak (ccf432b)
89275970Scy
90275970Scy New APIs (evutil_secure_rng)
91275970Scy   o Add evutil_secure_rng_set_urandom_device_file (2bbb5d7)
92275970Scy
93275970Scy Cleanups
94275970Scy   o Remove an unreachable return statement in minheap-internal.h (e639a9e)
95275970Scy
96275970Scy Sample code
97275970Scy   o sample/le-proxy: Fail more gracefully if opening listener fails (44b2491)
98275970Scy   o sample: drop uri_root from base_url in http-server. (6171e1c Azat Khuzhin)
99275970Scy
100275970Scy
101275970Scy
102275970Scy
103275970Scy
104275970Scy
105275970Scy
106275970Scy
107275970Scy
108275970Scy
109275970Scy
110275970ScyChanges in version 2.1.3-alpha (1 May 2013)
111275970Scy
112275970Scy Libevent 2.1.3-alpha fixes various bugs, adds new unit tests, and cleans
113275970Scy up the code in a couple of places. It has a new callback in evhttp for
114275970Scy reporting errors during a request, a new feature for allowing evdns to
115275970Scy not keep the event_base looping when there are no requests inflight, and
116275970Scy example code for writing an https client.
117275970Scy
118275970Scy Libevent 2.1.3-alpha also has an important new (experimental) event
119275970Scy finalization feature to allow safe event teardown in multithreaded
120275970Scy programs. This ought to fix the longstanding bug with deadlocks in
121275970Scy multithreaded use of SSL-based bufferevents that some people have been
122275970Scy experiencing since Libevent 2.0.
123275970Scy
124275970Scy
125275970Scy Core (event finalization)
126275970Scy   o Implement event_finalize() and related functions to avoid certain
127275970Scy     deadlocks (8eedeab)
128275970Scy   o Use finalization feature so bufferevents can avoid deadlocks (02fbf68)
129275970Scy   o Always run pending finalizers when event_base_free() is called (e9ebef8)
130275970Scy   o Remove bufferevent_del_generic_timeout_cbs as now unused (4ea4c6a)
131275970Scy   o More documentation for finalization feature (a800b91)
132275970Scy   o Make the event_finalize* functions return an error code (5d11f4f)
133275970Scy   o Mark the finalize stuff as experiemental in case it needs to
134275970Scy     change (23e2e29)
135275970Scy
136275970Scy Evdns
137275970Scy   o evdns: New flag to make evdns not prevent the event loop from
138275970Scy     exiting (6b7fa62 Azat Khuzhin)
139275970Scy
140275970Scy Bugfixes (Core)
141275970Scy   o Make event_remove_timer behave correctly with persistent timers (5623e80)
142275970Scy   o Unit test for event_remove_timer with EV_PERSIST. (96150dd)
143275970Scy   o Double-check next timeout when adding events (9443868 Nate Rosenblum)
144275970Scy   o event_base_update_cache_time should be a no-op if the loop isn't
145275970Scy     running (5e6fa2a)
146275970Scy
147275970Scy Bugfixes (evhttp, crash fix, from 2.0)
148275970Scy   o fix #73 and fix http_connection_fail_test to catch it (b618204 Greg Hazel)
149275970Scy
150275970Scy Bugfixes (compilation and portability, from 2.0)
151275970Scy   o Fix compilation with WIN32_HAVE_CONDITION_VARIABLES enabled (7e45739)
152275970Scy   o Fix missing AC_PROG_SED on older Autoconfs (9ab2b3f Tay Ray Chuan)
153275970Scy   o Backport libevent to vanilla Autoconf 2.59 (as used in RHEL5)
154275970Scy     (74d4c44 Kevin Bowling)
155275970Scy   o Use AC_CONFIG_HEADERS in place of AM_CONFIG_HEADERS for autmake
156275970Scy     1.13 compat (817ea36)
157275970Scy   o Rename configure.in to configure.ac to appease newer autoconfs (0c79787)
158275970Scy   o Avoid using top_srcdir in TESTS: new automakes do not like this (a55514e)
159275970Scy
160275970Scy Bugfixes (resource leaks/lock errors on error, from 2.0)
161275970Scy   o Avoid leaking fds on evconnlistener with no callback set (69db261)
162275970Scy   o Avoid double-close on getsockname error in evutil_ersatz_socketpair
163275970Scy     (0a822a6)
164275970Scy   o Fix a locking error in bufferevent_socket_get_dns_error. (0a5eb2e)
165275970Scy
166275970Scy Documentation Fixes (from 2.0)
167275970Scy   o Fix a mistake in evbuffer_remove() arguments in example http server code
168275970Scy     (c322c20 Gyepi Sam)
169275970Scy   o Fix a typo in a comment in buffer.h. Spotted by Alt_F4 (773b0a5)
170275970Scy
171275970Scy Documentation Fixes
172275970Scy   o minor documentation typos (809586a Patrick Pelletier)
173275970Scy   o Fix cut-and-paste err in whatsnew-2.1 (49905ac)
174275970Scy   o Fix comment to refer to sample/include.am correctly (9e8cdf3 Sebastian
175275970Scy     Hahn)
176275970Scy   o Fix typo : Dispatching instead of Dispaching (0c2bacc Volker Lendecke)
177275970Scy   o fix some hinky indentation in evhttp_make_request (80e220e Patrick
178275970Scy     Pelletier)
179275970Scy   o "buffer" spelling (a452811 Patrick Pelletier)
180275970Scy   o Specify return behavior in header for evbuffer_pullup() in corner case
181275970Scy     (cf8d1cd Dan Petro)
182275970Scy   o Clarify an important point about event_base_foreach_event() (920a5e6)
183275970Scy
184275970Scy Compilation Fixes/Tool Support
185275970Scy   o avoid valgrind false positive by zeroing epoll_event (1258614 Patrick
186275970Scy     Pelletier)
187275970Scy   o Fix harmless clang enum warning (b452a43 Sebastian Hahn)
188275970Scy   o remove all exes on "make clean", not just regress.exe (974bfa0 Patrick
189275970Scy     Pelletier)
190275970Scy   o Make --disable-libevent-regress work again (787fd74)
191275970Scy   o Do not build strlcpy.c when it will have no code. (4914620)
192275970Scy
193275970Scy Portability Fixes
194275970Scy   o When EWOULDBLOCK is not EAGAIN, treat it as equivalent to it (bf7a0ff)
195275970Scy   o Preliminary changes for Minix3. (0dda56a Nicholas Heath)
196275970Scy   o Use AC_CONFIG_HEADERS in place of AM_CONFIG_HEADERS for autmake 1.13
197275970Scy     compat (bf278b)
198275970Scy   o Avoid using $(top_srcdir) in TESTS. (2863c83)
199275970Scy   o build test/test-script.sh on systems with a less-featureful $< (f935e21)
200275970Scy   o Implement EVUTIL_ERR_IS_EAGAIN on windows. (42aaf4d)
201275970Scy
202275970Scy Evhttp changes:
203275970Scy   o Fix ipv6 support for http. When URL contain domain, not IP
204275970Scy     address. (71e709c Azat Khuzhin)
205275970Scy   o uri decode: fix for warning "use of uninitialised value" (64b6ece Azat
206275970Scy     Khuzhin)
207275970Scy   o uri decode: changed the test for the existence of the next character
208275970Scy     (e1903e3 Azat Khuzhin)
209275970Scy   o Move prototype of evhttp_decode_uri_internal() to http-internal.h
210275970Scy     (de8101a Azat Khuzhin)
211275970Scy   o Test: decoding just part of string with evhttp_decode_uri_internal()
212275970Scy     (1367653 Azat Khuzhin)
213275970Scy   o Add new error_cb for actual reporting of HTTP request errors. (7b07719
214275970Scy     Azat Khuzhin)
215275970Scy   o Add test for EVREQ_HTTP_REQUEST_CANCEL into http_cancel_test() (862c217
216275970Scy     Azat Khuzhin)
217275970Scy   o Drop extra header http_struct.h from regress_http.c (54cc800 Azat Khuzhin)
218275970Scy
219275970Scy Testing
220275970Scy   o Add regress test ipv6_for_domain. (9ec88bd Azat Khuzhin)
221275970Scy   o Add an environment variable (EVENT_DEBUG_MODE) to run unit tests in debug
222275970Scy     mode (2fad0f3)
223275970Scy   o Add a test with an active_later event at event_base_free time. (1c3147f)
224275970Scy   o Make all tests pass under EVENT_DEBUG_MODE=1 (b1b054f)
225275970Scy   o Add some verbose notes to bufferevent unit tests (9d893c9)
226275970Scy   o New test for active_later->active transition on event_active (a153874)
227275970Scy   o New tests for event_base_foreach_event() (0b096ef)
228275970Scy   o Unit tests for event_base_gettimeofday_cached() and
229275970Scy     event_base_update_cache_time() (30ea291)
230275970Scy   o A test for event_get_assignment() (f09629e)
231275970Scy   o More unit tests for initializing common timeouts. (d596739)
232275970Scy   o Fix a bug in the new main/event_foreach test (702c9aa)
233275970Scy
234275970Scy Windows:
235275970Scy   o use FormatMessage for winsock errors (0c6ec5d, 2078e9b, 4ccdd53, c9ad3af
236275970Scy     Patrick Pelletier)
237275970Scy   o a program to print out the error strings for winsock errors (7296512
238275970Scy     Patrick Pelletier)
239275970Scy   o Fix a warning introduced in 0c6ec5d8 (eeb700c)
240275970Scy   o Fix another warning introduced in 0c6ec5d8 (ed26561)
241275970Scy
242275970Scy Examples (http)
243275970Scy   o Add sample/https-client.c, an example of stacking evhttp as a client on
244275970Scy     top of bufferevent_ssl. (be46c99 Catalin Patulea)
245275970Scy   o use ${OPENSSL_LIBS} instead of -lssl -lcrypto (bf31fa5 Patrick Pelletier)
246275970Scy   o https-client was putting newlines at 256-byte boundaries (42d7441 Patrick
247275970Scy     Pelletier)
248275970Scy   o better handling of OpenSSL errors (5754d96 Patrick Pelletier)
249275970Scy   o use Debian's default root certificate location (aacd674 Patrick Pelletier)
250275970Scy   o use iSECPartners code to validate hostname in certificate (64d9f16
251275970Scy     Patrick Pelletier)
252275970Scy   o avoid sign mismatch warning in openssl_hostname_validation.c (6021cb5
253275970Scy     Patrick Pelletier)
254275970Scy   o pull in wildcard matching code from cURL (4db9da6 Patrick Pelletier)
255275970Scy   o Another tweak to https-client.c (95acdaa)
256275970Scy   o Remove http_struct.h usage in sample/https-client.c (8a90a85)
257275970Scy
258275970Scy
259275970Scy
260275970ScyChanges in version 2.1.2-alpha (18 Nov 2012)
261275970Scy
262275970Scy Libevent 2.1.2-alpha includes more portable for monotonic timers,
263275970Scy refactors much of Libevent's internal and external infrastructure,
264275970Scy closes some longstanding gaps in the interface, makde other
265275970Scy improvements.  Ths log below tries to organize features by rough area of
266275970Scy effect.  It omits a few commits which were pure bugfixes on other commits
267275970Scy listed below.  For more detail, see the git changelogs.  For more
268275970Scy insight, see the "whatsnew-2.1.txt" document included in the Libevent
269275970Scy 2.1.2-alpha distribution.
270275970Scy
271275970Scy Libevent 2.1.2-alpha also includes all changes made in 2.0.19-stable
272275970Scy through 2.0.21-stable inclusive.
273275970Scy
274275970Scy Performance (core):
275275970Scy   o Replace pipe-based notification with EVFILT_USER where possible. This
276275970Scy     should make multithreaded programs on OSX and *BSD alert the main thread a
277275970Scy     little faster. (53a07fe)
278275970Scy   o Make th_base_lock nonrecursive. (9cd5acb)
279275970Scy
280275970Scy New/Changed API Functions:
281275970Scy   o New event_get_priority() function to return an event's priority (f90e255)
282275970Scy   o Add a bufferevent_get_priority() function (bd39554)
283275970Scy   o Add an event_base_loopcontinue() to tell Libevent to rescan for more
284275970Scy     events right away (7d6aa5e)
285275970Scy   o Add a new callback to get called on evbuffer_file_segment free
286275970Scy     (e9f8feb yangacer, 64051b9)
287275970Scy   o Expose event_base_foreach_event() as a public API. (84fd6d7 Roman
288275970Scy      Puls, 232055e, ffe1643)
289275970Scy   o Add an event_remove_timer() to remove timer on an event without
290275970Scy     deleting it (e3b2e08)
291275970Scy   o Make bufferevent_set_timeouts(bev, NULL, NULL) have plausible
292275970Scy     semantics (9dee36b)
293275970Scy   o Rename event_enable_lock_debuging() to ..._debugging(). (The old name
294275970Scy     should still work.) (07e132e)
295275970Scy   o Add missing implementation for event_enable_debug_logging (3b3e21d)
296275970Scy
297275970Scy PORTABLE MONOTONIC TIMERS:
298275970Scy
299275970Scy   Libevent 2.1.2 includes internal support for monotonic timers on
300275970Scy   (nearly) all supported platforms, including Windows, and OSX.  Libevent
301275970Scy   applications should now be more resilient to jumps forwards or backwards
302275970Scy   in the system clock.  Also, on Linux systems with epoll, we now
303275970Scy   optionally support microsecond-level timeouts (whereas epoll only
304275970Scy   supports millisecond-precision timeouts).
305275970Scy
306275970Scy   o Use mach_absolute_time() for monotonic clock support on OSX. (b8fd6f9)
307275970Scy   o Do not track use_monotonic field when is no monotonic clock (cb653a0)
308275970Scy   o EVENT_BASE_FLAG_PRECISE_TIMER indicates we want fine timer precision
309275970Scy     (ddd69d3)
310275970Scy   o On Linux, use CLOCK_MONOTONIC_COARSE by default (55780a7)
311275970Scy   o Implement a GetTickCount-based monotonic timer for Windows (d5e1d5a)
312275970Scy   o Refactor monotonic timer handling into a new type and set of
313275970Scy     functions; add a gettimeofday-based ratcheting implementation (f5e4eb0)
314275970Scy   o Add EVENT_PRECISE_TIMER environment var for selecting precise-but-slow
315275970Scy     timer (a2598ec)
316275970Scy   o Implement fast/precise monotonic clocks on Windows (2c47045)
317275970Scy   o Simple unit tests for monotonic timers (630f077)
318275970Scy   o Improve the monotonic-time unit test: make it check the step size (7428c78)
319275970Scy   o When PRECISE_TIMERS is set with epoll, use timerfd for microsecond
320275970Scy     precision (26c7582)
321275970Scy   o Split out time-related evutil functions into a new evutil_time.c (c419485)
322275970Scy   o Split out time-related prototypes into time-internal.h (71bca50)
323275970Scy   o Add evutil_time.obj to Makefile.nmake (0ba0683)
324275970Scy   o Avoid giving a spurious warning when timerfd support is unavailable
325275970Scy     (1aaf9f0 Dave Hart)
326275970Scy   o Make test_evutil_monotonic a little more tolerant (def3b83)
327275970Scy   o Avoid unused-var warning on systems with clock_gettime but without
328275970Scy     CLOCK_MONOTONIC_COARSE (9be5468)
329275970Scy
330275970ScyEVENT_BASE_ONCE LEAKS:
331275970Scy   If a callback added by event_base_once() is never invoked, Libevent no
332275970Scy   longer leaks internal memory.
333275970Scy
334275970Scy   o Free dangling event_once objects on event_base_free() (c17dd59)
335275970Scy   o Add a unit test in which an event is created with event_base_once()
336275970Scy     but never fires (4343edf)
337275970Scy
338275970ScyTESTING SUPPORT, FIXES AND IMPROVEMENTS:
339275970Scy
340275970Scy   Libevent now disables by default its unit tests that would touch the
341275970Scy   network, or that tend to fail on heavily-loaded systems.  To re-enable
342275970Scy   them, invoke the ./test/regress program with the @all alias.
343275970Scy
344275970Scy   o Simplify test.sh code significantly. (9b856fd Ross Lagerwall)
345275970Scy   o Make all tests that hit the network disabled by default (f2cea87)
346275970Scy   o Avoid a resource leak on error in http client benchmark (ea92fba)
347275970Scy   o Update to latest tinytest (911b4f0349377) (ef7c4f7)
348275970Scy   o Avoid (unlikely) overflow in bench_httpclient.c (5671033)
349275970Scy   o Shave 700 msec off the persistent_timeout_jump test (21205b8)
350275970Scy   o Check return value of write() in regress.c (c8009d2)
351275970Scy   o Make load-dependent monotonic timer tests off-by-default (2b6fe8b)
352275970Scy   o Add deferred_cb_skew to list of timing-dependent tests (34c8f31)
353275970Scy   o Avoid test -e; older shs don't have one. (f1bd938)
354275970Scy   o Fix renegotiation test to work around openssl 1.0.1 bug (c2f3086)
355275970Scy   o Fix a couple of compile warnings in the unit tests (5a9a014)
356275970Scy
357275970ScyMISC:
358275970Scy   o Change evutil_weakrand_() to avoid platform random() (e86af4b Nicholas
359275970Scy     Marriott, 3aa4415)
360275970Scy
361275970ScyINFRASTRUCTURE (Active-later events):
362275970Scy   As a simplification and optimization to Libevent's "deferred callback"
363275970Scy   logic (introduced in 2.0 to avoid callback recursion), Libevent now
364275970Scy   treats all of its deferrable callback types using the same logic it uses
365275970Scy   for active events.  Now deferred events no longer cause priority
366275970Scy   inversion, no longer require special code to cancel them, and so on.
367275970Scy
368275970Scy   o Refactor the callback part of an event into its own event_callback
369275970Scy     type (cba59e5)
370275970Scy   o Add "active later" event_callbacks to supersede deferred (745a63d)
371275970Scy   o event_base_assert_ok: check value of event_active_count for
372275970Scy     correctness (fec8bae)
373275970Scy   o Replace deferred_cbs with event_callback-based implementation. (ae2b84b)
374275970Scy   o Replace more deferred_cb names with event_callback (a4079aa)
375275970Scy   o Give event_base_process_active a single exit path (581b5be)
376275970Scy   o Restore our priority-inversion-prevention code with deferreds (c0e425a)
377275970Scy   o Refactor event_persist_closure: raise and extract some common logic
378275970Scy     (bec22b4)
379275970Scy   o Remove the unused bits from EVLIST_ALL (9889a3d)
380275970Scy
381275970ScyBUILD IMPROVEMENTS:
382275970Scy Libevent 2.1.2-alpha modernizes Libevent's use of autotools, and makes
383275970Scy numerous other build system. Parallel builds should be faster, and all
384275970Scy builds should be quieter.
385275970Scy
386275970Scy   o Split long lists in Makefile.am into one-item-per-line (2711cda)
387275970Scy   o Remove unnecessary code in configure.in. (e65914f Ross Lagerwall)
388275970Scy   o attempt to support OpenSSL in Makefile.nmake (eba0eb2 Patrick Pelletier)
389275970Scy   o Use newer syntax for autoconf/automake init (7d60ba8)
390275970Scy   o Enable silent build rules by default. Override with V=1 (7b18e5c)
391275970Scy   o Switch to non-recursive makefiles (7092f3b)
392275970Scy   o Rename subordinate Makefile.ams to include.am (6cdfeeb)
393275970Scy   o Make quiet build even quieter (371a123)
394275970Scy   o New --quiet option for event_rpcgen.py (aa59c1e)
395275970Scy   o Be quiet when making regress.gen.[ch] (607a8ff)
396275970Scy   o Fix handling of no-python case for nonrecursive make (1e3123d)
397275970Scy   o We now require automake 1.9 or later. Modernize! (b7f6e89)
398275970Scy   o Rename configure.in to configure.ac. (b3fea67 Ross Lagerwall)
399275970Scy   o Use correct openssl libs and includes in pkgconfig file (d70af27)
400275970Scy   o Use the same CFLAGS for openssl when building unit tests as with
401275970Scy     libevent (1d9d511)
402275970Scy
403275970ScyDOCUMENTATION
404275970Scy   o Note that make_base_notifiable should not be necessary (26ee5f9)
405275970Scy   o Be more clear that LEV_OPT_DEFERRED_ACCEPT has tricky prereqs (371efeb)
406275970Scy   o Add caveat to docs about bufferevent_free() with data in outbuf (6fab9ee)
407275970Scy   o Make it more clear that NOLOCK means "I promise, no multithreading"
408275970Scy    (9444524)
409275970Scy   o Fix a comment in test-fdleak after 077c7e949. (3881d8f Ross Lagerwall)
410275970Scy   o Make the Makefile.nmake warning slightly less dire (e7bf4c8)
411275970Scy   o Fix typo : events instead of evets (05f1aca Azat Khuzhin)
412275970Scy   o Additional comments about OPENSSL_DIR variable, prompted by Dave Hart
413275970Scy     (6bde2ef Patrick Pelletier)
414275970Scy
415275970ScyEVHTTP:
416275970Scy   o ignore LWS after field-content in headers (370a2c0 Artem Germanov)
417275970Scy   o Clean up rtrim implementation (aa59d80)
418275970Scy   o Remove trailing tabs in HTTP headers as well. (ac42519)
419275970Scy   o Remove internal ws from multiline http headers correctly (c6ff381)
420275970Scy   o Move evutil_rtrim_lws_ to evutil.c where it belongs (61b93af)
421275970Scy   o add evhttp_request_get_response_code_line (4f4d0c9 Jay R. Wren)
422275970Scy   o Use EVUTIL_SOCKET_ERROR() wrapper to save/restore errno in
423275970Scy     evhttp_connection_fail_ (7afbd60)
424275970Scy   o preserve errno in evhttp_connection_fail_ for inspection by the
425275970Scy     callback (36d0ee5 Patrick Pelletier)
426275970Scy
427275970ScyBUGFIXES:
428275970Scy   o Correctly handle running on a system where accept4 doesn't work. (9fbfe9b)
429275970Scy   o Avoid double-free on error in evbuffer_add_file. Found by
430275970Scy     coverity. (6a81b1f)
431275970Scy   o Fix another possible uninitialized read in dns regression tests. Found
432275970Scy     by coverity. (13525c5)
433275970Scy   o Add checks for functions in test-ratelim.c; found by Coverity (aa501e1)
434275970Scy   o Avoid memory leak in test_event_calloc unit test; found by coverity
435275970Scy     (92817a1)
436275970Scy   o Fix a shadowed variable in addfile_test_readcb; found by coverity
437275970Scy     (225344c)
438275970Scy   o Check return value when using LEV_OPT_DEFERRED_ACCEPT. Found by
439275970Scy     coverity (6487f63)
440275970Scy   o Prevent reference leak of bufferevent if getaddrinfo fails. (b757786
441275970Scy     Joachim Bauch)
442275970Scy   o Make event_base_getnpriorities work with old "implicit base" code
443275970Scy     (c46cb9c)
444275970Scy   o Simplify and correct evutil_open_closeonexec_ (0de587f)
445275970Scy   o Fix event_dlist definition when sys/queue not included (81b6209
446275970Scy     Derrick Pallas)
447275970Scy
448275970Scy
449275970Scy
450275970ScyChanges in version 2.1.1-alpha (4 Apr 2012)
451275970Scy
452275970Scy Libevent 2.1.1-alpha includes a number of new features and performance
453275970Scy improvements.  The log below tries to organize them by rough area of
454275970Scy effect.  It omits some commits which were pure bugfixes on other commits
455275970Scy listed below.  For more detail, see the git changelogs.  For more
456275970Scy insight, see the "whatsnew-2.1.txt" document included in the Libevent
457275970Scy 2.1.1-alpha distribution.
458275970Scy
459275970Scy Performance: Core
460275970Scy   o Replace several TAILQ users with LIST. LIST can be a little faster than
461275970Scy     TAILQ for cases where we don't need queue-like behavior. (f9db33d,
462275970Scy     6494772, d313c29, 974d004)
463275970Scy   o Disabled code to optimize the case where we reinsert an existing
464275970Scy     timeout (e47042f, 09cbc3d)
465275970Scy   o Remove a needless base-notify when rescheduling the first timeout (77a96fd)
466275970Scy   o Save a needless comparison when removing/adjusting timeouts (dd5189b)
467275970Scy   o Possible optimization: split event_queue_insert/remove into
468275970Scy     separate functions. needs testing (efc4dc5)
469275970Scy   o Make event_count maintenance branchless at the expense of an
470275970Scy     extra shift. Needs benchmarking (d1cee3b)
471275970Scy   o In the 2.1 branch, let's try out lazy gettimeofday/clock_gettime
472275970Scy     comparison (2a83ecc)
473275970Scy   o Optimization in event_process_active(): ignore maxcb & endtime
474275970Scy     for highest priority events. (a9866aa Alexander Drozdov)
475275970Scy   o Bypass event_add when using event_base_once() for a 0-sec timeout (35c5c95)
476275970Scy   o Remove the eventqueue list and the ev_next pointers. (604569b 066775e)
477275970Scy
478275970Scy Performance: Evbuffers
479275970Scy   o Roughly 20% speed increase when line-draining a buffer using
480275970Scy     EVBUFFER_EOL_CRLF (5dde0f0 Mina Naguib)
481275970Scy   o Try to squeeze a little more speed out of EVBUFFER_EOL_CRLF (7b9d139)
482275970Scy   o Fix a bug in the improved EOL_CRLF code (d927965)
483275970Scy   o Remove a needless branch in evbuffer_drain() (d19a326)
484275970Scy
485275970Scy Performance: Linux
486275970Scy   o Infrastructure for using faster/fewer syscalls when creating
487275970Scy     sockets (a1c042b)
488275970Scy   o Minimize syscalls during socket creation in listener.c (7e9e289)
489275970Scy   o Use a wrapper function to create the notification
490275970Scy     pipe/socketpair/eventfd (ca76cd9)
491275970Scy   o Use pipes for telling signals to main thread when possible (a35f396)
492275970Scy   o Save syscalls when constructing listener sockets for evhttp (af6c9d8)
493275970Scy   o Save some syscalls when creating evdns sockets (713e570)
494275970Scy   o Save some syscalls when constructing a socket for a bufferevent (33fca62)
495275970Scy   o Prefer epoll_create1 on Linuxen that have it (bac906c)
496275970Scy
497275970Scy Performance: Epoll backend
498275970Scy   o Use current event set rather than current pending change when
499275970Scy     deciding whether to no-op a del (04ba27e Mike Smellie)
500275970Scy   o Replace big chain of if/thens in epoll.c with a table lookup (8c83eb6)
501275970Scy   o Clean up error handling in epoll_apply_one_change() a little (2d55a19)
502275970Scy
503275970Scy Performance: Evport backend
504275970Scy   o evport: use evmap_io to track fdinfo status. Should save time and
505275970Scy     RAM. (4687ce4)
506275970Scy   o evport: Remove a linear search over recent events when
507275970Scy     reactivating them (0f77efe)
508275970Scy   o evport: Use portev_user to remember fdinfo struct (276ec0e)
509275970Scy   o evport: don't scan more events in ed_pending than needed (849a5cf)
510275970Scy   o evport: Remove artificial low limit on max events per getn call (c04d927)
511275970Scy   o Reenable main/many_events_slow_add for evport in 2.1 (e903db3)
512275970Scy
513275970Scy Performance: Windows
514275970Scy   o Use GetSystemTimeAsFileTime to implement gettimeofday on
515275970Scy     win32. It's faster and more accurate than our old
516275970Scy     approach. (b8b8aa5)
517275970Scy
518275970Scy New functions and features: debugging
519275970Scy   o Add event_enable_debug_logging() to control use of debug logs (e30a82f)
520275970Scy
521275970Scy New functions and features: core
522275970Scy   o Add event_config function to limit time/callbacks between calls
523275970Scy     to dispatch (fd4de1e, 9fa56bd, a37a0c0, 3c63edd)
524275970Scy   o New EVLOOP_NO_EXIT_ON_EMPTY option to keep looping even when no
525275970Scy     events are pending (084e68f)
526275970Scy   o Add event_base_get_npriorities() function. (ee3a4ee Alexander Drozdov)
527275970Scy   o Make evbase_priority_init() and evbase_get_npriorities()
528275970Scy     threadsafe (3c55b5e)
529275970Scy   o New event_base_update_cache_time() to set cached_tv to current
530275970Scy     time (212533e Abel Mathew)
531275970Scy   o Add event_self_cbarg() to be used in conjunction with
532275970Scy     event_new(). (ed36e6a Ross Lagerwall, fa931bb, 09a1906, 1338e6c,
533275970Scy     33e43ef)
534275970Scy   o Add a new libevent_global_shutdown() to free all globals before
535275970Scy     exiting. (041ca00 Mark Ellzey, f98c158, 15296d0, 55e991b)
536275970Scy   o Use getifaddrs to detect our interfaces if possible (7085a45)
537275970Scy   o Add event_base_get_running_event() to get the event* whose cb we
538275970Scy     are in (c5732fd, 13dad99)
539275970Scy
540275970Scy New functions and features: building
541275970Scy   o Implement --enable-gcc-hardening configure option (7550267 Sebastian Hahn)
542275970Scy
543275970Scy New functions and features: evbuffers
544275970Scy   o Add evbuffer_add_file_segment() so one fd can be used efficiently
545275970Scy     in more than one evbuffer_add_file at a time (e72afae, c2d9884,
546275970Scy     3f405d2, 0aad014)
547275970Scy   o Fix windows file segment mappings (8254de7)
548275970Scy   o Allow evbuffer_ptr_set to yield a point just after the end of the
549275970Scy     buffer. (e6fe1da)
550275970Scy   o Allow evbuffer_ptr to point to position 0 in an empty evbuffer
551275970Scy     (7aeb2fd Nir Soffer)
552275970Scy   o Set the special "not found" evbuffer_ptr consistently. (e3e97ae Nir Soffer)
553275970Scy   o support adding buffers to other buffers non-destructively
554275970Scy     (9d7368a Joachim Bauch)
555275970Scy   o prevent nested multicast references, reworked locking (26041a8
556275970Scy     Joachim Bauch)
557275970Scy   o New EVBUFFER_EOL_NUL to read NUL-terminated strings from an
558275970Scy     evbuffer (d7a8b36 Andrea Montefusco, 54142c9)
559275970Scy   o Make evbuffer_file_segment_types adaptable (c6bbbf1)
560275970Scy   o Added evbuffer_add_iovec and unit tests. (aaec5ac Mark Ellzey, 27b5398)
561275970Scy   o Add evbuffer_copyout_from to copy data from the middle of a
562275970Scy     buffer (27e2225)
563275970Scy
564275970Scy New functions and features: bufferevents
565275970Scy   o Allow users to set allow_dirty_shutdown (099d27d Catalin Patulea)
566275970Scy   o Tweak allow_dirty_shutdown documentation (a44cd2b)
567275970Scy   o Fix two issues in the allow_dirty_shutdown code. (f3b89de)
568275970Scy   o Add a bufferevent_getcb() to find a bufferevent's current
569275970Scy     callbacks (a650394)
570275970Scy   o bufferevent: Add functions to set/get max_single_read/write
571275970Scy     values. (998c813 Alexander Drozdov)
572275970Scy   o bev_ssl: Be more specific in event callbacks. evhttp in particular gets
573275970Scy     confused without at least one of BEV_EVENT_{READING|WRITING}. (f7eb69a
574275970Scy     Catalin Patulea)
575275970Scy
576275970Scy New functions and features: evconnlisteners
577275970Scy   o Support TCP_DEFER_ACCEPT sockopts for listeners (5880e4a Mark Ellzey,
578275970Scy     a270728)
579275970Scy   o Add another caveat to the TCP_DEFER_ACCEPT documentation (a270728)
580275970Scy   o Allow evconnlistener to be created in disabled state. (9593a33
581275970Scy     Alexander Drozdov)
582275970Scy   o The LEV_OPT_CLOSE_ON_EXEC flag now applies to accepted listener
583275970Scy     sockets too (4970329)
584275970Scy
585275970Scy Evhttp:
586275970Scy   o Add new evhttp_{connection_}set_timeout_tv() functions to set
587275970Scy     finger-grained http timeouts (6350e6c Constantine Verutin)
588275970Scy   o Performance tweak to evhttp_parse_request_line. (aee1a97 Mark Ellzey)
589275970Scy   o Add missing break to evhttp_parse_request_line (0fcc536)
590275970Scy   o Add evhttp callback for bufferevent creation; this lets evhttp
591275970Scy     support SSL. (8d3a850)
592275970Scy   o Remove calls to deprecated bufferevent functions from evhttp.c (4d63758)
593275970Scy   o evhttp: Add evhttp_foreach_bound_socket. (a2c48e3 Samy Al Bahra)
594275970Scy
595275970Scy Build improvements:
596275970Scy   o Add AC_USE_SYSTEM_EXTENSIONS to configure.in. Requires follow on
597275970Scy     patches for correctness and robustness. (1fa7dbe Kevin Bowling)
598275970Scy   o Filter '# define' statements from autoconf and generate
599275970Scy     event-private.h (321b558 Kevin Bowling)
600275970Scy   o Remove internal usage of _GNU_SOURCE (3b26541 Kevin Bowling)
601275970Scy   o Eliminate a couple more manual internal _GNU_SOURCE defines (c51ef93
602275970Scy     Kevin Bowling)
603275970Scy   o Add AC_GNU_SOURCE to the fallback case. (ea8fa4c Kevin Bowling)
604275970Scy   o Use a Configuration Header Template for evconfig-private.h (868f888
605275970Scy     Kevin Bowling)
606275970Scy   o Fix a comment warning and add evconfig-private.h to .gitignore
607275970Scy     (f6d66bc Kevin Bowling)
608275970Scy   o Include evconfig-private.h in internal files for great good. (0915ca0
609275970Scy     Kevin Bowling)
610275970Scy   o Backport libevent to vanilla Autoconf 2.59 (as used in RHEL5)
611275970Scy     (ad03952 Kevin Bowling)
612275970Scy   o Prefer the ./configure evconfig-private.h in MinGW, just in
613275970Scy     case. (f964b72 Kevin Bowling)
614275970Scy   o Shell hack for weird mkdir -p commands (fd7b5a8 Kevin Bowling)
615275970Scy   o Add evconfig-private to remaining files (ded0a09 Kevin Bowling)
616275970Scy   o Allow use of --enable-silent-rules for quieter compilation with
617275970Scy     automake 1.11 (f1f8514 Dave Hart)
618275970Scy   o Use "_WIN32", not WIN32: it's standard and we don't need to fake it
619275970Scy     (9f560b)
620275970Scy   o In configure, test for _WIN32 not WIN32. (85078b1 Peter Rosin)
621275970Scy   o Do not define WIN32 in Makefile.nmake (d41f3ea Peter Rosin)
622275970Scy   o Provide the autoconf m4 macros for the new OpenSSL via pkg-config
623275970Scy     stuff. (674dc3d Harlan Stenn)
624275970Scy   o Use pkg-config (if available) to handle OpenSSL. (1c63860 Harlan Stenn)
625275970Scy   o We need AM_CPPFLAGS when compiling bufferevent_openssl.c (6d2613b
626275970Scy     Harlan Stenn)
627275970Scy   o Fix OSX build: $(OPENSSL_INCS) needs to be after
628275970Scy     $(AM_CPPFLAGS). (46f1769 Zack Weinberg)
629275970Scy   o Make gcc warnings on by default, and --enable-gcc-warnings only add
630275970Scy     -Werror (d46517e Sebastian Hahn)
631275970Scy   o Split up extra-long AC_CHECK_FUNCS/HEADERS lines in configure.in (88a30ad)
632275970Scy   o Move libevent 1.x headers to include/, to put all public headers in
633275970Scy     one place. (bbea8d6)
634275970Scy   o Put #ifdef around some files to support alternate build
635275970Scy     systems. (76d4c92 Ross Lagerwall)
636275970Scy   o Also make win32select.c conditional for IDE users (bf2c5a7)
637275970Scy
638275970Scy Debugging:
639275970Scy   o Add a magic number to debug_locks to better catch lock-coding
640275970Scy     errors. (b4a29c0 Dave Hart)
641275970Scy   o munge the debug_lock signature before freeing it: it might help us
642275970Scy     catch use-after-free (f28084d)
643275970Scy   o Added --enable-event-debugging in configure (bc7b4e4, a9c2c9a Mark Ellzey)
644275970Scy   o Debug addition for printing usec on TIMEOUT debugging. (ac43ce0 Mark Ellzey)
645275970Scy   o Added usec debug in another area for debug (3baab0d Mark Ellzey)
646275970Scy   o added timeout debug logs to include event ptr. (4b7d298 Mark Ellzey)
647275970Scy   o more event dbg updates (6727543 Mark Ellzey)
648275970Scy   o Clarify event_enable_debug_logging a little (6207826)
649275970Scy   o Make --enable-verbose-debug option match its help text (10c3450)
650275970Scy   o Add argument checks to some memory functions in `event.c'. (c8953d1
651275970Scy     Mansour Moufid)
652275970Scy
653275970Scy Testing:
654275970Scy   o More abstraction in test.sh (cd74c4e)
655275970Scy   o Add failing test for evbuffer_search_range. (8e26154 Nir Soffer)
656275970Scy   o Tweaks to return types with end-of-buf ptrs (9ab8ab8)
657275970Scy   o Add an (internal) usleep function for use by unit tests (f25d9d3)
658275970Scy   o Synchronize with upstream tinytest (6c81be7)
659275970Scy   o Make test-changelist faster (7622d26)
660275970Scy   o Reduce the timeout in the main/fork test. (ab14f7c)
661275970Scy   o New evhttp function to adjust initial retry timeout (350a3c4)
662275970Scy   o Make regression tests run over 3x faster. (67a1763)
663275970Scy   o Use test_timeval_diff_eq more consistently (b77b43f)
664275970Scy   o Allow more slop in deferred_cb_skew test; freebsd needs it (b9f7e5f)
665275970Scy   o When including an -internal.h header outside the main tree, do so
666275970Scy     early (95e2455)
667275970Scy   o Add a new test: test-fdleak which tests for fd leaks by creating many
668275970Scy     sockets. (2ef9278 Ross Lagerwall, f7af194, 1c4288f, etc)
669275970Scy   o Add a unit test for event_base_dump_events() (7afe48a, 8d08cce)
670275970Scy   o Test more bufferevent_ratelim features (c24f91a)
671275970Scy
672275970Scy Documentation:
673275970Scy   o Improve evbuffer_ptr documentation (261ba63)
674275970Scy   o added comments to describe refcounting of multicast chains (ba24f61
675275970Scy     Joachim Bauch)
676275970Scy   o Add doxygen for event_base_dump_events (cad5753)
677275970Scy
678275970Scy OSX:
679275970Scy   o Use "unlimited select" on OSX so that we can have more than
680275970Scy     FD_SETSIZE fds (1fb5cc6)
681275970Scy
682275970Scy KQueue:
683275970Scy   o Use SIG_IGN instead of a do-nothing handler for signal events with
684275970Scy     kqueue (148458e Zack Weinberg)
685275970Scy
686275970Scy evprc:
687275970Scy   o event_rpcgen.py now prints status information to stdout and errors to
688275970Scy     stderr. (ffb0ba0 Ross Lagerwall)
689275970Scy
690275970Scy Code improvement and refactoring:
691275970Scy   o Make event_reinit() more robust and maintainable (272033e)
692275970Scy   o Restore fast-path event_reinit() for slower backends (2c4b5de)
693275970Scy   o Check changelist as part of checking representational integrity (39b3f38)
694275970Scy   o Fix a compile warning in event_reinit (e4a56ed Sebastian Hahn)
695275970Scy   o Refactor the functions that run over every event. (c89b4e6)
696275970Scy   o Remove the last vestiges of _EVENT_USE_EVENTLIST (a3cec90)
697275970Scy   o Make event-config.h depend on Makefile.am (2958a5c)
698275970Scy
699275970Scy Build fixes:
700275970Scy   o Don't do clang version detection when disabling some flags (083296b
701275970Scy     Sebastian Hahn)
702275970Scy
703275970Scy C standards conformance:
704275970Scy   o Check for NULL return on win32 mm_calloc, and set ENOMEM. (af7ba69)
705275970Scy   o Convert event-config.h macros to avoid reserved identifiers (68120d9)
706275970Scy   o Generate event-config.h using the correct macros. (f82c57e)
707275970Scy   o Convert include-guard macro convention to avoid reserved identifiers
708275970Scy     (3f8c7cd)
709275970Scy   o Make event_rpcgen.py output conform to identifier conventions (372bff1)
710275970Scy   o Stop referring to an obsolete include guard in bench_http.h (5c0f7e0)
711275970Scy   o Make the generated event-config.h use correct include guards (639383a)
712275970Scy   o Fix all identifiers with names beginning with underscore. (cb9da0b)
713275970Scy   o Make event_rpcgen.py output conform to identifier conventions, more
714275970Scy     (bcefd24)
715275970Scy   o Fix some problems introduced by automated identifier cleanup script
716275970Scy     (c963534)
717275970Scy   o Have all visible internal function names end with an underscore. (8ac3c4c)
718275970Scy   o Apply the naming convention to our EVUTIL_IS* functions (c7848fa)
719275970Scy   o Clean up lingering _identifiers. (946b584)
720275970Scy   o Fix doxygen to use new macro conventions (da455e9)
721275970Scy
722275970Scy Bugfixes:
723275970Scy   o Do not use system EAI/AI values if we are not using the system
724275970Scy     getaddrinfo. (7bcac07)
725275970Scy
726275970Scy Sample Code:
727275970Scy   o Fix up sample/event-test.c to use newer interfaces and make it
728275970Scy     actually work. (19bab4f Ross Lagerwall)
729275970Scy   o On Unix, remove event.fifo left by sample/event-test.c. (c0dacd2 Ross
730275970Scy     Lagerwall)
731275970Scy   o Rename event-test.c to event-read-fifo.c. (a5b370a Ross Lagerwall)
732275970Scy   o event-read-fifo: Use EV_PERSIST appropriately (24dab0b)
733275970Scy
734275970Scy
735275970Scy
736275970Scy
737