Event Loop & Socket Type Multi-Support #692

xiazhvera · 2024-11-07T17:21:08Z

Issue #, if available:

Description of changes:

Allow select from different event loop type
Allow select from different socket implementation
So far the CI for dispatch queue failed as dispatch queue implementation is not there yet. Refer to Grand dispatch queue #661 and Apple Network Framework Socket Changes #662 for dispatch queue and nw_socket implementation.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov-commenter · 2024-11-07T18:17:01Z

Codecov Report

Attention: Patch coverage is 56.68790% with 68 lines in your changes missing coverage. Please review.

Project coverage is 79.36%. Comparing base (fcb38c8) to head (f5a5338).

Files with missing lines	Patch %	Lines
source/event_loop.c	25.86%	43 Missing ⚠️
source/socket.c	68.75%	25 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #692      +/-   ##
==========================================
- Coverage   80.08%   79.36%   -0.72%     
==========================================
  Files          29       30       +1     
  Lines        6001     6122     +121     
==========================================
+ Hits         4806     4859      +53     
- Misses       1195     1263      +68

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

… runtime_select_event_loop

This reverts commit 9323cc3.

…ies"" This reverts commit b771d8c.

graebm

posting what I got so far...

CMakeLists.txt

include/aws/io/socket.h

graebm · 2024-11-11T19:36:23Z

include/aws/io/socket.h

@@ -114,7 +137,44 @@ struct aws_socket_endpoint {
    uint32_t port;
 };

