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 66.24204% with 53 lines in your changes missing coverage. Please review.

Project coverage is 79.66%. Comparing base (b1d0202) to head (6fcd019).

Files with missing lines	Patch %	Lines
source/event_loop.c	43.10%	33 Missing ⚠️
source/socket.c	75.00%	20 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #692      +/-   ##
==========================================
- Coverage   80.10%   79.66%   -0.44%     
==========================================
  Files          29       30       +1     
  Lines        6001     6122     +121     
==========================================
+ Hits         4807     4877      +70     
- Misses       1194     1245      +51

☔ 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.

…t_event_loop

…io into runtime_select_event_loop

include/aws/io/event_loop.h

include/aws/io/private/event_loop_impl.h

include/aws/io/socket.h

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?

If not defined AWS_ENABLE_KQUEUE, the following function should be defined. (in source/event_loop.c)

#ifndef AWS_ENABLE_KQUEUE struct aws_event_loop *aws_event_loop_new_with_kqueue( struct aws_allocator *alloc, const struct aws_event_loop_options *options) { (void)alloc; (void)options; AWS_ASSERT(0); AWS_LOGF_DEBUG(AWS_LS_IO_EVENT_LOOP, "Kqueue is not supported on the platform"); aws_raise_error(AWS_ERROR_PLATFORM_NOT_SUPPORTED); return NULL; } #endif // AWS_ENABLE_EPOLL

Hmm, a rephrasing: "why is this source file being compiled if AWS_ENABLE_KQUEUE is not defined at compile time?"

source/socket.c

tests/event_loop_test.c

source/windows/iocp/socket.c

bretambrose · 2024-12-03T18:22:42Z

include/aws/io/socket.h

@@ -6,6 +6,7 @@
 */

 #include <aws/io/channel.h>
+#include <aws/io/event_loop.h>


Why is this necessary? I don't see a change that would seem to require it.

bretambrose · 2024-12-03T18:23:11Z

include/aws/io/socket.h

@@ -114,7 +138,10 @@ struct aws_socket_endpoint {
    uint32_t port;
 };

+struct aws_socket;


This doesn't do anything.

bretambrose · 2024-12-03T18:24:49Z

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


Hmm, a rephrasing: "why is this source file being compiled if AWS_ENABLE_KQUEUE is not defined at compile time?"

bretambrose · 2024-12-03T18:52:01Z

source/event_loop.c

+    switch (type) {
+        case AWS_EVENT_LOOP_EPOLL:
+#ifndef AWS_ENABLE_EPOLL
+            AWS_LOGF_DEBUG(AWS_LS_IO_EVENT_LOOP, "Event loop type EPOLL is not supported on the platform.");


I don't agree. An event loop platform mismatch is not an error anyone should be trying to handle. Something is fundamentally wrong and the developer needs to fix it.

bretambrose · 2024-12-03T19:07:50Z

source/socket.c

+static enum aws_socket_impl_type aws_socket_get_default_impl_type(void) {
+    enum aws_socket_impl_type type = AWS_SOCKET_IMPL_PLATFORM_DEFAULT;
+// override default socket
+#ifdef AWS_USE_APPLE_NETWORK_FRAMEWORK


This is pretty convoluted. Can we just simplify to

#ifdef AWS_USE_APPLE_NETWORK_FRAMEWORK static enum aws_socket_impl_type aws_socket_get_default_impl_type(void) { return AWS_SOCKET_IMPL_APPLE_NETWORK_FRAMEWORK; } #else <... normal impl> #endif

I don't see how we're not getting dead code warnings when AWS_USE_APPLE_NETWORK is defined.

bretambrose · 2024-12-03T19:10:57Z

source/socket.c

+#elif AWS_ENABLE_IO_COMPLETION_PORTS
+    return AWS_SOCKET_IMPL_WINSOCK;
+#else
+    return AWS_SOCKET_IMPL_PLATFORM_DEFAULT;


Is this reachable? Don't we cmake error if no event loop types are enabled? Maybe add a fatal assert

bretambrose · 2024-12-03T19:18:00Z

source/windows/iocp/socket.c

-    if (!impl->vtable || !impl->vtable->read) {
+    socket->vtable = &s_winsock_vtable;
+
+    impl->winsock_vtable = &s_winsock_vtables[options->domain][options->type];


Can we make the AWS_ASSERT on domain a fatal assert instead? Same with the assert on type. Making the asserts fatal means we crash "safely" on invariant violation and not perform undefined behavior by reading from invalid static section memory.

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 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

xiazhvera added 15 commits November 13, 2024 10:56

Merge branch 'main' into runtime_select_event_loop

f5a5338

renmae event loop new function

7ea8588

update code review comments

1cbe989

add unit test

667e41a

move to private socket header

48ad48c

move function definition

17b79a4

include private header & rename function

a32ee15

include private socket header

c53b4ad

format

ad5152c

move windows related header to private

1afb859

fix unreferenced param

182757f

rename windows creation

02afc29

format

6610f79

add event loop creation test for windows

53fc1fc

Merge branch 'main' into runtime_select_event_loop

6fcd019

bretambrose reviewed Dec 3, 2024

View reviewed changes

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

bretambrose Nov 13, 2024

xiazhvera Nov 21, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

bretambrose Dec 3, 2024

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

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