1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* 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.
*/
/*
Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef _clib_included_socket_h
#define _clib_included_socket_h
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <vppinfra/clib.h>
#include <vppinfra/error.h>
#include <vppinfra/format.h>
typedef struct _socket_t
{
/* File descriptor. */
i32 fd;
/* 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)
/* Transmit buffer. Holds data waiting to be written. */
u8 *tx_buffer;
/* Receive buffer. Holds data read from socket. */
u8 *rx_buffer;
/* Peer socket we are connected to. */
struct sockaddr_in peer;
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_socket_t;
/* 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_accept (clib_socket_t * server,
clib_socket_t * client);
always_inline uword
clib_socket_is_server (clib_socket_t * sock)
{
return (sock->flags & SOCKET_IS_SERVER) != 0;
}
always_inline uword
clib_socket_is_client (clib_socket_t * s)
{
return !clib_socket_is_server (s);
}
always_inline int
clib_socket_rx_end_of_file (clib_socket_t * s)
{
return s->flags & SOCKET_RX_END_OF_FILE;
}
always_inline void *
clib_socket_tx_add (clib_socket_t * s, int n_bytes)
{
u8 *result;
vec_add2 (s->tx_buffer, result, n_bytes);
return result;
}
always_inline void
clib_socket_tx_add_va_formatted (clib_socket_t * s, char *fmt, va_list * va)
{
s->tx_buffer = va_format (s->tx_buffer, fmt, va);
}
always_inline clib_error_t *
clib_socket_tx (clib_socket_t * s)
{
return s->write_func (s);
}
always_inline clib_error_t *
clib_socket_rx (clib_socket_t * s, int n_bytes)
{
return s->read_func (s, n_bytes);
}
always_inline void
clib_socket_free (clib_socket_t * s)
{
vec_free (s->tx_buffer);
vec_free (s->rx_buffer);
if (clib_mem_is_heap_object (s->config))
vec_free (s->config);
memset (s, 0, sizeof (s[0]));
}
always_inline clib_error_t *
clib_socket_close (clib_socket_t * sock)
{
clib_error_t *err;
err = (*sock->close_func) (sock);
return err;
}
void clib_socket_tx_add_formatted (clib_socket_t * s, char *fmt, ...);
#endif /* _clib_included_socket_h */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
