hs-test: filter relevant data from perf tests output
[vpp.git] / src / vppinfra / socket.h
index 08e22e7..132e89f 100644 (file)
 #include <vppinfra/error.h>
 #include <vppinfra/format.h>
 
+typedef enum
+{
+  CLIB_SOCKET_TYPE_UNKNOWN = 0,
+  CLIB_SOCKET_TYPE_INET,
+  CLIB_SOCKET_TYPE_UNIX,
+#if CLIB_LINUX
+  CLIB_SOCKET_TYPE_LINUX_ABSTRACT,
+#endif
+} clib_socket_type_t;
+
 typedef struct _socket_t
 {
   /* File descriptor. */
@@ -54,13 +64,21 @@ typedef struct _socket_t
   /* Config string for socket HOST:PORT or just HOST. */
   char *config;
 
-  u32 flags;
-#define SOCKET_IS_SERVER (1 << 0)
-#define SOCKET_IS_CLIENT (0 << 0)
-#define SOCKET_NON_BLOCKING_CONNECT (1 << 1)
-
-  /* Read returned end-of-file. */
-#define SOCKET_RX_END_OF_FILE (1 << 2)
+  union
+  {
+    struct
+    {
+      u32 is_server : 1;
+      u32 rx_end_of_file : 1;
+      u32 non_blocking_connect : 1;
+      u32 allow_group_write : 1;
+      u32 is_seqpacket : 1;
+      u32 passcred : 1;
+      u32 is_blocking : 1;
+      u32 local_only : 1;
+    };
+    u32 flags;
+  };
 
   /* Transmit buffer.  Holds data waiting to be written. */
   u8 *tx_buffer;
@@ -71,24 +89,46 @@ typedef struct _socket_t
   /* Peer socket we are connected to. */
   struct sockaddr_in peer;
 
+  /* Credentials, populated if CLIB_SOCKET_F_PASSCRED is set */
+  pid_t pid;
+  uid_t uid;
+  gid_t gid;
+
   clib_error_t *(*write_func) (struct _socket_t * sock);
   clib_error_t *(*read_func) (struct _socket_t * sock, int min_bytes);
   clib_error_t *(*close_func) (struct _socket_t * sock);
-  void *private_data;
+  clib_error_t *(*recvmsg_func) (struct _socket_t * s, void *msg, int msglen,
+                                int fds[], int num_fds);
+  clib_error_t *(*sendmsg_func) (struct _socket_t * s, void *msg, int msglen,
+                                int fds[], int num_fds);
+  clib_socket_type_t type;
+  uword private_data;
 } clib_socket_t;
 
+#define CLIB_SOCKET_FLAG(f)            (((clib_socket_t){ .f = 1 }).flags)
+#define CLIB_SOCKET_F_IS_CLIENT                0
+#define CLIB_SOCKET_F_IS_SERVER                CLIB_SOCKET_FLAG (is_server)
+#define CLIB_SOCKET_F_ALLOW_GROUP_WRITE CLIB_SOCKET_FLAG (allow_group_write)
+#define CLIB_SOCKET_F_SEQPACKET                CLIB_SOCKET_FLAG (is_seqpacket)
+#define CLIB_SOCKET_F_PASSCRED         CLIB_SOCKET_FLAG (passcred)
+#define CLIB_SOCKET_F_BLOCKING         CLIB_SOCKET_FLAG (is_blocking)
+
 /* socket config format is host:port.
    Unspecified port causes a free one to be chosen starting
    from IPPORT_USERRESERVED (5000). */
 clib_error_t *clib_socket_init (clib_socket_t * socket);
 
+clib_error_t *clib_socket_init_netns (clib_socket_t *socket, u8 *namespace);
+
 clib_error_t *clib_socket_accept (clib_socket_t * server,
                                  clib_socket_t * client);
 
+int clib_socket_prefix_is_valid (char *s);
+
 always_inline uword
 clib_socket_is_server (clib_socket_t * sock)
 {
-  return (sock->flags & SOCKET_IS_SERVER) != 0;
+  return sock->is_server;
 }
 
 always_inline uword
@@ -97,10 +137,17 @@ clib_socket_is_client (clib_socket_t * s)
   return !clib_socket_is_server (s);
 }
 
+always_inline uword
+clib_socket_is_connected (clib_socket_t * sock)
+{
+  return sock->fd > 0;
+}
+
+
 always_inline int
 clib_socket_rx_end_of_file (clib_socket_t * s)
 {
-  return s->flags & SOCKET_RX_END_OF_FILE;
+  return s->rx_end_of_file;
 }
 
 always_inline void *
@@ -129,6 +176,20 @@ clib_socket_rx (clib_socket_t * s, int n_bytes)
   return s->read_func (s, n_bytes);
 }
 
+always_inline clib_error_t *
+clib_socket_sendmsg (clib_socket_t * s, void *msg, int msglen,
+                    int fds[], int num_fds)
+{
+  return s->sendmsg_func (s, msg, msglen, fds, num_fds);
+}
+
+always_inline clib_error_t *
+clib_socket_recvmsg (clib_socket_t * s, void *msg, int msglen,
+                    int fds[], int num_fds)
+{
+  return s->recvmsg_func (s, msg, msglen, fds, num_fds);
+}
+
 always_inline void
 clib_socket_free (clib_socket_t * s)
 {
@@ -136,7 +197,7 @@ clib_socket_free (clib_socket_t * s)
   vec_free (s->rx_buffer);
   if (clib_mem_is_heap_object (s->config))
     vec_free (s->config);
-  memset (s, 0, sizeof (s[0]));
+  clib_memset (s, 0, sizeof (s[0]));
 }
 
 always_inline clib_error_t *