Edit

kc3-lang/libevent/include/event2/event_struct.h

Branch :

  • Browse

    Commit

  • Author : Nathan French
    Date : 2018-04-30 18:13:45
    Hash : 1af80176
    Message : [core] re-order fields in struct event for memory efficiency The sizeof `struct event` can reduced on both 32 bit and 64 bit systems by moving the 4 bytes that make up `ev_events` and `ev_res` below `ev_fd`, before `struct event_base * ev_base;` since our compiler wouldn't dare do such a thing (it instead will pad twice, whereas it only needs to be padded once) ```C struct event { /* OFFS | SZ Bytes | Total Bytes | START - END */ struct event_callback ev_evcallback; /* 0x0 | 40 | 40 | 0x0 - 0x28 */ union { /* 0x28 | ----------- | ----------- | ------------ */ TAILQ_ENTRY(event) ev_next_with_common_timeout; /* | ((16)) | | */ int min_heap_idx; /* | ((04)) | | */ } ev_timeout_pos; /* | 16 | 56 | 0x28 - 0x38 */ int ev_fd; /* 0x38 | 04 | 60 | 0x38 - 0x3c */ ``` Since the next field is 8 bytes in length, and we are up to 60 bytes, `ev_fd` ends up being padded (4 more bytes on 64b). ```C /* --- 1 byte gap HERE ---> 1 | <61> */ /* --- 1 byte gap HERE ---> 1 | <62> */ /* --- 1 byte gap HERE ---> 1 | <63> */ /* --- 1 byte gap HERE ---> 1 | <64> */ struct event_base * ev_base; /* 0x3c | 8 | 68 | 0x3c - 0x40 */ union { /* 0x40 | ------------ | ---------- | ------------ */ struct { /* | ------------ | | */ LIST_ENTRY (event) ev_io_next; /* | ((16+ | | */ struct timeval ev_timeout; /* | 16)) | | */ } ev_io; /* | ((32)) | | */ struct { /* | ------------ | | */ LIST_ENTRY (event) ev_signal_next; /* | ((16+ | | */ short ev_ncalls; /* | 02+ | | */ short * ev_pncalls; /* | 08)) | | */ } ev_signal; /* | ((26)) | | */ } ev_; /* 0x60 | 32 | 100 | 0x40 - 0x60 */ short ev_events; /* 0x60 | 2 | 102 | 0x60 - 0x62 */ short ev_res; /* 0x62 | 2 | 104 | 0x62 - 0x64 */ ``` We now hit another line, `struct timeval` is 16 bytes on 64b arch, so we have 4 more bytes of padding on `ev_res`. ```C /* --- 1 byte gap HERE --- */ /* --- 1 byte gap HERE --- */ /* --- 1 byte gap HERE --- */ /* --- 1 byte gap HERE --- */ struct timeval ev_timeout; /* 0x64 | 16 | 120 | 0x64 - 0x74 */ }; ``` After moving `ev_events` and `ev_res` below `ev_fd` we have something a bit more optimal: ```C struct event2 { /* OFFS | SZ / Bytes | RSUM Bytes | START - END */ struct event_callback ev_evcallback; /* 0x0 | 40 | 40 | 0x0 - 0x28 */ union { /* 0x28 | ------------ | ---------- | ------------ */ TAILQ_ENTRY(event) ev_next_with_common_timeout; /* | ((16)) | | */ int min_heap_idx; /* | ((04)) | | */ } ev_timeout_pos; /* | 16 | 56 | 0x28 - 0x38 */ int ev_fd; /* 0x38 | 4 | 60 | 0x38 - 0x3c */ short ev_events; /* 0x3c | 2 | 62 | 0x3c - 0x3e */ short ev_res; /* 0x3e | 2 | 64 | 0x3e - 0x40 */ struct event_base * ev_base; /* 0x40 | 8 | 74 | 0x40 - 0x48 */ union { /* 0x48 | ------------ | ---------- | ------------ */ struct { /* | ------------ | | */ LIST_ENTRY (event) ev_io_next; /* | ((16+ | | */ struct timeval ev_timeout; /* | 16)) | | */ } ev_io; /* | ((32)) | | */ struct { /* | ------------ | | */ LIST_ENTRY (event) ev_signal_next; /* | ((16+ | | */ short ev_ncalls; /* | 02+ | | */ short * ev_pncalls; /* | 08)) | | */ } ev_signal; /* | ((26)) | | */ } ev_; /* | 32 | 106 | 0x48 - 0x68 */ struct timeval ev_timeout; /* 0x68 | 16 | 120 | 0x68 - 0x78 */ }; ``` We still have a gap here, but the first was removed. Again, we can save 8 bytes on both 32 and 64 word sizes (32/64 byte cacheline). Below are the results for testing v2.1.6 -> master -> master + this patch (Release/-O3) Code: ```C #include <event2/event.h> int main(int argc, char ** argv) { printf("%zu\n", event_get_struct_event_size()); return 0; } ``` Branch: `master` (2.2.x) ``` $ gcc -O3 -Wall -Wl,-R/usr/local/lib bleh.c -L/usr/local/lib -o bleh -levent $ ldd bleh linux-vdso.so.1 => (0x00007ffc3df50000) libevent.so.2.2.0 => /usr/local/lib/libevent.so.2.2.0 (0x00007f91fd781000) libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f91fd3a1000) libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007f91fd182000) /lib64/ld-linux-x86-64.so.2 (0x00007f91fdbcc000) $ ./bleh 128 ``` Release: `2.1.6` ``` $ gcc -O3 bleh.c -o bleh -levent $ ldd bleh linux-vdso.so.1 => (0x00007ffd43773000) libevent-2.1.so.6 => /usr/lib/x86_64-linux-gnu/libevent-2.1.so.6 (0x00007feb3add6000) libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007feb3a9f6000) libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007feb3a7d7000) /lib64/ld-linux-x86-64.so.2 (0x00007feb3b22a000) $ ./bleh 128 ``` Branch: `this one` ``` $ gcc -O3 -Wl,-R./lib bleh.c -o bleh -L./lib -levent $ ldd bleh linux-vdso.so.1 => (0x00007ffff55f7000) libevent.so.2.2.0 => ./lib/libevent.so.2.2.0 (0x00007ff8e5c82000) libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007ff8e58a2000) libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007ff8e5683000) /lib64/ld-linux-x86-64.so.2 (0x00007ff8e60cd000) $ ./bleh 120 ```

  • include/event2/event_struct.h
  • /*
     * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
     * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
     *
     * Redistribution and use in source and binary forms, with or without
     * modification, are permitted provided that the following conditions
     * are met:
     * 1. Redistributions of source code must retain the above copyright
     *    notice, this list of conditions and the following disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     * 3. The name of the author may not be used to endorse or promote products
     *    derived from this software without specific prior written permission.
     *
     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     */
    #ifndef EVENT2_EVENT_STRUCT_H_INCLUDED_
    #define EVENT2_EVENT_STRUCT_H_INCLUDED_
    
    /** @file event2/event_struct.h
    
      Structures used by event.h.  Using these structures directly WILL harm
      forward compatibility: be careful.
    
      No field declared in this file should be used directly in user code.  Except
      for historical reasons, these fields would not be exposed at all.
     */
    
    #ifdef __cplusplus
    extern "C" {
    #endif
    
    #include <event2/event-config.h>
    #ifdef EVENT__HAVE_SYS_TYPES_H
    #include <sys/types.h>
    #endif
    #ifdef EVENT__HAVE_SYS_TIME_H
    #include <sys/time.h>
    #endif
    
    /* For int types. */
    #include <event2/util.h>
    
    /* For evkeyvalq */
    #include <event2/keyvalq_struct.h>
    
    #define EVLIST_TIMEOUT	    0x01
    #define EVLIST_INSERTED	    0x02
    #define EVLIST_SIGNAL	    0x04
    #define EVLIST_ACTIVE	    0x08
    #define EVLIST_INTERNAL	    0x10
    #define EVLIST_ACTIVE_LATER 0x20
    #define EVLIST_FINALIZING   0x40
    #define EVLIST_INIT	    0x80
    
    #define EVLIST_ALL          0xff
    
    /* Fix so that people don't have to run with <sys/queue.h> */
    #ifndef TAILQ_ENTRY
    #define EVENT_DEFINED_TQENTRY_
    #define TAILQ_ENTRY(type)						\
    struct {								\
    	struct type *tqe_next;	/* next element */			\
    	struct type **tqe_prev;	/* address of previous next element */	\
    }
    #endif /* !TAILQ_ENTRY */
    
    #ifndef TAILQ_HEAD
    #define EVENT_DEFINED_TQHEAD_
    #define TAILQ_HEAD(name, type)			\
    struct name {					\
    	struct type *tqh_first;			\
    	struct type **tqh_last;			\
    }
    #endif
    
    /* Fix so that people don't have to run with <sys/queue.h> */
    #ifndef LIST_ENTRY
    #define EVENT_DEFINED_LISTENTRY_
    #define LIST_ENTRY(type)						\
    struct {								\
    	struct type *le_next;	/* next element */			\
    	struct type **le_prev;	/* address of previous next element */	\
    }
    #endif /* !LIST_ENTRY */
    
    #ifndef LIST_HEAD
    #define EVENT_DEFINED_LISTHEAD_
    #define LIST_HEAD(name, type)						\
    struct name {								\
    	struct type *lh_first;  /* first element */			\
    	}
    #endif /* !LIST_HEAD */
    
    struct event;
    
    struct event_callback {
    	TAILQ_ENTRY(event_callback) evcb_active_next;
    	short evcb_flags;
    	ev_uint8_t evcb_pri;	/* smaller numbers are higher priority */
    	ev_uint8_t evcb_closure;
    	/* allows us to adopt for different types of events */
            union {
    		void (*evcb_callback)(evutil_socket_t, short, void *);
    		void (*evcb_selfcb)(struct event_callback *, void *);
    		void (*evcb_evfinalize)(struct event *, void *);
    		void (*evcb_cbfinalize)(struct event_callback *, void *);
    	} evcb_cb_union;
    	void *evcb_arg;
    };
    
    struct event_base;
    struct event {
    	struct event_callback ev_evcallback;
    
    	/* for managing timeouts */
    	union {
    		TAILQ_ENTRY(event) ev_next_with_common_timeout;
    		int min_heap_idx;
    	} ev_timeout_pos;
    	evutil_socket_t ev_fd;
    
    	short ev_events;
    	short ev_res;		/* result passed to event callback */
    
    	struct event_base *ev_base;
    
    	union {
    		/* used for io events */
    		struct {
    			LIST_ENTRY (event) ev_io_next;
    			struct timeval ev_timeout;
    		} ev_io;
    
    		/* used by signal events */
    		struct {
    			LIST_ENTRY (event) ev_signal_next;
    			short ev_ncalls;
    			/* Allows deletes in callback */
    			short *ev_pncalls;
    		} ev_signal;
    	} ev_;
    
    
    	struct timeval ev_timeout;
    };
    
    TAILQ_HEAD (event_list, event);
    
    #ifdef EVENT_DEFINED_TQENTRY_
    #undef TAILQ_ENTRY
    #endif
    
    #ifdef EVENT_DEFINED_TQHEAD_
    #undef TAILQ_HEAD
    #endif
    
    LIST_HEAD (event_dlist, event); 
    
    #ifdef EVENT_DEFINED_LISTENTRY_
    #undef LIST_ENTRY
    #endif
    
    #ifdef EVENT_DEFINED_LISTHEAD_
    #undef LIST_HEAD
    #endif
    
    #ifdef __cplusplus
    }
    #endif
    
    #endif /* EVENT2_EVENT_STRUCT_H_INCLUDED_ */