socket.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal/socket.h: Platform-neutral BSD-modeled network socket implementation. */
 
#ifndef ETCPAL_SOCKET_H_
#define ETCPAL_SOCKET_H_
 
#include <stdbool.h>
#include <stddef.h>
#include "etcpal/common.h"
#include "etcpal/error.h"
#include "etcpal/inet.h"
 
typedef uint32_t etcpal_poll_events_t;
 
#include "etcpal/os_socket.h" /* The os-specific socket definitions */
 
/* clang-format off */
 
#define ETCPAL_MSG_PEEK 0x1 
/* Note: no flags are currently implemented for etcpal_sendto() */
 
#define ETCPAL_SOL_SOCKET     0 
#define ETCPAL_IPPROTO_IP     1 
#define ETCPAL_IPPROTO_ICMPV6 2 
#define ETCPAL_IPPROTO_IPV6   3 
#define ETCPAL_IPPROTO_TCP    4 
#define ETCPAL_IPPROTO_UDP    5 
#define ETCPAL_SO_BROADCAST 0  
#define ETCPAL_SO_ERROR     1  
#define ETCPAL_SO_KEEPALIVE 2  
#define ETCPAL_SO_LINGER    3  
#define ETCPAL_SO_RCVBUF    4  
#define ETCPAL_SO_SNDBUF    5  
#define ETCPAL_SO_RCVTIMEO  6  
#define ETCPAL_SO_SNDTIMEO  7  
#define ETCPAL_SO_REUSEADDR 8  
#define ETCPAL_SO_REUSEPORT 9  
#define ETCPAL_SO_TYPE      10 
#define ETCPAL_IP_TTL             11
#define ETCPAL_IP_MULTICAST_IF    12
#define ETCPAL_IP_MULTICAST_TTL   13
#define ETCPAL_IP_MULTICAST_LOOP  14 
#define ETCPAL_IP_ADD_MEMBERSHIP  15
#define ETCPAL_IP_DROP_MEMBERSHIP 16
#define ETCPAL_MCAST_JOIN_GROUP   17 
#define ETCPAL_MCAST_LEAVE_GROUP  18 
#define ETCPAL_IPV6_V6ONLY        19 
#define ETCPAL_IP_PKTINFO         20
 
#define ETCPAL_IPV6_PKTINFO       21
 
/* clang-format on */
 
/* ETCPAL_IPPROTO_TCP: TODO */
 
typedef struct EtcPalLinger
{
  int onoff;  
  int linger; 
} EtcPalLinger;
 
typedef struct EtcPalMreq
{
  EtcPalIpAddr netint;
  EtcPalIpAddr group;
} EtcPalMreq;
 
typedef struct EtcPalGroupReq
{
  unsigned int ifindex;
  EtcPalIpAddr group;
} EtcPalGroupReq;
 
typedef struct EtcPalMsgHdr
{
  EtcPalSockAddr name;       
  void*          buf;        
  size_t         buflen;     
  void*          control;    
  size_t         controllen; 
  int            flags;      
} EtcPalMsgHdr;
 
typedef struct EtcPalCMsgHdr
{
  bool   valid; 
  size_t len;   
  int    level; 
  int    type;  
  void*  pd;    
} EtcPalCMsgHdr;
 
#define ETCPAL_CMSG_IS_VALID(cmsg) ((cmsg)->valid)
 
typedef struct EtcPalPktInfo
{
  EtcPalIpAddr addr;    
  unsigned int ifindex; 
} EtcPalPktInfo;
 
#define ETCPAL_SHUT_RD   0
#define ETCPAL_SHUT_WR   1
#define ETCPAL_SHUT_RDWR 2
#define ETCPAL_AF_UNSPEC 0u
#define ETCPAL_AF_INET   1u
#define ETCPAL_AF_INET6  2u
#define ETCPAL_SOCK_STREAM 0u
#define ETCPAL_SOCK_DGRAM  1u
#define ETCPAL_MSG_TRUNC  0x2 
#define ETCPAL_MSG_CTRUNC 0x4 
#define ETCPAL_CONTROL_SIZE_IP_PKTINFO ETCPAL_PLATFORM_IN_PKTINFO_SPACE
 
#define ETCPAL_CONTROL_SIZE_IPV6_PKTINFO ETCPAL_PLATFORM_IN6_PKTINFO_SPACE
 
#define ETCPAL_MAX_CONTROL_SIZE_PKTINFO                                                               \
  (ETCPAL_CONTROL_SIZE_IP_PKTINFO > ETCPAL_CONTROL_SIZE_IPV6_PKTINFO ? ETCPAL_CONTROL_SIZE_IP_PKTINFO \
                                                                     : ETCPAL_CONTROL_SIZE_IPV6_PKTINFO)
 
/********************** Mimic sys/socket.h functions *************************/
 
