2 * Copyright (c) 2002-2007 Niels Provos <provos@citi.umich.edu>
3 * Copyright (c) 2007-2010 Niels Provos and Nick Mathewson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "event2/event-config.h"
36 #ifdef _EVENT_HAVE_VASPRINTF
37 /* If we have vasprintf, we need to define this before we include stdio.h. */
41 #include <sys/types.h>
43 #ifdef _EVENT_HAVE_SYS_TIME_H
47 #ifdef _EVENT_HAVE_SYS_SOCKET_H
48 #include <sys/socket.h>
51 #ifdef _EVENT_HAVE_SYS_UIO_H
55 #ifdef _EVENT_HAVE_SYS_IOCTL_H
56 #include <sys/ioctl.h>
59 #ifdef _EVENT_HAVE_SYS_MMAN_H
63 #ifdef _EVENT_HAVE_SYS_SENDFILE_H
64 #include <sys/sendfile.h>
71 #ifdef _EVENT_HAVE_STDARG_H
74 #ifdef _EVENT_HAVE_UNISTD_H
79 #include "event2/event.h"
80 #include "event2/buffer.h"
81 #include "event2/buffer_compat.h"
82 #include "event2/bufferevent.h"
83 #include "event2/bufferevent_compat.h"
84 #include "event2/bufferevent_struct.h"
85 #include "event2/thread.h"
86 #include "event2/event-config.h"
87 #include "log-internal.h"
88 #include "mm-internal.h"
89 #include "util-internal.h"
90 #include "evthread-internal.h"
91 #include "evbuffer-internal.h"
92 #include "bufferevent-internal.h"
94 /* some systems do not have MAP_FAILED */
96 #define MAP_FAILED ((void *)-1)
99 /* send file support */
100 #if defined(_EVENT_HAVE_SYS_SENDFILE_H) && defined(_EVENT_HAVE_SENDFILE) && defined(__linux__)
101 #define USE_SENDFILE 1
102 #define SENDFILE_IS_LINUX 1
103 #elif defined(_EVENT_HAVE_SENDFILE) && defined(__FreeBSD__)
104 #define USE_SENDFILE 1
105 #define SENDFILE_IS_FREEBSD 1
106 #elif defined(_EVENT_HAVE_SENDFILE) && defined(__APPLE__)
107 #define USE_SENDFILE 1
108 #define SENDFILE_IS_MACOSX 1
109 #elif defined(_EVENT_HAVE_SENDFILE) && defined(__sun__) && defined(__svr4__)
110 #define USE_SENDFILE 1
111 #define SENDFILE_IS_SOLARIS 1
115 static int use_sendfile = 1;
117 #ifdef _EVENT_HAVE_MMAP
118 static int use_mmap = 1;
122 /* Mask of user-selectable callback flags. */
123 #define EVBUFFER_CB_USER_FLAGS 0xffff
124 /* Mask of all internal-use-only flags. */
125 #define EVBUFFER_CB_INTERNAL_FLAGS 0xffff0000
127 /* Flag set if the callback is using the cb_obsolete function pointer */
128 #define EVBUFFER_CB_OBSOLETE 0x00040000
130 /* evbuffer_chain support */
131 #define CHAIN_SPACE_PTR(ch) ((ch)->buffer + (ch)->misalign + (ch)->off)
132 #define CHAIN_SPACE_LEN(ch) ((ch)->flags & EVBUFFER_IMMUTABLE ? \
133 0 : (ch)->buffer_len - ((ch)->misalign + (ch)->off))
135 #define CHAIN_PINNED(ch) (((ch)->flags & EVBUFFER_MEM_PINNED_ANY) != 0)
136 #define CHAIN_PINNED_R(ch) (((ch)->flags & EVBUFFER_MEM_PINNED_R) != 0)
138 static void evbuffer_chain_align(struct evbuffer_chain *chain);
139 static int evbuffer_chain_should_realign(struct evbuffer_chain *chain,
141 static void evbuffer_deferred_callback(struct deferred_cb *cb, void *arg);
142 static int evbuffer_ptr_memcmp(const struct evbuffer *buf,
143 const struct evbuffer_ptr *pos, const char *mem, size_t len);
144 static struct evbuffer_chain *evbuffer_expand_singlechain(struct evbuffer *buf,
148 static int evbuffer_readfile(struct evbuffer *buf, evutil_socket_t fd,
151 #define evbuffer_readfile evbuffer_read
154 static struct evbuffer_chain *
155 evbuffer_chain_new(size_t size)
157 struct evbuffer_chain *chain;
160 size += EVBUFFER_CHAIN_SIZE;
162 /* get the next largest memory that can hold the buffer */
163 to_alloc = MIN_BUFFER_SIZE;
164 while (to_alloc < size)
167 /* we get everything in one chunk */
168 if ((chain = mm_malloc(to_alloc)) == NULL)
171 memset(chain, 0, EVBUFFER_CHAIN_SIZE);
173 chain->buffer_len = to_alloc - EVBUFFER_CHAIN_SIZE;
175 /* this way we can manipulate the buffer to different addresses,
176 * which is required for mmap for example.
178 chain->buffer = EVBUFFER_CHAIN_EXTRA(u_char, chain);
184 evbuffer_chain_free(struct evbuffer_chain *chain)
186 if (CHAIN_PINNED(chain)) {
187 chain->flags |= EVBUFFER_DANGLING;
190 if (chain->flags & (EVBUFFER_MMAP|EVBUFFER_SENDFILE|
191 EVBUFFER_REFERENCE)) {
192 if (chain->flags & EVBUFFER_REFERENCE) {
193 struct evbuffer_chain_reference *info =
194 EVBUFFER_CHAIN_EXTRA(
195 struct evbuffer_chain_reference,
198 (*info->cleanupfn)(chain->buffer,
202 #ifdef _EVENT_HAVE_MMAP
203 if (chain->flags & EVBUFFER_MMAP) {
204 struct evbuffer_chain_fd *info =
205 EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_fd,
207 if (munmap(chain->buffer, chain->buffer_len) == -1)
208 event_warn("%s: munmap failed", __func__);
209 if (close(info->fd) == -1)
210 event_warn("%s: close(%d) failed",
215 if (chain->flags & EVBUFFER_SENDFILE) {
216 struct evbuffer_chain_fd *info =
217 EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_fd,
219 if (close(info->fd) == -1)
220 event_warn("%s: close(%d) failed",
230 evbuffer_free_all_chains(struct evbuffer_chain *chain)
232 struct evbuffer_chain *next;
233 for (; chain; chain = next) {
235 evbuffer_chain_free(chain);
241 evbuffer_chains_all_empty(struct evbuffer_chain *chain)
243 for (; chain; chain = chain->next) {
250 /* The definition is needed for EVUTIL_ASSERT, which uses sizeof to avoid
251 "unused variable" warnings. */
252 static inline int evbuffer_chains_all_empty(struct evbuffer_chain *chain) {
258 evbuffer_chain_insert(struct evbuffer *buf,
259 struct evbuffer_chain *chain)
261 ASSERT_EVBUFFER_LOCKED(buf);
262 if (*buf->last_with_datap == NULL) {
263 /* There are no chains data on the buffer at all. */
264 EVUTIL_ASSERT(buf->last_with_datap == &buf->first);
265 EVUTIL_ASSERT(buf->first == NULL);
266 buf->first = buf->last = chain;
268 struct evbuffer_chain **ch = buf->last_with_datap;
269 /* Find the first victim chain. It might be *last_with_datap */
270 while ((*ch) && ((*ch)->off != 0 || CHAIN_PINNED(*ch)))
273 /* There is no victim; just append this new chain. */
274 buf->last->next = chain;
276 buf->last_with_datap = &buf->last->next;
278 /* Replace all victim chains with this chain. */
279 EVUTIL_ASSERT(evbuffer_chains_all_empty(*ch));
280 evbuffer_free_all_chains(*ch);
285 buf->total_len += chain->off;
288 static inline struct evbuffer_chain *
289 evbuffer_chain_insert_new(struct evbuffer *buf, size_t datlen)
291 struct evbuffer_chain *chain;
292 if ((chain = evbuffer_chain_new(datlen)) == NULL)
294 evbuffer_chain_insert(buf, chain);
299 _evbuffer_chain_pin(struct evbuffer_chain *chain, unsigned flag)
301 EVUTIL_ASSERT((chain->flags & flag) == 0);
302 chain->flags |= flag;
306 _evbuffer_chain_unpin(struct evbuffer_chain *chain, unsigned flag)
308 EVUTIL_ASSERT((chain->flags & flag) != 0);
309 chain->flags &= ~flag;
310 if (chain->flags & EVBUFFER_DANGLING)
311 evbuffer_chain_free(chain);
317 struct evbuffer *buffer;
319 buffer = mm_calloc(1, sizeof(struct evbuffer));
323 TAILQ_INIT(&buffer->callbacks);
325 buffer->last_with_datap = &buffer->first;
331 _evbuffer_incref(struct evbuffer *buf)
335 EVBUFFER_UNLOCK(buf);
339 _evbuffer_incref_and_lock(struct evbuffer *buf)
346 evbuffer_defer_callbacks(struct evbuffer *buffer, struct event_base *base)
348 EVBUFFER_LOCK(buffer);
349 buffer->cb_queue = event_base_get_deferred_cb_queue(base);
350 buffer->deferred_cbs = 1;
351 event_deferred_cb_init(&buffer->deferred,
352 evbuffer_deferred_callback, buffer);
353 EVBUFFER_UNLOCK(buffer);
358 evbuffer_enable_locking(struct evbuffer *buf, void *lock)
360 #ifdef _EVENT_DISABLE_THREAD_SUPPORT
367 EVTHREAD_ALLOC_LOCK(lock, EVTHREAD_LOCKTYPE_RECURSIVE);
382 evbuffer_set_parent(struct evbuffer *buf, struct bufferevent *bev)
386 EVBUFFER_UNLOCK(buf);
390 evbuffer_run_callbacks(struct evbuffer *buffer, int running_deferred)
392 struct evbuffer_cb_entry *cbent, *next;
393 struct evbuffer_cb_info info;
395 ev_uint32_t mask, masked_val;
398 if (running_deferred) {
399 mask = EVBUFFER_CB_NODEFER|EVBUFFER_CB_ENABLED;
400 masked_val = EVBUFFER_CB_ENABLED;
401 } else if (buffer->deferred_cbs) {
402 mask = EVBUFFER_CB_NODEFER|EVBUFFER_CB_ENABLED;
403 masked_val = EVBUFFER_CB_NODEFER|EVBUFFER_CB_ENABLED;
404 /* Don't zero-out n_add/n_del, since the deferred callbacks
405 will want to see them. */
408 mask = EVBUFFER_CB_ENABLED;
409 masked_val = EVBUFFER_CB_ENABLED;
412 ASSERT_EVBUFFER_LOCKED(buffer);
414 if (TAILQ_EMPTY(&buffer->callbacks)) {
415 buffer->n_add_for_cb = buffer->n_del_for_cb = 0;
418 if (buffer->n_add_for_cb == 0 && buffer->n_del_for_cb == 0)
421 new_size = buffer->total_len;
422 info.orig_size = new_size + buffer->n_del_for_cb - buffer->n_add_for_cb;
423 info.n_added = buffer->n_add_for_cb;
424 info.n_deleted = buffer->n_del_for_cb;
426 buffer->n_add_for_cb = 0;
427 buffer->n_del_for_cb = 0;
429 for (cbent = TAILQ_FIRST(&buffer->callbacks);
430 cbent != TAILQ_END(&buffer->callbacks);
432 /* Get the 'next' pointer now in case this callback decides
433 * to remove itself or something. */
434 next = TAILQ_NEXT(cbent, next);
436 if ((cbent->flags & mask) != masked_val)
439 if ((cbent->flags & EVBUFFER_CB_OBSOLETE))
440 cbent->cb.cb_obsolete(buffer,
441 info.orig_size, new_size, cbent->cbarg);
443 cbent->cb.cb_func(buffer, &info, cbent->cbarg);
448 evbuffer_invoke_callbacks(struct evbuffer *buffer)
450 if (buffer->deferred_cbs) {
451 if (buffer->deferred.queued)
453 _evbuffer_incref_and_lock(buffer);
455 bufferevent_incref(buffer->parent);
456 EVBUFFER_UNLOCK(buffer);
457 event_deferred_cb_schedule(buffer->cb_queue, &buffer->deferred);
460 evbuffer_run_callbacks(buffer, 0);
464 evbuffer_deferred_callback(struct deferred_cb *cb, void *arg)
466 struct bufferevent *parent = NULL;
467 struct evbuffer *buffer = arg;
469 /* XXXX It would be better to run these callbacks without holding the
471 EVBUFFER_LOCK(buffer);
472 parent = buffer->parent;
473 evbuffer_run_callbacks(buffer, 1);
474 _evbuffer_decref_and_unlock(buffer);
476 bufferevent_decref(parent);
480 evbuffer_remove_all_callbacks(struct evbuffer *buffer)
482 struct evbuffer_cb_entry *cbent;
484 while ((cbent = TAILQ_FIRST(&buffer->callbacks))) {
485 TAILQ_REMOVE(&buffer->callbacks, cbent, next);
491 _evbuffer_decref_and_unlock(struct evbuffer *buffer)
493 struct evbuffer_chain *chain, *next;
494 ASSERT_EVBUFFER_LOCKED(buffer);
496 EVUTIL_ASSERT(buffer->refcnt > 0);
498 if (--buffer->refcnt > 0) {
499 EVBUFFER_UNLOCK(buffer);
503 for (chain = buffer->first; chain != NULL; chain = next) {
505 evbuffer_chain_free(chain);
507 evbuffer_remove_all_callbacks(buffer);
508 if (buffer->deferred_cbs)
509 event_deferred_cb_cancel(buffer->cb_queue, &buffer->deferred);
511 EVBUFFER_UNLOCK(buffer);
512 if (buffer->own_lock)
513 EVTHREAD_FREE_LOCK(buffer->lock, EVTHREAD_LOCKTYPE_RECURSIVE);
518 evbuffer_free(struct evbuffer *buffer)
520 EVBUFFER_LOCK(buffer);
521 _evbuffer_decref_and_unlock(buffer);
525 evbuffer_lock(struct evbuffer *buf)
531 evbuffer_unlock(struct evbuffer *buf)
533 EVBUFFER_UNLOCK(buf);
537 evbuffer_get_length(const struct evbuffer *buffer)
541 EVBUFFER_LOCK(buffer);
543 result = (buffer->total_len);
545 EVBUFFER_UNLOCK(buffer);
551 evbuffer_get_contiguous_space(const struct evbuffer *buf)
553 struct evbuffer_chain *chain;
558 result = (chain != NULL ? chain->off : 0);
559 EVBUFFER_UNLOCK(buf);
565 evbuffer_reserve_space(struct evbuffer *buf, ev_ssize_t size,
566 struct evbuffer_iovec *vec, int n_vecs)
568 struct evbuffer_chain *chain, **chainp;
577 if ((chain = evbuffer_expand_singlechain(buf, size)) == NULL)
580 vec[0].iov_base = CHAIN_SPACE_PTR(chain);
581 vec[0].iov_len = (size_t) CHAIN_SPACE_LEN(chain);
582 EVUTIL_ASSERT(size<0 || (size_t)vec[0].iov_len >= (size_t)size);
585 if (_evbuffer_expand_fast(buf, size, n_vecs)<0)
587 n = _evbuffer_read_setup_vecs(buf, size, vec, n_vecs,
592 EVBUFFER_UNLOCK(buf);
598 advance_last_with_data(struct evbuffer *buf)
601 ASSERT_EVBUFFER_LOCKED(buf);
603 if (!*buf->last_with_datap)
606 while ((*buf->last_with_datap)->next && (*buf->last_with_datap)->next->off) {
607 buf->last_with_datap = &(*buf->last_with_datap)->next;
614 evbuffer_commit_space(struct evbuffer *buf,
615 struct evbuffer_iovec *vec, int n_vecs)
617 struct evbuffer_chain *chain, **firstchainp, **chainp;
629 } else if (n_vecs == 1 &&
630 (buf->last && vec[0].iov_base == (void*)CHAIN_SPACE_PTR(buf->last))) {
631 /* The user only got or used one chain; it might not
632 * be the first one with space in it. */
633 if ((size_t)vec[0].iov_len > (size_t)CHAIN_SPACE_LEN(buf->last))
635 buf->last->off += vec[0].iov_len;
636 added = vec[0].iov_len;
638 advance_last_with_data(buf);
642 /* Advance 'firstchain' to the first chain with space in it. */
643 firstchainp = buf->last_with_datap;
646 if (CHAIN_SPACE_LEN(*firstchainp) == 0) {
647 firstchainp = &(*firstchainp)->next;
650 chain = *firstchainp;
651 /* pass 1: make sure that the pointers and lengths of vecs[] are in
652 * bounds before we try to commit anything. */
653 for (i=0; i<n_vecs; ++i) {
656 if (vec[i].iov_base != (void*)CHAIN_SPACE_PTR(chain) ||
657 (size_t)vec[i].iov_len > CHAIN_SPACE_LEN(chain))
661 /* pass 2: actually adjust all the chains. */
662 chainp = firstchainp;
663 for (i=0; i<n_vecs; ++i) {
664 (*chainp)->off += vec[i].iov_len;
665 added += vec[i].iov_len;
666 if (vec[i].iov_len) {
667 buf->last_with_datap = chainp;
669 chainp = &(*chainp)->next;
673 buf->total_len += added;
674 buf->n_add_for_cb += added;
676 evbuffer_invoke_callbacks(buf);
679 EVBUFFER_UNLOCK(buf);
684 HAS_PINNED_R(struct evbuffer *buf)
686 return (buf->last && CHAIN_PINNED_R(buf->last));
690 ZERO_CHAIN(struct evbuffer *dst)
692 ASSERT_EVBUFFER_LOCKED(dst);
695 dst->last_with_datap = &(dst)->first;
699 /* Prepares the contents of src to be moved to another buffer by removing
700 * read-pinned chains. The first pinned chain is saved in first, and the
701 * last in last. If src has no read-pinned chains, first and last are set
704 PRESERVE_PINNED(struct evbuffer *src, struct evbuffer_chain **first,
705 struct evbuffer_chain **last)
707 struct evbuffer_chain *chain, **pinned;
709 ASSERT_EVBUFFER_LOCKED(src);
711 if (!HAS_PINNED_R(src)) {
712 *first = *last = NULL;
716 pinned = src->last_with_datap;
717 if (!CHAIN_PINNED_R(*pinned))
718 pinned = &(*pinned)->next;
719 EVUTIL_ASSERT(CHAIN_PINNED_R(*pinned));
720 chain = *first = *pinned;
723 /* If there's data in the first pinned chain, we need to allocate
724 * a new chain and copy the data over. */
726 struct evbuffer_chain *tmp;
728 EVUTIL_ASSERT(pinned == src->last_with_datap);
729 tmp = evbuffer_chain_new(chain->off);
732 memcpy(tmp->buffer, chain->buffer + chain->misalign,
734 tmp->off = chain->off;
735 *src->last_with_datap = tmp;
737 chain->misalign += chain->off;
740 src->last = *src->last_with_datap;
748 RESTORE_PINNED(struct evbuffer *src, struct evbuffer_chain *pinned,
749 struct evbuffer_chain *last)
751 ASSERT_EVBUFFER_LOCKED(src);
760 src->last_with_datap = &src->first;
765 COPY_CHAIN(struct evbuffer *dst, struct evbuffer *src)
767 ASSERT_EVBUFFER_LOCKED(dst);
768 ASSERT_EVBUFFER_LOCKED(src);
769 dst->first = src->first;
770 if (src->last_with_datap == &src->first)
771 dst->last_with_datap = &dst->first;
773 dst->last_with_datap = src->last_with_datap;
774 dst->last = src->last;
775 dst->total_len = src->total_len;
779 APPEND_CHAIN(struct evbuffer *dst, struct evbuffer *src)
781 ASSERT_EVBUFFER_LOCKED(dst);
782 ASSERT_EVBUFFER_LOCKED(src);
783 dst->last->next = src->first;
784 if (src->last_with_datap == &src->first)
785 dst->last_with_datap = &dst->last->next;
787 dst->last_with_datap = src->last_with_datap;
788 dst->last = src->last;
789 dst->total_len += src->total_len;
793 PREPEND_CHAIN(struct evbuffer *dst, struct evbuffer *src)
795 ASSERT_EVBUFFER_LOCKED(dst);
796 ASSERT_EVBUFFER_LOCKED(src);
797 src->last->next = dst->first;
798 dst->first = src->first;
799 dst->total_len += src->total_len;
800 if (*dst->last_with_datap == NULL) {
801 if (src->last_with_datap == &(src)->first)
802 dst->last_with_datap = &dst->first;
804 dst->last_with_datap = src->last_with_datap;
805 } else if (dst->last_with_datap == &dst->first) {
806 dst->last_with_datap = &src->last->next;
811 evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf)
813 struct evbuffer_chain *pinned, *last;
814 size_t in_total_len, out_total_len;
817 EVBUFFER_LOCK2(inbuf, outbuf);
818 in_total_len = inbuf->total_len;
819 out_total_len = outbuf->total_len;
821 if (in_total_len == 0 || outbuf == inbuf)
824 if (outbuf->freeze_end || inbuf->freeze_start) {
829 if (PRESERVE_PINNED(inbuf, &pinned, &last) < 0) {
834 if (out_total_len == 0) {
835 /* There might be an empty chain at the start of outbuf; free
837 evbuffer_free_all_chains(outbuf->first);
838 COPY_CHAIN(outbuf, inbuf);
840 APPEND_CHAIN(outbuf, inbuf);
843 RESTORE_PINNED(inbuf, pinned, last);
845 inbuf->n_del_for_cb += in_total_len;
846 outbuf->n_add_for_cb += in_total_len;
848 evbuffer_invoke_callbacks(inbuf);
849 evbuffer_invoke_callbacks(outbuf);
852 EVBUFFER_UNLOCK2(inbuf, outbuf);
857 evbuffer_prepend_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf)
859 struct evbuffer_chain *pinned, *last;
860 size_t in_total_len, out_total_len;
863 EVBUFFER_LOCK2(inbuf, outbuf);
865 in_total_len = inbuf->total_len;
866 out_total_len = outbuf->total_len;
868 if (!in_total_len || inbuf == outbuf)
871 if (outbuf->freeze_start || inbuf->freeze_start) {
876 if (PRESERVE_PINNED(inbuf, &pinned, &last) < 0) {
881 if (out_total_len == 0) {
882 /* There might be an empty chain at the start of outbuf; free
884 evbuffer_free_all_chains(outbuf->first);
885 COPY_CHAIN(outbuf, inbuf);
887 PREPEND_CHAIN(outbuf, inbuf);
890 RESTORE_PINNED(inbuf, pinned, last);
892 inbuf->n_del_for_cb += in_total_len;
893 outbuf->n_add_for_cb += in_total_len;
895 evbuffer_invoke_callbacks(inbuf);
896 evbuffer_invoke_callbacks(outbuf);
898 EVBUFFER_UNLOCK2(inbuf, outbuf);
903 evbuffer_drain(struct evbuffer *buf, size_t len)
905 struct evbuffer_chain *chain, *next;
906 size_t remaining, old_len;
910 old_len = buf->total_len;
915 if (buf->freeze_start) {
920 if (len >= old_len && !HAS_PINNED_R(buf)) {
922 for (chain = buf->first; chain != NULL; chain = next) {
924 evbuffer_chain_free(chain);
932 buf->total_len -= len;
934 for (chain = buf->first;
935 remaining >= chain->off;
938 remaining -= chain->off;
940 if (chain == *buf->last_with_datap) {
941 buf->last_with_datap = &buf->first;
943 if (&chain->next == buf->last_with_datap)
944 buf->last_with_datap = &buf->first;
946 if (CHAIN_PINNED_R(chain)) {
947 EVUTIL_ASSERT(remaining == 0);
948 chain->misalign += chain->off;
952 evbuffer_chain_free(chain);
957 chain->misalign += remaining;
958 chain->off -= remaining;
962 buf->n_del_for_cb += len;
963 /* Tell someone about changes in this buffer */
964 evbuffer_invoke_callbacks(buf);
967 EVBUFFER_UNLOCK(buf);
971 /* Reads data from an event buffer and drains the bytes read */
973 evbuffer_remove(struct evbuffer *buf, void *data_out, size_t datlen)
977 n = evbuffer_copyout(buf, data_out, datlen);
979 if (evbuffer_drain(buf, n)<0)
982 EVBUFFER_UNLOCK(buf);
987 evbuffer_copyout(struct evbuffer *buf, void *data_out, size_t datlen)
989 /*XXX fails badly on sendfile case. */
990 struct evbuffer_chain *chain;
991 char *data = data_out;
993 ev_ssize_t result = 0;
999 if (datlen >= buf->total_len)
1000 datlen = buf->total_len;
1005 if (buf->freeze_start) {
1012 while (datlen && datlen >= chain->off) {
1013 memcpy(data, chain->buffer + chain->misalign, chain->off);
1015 datlen -= chain->off;
1017 chain = chain->next;
1018 EVUTIL_ASSERT(chain || datlen==0);
1022 EVUTIL_ASSERT(chain);
1023 memcpy(data, chain->buffer + chain->misalign, datlen);
1028 EVBUFFER_UNLOCK(buf);
1032 /* reads data from the src buffer to the dst buffer, avoids memcpy as
1034 /* XXXX should return ev_ssize_t */
1036 evbuffer_remove_buffer(struct evbuffer *src, struct evbuffer *dst,
1039 /*XXX We should have an option to force this to be zero-copy.*/
1041 /*XXX can fail badly on sendfile case. */
1042 struct evbuffer_chain *chain, *previous;
1046 EVBUFFER_LOCK2(src, dst);
1048 chain = previous = src->first;
1050 if (datlen == 0 || dst == src) {
1055 if (dst->freeze_end || src->freeze_start) {
1060 /* short-cut if there is no more data buffered */
1061 if (datlen >= src->total_len) {
1062 datlen = src->total_len;
1063 evbuffer_add_buffer(dst, src);
1064 result = (int)datlen; /*XXXX should return ev_ssize_t*/
1068 /* removes chains if possible */
1069 while (chain->off <= datlen) {
1070 /* We can't remove the last with data from src unless we
1071 * remove all chains, in which case we would have done the if
1073 EVUTIL_ASSERT(chain != *src->last_with_datap);
1074 nread += chain->off;
1075 datlen -= chain->off;
1077 if (src->last_with_datap == &chain->next)
1078 src->last_with_datap = &src->first;
1079 chain = chain->next;
1083 /* we can remove the chain */
1084 if (dst->first == NULL) {
1085 dst->first = src->first;
1087 dst->last->next = src->first;
1089 dst->last = previous;
1090 previous->next = NULL;
1092 advance_last_with_data(dst);
1094 dst->total_len += nread;
1095 dst->n_add_for_cb += nread;
1098 /* we know that there is more data in the src buffer than
1099 * we want to read, so we manually drain the chain */
1100 evbuffer_add(dst, chain->buffer + chain->misalign, datlen);
1101 chain->misalign += datlen;
1102 chain->off -= datlen;
1105 src->total_len -= nread;
1106 src->n_del_for_cb += nread;
1109 evbuffer_invoke_callbacks(dst);
1110 evbuffer_invoke_callbacks(src);
1112 result = (int)nread;/*XXXX should change return type */
1115 EVBUFFER_UNLOCK2(src, dst);
1120 evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size)
1122 struct evbuffer_chain *chain, *next, *tmp, *last_with_data;
1123 unsigned char *buffer, *result = NULL;
1124 ev_ssize_t remaining;
1125 int removed_last_with_data = 0;
1126 int removed_last_with_datap = 0;
1133 size = buf->total_len;
1134 /* if size > buf->total_len, we cannot guarantee to the user that she
1135 * is going to have a long enough buffer afterwards; so we return
1137 if (size == 0 || (size_t)size > buf->total_len)
1140 /* No need to pull up anything; the first size bytes are
1142 if (chain->off >= (size_t)size) {
1143 result = chain->buffer + chain->misalign;
1147 /* Make sure that none of the chains we need to copy from is pinned. */
1148 remaining = size - chain->off;
1149 EVUTIL_ASSERT(remaining >= 0);
1150 for (tmp=chain->next; tmp; tmp=tmp->next) {
1151 if (CHAIN_PINNED(tmp))
1153 if (tmp->off >= (size_t)remaining)
1155 remaining -= tmp->off;
1158 if (CHAIN_PINNED(chain)) {
1159 size_t old_off = chain->off;
1160 if (CHAIN_SPACE_LEN(chain) < size - chain->off) {
1161 /* not enough room at end of chunk. */
1164 buffer = CHAIN_SPACE_PTR(chain);
1168 chain = chain->next;
1169 } else if (chain->buffer_len - chain->misalign >= (size_t)size) {
1170 /* already have enough space in the first chain */
1171 size_t old_off = chain->off;
1172 buffer = chain->buffer + chain->misalign + chain->off;
1176 chain = chain->next;
1178 if ((tmp = evbuffer_chain_new(size)) == NULL) {
1179 event_warn("%s: out of memory", __func__);
1182 buffer = tmp->buffer;
1187 /* TODO(niels): deal with buffers that point to NULL like sendfile */
1189 /* Copy and free every chunk that will be entirely pulled into tmp */
1190 last_with_data = *buf->last_with_datap;
1191 for (; chain != NULL && (size_t)size >= chain->off; chain = next) {
1194 memcpy(buffer, chain->buffer + chain->misalign, chain->off);
1196 buffer += chain->off;
1197 if (chain == last_with_data)
1198 removed_last_with_data = 1;
1199 if (&chain->next == buf->last_with_datap)
1200 removed_last_with_datap = 1;
1202 evbuffer_chain_free(chain);
1205 if (chain != NULL) {
1206 memcpy(buffer, chain->buffer + chain->misalign, size);
1207 chain->misalign += size;
1215 if (removed_last_with_data) {
1216 buf->last_with_datap = &buf->first;
1217 } else if (removed_last_with_datap) {
1218 if (buf->first->next && buf->first->next->off)
1219 buf->last_with_datap = &buf->first->next;
1221 buf->last_with_datap = &buf->first;
1224 result = (tmp->buffer + tmp->misalign);
1227 EVBUFFER_UNLOCK(buf);
1232 * Reads a line terminated by either '\r\n', '\n\r' or '\r' or '\n'.
1233 * The returned buffer needs to be freed by the called.
1236 evbuffer_readline(struct evbuffer *buffer)
1238 return evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY);
1241 static inline ev_ssize_t
1242 evbuffer_strchr(struct evbuffer_ptr *it, const char chr)
1244 struct evbuffer_chain *chain = it->_internal.chain;
1245 size_t i = it->_internal.pos_in_chain;
1246 while (chain != NULL) {
1247 char *buffer = (char *)chain->buffer + chain->misalign;
1248 char *cp = memchr(buffer+i, chr, chain->off-i);
1250 it->_internal.chain = chain;
1251 it->_internal.pos_in_chain = cp - buffer;
1252 it->pos += (cp - buffer);
1255 it->pos += chain->off - i;
1257 chain = chain->next;
1263 static inline char *
1264 find_eol_char(char *s, size_t len)
1266 #define CHUNK_SZ 128
1267 /* Lots of benchmarking found this approach to be faster in practice
1268 * than doing two memchrs over the whole buffer, doin a memchr on each
1269 * char of the buffer, or trying to emulate memchr by hand. */
1270 char *s_end, *cr, *lf;
1273 size_t chunk = (s + CHUNK_SZ < s_end) ? CHUNK_SZ : (s_end - s);
1274 cr = memchr(s, '\r', chunk);
1275 lf = memchr(s, '\n', chunk);
1291 evbuffer_find_eol_char(struct evbuffer_ptr *it)
1293 struct evbuffer_chain *chain = it->_internal.chain;
1294 size_t i = it->_internal.pos_in_chain;
1295 while (chain != NULL) {
1296 char *buffer = (char *)chain->buffer + chain->misalign;
1297 char *cp = find_eol_char(buffer+i, chain->off-i);
1299 it->_internal.chain = chain;
1300 it->_internal.pos_in_chain = cp - buffer;
1301 it->pos += (cp - buffer) - i;
1304 it->pos += chain->off - i;
1306 chain = chain->next;
1314 struct evbuffer_ptr *ptr, const char *chrset)
1317 struct evbuffer_chain *chain = ptr->_internal.chain;
1318 size_t i = ptr->_internal.pos_in_chain;
1324 char *buffer = (char *)chain->buffer + chain->misalign;
1325 for (; i < chain->off; ++i) {
1326 const char *p = chrset;
1328 if (buffer[i] == *p++)
1331 ptr->_internal.chain = chain;
1332 ptr->_internal.pos_in_chain = i;
1340 if (! chain->next) {
1341 ptr->_internal.chain = chain;
1342 ptr->_internal.pos_in_chain = i;
1347 chain = chain->next;
1353 evbuffer_getchr(struct evbuffer_ptr *it)
1355 struct evbuffer_chain *chain = it->_internal.chain;
1356 size_t off = it->_internal.pos_in_chain;
1358 return chain->buffer[chain->misalign + off];
1362 evbuffer_search_eol(struct evbuffer *buffer,
1363 struct evbuffer_ptr *start, size_t *eol_len_out,
1364 enum evbuffer_eol_style eol_style)
1366 struct evbuffer_ptr it, it2;
1367 size_t extra_drain = 0;
1370 EVBUFFER_LOCK(buffer);
1373 memcpy(&it, start, sizeof(it));
1376 it._internal.chain = buffer->first;
1377 it._internal.pos_in_chain = 0;
1380 /* the eol_style determines our first stop character and how many
1381 * characters we are going to drain afterwards. */
1382 switch (eol_style) {
1383 case EVBUFFER_EOL_ANY:
1384 if (evbuffer_find_eol_char(&it) < 0)
1386 memcpy(&it2, &it, sizeof(it));
1387 extra_drain = evbuffer_strspn(&it2, "\r\n");
1389 case EVBUFFER_EOL_CRLF_STRICT: {
1390 it = evbuffer_search(buffer, "\r\n", 2, &it);
1396 case EVBUFFER_EOL_CRLF:
1398 if (evbuffer_find_eol_char(&it) < 0)
1400 if (evbuffer_getchr(&it) == '\n') {
1403 } else if (!evbuffer_ptr_memcmp(
1404 buffer, &it, "\r\n", 2)) {
1408 if (evbuffer_ptr_set(buffer, &it, 1,
1409 EVBUFFER_PTR_ADD)<0)
1414 case EVBUFFER_EOL_LF:
1415 if (evbuffer_strchr(&it, '\n') < 0)
1425 EVBUFFER_UNLOCK(buffer);
1431 *eol_len_out = extra_drain;
1437 evbuffer_readln(struct evbuffer *buffer, size_t *n_read_out,
1438 enum evbuffer_eol_style eol_style)
1440 struct evbuffer_ptr it;
1442 size_t n_to_copy=0, extra_drain=0;
1443 char *result = NULL;
1445 EVBUFFER_LOCK(buffer);
1447 if (buffer->freeze_start) {
1451 it = evbuffer_search_eol(buffer, NULL, &extra_drain, eol_style);
1456 if ((line = mm_malloc(n_to_copy+1)) == NULL) {
1457 event_warn("%s: out of memory", __func__);
1461 evbuffer_remove(buffer, line, n_to_copy);
1462 line[n_to_copy] = '\0';
1464 evbuffer_drain(buffer, extra_drain);
1467 EVBUFFER_UNLOCK(buffer);
1470 *n_read_out = result ? n_to_copy : 0;
1475 #define EVBUFFER_CHAIN_MAX_AUTO_SIZE 4096
1477 /* Adds data to an event buffer */
1480 evbuffer_add(struct evbuffer *buf, const void *data_in, size_t datlen)
1482 struct evbuffer_chain *chain, *tmp;
1483 const unsigned char *data = data_in;
1484 size_t remain, to_alloc;
1489 if (buf->freeze_end) {
1495 /* If there are no chains allocated for this buffer, allocate one
1496 * big enough to hold all the data. */
1497 if (chain == NULL) {
1498 chain = evbuffer_chain_new(datlen);
1501 evbuffer_chain_insert(buf, chain);
1504 if ((chain->flags & EVBUFFER_IMMUTABLE) == 0) {
1505 remain = (size_t)(chain->buffer_len - chain->misalign - chain->off);
1506 if (remain >= datlen) {
1507 /* there's enough space to hold all the data in the
1508 * current last chain */
1509 memcpy(chain->buffer + chain->misalign + chain->off,
1511 chain->off += datlen;
1512 buf->total_len += datlen;
1513 buf->n_add_for_cb += datlen;
1515 } else if (!CHAIN_PINNED(chain) &&
1516 evbuffer_chain_should_realign(chain, datlen)) {
1517 /* we can fit the data into the misalignment */
1518 evbuffer_chain_align(chain);
1520 memcpy(chain->buffer + chain->off, data, datlen);
1521 chain->off += datlen;
1522 buf->total_len += datlen;
1523 buf->n_add_for_cb += datlen;
1527 /* we cannot write any data to the last chain */
1531 /* we need to add another chain */
1532 to_alloc = chain->buffer_len;
1533 if (to_alloc <= EVBUFFER_CHAIN_MAX_AUTO_SIZE/2)
1535 if (datlen > to_alloc)
1537 tmp = evbuffer_chain_new(to_alloc);
1542 memcpy(chain->buffer + chain->misalign + chain->off,
1544 chain->off += remain;
1545 buf->total_len += remain;
1546 buf->n_add_for_cb += remain;
1552 memcpy(tmp->buffer, data, datlen);
1554 evbuffer_chain_insert(buf, tmp);
1557 evbuffer_invoke_callbacks(buf);
1560 EVBUFFER_UNLOCK(buf);
1565 evbuffer_prepend(struct evbuffer *buf, const void *data, size_t datlen)
1567 struct evbuffer_chain *chain, *tmp;
1572 if (buf->freeze_start) {
1578 if (chain == NULL) {
1579 chain = evbuffer_chain_new(datlen);
1582 evbuffer_chain_insert(buf, chain);
1585 /* we cannot touch immutable buffers */
1586 if ((chain->flags & EVBUFFER_IMMUTABLE) == 0) {
1587 /* If this chain is empty, we can treat it as
1588 * 'empty at the beginning' rather than 'empty at the end' */
1589 if (chain->off == 0)
1590 chain->misalign = chain->buffer_len;
1592 if ((size_t)chain->misalign >= datlen) {
1593 /* we have enough space to fit everything */
1594 memcpy(chain->buffer + chain->misalign - datlen,
1596 chain->off += datlen;
1597 chain->misalign -= datlen;
1598 buf->total_len += datlen;
1599 buf->n_add_for_cb += datlen;
1601 } else if (chain->misalign) {
1602 /* we can only fit some of the data. */
1603 memcpy(chain->buffer,
1604 (char*)data + datlen - chain->misalign,
1605 (size_t)chain->misalign);
1606 chain->off += (size_t)chain->misalign;
1607 buf->total_len += (size_t)chain->misalign;
1608 buf->n_add_for_cb += (size_t)chain->misalign;
1609 datlen -= (size_t)chain->misalign;
1610 chain->misalign = 0;
1614 /* we need to add another chain */
1615 if ((tmp = evbuffer_chain_new(datlen)) == NULL)
1618 if (buf->last_with_datap == &buf->first)
1619 buf->last_with_datap = &tmp->next;
1624 tmp->misalign = tmp->buffer_len - datlen;
1626 memcpy(tmp->buffer + tmp->misalign, data, datlen);
1627 buf->total_len += datlen;
1628 buf->n_add_for_cb += (size_t)chain->misalign;
1631 evbuffer_invoke_callbacks(buf);
1634 EVBUFFER_UNLOCK(buf);
1638 /** Helper: realigns the memory in chain->buffer so that misalign is 0. */
1640 evbuffer_chain_align(struct evbuffer_chain *chain)
1642 EVUTIL_ASSERT(!(chain->flags & EVBUFFER_IMMUTABLE));
1643 EVUTIL_ASSERT(!(chain->flags & EVBUFFER_MEM_PINNED_ANY));
1644 memmove(chain->buffer, chain->buffer + chain->misalign, chain->off);
1645 chain->misalign = 0;
1648 #define MAX_TO_COPY_IN_EXPAND 4096
1649 #define MAX_TO_REALIGN_IN_EXPAND 2048
1651 /** Helper: return true iff we should realign chain to fit datalen bytes of
1654 evbuffer_chain_should_realign(struct evbuffer_chain *chain,
1657 return chain->buffer_len - chain->off >= datlen &&
1658 (chain->off < chain->buffer_len / 2) &&
1659 (chain->off <= MAX_TO_REALIGN_IN_EXPAND);
1662 /* Expands the available space in the event buffer to at least datlen, all in
1663 * a single chunk. Return that chunk. */
1664 static struct evbuffer_chain *
1665 evbuffer_expand_singlechain(struct evbuffer *buf, size_t datlen)
1667 struct evbuffer_chain *chain, **chainp;
1668 struct evbuffer_chain *result = NULL;
1669 ASSERT_EVBUFFER_LOCKED(buf);
1671 chainp = buf->last_with_datap;
1673 /* XXX If *chainp is no longer writeable, but has enough space in its
1674 * misalign, this might be a bad idea: we could still use *chainp, not
1675 * (*chainp)->next. */
1676 if (*chainp && CHAIN_SPACE_LEN(*chainp) == 0)
1677 chainp = &(*chainp)->next;
1679 /* 'chain' now points to the first chain with writable space (if any)
1680 * We will either use it, realign it, replace it, or resize it. */
1683 if (chain == NULL ||
1684 (chain->flags & (EVBUFFER_IMMUTABLE|EVBUFFER_MEM_PINNED_ANY))) {
1685 /* We can't use the last_with_data chain at all. Just add a
1686 * new one that's big enough. */
1690 /* If we can fit all the data, then we don't have to do anything */
1691 if (CHAIN_SPACE_LEN(chain) >= datlen) {
1696 /* If the chain is completely empty, just replace it by adding a new
1698 if (chain->off == 0) {
1702 /* If the misalignment plus the remaining space fulfills our data
1703 * needs, we could just force an alignment to happen. Afterwards, we
1704 * have enough space. But only do this if we're saving a lot of space
1705 * and not moving too much data. Otherwise the space savings are
1706 * probably offset by the time lost in copying.
1708 if (evbuffer_chain_should_realign(chain, datlen)) {
1709 evbuffer_chain_align(chain);
1714 /* At this point, we can either resize the last chunk with space in
1715 * it, use the next chunk after it, or If we add a new chunk, we waste
1716 * CHAIN_SPACE_LEN(chain) bytes in the former last chunk. If we
1717 * resize, we have to copy chain->off bytes.
1720 /* Would expanding this chunk be affordable and worthwhile? */
1721 if (CHAIN_SPACE_LEN(chain) < chain->buffer_len / 8 ||
1722 chain->off > MAX_TO_COPY_IN_EXPAND) {
1723 /* It's not worth resizing this chain. Can the next one be
1725 if (chain->next && CHAIN_SPACE_LEN(chain->next) >= datlen) {
1726 /* Yes, we can just use the next chain (which should
1728 result = chain->next;
1731 /* No; append a new chain (which will free all
1732 * terminal empty chains.) */
1736 /* Okay, we're going to try to resize this chain: Not doing so
1737 * would waste at least 1/8 of its current allocation, and we
1738 * can do so without having to copy more than
1739 * MAX_TO_COPY_IN_EXPAND bytes. */
1740 /* figure out how much space we need */
1741 size_t length = chain->off + datlen;
1742 struct evbuffer_chain *tmp = evbuffer_chain_new(length);
1746 /* copy the data over that we had so far */
1747 tmp->off = chain->off;
1748 memcpy(tmp->buffer, chain->buffer + chain->misalign,
1750 /* fix up the list */
1751 EVUTIL_ASSERT(*chainp == chain);
1752 result = *chainp = tmp;
1754 if (buf->last == chain)
1757 tmp->next = chain->next;
1758 evbuffer_chain_free(chain);
1763 result = evbuffer_chain_insert_new(buf, datlen);
1767 EVUTIL_ASSERT(result);
1768 EVUTIL_ASSERT(CHAIN_SPACE_LEN(result) >= datlen);
1773 /* Make sure that datlen bytes are available for writing in the last n
1774 * chains. Never copies or moves data. */
1776 _evbuffer_expand_fast(struct evbuffer *buf, size_t datlen, int n)
1778 struct evbuffer_chain *chain = buf->last, *tmp, *next;
1782 ASSERT_EVBUFFER_LOCKED(buf);
1783 EVUTIL_ASSERT(n >= 2);
1785 if (chain == NULL || (chain->flags & EVBUFFER_IMMUTABLE)) {
1786 /* There is no last chunk, or we can't touch the last chunk.
1787 * Just add a new chunk. */
1788 chain = evbuffer_chain_new(datlen);
1792 evbuffer_chain_insert(buf, chain);
1796 used = 0; /* number of chains we're using space in. */
1797 avail = 0; /* how much space they have. */
1798 /* How many bytes can we stick at the end of buffer as it is? Iterate
1799 * over the chains at the end of the buffer, tring to see how much
1800 * space we have in the first n. */
1801 for (chain = *buf->last_with_datap; chain; chain = chain->next) {
1803 size_t space = (size_t) CHAIN_SPACE_LEN(chain);
1804 EVUTIL_ASSERT(chain == *buf->last_with_datap);
1810 /* No data in chain; realign it. */
1811 chain->misalign = 0;
1812 avail += chain->buffer_len;
1815 if (avail >= datlen) {
1816 /* There is already enough space. Just return */
1823 /* There wasn't enough space in the first n chains with space in
1824 * them. Either add a new chain with enough space, or replace all
1825 * empty chains with one that has enough space, depending on n. */
1827 /* The loop ran off the end of the chains before it hit n
1828 * chains; we can add another. */
1829 EVUTIL_ASSERT(chain == NULL);
1831 tmp = evbuffer_chain_new(datlen - avail);
1835 buf->last->next = tmp;
1837 /* (we would only set last_with_data if we added the first
1838 * chain. But if the buffer had no chains, we would have
1839 * just allocated a new chain earlier) */
1842 /* Nuke _all_ the empty chains. */
1843 int rmv_all = 0; /* True iff we removed last_with_data. */
1844 chain = *buf->last_with_datap;
1846 EVUTIL_ASSERT(chain == buf->first);
1850 avail = (size_t) CHAIN_SPACE_LEN(chain);
1851 chain = chain->next;
1855 for (; chain; chain = next) {
1857 EVUTIL_ASSERT(chain->off == 0);
1858 evbuffer_chain_free(chain);
1860 tmp = evbuffer_chain_new(datlen - avail);
1865 buf->last = *buf->last_with_datap;
1866 (*buf->last_with_datap)->next = NULL;
1872 buf->first = buf->last = tmp;
1873 buf->last_with_datap = &buf->first;
1875 (*buf->last_with_datap)->next = tmp;
1883 evbuffer_expand(struct evbuffer *buf, size_t datlen)
1885 struct evbuffer_chain *chain;
1888 chain = evbuffer_expand_singlechain(buf, datlen);
1889 EVBUFFER_UNLOCK(buf);
1890 return chain ? 0 : -1;
1894 * Reads data from a file descriptor into a buffer.
1897 #if defined(_EVENT_HAVE_SYS_UIO_H) || defined(WIN32)
1898 #define USE_IOVEC_IMPL
1901 #ifdef USE_IOVEC_IMPL
1903 #ifdef _EVENT_HAVE_SYS_UIO_H
1904 /* number of iovec we use for writev, fragmentation is going to determine
1905 * how much we end up writing */
1907 #define DEFAULT_WRITE_IOVEC 128
1909 #if defined(UIO_MAXIOV) && UIO_MAXIOV < DEFAULT_WRITE_IOVEC
1910 #define NUM_WRITE_IOVEC UIO_MAXIOV
1911 #elif defined(IOV_MAX) && IOV_MAX < DEFAULT_WRITE_IOVEC
1912 #define NUM_WRITE_IOVEC IOV_MAX
1914 #define NUM_WRITE_IOVEC DEFAULT_WRITE_IOVEC
1917 #define IOV_TYPE struct iovec
1918 #define IOV_PTR_FIELD iov_base
1919 #define IOV_LEN_FIELD iov_len
1920 #define IOV_LEN_TYPE size_t
1922 #define NUM_WRITE_IOVEC 16
1923 #define IOV_TYPE WSABUF
1924 #define IOV_PTR_FIELD buf
1925 #define IOV_LEN_FIELD len
1926 #define IOV_LEN_TYPE unsigned long
1929 #define NUM_READ_IOVEC 4
1931 #define EVBUFFER_MAX_READ 4096
1933 /** Helper function to figure out which space to use for reading data into
1934 an evbuffer. Internal use only.
1936 @param buf The buffer to read into
1937 @param howmuch How much we want to read.
1938 @param vecs An array of two or more iovecs or WSABUFs.
1939 @param n_vecs_avail The length of vecs
1940 @param chainp A pointer to a variable to hold the first chain we're
1942 @param exact Boolean: if true, we do not provide more than 'howmuch'
1943 space in the vectors, even if more space is available.
1944 @return The number of buffers we're using.
1947 _evbuffer_read_setup_vecs(struct evbuffer *buf, ev_ssize_t howmuch,
1948 struct evbuffer_iovec *vecs, int n_vecs_avail,
1949 struct evbuffer_chain ***chainp, int exact)
1951 struct evbuffer_chain *chain;
1952 struct evbuffer_chain **firstchainp;
1955 ASSERT_EVBUFFER_LOCKED(buf);
1961 /* Let firstchain be the first chain with any space on it */
1962 firstchainp = buf->last_with_datap;
1963 if (CHAIN_SPACE_LEN(*firstchainp) == 0) {
1964 firstchainp = &(*firstchainp)->next;
1967 chain = *firstchainp;
1968 for (i = 0; i < n_vecs_avail && so_far < (size_t)howmuch; ++i) {
1969 size_t avail = (size_t) CHAIN_SPACE_LEN(chain);
1970 if (avail > (howmuch - so_far) && exact)
1971 avail = howmuch - so_far;
1972 vecs[i].iov_base = CHAIN_SPACE_PTR(chain);
1973 vecs[i].iov_len = avail;
1975 chain = chain->next;
1978 *chainp = firstchainp;
1983 get_n_bytes_readable_on_socket(evutil_socket_t fd)
1985 #if defined(FIONREAD) && defined(WIN32)
1986 unsigned long lng = EVBUFFER_MAX_READ;
1987 if (ioctlsocket(fd, FIONREAD, &lng) < 0)
1990 #elif defined(FIONREAD)
1991 int n = EVBUFFER_MAX_READ;
1992 if (ioctl(fd, FIONREAD, &n) < 0)
1996 return EVBUFFER_MAX_READ;
2000 /* TODO(niels): should this function return ev_ssize_t and take ev_ssize_t
2003 evbuffer_read(struct evbuffer *buf, evutil_socket_t fd, int howmuch)
2005 struct evbuffer_chain **chainp;
2009 #ifdef USE_IOVEC_IMPL
2010 int nvecs, i, remaining;
2012 struct evbuffer_chain *chain;
2018 if (buf->freeze_end) {
2023 n = get_n_bytes_readable_on_socket(fd);
2024 if (n <= 0 || n > EVBUFFER_MAX_READ)
2025 n = EVBUFFER_MAX_READ;
2026 if (howmuch < 0 || howmuch > n)
2029 #ifdef USE_IOVEC_IMPL
2030 /* Since we can use iovecs, we're willing to use the last
2031 * NUM_READ_IOVEC chains. */
2032 if (_evbuffer_expand_fast(buf, howmuch, NUM_READ_IOVEC) == -1) {
2036 IOV_TYPE vecs[NUM_READ_IOVEC];
2037 #ifdef _EVBUFFER_IOVEC_IS_NATIVE
2038 nvecs = _evbuffer_read_setup_vecs(buf, howmuch, vecs,
2039 NUM_READ_IOVEC, &chainp, 1);
2041 /* We aren't using the native struct iovec. Therefore,
2043 struct evbuffer_iovec ev_vecs[NUM_READ_IOVEC];
2044 nvecs = _evbuffer_read_setup_vecs(buf, howmuch, ev_vecs, 2,
2047 for (i=0; i < nvecs; ++i)
2048 WSABUF_FROM_EVBUFFER_IOV(&vecs[i], &ev_vecs[i]);
2055 if (WSARecv(fd, vecs, nvecs, &bytesRead, &flags, NULL, NULL)) {
2056 /* The read failed. It might be a close,
2057 * or it might be an error. */
2058 if (WSAGetLastError() == WSAECONNABORTED)
2066 n = readv(fd, vecs, nvecs);
2070 #else /*!USE_IOVEC_IMPL*/
2071 /* If we don't have FIONREAD, we might waste some space here */
2072 /* XXX we _will_ waste some space here if there is any space left
2073 * over on buf->last. */
2074 if ((chain = evbuffer_expand_singlechain(buf, howmuch)) == NULL) {
2079 /* We can append new data at this point */
2080 p = chain->buffer + chain->misalign + chain->off;
2083 n = read(fd, p, howmuch);
2085 n = recv(fd, p, howmuch, 0);
2087 #endif /* USE_IOVEC_IMPL */
2098 #ifdef USE_IOVEC_IMPL
2100 for (i=0; i < nvecs; ++i) {
2101 ev_ssize_t space = (ev_ssize_t) CHAIN_SPACE_LEN(*chainp);
2102 if (space < remaining) {
2103 (*chainp)->off += space;
2104 remaining -= (int)space;
2106 (*chainp)->off += remaining;
2107 buf->last_with_datap = chainp;
2110 chainp = &(*chainp)->next;
2114 advance_last_with_data(buf);
2116 buf->total_len += n;
2117 buf->n_add_for_cb += n;
2119 /* Tell someone about changes in this buffer */
2120 evbuffer_invoke_callbacks(buf);
2123 EVBUFFER_UNLOCK(buf);
2129 evbuffer_readfile(struct evbuffer *buf, evutil_socket_t fd, ev_ssize_t howmuch)
2133 struct evbuffer_iovec v[2];
2137 if (buf->freeze_end) {
2146 /* XXX we _will_ waste some space here if there is any space left
2147 * over on buf->last. */
2148 nchains = evbuffer_reserve_space(buf, howmuch, v, 2);
2149 if (nchains < 1 || nchains > 2) {
2153 n = read((int)fd, v[0].iov_base, (unsigned int)v[0].iov_len);
2158 v[0].iov_len = (IOV_LEN_TYPE) n; /* XXXX another problem with big n.*/
2160 n = read((int)fd, v[1].iov_base, (unsigned int)v[1].iov_len);
2162 result = (unsigned long) v[0].iov_len;
2163 evbuffer_commit_space(buf, v, 1);
2168 evbuffer_commit_space(buf, v, nchains);
2172 EVBUFFER_UNLOCK(buf);
2177 #ifdef USE_IOVEC_IMPL
2179 evbuffer_write_iovec(struct evbuffer *buffer, evutil_socket_t fd,
2182 IOV_TYPE iov[NUM_WRITE_IOVEC];
2183 struct evbuffer_chain *chain = buffer->first;
2189 ASSERT_EVBUFFER_LOCKED(buffer);
2190 /* XXX make this top out at some maximal data length? if the
2191 * buffer has (say) 1MB in it, split over 128 chains, there's
2192 * no way it all gets written in one go. */
2193 while (chain != NULL && i < NUM_WRITE_IOVEC && howmuch) {
2195 /* we cannot write the file info via writev */
2196 if (chain->flags & EVBUFFER_SENDFILE)
2199 iov[i].IOV_PTR_FIELD = (void *) (chain->buffer + chain->misalign);
2200 if ((size_t)howmuch >= chain->off) {
2201 /* XXXcould be problematic when windows supports mmap*/
2202 iov[i++].IOV_LEN_FIELD = (IOV_LEN_TYPE)chain->off;
2203 howmuch -= chain->off;
2205 /* XXXcould be problematic when windows supports mmap*/
2206 iov[i++].IOV_LEN_FIELD = (IOV_LEN_TYPE)howmuch;
2209 chain = chain->next;
2214 if (WSASend(fd, iov, i, &bytesSent, 0, NULL, NULL))
2220 n = writev(fd, iov, i);
2228 evbuffer_write_sendfile(struct evbuffer *buffer, evutil_socket_t fd,
2231 struct evbuffer_chain *chain = buffer->first;
2232 struct evbuffer_chain_fd *info =
2233 EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_fd, chain);
2234 #if defined(SENDFILE_IS_MACOSX) || defined(SENDFILE_IS_FREEBSD)
2236 off_t len = chain->off;
2237 #elif defined(SENDFILE_IS_LINUX) || defined(SENDFILE_IS_SOLARIS)
2239 off_t offset = chain->misalign;
2242 ASSERT_EVBUFFER_LOCKED(buffer);
2244 #if defined(SENDFILE_IS_MACOSX)
2245 res = sendfile(info->fd, fd, chain->misalign, &len, NULL, 0);
2246 if (res == -1 && !EVUTIL_ERR_RW_RETRIABLE(errno))
2250 #elif defined(SENDFILE_IS_FREEBSD)
2251 res = sendfile(info->fd, fd, chain->misalign, chain->off, NULL, &len, 0);
2252 if (res == -1 && !EVUTIL_ERR_RW_RETRIABLE(errno))
2256 #elif defined(SENDFILE_IS_LINUX)
2257 /* TODO(niels): implement splice */
2258 res = sendfile(fd, info->fd, &offset, chain->off);
2259 if (res == -1 && EVUTIL_ERR_RW_RETRIABLE(errno)) {
2260 /* if this is EAGAIN or EINTR return 0; otherwise, -1 */
2264 #elif defined(SENDFILE_IS_SOLARIS)
2265 res = sendfile(fd, info->fd, &offset, chain->off);
2266 if (res == -1 && EVUTIL_ERR_RW_RETRIABLE(errno)) {
2267 /* if this is EAGAIN or EINTR return 0; otherwise, -1 */
2276 evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd,
2281 EVBUFFER_LOCK(buffer);
2283 if (buffer->freeze_start) {
2287 if (howmuch < 0 || (size_t)howmuch > buffer->total_len)
2288 howmuch = buffer->total_len;
2292 struct evbuffer_chain *chain = buffer->first;
2293 if (chain != NULL && (chain->flags & EVBUFFER_SENDFILE))
2294 n = evbuffer_write_sendfile(buffer, fd, howmuch);
2297 #ifdef USE_IOVEC_IMPL
2298 n = evbuffer_write_iovec(buffer, fd, howmuch);
2299 #elif defined(WIN32)
2300 /* XXX(nickm) Don't disable this code until we know if
2301 * the WSARecv code above works. */
2302 void *p = evbuffer_pullup(buffer, howmuch);
2303 n = send(fd, p, howmuch, 0);
2305 void *p = evbuffer_pullup(buffer, howmuch);
2306 n = write(fd, p, howmuch);
2314 evbuffer_drain(buffer, n);
2317 EVBUFFER_UNLOCK(buffer);
2322 evbuffer_write(struct evbuffer *buffer, evutil_socket_t fd)
2324 return evbuffer_write_atmost(buffer, fd, -1);
2328 evbuffer_find(struct evbuffer *buffer, const unsigned char *what, size_t len)
2330 unsigned char *search;
2331 struct evbuffer_ptr ptr;
2333 EVBUFFER_LOCK(buffer);
2335 ptr = evbuffer_search(buffer, (const char *)what, len, NULL);
2339 search = evbuffer_pullup(buffer, ptr.pos + len);
2343 EVBUFFER_UNLOCK(buffer);
2348 evbuffer_ptr_set(struct evbuffer *buf, struct evbuffer_ptr *pos,
2349 size_t position, enum evbuffer_ptr_how how)
2351 size_t left = position;
2352 struct evbuffer_chain *chain = NULL;
2357 case EVBUFFER_PTR_SET:
2359 pos->pos = position;
2362 case EVBUFFER_PTR_ADD:
2363 /* this avoids iterating over all previous chains if
2364 we just want to advance the position */
2365 chain = pos->_internal.chain;
2366 pos->pos += position;
2367 position = pos->_internal.pos_in_chain;
2371 while (chain && position + left >= chain->off) {
2372 left -= chain->off - position;
2373 chain = chain->next;
2377 pos->_internal.chain = chain;
2378 pos->_internal.pos_in_chain = position + left;
2380 pos->_internal.chain = NULL;
2384 EVBUFFER_UNLOCK(buf);
2386 return chain != NULL ? 0 : -1;
2390 Compare the bytes in buf at position pos to the len bytes in mem. Return
2391 less than 0, 0, or greater than 0 as memcmp.
2394 evbuffer_ptr_memcmp(const struct evbuffer *buf, const struct evbuffer_ptr *pos,
2395 const char *mem, size_t len)
2397 struct evbuffer_chain *chain;
2401 ASSERT_EVBUFFER_LOCKED(buf);
2403 if (pos->pos + len > buf->total_len)
2406 chain = pos->_internal.chain;
2407 position = pos->_internal.pos_in_chain;
2408 while (len && chain) {
2409 size_t n_comparable;
2410 if (len + position > chain->off)
2411 n_comparable = chain->off - position;
2414 r = memcmp(chain->buffer + chain->misalign + position, mem,
2418 mem += n_comparable;
2419 len -= n_comparable;
2421 chain = chain->next;
2428 evbuffer_search(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start)
2430 return evbuffer_search_range(buffer, what, len, start, NULL);
2434 evbuffer_search_range(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start, const struct evbuffer_ptr *end)
2436 struct evbuffer_ptr pos;
2437 struct evbuffer_chain *chain, *last_chain = NULL;
2438 const unsigned char *p;
2441 EVBUFFER_LOCK(buffer);
2444 memcpy(&pos, start, sizeof(pos));
2445 chain = pos._internal.chain;
2448 chain = pos._internal.chain = buffer->first;
2449 pos._internal.pos_in_chain = 0;
2453 last_chain = end->_internal.chain;
2455 if (!len || len > EV_SSIZE_MAX)
2461 const unsigned char *start_at =
2462 chain->buffer + chain->misalign +
2463 pos._internal.pos_in_chain;
2464 p = memchr(start_at, first,
2465 chain->off - pos._internal.pos_in_chain);
2467 pos.pos += p - start_at;
2468 pos._internal.pos_in_chain += p - start_at;
2469 if (!evbuffer_ptr_memcmp(buffer, &pos, what, len)) {
2470 if (end && pos.pos + (ev_ssize_t)len > end->pos)
2476 ++pos._internal.pos_in_chain;
2477 if (pos._internal.pos_in_chain == chain->off) {
2478 chain = pos._internal.chain = chain->next;
2479 pos._internal.pos_in_chain = 0;
2482 if (chain == last_chain)
2484 pos.pos += chain->off - pos._internal.pos_in_chain;
2485 chain = pos._internal.chain = chain->next;
2486 pos._internal.pos_in_chain = 0;
2492 pos._internal.chain = NULL;
2494 EVBUFFER_UNLOCK(buffer);
2499 evbuffer_peek(struct evbuffer *buffer, ev_ssize_t len,
2500 struct evbuffer_ptr *start_at,
2501 struct evbuffer_iovec *vec, int n_vec)
2503 struct evbuffer_chain *chain;
2505 ev_ssize_t len_so_far = 0;
2507 EVBUFFER_LOCK(buffer);
2510 chain = start_at->_internal.chain;
2511 len_so_far = chain->off
2512 - start_at->_internal.pos_in_chain;
2515 vec[0].iov_base = chain->buffer + chain->misalign
2516 + start_at->_internal.pos_in_chain;
2517 vec[0].iov_len = len_so_far;
2519 chain = chain->next;
2521 chain = buffer->first;
2525 if (len >= 0 && len_so_far >= len)
2528 vec[idx].iov_base = chain->buffer + chain->misalign;
2529 vec[idx].iov_len = chain->off;
2533 len_so_far += chain->off;
2534 chain = chain->next;
2537 EVBUFFER_UNLOCK(buffer);
2544 evbuffer_add_vprintf(struct evbuffer *buf, const char *fmt, va_list ap)
2548 int sz, result = -1;
2550 struct evbuffer_chain *chain;
2555 if (buf->freeze_end) {
2559 /* make sure that at least some space is available */
2560 if ((chain = evbuffer_expand_singlechain(buf, 64)) == NULL)
2565 size_t used = chain->misalign + chain->off;
2566 buffer = (char *)chain->buffer + chain->misalign + chain->off;
2567 EVUTIL_ASSERT(chain->buffer_len >= used);
2568 space = chain->buffer_len - used;
2570 buffer = (char*) CHAIN_SPACE_PTR(chain);
2571 space = (size_t) CHAIN_SPACE_LEN(chain);
2574 #define va_copy(dst, src) memcpy(&(dst), &(src), sizeof(va_list))
2578 sz = evutil_vsnprintf(buffer, space, fmt, aq);
2584 if ((size_t)sz < space) {
2586 buf->total_len += sz;
2587 buf->n_add_for_cb += sz;
2589 advance_last_with_data(buf);
2590 evbuffer_invoke_callbacks(buf);
2594 if ((chain = evbuffer_expand_singlechain(buf, sz + 1)) == NULL)
2600 EVBUFFER_UNLOCK(buf);
2605 evbuffer_add_printf(struct evbuffer *buf, const char *fmt, ...)
2611 res = evbuffer_add_vprintf(buf, fmt, ap);
2618 evbuffer_add_reference(struct evbuffer *outbuf,
2619 const void *data, size_t datlen,
2620 evbuffer_ref_cleanup_cb cleanupfn, void *extra)
2622 struct evbuffer_chain *chain;
2623 struct evbuffer_chain_reference *info;
2626 chain = evbuffer_chain_new(sizeof(struct evbuffer_chain_reference));
2629 chain->flags |= EVBUFFER_REFERENCE | EVBUFFER_IMMUTABLE;
2630 chain->buffer = (u_char *)data;
2631 chain->buffer_len = datlen;
2632 chain->off = datlen;
2634 info = EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_reference, chain);
2635 info->cleanupfn = cleanupfn;
2636 info->extra = extra;
2638 EVBUFFER_LOCK(outbuf);
2639 if (outbuf->freeze_end) {
2640 /* don't call chain_free; we do not want to actually invoke
2641 * the cleanup function */
2645 evbuffer_chain_insert(outbuf, chain);
2646 outbuf->n_add_for_cb += datlen;
2648 evbuffer_invoke_callbacks(outbuf);
2652 EVBUFFER_UNLOCK(outbuf);
2657 /* TODO(niels): maybe we don't want to own the fd, however, in that
2658 * case, we should dup it - dup is cheap. Perhaps, we should use a
2661 /* TODO(niels): we may want to add to automagically convert to mmap, in
2662 * case evbuffer_remove() or evbuffer_pullup() are being used.
2665 evbuffer_add_file(struct evbuffer *outbuf, int fd,
2666 ev_off_t offset, ev_off_t length)
2668 #if defined(USE_SENDFILE) || defined(_EVENT_HAVE_MMAP)
2669 struct evbuffer_chain *chain;
2670 struct evbuffer_chain_fd *info;
2674 #if defined(USE_SENDFILE)
2676 chain = evbuffer_chain_new(sizeof(struct evbuffer_chain_fd));
2677 if (chain == NULL) {
2678 event_warn("%s: out of memory", __func__);
2682 chain->flags |= EVBUFFER_SENDFILE | EVBUFFER_IMMUTABLE;
2683 chain->buffer = NULL; /* no reading possible */
2684 chain->buffer_len = length + offset;
2685 chain->off = length;
2686 chain->misalign = offset;
2688 info = EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_fd, chain);
2691 EVBUFFER_LOCK(outbuf);
2692 if (outbuf->freeze_end) {
2696 outbuf->n_add_for_cb += length;
2697 evbuffer_chain_insert(outbuf, chain);
2701 #if defined(_EVENT_HAVE_MMAP)
2703 void *mapped = mmap(NULL, length + offset, PROT_READ,
2712 /* some mmap implementations require offset to be a multiple of
2713 * the page size. most users of this api, are likely to use 0
2714 * so mapping everything is not likely to be a problem.
2715 * TODO(niels): determine page size and round offset to that
2716 * page size to avoid mapping too much memory.
2718 if (mapped == MAP_FAILED) {
2719 event_warn("%s: mmap(%d, %d, %zu) failed",
2720 __func__, fd, 0, (size_t)(offset + length));
2723 chain = evbuffer_chain_new(sizeof(struct evbuffer_chain_fd));
2724 if (chain == NULL) {
2725 event_warn("%s: out of memory", __func__);
2726 munmap(mapped, length);
2730 chain->flags |= EVBUFFER_MMAP | EVBUFFER_IMMUTABLE;
2731 chain->buffer = mapped;
2732 chain->buffer_len = length + offset;
2733 chain->off = length + offset;
2735 info = EVBUFFER_CHAIN_EXTRA(struct evbuffer_chain_fd, chain);
2738 EVBUFFER_LOCK(outbuf);
2739 if (outbuf->freeze_end) {
2741 evbuffer_chain_free(chain);
2744 outbuf->n_add_for_cb += length;
2746 evbuffer_chain_insert(outbuf, chain);
2748 /* we need to subtract whatever we don't need */
2749 evbuffer_drain(outbuf, offset);
2754 /* the default implementation */
2755 struct evbuffer *tmp = evbuffer_new();
2762 #define lseek _lseeki64
2764 if (lseek(fd, offset, SEEK_SET) == -1) {
2769 /* we add everything to a temporary buffer, so that we
2770 * can abort without side effects if the read fails.
2773 read = evbuffer_readfile(tmp, fd, (ev_ssize_t)length);
2782 EVBUFFER_LOCK(outbuf);
2783 if (outbuf->freeze_end) {
2787 evbuffer_add_buffer(outbuf, tmp);
2791 #define close _close
2798 evbuffer_invoke_callbacks(outbuf);
2799 EVBUFFER_UNLOCK(outbuf);
2806 evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg)
2808 EVBUFFER_LOCK(buffer);
2810 if (!TAILQ_EMPTY(&buffer->callbacks))
2811 evbuffer_remove_all_callbacks(buffer);
2814 struct evbuffer_cb_entry *ent =
2815 evbuffer_add_cb(buffer, NULL, cbarg);
2816 ent->cb.cb_obsolete = cb;
2817 ent->flags |= EVBUFFER_CB_OBSOLETE;
2819 EVBUFFER_UNLOCK(buffer);
2822 struct evbuffer_cb_entry *
2823 evbuffer_add_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg)
2825 struct evbuffer_cb_entry *e;
2826 if (! (e = mm_calloc(1, sizeof(struct evbuffer_cb_entry))))
2828 EVBUFFER_LOCK(buffer);
2831 e->flags = EVBUFFER_CB_ENABLED;
2832 TAILQ_INSERT_HEAD(&buffer->callbacks, e, next);
2833 EVBUFFER_UNLOCK(buffer);
2838 evbuffer_remove_cb_entry(struct evbuffer *buffer,
2839 struct evbuffer_cb_entry *ent)
2841 EVBUFFER_LOCK(buffer);
2842 TAILQ_REMOVE(&buffer->callbacks, ent, next);
2843 EVBUFFER_UNLOCK(buffer);
2849 evbuffer_remove_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg)
2851 struct evbuffer_cb_entry *cbent;
2853 EVBUFFER_LOCK(buffer);
2854 TAILQ_FOREACH(cbent, &buffer->callbacks, next) {
2855 if (cb == cbent->cb.cb_func && cbarg == cbent->cbarg) {
2856 result = evbuffer_remove_cb_entry(buffer, cbent);
2861 EVBUFFER_UNLOCK(buffer);
2866 evbuffer_cb_set_flags(struct evbuffer *buffer,
2867 struct evbuffer_cb_entry *cb, ev_uint32_t flags)
2869 /* the user isn't allowed to mess with these. */
2870 flags &= ~EVBUFFER_CB_INTERNAL_FLAGS;
2871 EVBUFFER_LOCK(buffer);
2873 EVBUFFER_UNLOCK(buffer);
2878 evbuffer_cb_clear_flags(struct evbuffer *buffer,
2879 struct evbuffer_cb_entry *cb, ev_uint32_t flags)
2881 /* the user isn't allowed to mess with these. */
2882 flags &= ~EVBUFFER_CB_INTERNAL_FLAGS;
2883 EVBUFFER_LOCK(buffer);
2884 cb->flags &= ~flags;
2885 EVBUFFER_UNLOCK(buffer);
2890 evbuffer_freeze(struct evbuffer *buffer, int start)
2892 EVBUFFER_LOCK(buffer);
2894 buffer->freeze_start = 1;
2896 buffer->freeze_end = 1;
2897 EVBUFFER_UNLOCK(buffer);
2902 evbuffer_unfreeze(struct evbuffer *buffer, int start)
2904 EVBUFFER_LOCK(buffer);
2906 buffer->freeze_start = 0;
2908 buffer->freeze_end = 0;
2909 EVBUFFER_UNLOCK(buffer);
2915 evbuffer_cb_suspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb)
2917 if (!(cb->flags & EVBUFFER_CB_SUSPENDED)) {
2918 cb->size_before_suspend = evbuffer_get_length(buffer);
2919 cb->flags |= EVBUFFER_CB_SUSPENDED;
2924 evbuffer_cb_unsuspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb)
2926 if ((cb->flags & EVBUFFER_CB_SUSPENDED)) {
2927 unsigned call = (cb->flags & EVBUFFER_CB_CALL_ON_UNSUSPEND);
2928 size_t sz = cb->size_before_suspend;
2929 cb->flags &= ~(EVBUFFER_CB_SUSPENDED|
2930 EVBUFFER_CB_CALL_ON_UNSUSPEND);
2931 cb->size_before_suspend = 0;
2932 if (call && (cb->flags & EVBUFFER_CB_ENABLED)) {
2933 cb->cb(buffer, sz, evbuffer_get_length(buffer), cb->cbarg);
2939 /* These hooks are exposed so that the unit tests can temporarily disable
2940 * sendfile support in order to test mmap, or both to test linear
2941 * access. Don't use it; if we need to add a way to disable sendfile support
2942 * in the future, it will probably be via an alternate version of
2943 * evbuffer_add_file() with a 'flags' argument.
2945 int _evbuffer_testing_use_sendfile(void);
2946 int _evbuffer_testing_use_mmap(void);
2947 int _evbuffer_testing_use_linear_file_access(void);
2950 _evbuffer_testing_use_sendfile(void)
2957 #ifdef _EVENT_HAVE_MMAP
2963 _evbuffer_testing_use_mmap(void)
2969 #ifdef _EVENT_HAVE_MMAP
2976 _evbuffer_testing_use_linear_file_access(void)
2981 #ifdef _EVENT_HAVE_MMAP