Properly unmap ring buffer file-map in interactive service
PATCH 1/1 Properly unmap ring buffer file-map in interactive service
From: Selva Nair <[email protected]...>
The return value of MapViewOfFile must be passed to UnmapViewofFile, instead of the file handle.
Fixes #206
--- src/openvpnserv/interactive.c | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-)
src/openvpnserv/interactive.c +15 -13
@@ -109,6 +109,8 @@ typedef struct {HANDLE send_tail_moved;HANDLE receive_tail_moved;HANDLE device; +struct tun_ring *send_ring; +struct tun_ring *receive_ring; } ring_buffer_handles_t;
@@ -165,15 +167,14 @@ CloseHandleEx(LPHANDLE handle)return INVALID_HANDLE_VALUE ; } -static HANDLE -OvpnUnmapViewOfFile (LPHANDLE handle) +static void +OvpnUnmapViewOfFile (struct tun_ring **ring) { -if (handle && *handle && *handle !=INVALID_HANDLE_VALUE ) +if (ring && *ring) { -UnmapViewOfFile (*handle); - *handle =INVALID_HANDLE_VALUE ; +UnmapViewOfFile (*ring); } -return INVALID_HANDLE_VALUE ; + *ring =NULL ; } static void
@@ -182,8 +183,10 @@ CloseRingBufferHandles(ring_buffer_handles_t *ring_buffer_handles)CloseHandleEx (&ring_buffer_handles->device);CloseHandleEx (&ring_buffer_handles->receive_tail_moved);CloseHandleEx (&ring_buffer_handles->send_tail_moved); -OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring_handle); -OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring_handle); +OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring); +OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring); +CloseHandleEx (&ring_buffer_handles->receive_ring_handle); +CloseHandleEx (&ring_buffer_handles->send_ring_handle); } static HANDLE
@@ -1354,8 +1357,6 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovp ring_buffer_handles_t *ring_buffer_handles) {DWORD err =0 ; -struct tun_ring *send_ring; -struct tun_ring *receive_ring;CloseRingBufferHandles (ring_buffer_handles);
@@ -1365,13 +1366,13 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &send_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &ring_buffer_handles->send_ring);if (err !=ERROR_SUCCESS ) {return err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &receive_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &ring_buffer_handles->receive_ring);if (err !=ERROR_SUCCESS ) {return err;
@@ -1389,7 +1390,8 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } -if (!register_ring_buffers (ring_buffer_handles->device, send_ring, receive_ring, +if (!register_ring_buffers (ring_buffer_handles->device, ring_buffer_handles->send_ring, + ring_buffer_handles->receive_ring, ring_buffer_handles->send_tail_moved, ring_buffer_handles->receive_tail_moved)) { err =GetLastError ();
Signature · 1 line
2.34.1
Hi,
Quoted 2 lines
The return value of MapViewOfFile must be passed to UnmapViewofFile, instead of the file handle.
Good catch!
Quoted 1 line
Fixes #206
Strangely enough, I am not able to reproduce this bug - I posted logs to the GitHub issue.
Fix indeed makes sense. Indeed, according to docs, UnmapViewOfFile() accepts return value from MapViewOfFile(),
not from CreateFileMapping(), like it is implemented in interactive service. Interesting that in tun.c implementation
is correct.
src/openvpnserv/interactive.c CloseHandleEx(LPHANDLE handle) · line 177
Quoted 9 lines
src/openvpnserv/interactive.c +3
-4-if (handle && *handle && *handle !=INVALID_HANDLE_VALUE ) +if (ring && *ring) { -UnmapViewOfFile (*handle); - *handle =INVALID_HANDLE_VALUE ; +UnmapViewOfFile (*ring); } -return INVALID_HANDLE_VALUE ; + *ring =NULL ;
It makes sense to move NULL assignment inside if { } to handle unlikely case when the passed "ring" is NULL.
PATCH v2 1/1 Properly unmap ring buffer file-map in interactive service
In reply to [email protected]...From: Selva Nair <[email protected]...>
The return value of MapViewOfFile must be passed to UnmapViewofFile, instead of the file handle.
Fixes #206
v2: move *ring = NULL inside if {}
--- src/openvpnserv/interactive.c | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-)
src/openvpnserv/interactive.c +15 -13
@@ -109,6 +109,8 @@ typedef struct {HANDLE send_tail_moved;HANDLE receive_tail_moved;HANDLE device; +struct tun_ring *send_ring; +struct tun_ring *receive_ring; } ring_buffer_handles_t;
@@ -165,15 +167,14 @@ CloseHandleEx(LPHANDLE handle)return INVALID_HANDLE_VALUE ; } -static HANDLE -OvpnUnmapViewOfFile (LPHANDLE handle) +static void +OvpnUnmapViewOfFile (struct tun_ring **ring) { -if (handle && *handle && *handle !=INVALID_HANDLE_VALUE ) +if (ring && *ring) { -UnmapViewOfFile (*handle); - *handle =INVALID_HANDLE_VALUE ; +UnmapViewOfFile (*ring); + *ring =NULL ; } -return INVALID_HANDLE_VALUE ; } static void
@@ -182,8 +183,10 @@ CloseRingBufferHandles(ring_buffer_handles_t *ring_buffer_handles)CloseHandleEx (&ring_buffer_handles->device);CloseHandleEx (&ring_buffer_handles->receive_tail_moved);CloseHandleEx (&ring_buffer_handles->send_tail_moved); -OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring_handle); -OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring_handle); +OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring); +OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring); +CloseHandleEx (&ring_buffer_handles->receive_ring_handle); +CloseHandleEx (&ring_buffer_handles->send_ring_handle); } static HANDLE
@@ -1354,8 +1357,6 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovp ring_buffer_handles_t *ring_buffer_handles) {DWORD err =0 ; -struct tun_ring *send_ring; -struct tun_ring *receive_ring;CloseRingBufferHandles (ring_buffer_handles);
@@ -1365,13 +1366,13 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &send_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &ring_buffer_handles->send_ring);if (err !=ERROR_SUCCESS ) {return err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &receive_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &ring_buffer_handles->receive_ring);if (err !=ERROR_SUCCESS ) {return err;
@@ -1389,7 +1390,8 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } -if (!register_ring_buffers (ring_buffer_handles->device, send_ring, receive_ring, +if (!register_ring_buffers (ring_buffer_handles->device, ring_buffer_handles->send_ring, + ring_buffer_handles->receive_ring, ring_buffer_handles->send_tail_moved, ring_buffer_handles->receive_tail_moved)) { err =GetLastError ();
Signature · 1 line
2.34.1
to 29. jouluk. 2022 klo 15.48 [email protected]... kirjoitti:
Quoted 106 lines
From: Selva Nair <[email protected]...>
The return value of MapViewOfFile must be passed to UnmapViewofFile, instead of the file handle.
Fixes #206
v2: move *ring = NULL inside if {}
Signed-off-by Selva Nair <[email protected]...>--- src/openvpnserv/interactive.c | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-)src/openvpnserv/interactive.c +15
-14@@ -109,6 +109,8 @@ typedef struct {HANDLE send_tail_moved;HANDLE receive_tail_moved;HANDLE device; +struct tun_ring *send_ring; +struct tun_ring *receive_ring; } ring_buffer_handles_t;@@ -165,15 +167,14 @@ CloseHandleEx(LPHANDLE handle)return INVALID_HANDLE_VALUE ; } -static HANDLE -OvpnUnmapViewOfFile (LPHANDLE handle) +static void +OvpnUnmapViewOfFile (struct tun_ring **ring) { -if (handle && *handle && *handle !=INVALID_HANDLE_VALUE ) +if (ring && *ring) { -UnmapViewOfFile (*handle); - *handle =INVALID_HANDLE_VALUE ; +UnmapViewOfFile (*ring); + *ring =NULL ; } -return INVALID_HANDLE_VALUE ; } static void@@ -182,8 +183,10 @@ CloseRingBufferHandles(ring_buffer_handles_t *ring_buffer_handles)CloseHandleEx (&ring_buffer_handles->device);CloseHandleEx (&ring_buffer_handles->receive_tail_moved);CloseHandleEx (&ring_buffer_handles->send_tail_moved); -OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring_handle); -OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring_handle); +OvpnUnmapViewOfFile (&ring_buffer_handles->send_ring); +OvpnUnmapViewOfFile (&ring_buffer_handles->receive_ring); +CloseHandleEx (&ring_buffer_handles->receive_ring_handle); +CloseHandleEx (&ring_buffer_handles->send_ring_handle); } static HANDLE@@ -1354,8 +1357,6 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovp ring_buffer_handles_t *ring_buffer_handles) {DWORD err =0 ; -struct tun_ring *send_ring; -struct tun_ring *receive_ring;CloseRingBufferHandles (ring_buffer_handles);@@ -1365,13 +1366,13 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &send_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->send_ring_handle, &ring_buffer_handles->send_ring_handle, &ring_buffer_handles->send_ring);if (err !=ERROR_SUCCESS ) {return err; } - err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &receive_ring); + err =DuplicateAndMapRing (ovpn_proc, rrb->receive_ring_handle, &ring_buffer_handles->receive_ring_handle, &ring_buffer_handles->receive_ring);if (err !=ERROR_SUCCESS ) {return err;@@ -1389,7 +1390,8 @@ HandleRegisterRingBuffers(const register_ring_buffers_message_t *rrb, HANDLE ovpreturn err; } -if (!register_ring_buffers (ring_buffer_handles->device, send_ring, receive_ring, +if (!register_ring_buffers (ring_buffer_handles->device, ring_buffer_handles->send_ring, + ring_buffer_handles->receive_ring, ring_buffer_handles->send_tail_moved, ring_buffer_handles->receive_tail_moved)) { err =GetLastError (); --2.34.1
_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel
Signature · 1 line
-Lev
I have not tested this beyond "push to github, see MSVC compile succeed" (but trust Selva and Lev to get this right, and the code change seems to match the discussion in the issue)
Your patch has been applied to the master and release/2.6 branch.
commit 64f8833e119e31cf01dfe198538fbb5566fabf8f (master) commit f87aed6ae2f6c4165b19c00fe4d39c44232cf44e (release/2.6)
Author: Selva Nair Date: Thu Dec 29 08:47:29 2022 -0500
Properly unmap ring buffer file-map in interactive service
Signed-off-by: Selva Nair <[email protected]...>
Acked-by: Lev Stipakov <[email protected]...>
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg25859.html
Signed-off-by: Gert Doering <[email protected]...>--
kind regards,
Gert Doering