From patchwork Sun Apr 25 13:28:31 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonio Quartulli X-Patchwork-Id: 1773 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director7.mail.ord1d.rsapps.net ([172.30.191.6]) by backend30.mail.ord1d.rsapps.net with LMTP id aGqMLVL7hWBhXAAAIUCqbw (envelope-from ) for ; Sun, 25 Apr 2021 19:29:22 -0400 Received: from proxy20.mail.ord1d.rsapps.net ([172.30.191.6]) by director7.mail.ord1d.rsapps.net with LMTP id aJdGLVL7hWB9TgAAovjBpQ (envelope-from ) for ; Sun, 25 Apr 2021 19:29:22 -0400 Received: from smtp7.gate.ord1d ([172.30.191.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy20.mail.ord1d.rsapps.net with LMTPS id CMgCLVL7hWBcLQAAsk8m8w (envelope-from ) for ; Sun, 25 Apr 2021 19:29:22 -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: smtp7.gate.ord1d.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: 106566cc-a61e-11eb-b5ee-525400d0c497-1-1 Received: from [216.105.38.7] ([216.105.38.7:41382] helo=lists.sourceforge.net) by smtp7.gate.ord1d.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id D3/B9-10147-25BF5806; Sun, 25 Apr 2021 19:29:22 -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 1laoB5-0005Vt-UB; Sun, 25 Apr 2021 23:28:39 +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 1laoB3-0005VM-Rz for openvpn-devel@lists.sourceforge.net; Sun, 25 Apr 2021 23:28:37 +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=UHxuk1Mf7cuy92/ntMnPhniREpZwDEHsksXmnxNOBz8=; b=D9UbOTqMkSzKpoPK/3QiuCMJ+W Q8oX8aP4YCElU2LXoICnlTZBv5LyvcV40k4zrLSUQyc6BsgzdEybkHHboRLGvtJI0dvGq9Je5DDVj rmF6T8/O1j7bDUV4kCTEgjWrXjepiGZI5mL65ILa102NVTIjOqiSVBsC/eTYvIU2dgrE=; 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=UHxuk1Mf7cuy92/ntMnPhniREpZwDEHsksXmnxNOBz8=; b=TZ65wdcUr8F0BJGWK7tKvmyR4z Ae3t8gjog0Rwjwg3zI2nIXJs6NqnEIRTJ2D4BrQS0imWS+12h9BZW52DRWjF3cmyOrZZJep1w7Sgn OgKXgCWtUpXR4m8S5zPt8GPh3/qfRIkQIlp5tBJGdv/g2zy4sCpmdegD65B6QDYR7qmw=; Received: from s2.neomailbox.net ([5.148.176.60]) by sfi-mx-1.v28.lw.sourceforge.com with esmtps (TLSv1.2:DHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.2) id 1laoAz-009Ar9-De for openvpn-devel@lists.sourceforge.net; Sun, 25 Apr 2021 23:28:38 +0000 From: Antonio Quartulli To: openvpn-devel@lists.sourceforge.net Date: Mon, 26 Apr 2021 01:28:31 +0200 Message-Id: <20210425232831.2611-1-a@unstable.cc> In-Reply-To: <20210401131337.3684-5-arne@rfc2549.org> References: <20210401131337.3684-5-arne@rfc2549.org> 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_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record X-Headers-End: 1laoAz-009Ar9-De Subject: [Openvpn-devel] [PATCH v2] 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: Arne Schwabe 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: Arne Schwabe Signed-off-by: Antonio Quartulli --- Passed all compile tests on my GitLab CI. (including enabling/disabling mgmt and async push) src/openvpn/forward.c | 14 +++++++----- src/openvpn/openvpn.h | 51 ++++++++++++++++++++++++++++++++++--------- 2 files changed, 49 insertions(+), 16 deletions(-) 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..02eede92 100644 --- a/src/openvpn/openvpn.h +++ b/src/openvpn/openvpn.h @@ -232,16 +232,47 @@ 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) + /* 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 READ_SHIFT 0 +#define WRITE_SHIFT 1 + +#define SHIFT(_name, _op) (1 << (_name ## _SHIFT + _op ## _SHIFT)) + +#define SOCKET_SHIFT 0 +#define SOCKET_READ SHIFT(SOCKET, READ) +#define SOCKET_WRITE SHIFT(SOCKET, WRITE) +#define TUN_SHIFT 2 +#define TUN_READ SHIFT(TUN, READ) +#define TUN_WRITE SHIFT(TUN, WRITE) +#define ERR_SHIFT 4 +#define ES_ERROR SHIFT(ERR, READ) +#define ES_TIMEOUT SHIFT(ERR, WRITE) +#ifdef ENABLE_MANAGEMENT +#define MANAGEMENT_SHIFT 6 +#define MANAGEMENT_READ SHIFT(MANAGEMENT, READ) +#define MANAGEMENT_WRITE SHIFT(MANAGEMENT, WRITE) +#endif +#ifdef ENABLE_ASYNC_PUSH +#define FILE_SHIFT 8 +#define FILE_CLOSED SHIFT(FILE, READ) +#endif unsigned int event_set_status;