+struct aws_socket;
+
+struct aws_socket_vtable {


can we move the vtable, and the aws_socket struct to a private header?
or is it a big enough change that it needs its own PR...

Moving the aws_socket into private will affect several downstream libs (mainly c-http). I will hold it for now and create its own PR later.

source/event_loop.c

include/aws/io/event_loop.h

source/event_loop.c

source/socket.c

… runtime_select_event_loop

Co-authored-by: Michael Graeb <graebm@amazon.com>

CMakeLists.txt

graebm · 2024-11-11T21:30:38Z

include/aws/io/private/event_loop_impl.h

@@ -172,6 +192,8 @@ struct aws_event_loop *aws_event_loop_new_default(struct aws_allocator *alloc, a
 /**
 * Creates an instance of the default event loop implementation for the current architecture and operating system using
 * extendable options.
+ *
+ * Please note the event loop type defined in the options will be ignored.
 */
 AWS_IO_API
 struct aws_event_loop *aws_event_loop_new_default_with_options(


Can we just eliminate all these alternate constructors and replace them with a single aws_event_loop_new(allocator, options)?

I mean ... they were already in a private header
or is that going to happen in some future PR?

I eventually keep two constructors: aws_event_loop_new_default and aws_event_loop_new. aws_event_loop_new_default was used cross the aws-c-io tests to create default event loop. If we remove it, we probably need create help functions in all those test files, therefore I leave it there...

source/exponential_backoff_retry_strategy.c

graebm · 2024-11-11T21:38:35Z

source/socket.c

+            AWS_ASSERT(false && "Invalid socket implementation on platform.");
+            return aws_socket_init_apple_nw_socket(socket, alloc, options);


why is this assert(false) here?

At the point of this PR, apple network framework is not supported yet. Added the assertion to warn developer that we should never use this type so far.
I will update the comments to explan it.

source/socket.c

…io into runtime_select_event_loop

…t_event_loop

…io into runtime_select_event_loop

bretambrose · 2024-11-13T17:18:01Z

include/aws/io/event_loop.h

+ * default.
+ *
+ * Default Event Loop Type
+ * Linux       | AWS_EVENT_LOOP_EPOLL


Table isn't very well aligned

bretambrose · 2024-11-13T17:21:35Z

include/aws/io/private/event_loop_impl.h

 };

+struct aws_event_loop *aws_event_loop_new_iocp_with_options(
+    struct aws_allocator *alloc,
+    const struct aws_event_loop_options *options);


Let's put an empty line between function decls.

Also I'd drop the 'with_options'. That's not saying anything useful. I'd use 'with_<event_loop_type>' instead (with_dispatch_queue, with_kqueue, etc...)

bretambrose · 2024-11-13T17:25:17Z

include/aws/io/socket.h

+ * `AWS_SOCKET_IMPL_PLATFORM_DEFAULT`, it will automatically use the platform’s default.
+ *
+ * PLATFORM DEFAULT SOCKET IMPLEMENTATION TYPE
+ * Linux       | AWS_SOCKET_IMPL_POSIX


bretambrose · 2024-11-13T17:27:56Z

include/aws/io/socket.h

@@ -145,6 +206,21 @@ aws_ms_fn_ptr aws_winsock_get_connectex_fn(void);
 aws_ms_fn_ptr aws_winsock_get_acceptex_fn(void);
 #endif

+int aws_socket_init_posix(


Why are these in the public API?

bretambrose · 2024-11-13T17:29:29Z

source/bsd/kqueue_event_loop.c

@@ -131,7 +131,8 @@ struct aws_event_loop_vtable s_kqueue_vtable = {
    .is_on_callers_thread = s_is_event_thread,
 };

-struct aws_event_loop *aws_event_loop_new_default_with_options(
+#ifdef AWS_ENABLE_KQUEUE


How would we be here if this wasn't defined?

bretambrose · 2024-11-13T17:57:27Z

source/socket.c

+    return socket->vtable->socket_is_open_fn(socket);
+}
+
+static enum aws_socket_impl_type aws_socket_get_default_impl_type(void);


Why not just define these in dependency order?

bretambrose · 2024-11-13T18:00:22Z

source/socket.c

+    struct aws_byte_buf uuid_buf = aws_byte_buf_from_empty_array(uuid_str, sizeof(uuid_str));
+    AWS_FATAL_ASSERT(aws_uuid_to_str(&uuid, &uuid_buf) == AWS_OP_SUCCESS);
+
+#if defined(AWS_ENABLE_KQUEUE) || defined(AWS_ENABLE_EPOLL)


Something feels off about this function using event loop #defines and not default socket type

bretambrose · 2024-11-13T18:01:23Z

source/socket.c

+ * Ideally we should use the platform definition (e.x.: AWS_OS_APPLE) here, however the platform
+ * definition was declared in aws-c-common. We probably do not want to introduce extra dependency here.
+ */
+#if defined(AWS_ENABLE_KQUEUE) || defined(AWS_ENABLE_EPOLL)


elif this sequence, otherwise having multiple types enabled leads to multiple return statements with all but one useless

bretambrose · 2024-11-13T18:03:21Z

tests/event_loop_test.c

@@ -172,7 +172,7 @@ static int s_test_event_loop_canceled_tasks_run_in_el_thread(struct aws_allocato

 AWS_TEST_CASE(event_loop_canceled_tasks_run_in_el_thread, s_test_event_loop_canceled_tasks_run_in_el_thread)

-#if AWS_USE_IO_COMPLETION_PORTS
+#if AWS_ENABLE_IO_COMPLETION_PORTS


Some tests that verify failure on mismatch between request type (for both sockets and event loops) and platform would be nice.

bretambrose · 2024-11-13T18:07:35Z

source/windows/iocp/socket.c

@@ -239,6 +270,24 @@ static struct socket_vtable vtables[3][2] = {
        },
 };

+struct aws_socket_vtable g_winsock_vtable = {


static, -g_ + s_

bretambrose and others added 15 commits October 30, 2024 16:28

Checkpoint

9d97302

Updated with doc comments

9781845

Creation API

754c56d

Checkpoint

974a9b2

Merge branch 'main' into EventLoopPublicApi

0b7b061

Formatting

75e4f45

Oops

4a784cc

Windows updates

381f3dd

test update

e63c0a8

[WIP] API update for runtime switch event loop

09cff00

update event loop group creation

ca3a134

clang format

6619695

revert shutdown_types?

7a89d9e

rename cmake flags

56fa4d1

fix default event loop

c1a4971

xiazhvera and others added 12 commits November 7, 2024 10:19

improve error message

470164b

Update based on PR feedback:

9e6d574

Merge branch 'EventLoopPublicApi' of github.com:awslabs/aws-c-io into…

d8f5fdd

… runtime_select_event_loop

Make io testing channel usable across library boundaries

9323cc3

Revert "Make io testing channel usable across library boundaries"

b771d8c

This reverts commit 9323cc3.

add function to override the default event loop type

4f3048e

Revert "Revert "Make io testing channel usable across library boundar…

fcb3d9a

…ies"" This reverts commit b771d8c.

Set allocator

9b16a3b

default event loop type override

a30cd39

hide the test help function as internal private

74733ad

clang format

558d179

remove unreachable..

16d4e25

xiazhvera changed the title ~~Event Loop Type Multi-Support~~ Event Loop Type & Socket Multi-Support Nov 8, 2024

update cmake for dispatch queue

7cb0936

xiazhvera and others added 6 commits November 8, 2024 16:42

fix flag

6233c9d

set apple networkframework flag

0f75185

prevent fail fast

f7fb5a2

update cmake event loop defines

16861b9

temporary remove dispatch queue wrap

17c7cca

Doc comments

d68acdb

xiazhvera changed the title ~~Event Loop Type Multi-Support~~ Event Loop & Socket Type Multi-Support Nov 11, 2024

graebm reviewed Nov 11, 2024

View reviewed changes

xiazhvera and others added 3 commits November 11, 2024 13:14

make apple network framework public

3999196

Merge branch 'EventLoopPublicApi' of github.com:awslabs/aws-c-io into…

6f1984c

… runtime_select_event_loop

Apply suggestions from code review

8d84d11

Co-authored-by: Michael Graeb <graebm@amazon.com>

graebm reviewed Nov 11, 2024

View reviewed changes

xiazhvera added 2 commits November 11, 2024 14:33

update cr changes

71fae6f

Merge branch 'runtime_select_event_loop' of github.com:awslabs/aws-c-…

35efc2e

…io into runtime_select_event_loop

Base automatically changed from EventLoopPublicApi to main November 12, 2024 17:45

xiazhvera added 12 commits November 12, 2024 09:50

rename enum

405c988

Merge branch 'main' of github.com:awslabs/aws-c-io into runtime_selec…

e614bdc

…t_event_loop

Merge branch 'main' into runtime_select_event_loop

e22131a

eliminate event loop constructor

51e2d5a

clean up and format

8be6cd2

Merge branch 'main' into runtime_select_event_loop

ab05a35

lint

61cbc90

Merge branch 'runtime_select_event_loop' of github.com:awslabs/aws-c-…

4d0e12c

…io into runtime_select_event_loop

wrap the kqueue function

7b51b56

add posix file for non-darwin Apple platform

aa876a1

fix lint

ee7fa76

handling library error in cmake

2fb32ab

xiazhvera marked this pull request as ready for review November 12, 2024 23:59

bretambrose reviewed Nov 13, 2024

View reviewed changes

Merge branch 'main' into runtime_select_event_loop

f5a5338

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Event Loop & Socket Type Multi-Support #692

Event Loop & Socket Type Multi-Support #692

xiazhvera commented Nov 7, 2024 •

edited

Loading

codecov-commenter commented Nov 7, 2024 •

edited

Loading

graebm left a comment

graebm Nov 11, 2024

xiazhvera Nov 12, 2024

graebm Nov 11, 2024

xiazhvera Nov 12, 2024

graebm Nov 11, 2024

xiazhvera Nov 12, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

bretambrose Nov 13, 2024

		AWS_ASSERT(false && "Invalid socket implementation on platform.");
		return aws_socket_init_apple_nw_socket(socket, alloc, options);

Event Loop & Socket Type Multi-Support #692

Are you sure you want to change the base?

Event Loop & Socket Type Multi-Support #692

Conversation

xiazhvera commented Nov 7, 2024 • edited Loading

codecov-commenter commented Nov 7, 2024 • edited Loading

Codecov Report

graebm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xiazhvera commented Nov 7, 2024 •

edited

Loading

codecov-commenter commented Nov 7, 2024 •

edited

Loading