From patchwork Mon Apr 26 05:29:14 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonio Quartulli X-Patchwork-Id: 1775 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director14.mail.ord1d.rsapps.net ([172.31.255.6]) by backend30.mail.ord1d.rsapps.net with LMTP id 6HlcHn7chmD0SgAAIUCqbw (envelope-from ) for ; Mon, 26 Apr 2021 11:30:06 -0400 Received: from proxy17.mail.iad3b.rsapps.net ([172.31.255.6]) by director14.mail.ord1d.rsapps.net with LMTP id +C0HHn7chmBtQAAAeJ7fFg (envelope-from ) for ; Mon, 26 Apr 2021 11:30:06 -0400 Received: from smtp30.gate.iad3b ([172.31.255.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy17.mail.iad3b.rsapps.net with LMTPS id iDorF37chmAmBAAA5ccGVQ (envelope-from ) for ; Mon, 26 Apr 2021 11:30:06 -0400 X-Spam-Threshold: 95 X-Spam-Score: 0 X-Spam-Flag: NO X-Virus-Scanned: OK X-Orig-To: openvpnslackdevel@openvpn.net X-Originating-Ip: [216.105.38.7] Authentication-Results: smtp30.gate.iad3b.rsapps.net; iprev=pass policy.iprev="216.105.38.7"; spf=pass smtp.mailfrom="openvpn-devel-bounces@lists.sourceforge.net" smtp.helo="lists.sourceforge.net"; dkim=fail (signature verification failed) header.d=sourceforge.net; dkim=fail (signature verification failed) header.d=sf.net; dmarc=none (p=nil; dis=none) header.from=unstable.cc X-Suspicious-Flag: YES X-Classification-ID: 4644c928-a6a4-11eb-a0cb-525400502618-1-1 Received: from [216.105.38.7] ([216.105.38.7:38412] helo=lists.sourceforge.net) by smtp30.gate.iad3b.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id F3/34-16829-D7CD6806; Mon, 26 Apr 2021 11:30:05 -0400 Received: from [127.0.0.1] (helo=sfs-ml-4.v29.lw.sourceforge.com) by sfs-ml-4.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1lb3Af-0007Ox-RA; Mon, 26 Apr 2021 15:29:14 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-4.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lb3Ac-0007OQ-El for openvpn-devel@lists.sourceforge.net; Mon, 26 Apr 2021 15:29:10 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:References: In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=1SHhYeYcGp8Y/Kvw5nN/VCd0pg5awWHgwldN4DeE0xg=; b=C5hKL2ZPHk1kBjpqaEqEBKWknZ p+NZmv3TpuFqJlSCHcBaflbKBI/bBwinls3NnA3tSLP7G/DJLMeYnD8C8S7QALBxT2HHtsr8EfUx5 DuY9vw6zbCMh8BzG86RQ6o22ZFGWCmu551BxzY7C7zIW35J+qlWjUpDeZiyCskI778n8=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To:Message-Id: Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=1SHhYeYcGp8Y/Kvw5nN/VCd0pg5awWHgwldN4DeE0xg=; b=W+1Cu2YWwbX7s8Us9Mv7i710mm 9yZvSxE1QN4o8OWlUxS4PkvJDeVaZqkrTbYXAqfRE+hbJ0A6xahhmT9slJUkf/gvrfRz6Uk0AEZGq L6m10BaHWmu8oZpaXqMZqtEM9QjtpYvjE6Lduj4cysTRgKZ4h9D5SjZnBZ1b26k8ENaI=; Received: from s2.neomailbox.net ([5.148.176.60]) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLSv1.2:DHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.3) id 1lb3AZ-0006UM-FB for openvpn-devel@lists.sourceforge.net; Mon, 26 Apr 2021 15:29:11 +0000 From: Antonio Quartulli To: openvpn-devel@lists.sourceforge.net Date: Mon, 26 Apr 2021 17:29:14 +0200 Message-Id: <20210426152914.18314-1-a@unstable.cc> In-Reply-To: <20210426132603.31629-1-a@unstable.cc> References: <20210426132603.31629-1-a@unstable.cc> MIME-Version: 1.0 X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -0.0 SPF_HELO_PASS SPF: HELO matches SPF record -0.0 SPF_PASS SPF: sender matches SPF record X-Headers-End: 1lb3AZ-0006UM-FB Subject: [Openvpn-devel] [PATCH v4] Add documentation on EVENT_READ/EVENT_WRITE constants X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Antonio Quartulli Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox From: Antonio Quartulli Changes from v3: - re-introduce READ/WRITE_SHIFT because they are different from EVENT_READ/WRITE - define also EVENT_READ/WRITE using READ/WRITE_SHIFT Changes from v2: - moved event definitions to event.h - removed READ/WRITE_SHIFT and use EVENT_READ/WRITE - removed ifdefs around *_SHIFTS definitions in event.h Changes from v1: - fixed typ0s - extended comment - moved *_SHIFT definition to openvpn.h - made READ/WRITE events dependant on _SHIFT definition with a macro Signed-off-by: Antonio Quartulli --- src/openvpn/event.h | 44 +++++++++++++++++++++++++++++++++++++++++-- src/openvpn/forward.c | 14 ++++++++------ src/openvpn/openvpn.h | 12 +----------- 3 files changed, 51 insertions(+), 19 deletions(-) diff --git a/src/openvpn/event.h b/src/openvpn/event.h index 4af6371e..bfc3d51f 100644 --- a/src/openvpn/event.h +++ b/src/openvpn/event.h @@ -32,9 +32,49 @@ * rwflags passed to event_ctl and returned by * struct event_set_return. */ +#define READ_SHIFT 0 +#define WRITE_SHIFT 1 + #define EVENT_UNDEF 4 -#define EVENT_READ (1<<0) -#define EVENT_WRITE (1<<1) +#define EVENT_READ (1 << READ_SHIFT) +#define EVENT_WRITE (1 << WRITE_SHIFT) + +/* event flags returned by io_wait. + * + * All these events are defined as bits in a bitfield. + * Each event type owns two bits in the bitfield: one for the READ + * event and one for the WRITE event. + * + * For this reason, the specific event bit is calculated by adding + * the event type identifier (always a multiple of 2, as defined + * below) to 0 for READ and 1 for WRITE. + * + * E.g. + * MANAGEMENT_SHIFT = 6; <---- event type identifier + * MANAGEMENT_READ = (1 << (6 + 0)), <---- READ event + * MANAGEMENT_WRITE = (1 << (6 + 1)) <---- WRITE event + * + * 'error' and 'file_close' are special and use read/write for different + * signals. + */ + +#define EVENT_SHIFT(_name, _op) (1 << (_name ## _SHIFT + _op ## _SHIFT)) + +#define SOCKET_SHIFT 0 +#define SOCKET_READ EVENT_SHIFT(SOCKET, READ) +#define SOCKET_WRITE EVENT_SHIFT(SOCKET, WRITE) +#define TUN_SHIFT 2 +#define TUN_READ EVENT_SHIFT(TUN, READ) +#define TUN_WRITE EVENT_SHIFT(TUN, WRITE) +#define ERR_SHIFT 4 +#define ES_ERROR EVENT_SHIFT(ERR, READ) +#define ES_TIMEOUT EVENT_SHIFT(ERR, WRITE) +#define MANAGEMENT_SHIFT 6 +#define MANAGEMENT_READ EVENT_SHIFT(MANAGEMENT, READ) +#define MANAGEMENT_WRITE EVENT_SHIFT(MANAGEMENT, WRITE) +#define FILE_SHIFT 8 +#define FILE_CLOSED EVENT_SHIFT(FILE, READ) + /* * Initialization flags passed to event_set_init */ diff --git a/src/openvpn/forward.c b/src/openvpn/forward.c index df96d048..e302d8e0 100644 --- a/src/openvpn/forward.c +++ b/src/openvpn/forward.c @@ -1867,15 +1867,17 @@ io_wait_dowork(struct context *c, const unsigned int flags) unsigned int tuntap = 0; struct event_set_return esr[4]; - /* These shifts all depend on EVENT_READ and EVENT_WRITE */ - static int socket_shift = 0; /* depends on SOCKET_READ and SOCKET_WRITE */ - static int tun_shift = 2; /* depends on TUN_READ and TUN_WRITE */ - static int err_shift = 4; /* depends on ES_ERROR */ + /* These shifts all depend on EVENT_READ (=1) and EVENT_WRITE (=2) + * and are added to the shift. Check openvpn.h for more details. + */ + static int socket_shift = SOCKET_SHIFT; + static int tun_shift = TUN_SHIFT; + static int err_shift = ERR_SHIFT; #ifdef ENABLE_MANAGEMENT - static int management_shift = 6; /* depends on MANAGEMENT_READ and MANAGEMENT_WRITE */ + static int management_shift = MANAGEMENT_SHIFT; #endif #ifdef ENABLE_ASYNC_PUSH - static int file_shift = 8; /* listening inotify events */ + static int file_shift = FILE_SHIFT; #endif /* diff --git a/src/openvpn/openvpn.h b/src/openvpn/openvpn.h index a15ff08d..6e4651cf 100644 --- a/src/openvpn/openvpn.h +++ b/src/openvpn/openvpn.h @@ -232,17 +232,7 @@ struct context_2 int event_set_max; bool event_set_owned; - /* event flags returned by io_wait */ -#define SOCKET_READ (1<<0) -#define SOCKET_WRITE (1<<1) -#define TUN_READ (1<<2) -#define TUN_WRITE (1<<3) -#define ES_ERROR (1<<4) -#define ES_TIMEOUT (1<<5) -#define MANAGEMENT_READ (1<<6) -#define MANAGEMENT_WRITE (1<<7) -#define FILE_CLOSED (1<<8) - + /* bitmask for event status. Check event.h for possible values */ unsigned int event_set_status; struct link_socket *link_socket; /* socket used for TCP/UDP connection to remote */