#ifdef __cplusplus
extern "C" {
#endif
 
etcpal_error_t etcpal_accept(etcpal_socket_t id, EtcPalSockAddr* address, etcpal_socket_t* conn_sock);
etcpal_error_t etcpal_bind(etcpal_socket_t id, const EtcPalSockAddr* address);
etcpal_error_t etcpal_close(etcpal_socket_t id);
etcpal_error_t etcpal_connect(etcpal_socket_t id, const EtcPalSockAddr* address);
etcpal_error_t etcpal_getpeername(etcpal_socket_t id, EtcPalSockAddr* address);
etcpal_error_t etcpal_getsockname(etcpal_socket_t id, EtcPalSockAddr* address);
etcpal_error_t etcpal_getsockopt(etcpal_socket_t id,
                                 int             level,
                                 int             option_name,
                                 void*           option_value,
                                 size_t*         option_len);
etcpal_error_t etcpal_listen(etcpal_socket_t id, int backlog);
int            etcpal_recv(etcpal_socket_t id, void* buffer, size_t length, int flags);
int            etcpal_recvfrom(etcpal_socket_t id, void* buffer, size_t length, int flags, EtcPalSockAddr* address);
int            etcpal_recvmsg(etcpal_socket_t id, EtcPalMsgHdr* msg, int flags);
bool           etcpal_cmsg_firsthdr(EtcPalMsgHdr* msgh, EtcPalCMsgHdr* firsthdr);
bool           etcpal_cmsg_nxthdr(EtcPalMsgHdr* msgh, const EtcPalCMsgHdr* cmsg, EtcPalCMsgHdr* nxthdr);
bool           etcpal_cmsg_to_pktinfo(const EtcPalCMsgHdr* cmsg, EtcPalPktInfo* pktinfo);
int            etcpal_send(etcpal_socket_t id, const void* message, size_t length, int flags);
/* sendmsg - not implemented */
int etcpal_sendto(etcpal_socket_t id, const void* message, size_t length, int flags, const EtcPalSockAddr* dest_addr);
etcpal_error_t etcpal_setsockopt(etcpal_socket_t id,
                                 int             level,
                                 int             option_name,
                                 const void*     option_value,
                                 size_t          option_len);
etcpal_error_t etcpal_shutdown(etcpal_socket_t id, int how);
etcpal_error_t etcpal_socket(unsigned int family, unsigned int type, etcpal_socket_t* id);
/* socketpair - not implemented */
 
/**************************** Mimic fcntl() API ******************************/
 
etcpal_error_t etcpal_setblocking(etcpal_socket_t id, bool blocking);
etcpal_error_t etcpal_getblocking(etcpal_socket_t id, bool* blocking);
 
/**************************** Mimic poll() API *******************************/
 
#define ETCPAL_POLL_IN      0x1u  
#define ETCPAL_POLL_OUT     0x2u  
#define ETCPAL_POLL_CONNECT 0x4u  
#define ETCPAL_POLL_OOB     0x8u  
#define ETCPAL_POLL_ERR     0x10u 
#define ETCPAL_POLL_VALID_INPUT_EVENT_MASK 0x0fu
 
typedef struct EtcPalPollEvent
{
  etcpal_socket_t      socket;    
  etcpal_poll_events_t events;    
  etcpal_error_t       err;       
  void*                user_data; 
} EtcPalPollEvent;
 
etcpal_error_t etcpal_poll_context_init(EtcPalPollContext* context);
void           etcpal_poll_context_deinit(EtcPalPollContext* context);
etcpal_error_t etcpal_poll_add_socket(EtcPalPollContext*   context,
                                      etcpal_socket_t      socket,
                                      etcpal_poll_events_t events,
                                      void*                user_data);
etcpal_error_t etcpal_poll_modify_socket(EtcPalPollContext*   context,
                                         etcpal_socket_t      socket,
                                         etcpal_poll_events_t new_events,
                                         void*                new_user_data);
void           etcpal_poll_remove_socket(EtcPalPollContext* context, etcpal_socket_t socket);
etcpal_error_t etcpal_poll_wait(EtcPalPollContext* context, EtcPalPollEvent* event, int timeout_ms);
 
/************************ Mimic getaddrinfo() API ****************************/
 
#define ETCPAL_AI_PASSIVE     0x01
#define ETCPAL_AI_CANONNAME   0x02
#define ETCPAL_AI_NUMERICHOST 0x04
typedef struct EtcPalAddrinfo
{
  int            ai_flags;     
  int            ai_family;    
  int            ai_socktype;  
  int            ai_protocol;  
  char*          ai_canonname; 
  EtcPalSockAddr ai_addr;      
  void*          pd[2];        
} EtcPalAddrinfo;
 
etcpal_error_t etcpal_getaddrinfo(const char*           hostname,
                                  const char*           service,
                                  const EtcPalAddrinfo* hints,
                                  EtcPalAddrinfo*       result);
 
bool etcpal_nextaddr(EtcPalAddrinfo* ai);
 
/* Call with any of the EtcPalAddrinfos in the list to free the whole list */
void etcpal_freeaddrinfo(EtcPalAddrinfo* ai);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_SOCKET_H_ */