OMRSOCK API: Implementing omrsock_setsockopt and omrsock_getsockopt functions on Unix #5158

caohaley · 2020-05-06T04:39:38Z

Working on Issue: #4102
/cc @rwy0717 @mpirvu

The minimal socket api for Unix is done being implemented and is currently waiting to be merged. However, these functions need to be added for the JITServer team functionalities and will be the last functions to be implemented.

Omrsock functions to be implemented:
omrsock_setsockopt_int, omrsock_setsockopt_linger, j9sock_linger_init, omrsock_setsockopt_timeval, j9sock_timeval_init

omrsock_getsockopt_int, omrsock_getsockopt_linger, omrsock_getsockopt_timeval

Descriptions

setsockopt basically configures the socket options at a specifed level, usually at the socket level SOL_SOCKET but could be different depending on what option you set. The function prototype for systemsetsockopt is:

int setsockopt(int s, int optionLevel, int optionName, const void *optionValue, socklen_t optionLength);

Depending on the option you set, it may belong to a different option level, and may require you to input a specific value type, such as a pointer to integer, boolean, linger struct, timeval struct and so on (thus it takes in a void *), and have you specify the length.

getsockopt essentially does the opposite where the users pass in a preallocated buffer and the function call fills in the buffer with the current configuration of the socket for that option. The function prototype for systemgetsockopt is:

int getsockopt(int s, int level, int optname, void *optval, socklen_t *optlen);

Implementation Details:

The options that will be supported first will be the ones that JITServer currently uses in the code including:

SO_REUSEADDR
SO_KEEPALIVE
SO_LINGER
SO_RCVTIMEO
SO_SNDTIMEO
TCP_NODELAY

We will introduce two new data types in omrportsocktypes.h:

struct omrsock_timeval that contains struct timeval
and
struct omrsock_linger that contains struct linger

We will also introduce two corresponding init functions: j9sock_timeval_init and j9sock_linger_init to fill in the value of these two option values.

Because of the user isolation and they can not directly modify the option values, we will need to implement three different functions rather than the one in system socket api. We will separate the option value types into integer, struct timeval and struct linger.

Thus, there will be a different function call for each of the different option types: omrsock_setsockopt_int, omrsock_setsockopt_linger, omrsock_setsockopt_timeval.

However, all three functions will be just set up to call the system socket api setsockopt and getsockopt functions. It will be tested to see if it works on all Unix systems and if there is anything to be added.

Unix Progress Tracker

Implement omrsock_getaddrinfo_create_hints (and socket per thread buffer). PR:Added a per thread buffer and related tests for OMR socket API #4555
Implement OMRAddrInfoNode element extraction (omrsock_getaddrinfo_length, family, socktype, protocol). Issue:OMRSOCK API: Implement OMRAddrInfoNode Element Extraction Functions on Unix #4745, PR:Added Unix Implementations for Element Extracting Functions in OMRSOCK API #4738
Implementing omrsock_getaddrinfo. Issue:OMRSOCK API: Implement omrsock_getaddrinfo function on Unix #4794 PR:Added Unix Implementation for omrsock_getaddrinfo and omrsock_freeaddrinfo in OMRSOCK API #4832
Implementing omrsock_socket (constants definition of socket types) and omrsock_close. Issue:OMRSOCK API: Implement omrsock_socket Function on Unix #4795 PRs:Added constants for Unix Implementations in OMRSOCK API #4878, Added Unix Implementations for omrsock_socket and omrsock_close in OMRSOCK API #4887
Implementing omrsock_bind and omrsock_listen Issue:OMRSOCK API: Implement omrsock_bind and omrsock_listen functions on Unix #4919 PRs:Setting Up Socket Address for Bind and Listen #4974, Implement omrsock_bind and omrsock_listen on Unix #5034
Implementing omrsock_connect and omrsock_accept Issue:OMRSOCK API: Implement omrsock_connect and omrsock_accept functions on Unix #5043 PR:Added Unix Implementations for omrsock_connect and omrsock_accept functions #5066
Implementing omrsock_send and receive Issue:OMRSOCK API: Implement omrsock_read and omrsock_recv functions on Unix #5069 PR:Added Unix Implementations for Send and Recv #5124
Implementing omrsock_sendto and recvfrom Issue:OMRSOCK API: Implement omrsock_sendto and omrsock_recvfrom functions on Unix #5128 PR:Added Unix Implementations for omrsock_sendto and omrsock_recvfrom #5139
Implementing omrsock_setsockopt and omrsock_getsockopt functions

The text was updated successfully, but these errors were encountered:

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions for types integer, timeval and linger struct. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 3 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, one to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions for types integer, timeval and linger struct. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 3 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, one to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added a new test socket_options that calls set/get sockopt - Added test that initializes timeval and linger structs. - Created a socket and set options including keepalive, linger, rcvtimeo, sndtimeo, tcp_nodelay. - Get the same options and compare with values inputted into set options, and make sure they are the same. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions for types integer, timeval and linger struct. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 3 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, one to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added a new test socket_options that calls set/get sockopt - Added test that initializes timeval and linger structs. - Created a socket and set options including keepalive, linger, rcvtimeo, sndtimeo, tcp_nodelay. - Get the same options and compare with values inputted into set options, and make sure they are the same. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions for types integer, timeval and linger struct. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 3 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, one to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added a new test socket_options that calls set/get sockopt - Added test that initializes timeval and linger structs. - Created a socket and set options including keepalive, linger, rcvtimeo, sndtimeo, tcp_nodelay. - Get the same options and compare with values inputted into set options, and make sure they are the same. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Setting up socket option definitions and function prototype - Set up omrsock_linger_t pointer, OMRLinger struct to be used in the linger socket option. - Set up omrsock_timeval_t pointer, OMRTimeval struct to be used in the timeval socket option. - Set up omr public socket option definitions and private os socket option definitions. - Set up functions prototypes for the socket option related functions for types integer, timeval and linger struct. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 4 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, two to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added a new test socket_options that calls set/get sockopt - Added test that initializes timeval and linger structs. - Created a socket and set options including keepalive, linger, rcvtimeo, sndtimeo, tcp_nodelay. - Get the same options and compare with values inputted into set options, and make sure they are the same. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>

Added internal functions and implementations for sockopt functions - Added 4 internal functions: one to retrieve OMR to OS mapping for socket levels, one to retrieve OMR to OS mapping for socket options, two to wrap the code for the socket option functions to reduce clutter. - Added simple implemnentations for the 6 socket options functions. - Assign the size of option value to socklen_t optlen before passing into the setsockopt and getsockopt options to avoid inconsistent error due to int to socklen_t conversion. Issue: eclipse-omr#5158 Signed-off-by: Haley Cao <haleycao88@hotmail.com>