1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2013 Matthieu Lucas <lucasmatthieu@gmail.com>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Low-level socket functionalities
25 #include <sys/socket.h>
26 #include <sys/types.h>
27 #include <netinet/in.h>
28 #include <arpa/inet.h>
34 # Wrapper for the data structure PollFD used for polling on a socket
38 private var poll_struct
: NativeSocketPollFD
40 # A collection of the events to be watched
41 var events
: Array[NativeSocketPollValues]
43 init(pid
: Int, events
: Array[NativeSocketPollValues])
45 assert events
.length
>= 1
48 var events_in_one
= events
[0]
50 for i
in [1 .. events
.length-1
] do
51 events_in_one
+= events
[i
]
54 self.poll_struct
= new NativeSocketPollFD(pid
, events_in_one
)
57 # Reads the response and returns an array with the type of events that have been found
58 private fun check_response
(response
: Int): Array[NativeSocketPollValues]
60 var resp_array
= new Array[NativeSocketPollValues]
62 if c_check_resp
(response
, i
) != 0 then
69 # Checks if the poll call has returned true for a particular type of event
70 private fun c_check_resp
(response
: Int, mask
: NativeSocketPollValues): Int
72 return response & mask;
77 # Data structure used by the poll function
78 private extern class NativeSocketPollFD `{ struct pollfd `}
81 private fun fd: Int `{ return recv.fd; `}
83 # List of events to be watched
84 private fun events
: Int `{ return recv.events; `}
86 # List of events received by the last poll function
87 private fun revents: Int `{ return recv.revents; `}
89 new (pid
: Int, events
: NativeSocketPollValues) `{
98 extern class NativeSocket `{ int* `}
100 new socket(domain: NativeSocketAddressFamilies, socketType: NativeSocketTypes, protocol: NativeSocketProtocolFamilies) `{
101 int ds
= socket
(domain
, socketType
, protocol
);
105 int
*d
= malloc
(sizeof
(int
));
106 memcpy
(d
, &ds
, sizeof
(ds
));
110 fun destroy `{ free(recv); `}
112 fun close
: Int `{ return close(*recv); `}
114 fun descriptor: Int `{ return *recv; `}
116 fun gethostbyname
(n
: String): NativeSocketHostent import String.to_cstring
`{ return gethostbyname(String_to_cstring(n)); `}
118 fun connect(addrIn: NativeSocketAddrIn): Int `{
119 return connect
(*recv
, (struct sockaddr
*)addrIn
, sizeof
(*addrIn
));
122 fun write(buffer: String): Int
123 import String.to_cstring, String.length `{
124 return write
(*recv
, (char
*)String_to_cstring(buffer
), String_length(buffer
));
127 fun read: String import NativeString.to_s_with_length `{
129 int n
= read
(*recv
, c
, 1024);
131 return NativeString_to_s_with_length("",0);
133 char
* ret
= malloc
(n
+ 1);
136 return NativeString_to_s_with_length(ret
, n
);
139 # Sets an option for the socket
140 fun setsockopt(level: NativeSocketOptLevels, option_name: NativeSocketOptNames, option_value: Int) `{
141 int err
= setsockopt
(*recv
, level
, option_name
, &option_value
, sizeof
(int
));
143 perror
("Error on setsockopts: ");
148 fun bind(addrIn: NativeSocketAddrIn): Int `{ return bind(*recv, (struct sockaddr*)addrIn, sizeof(*addrIn)); `}
150 fun listen
(size
: Int): Int `{ return listen(*recv, size); `}
152 # Checks if the buffer is ready for any event specified when creating the pollfd structure
153 fun socket_poll(filedesc: PollFD, timeout: Int): Array[NativeSocketPollValues]
155 var result = native_poll(filedesc.poll_struct, timeout)
157 return filedesc.check_response(result)
160 # Call to the poll function of the C socket
163 # int poll(struct pollfd fds[], nfds_t nfds, int timeout);
165 # Official documentation of the poll function:
167 # The poll() function provides applications with a mechanism for multiplexing input/output over a set of file descriptors.
168 # For each member of the array pointed to by fds, poll() shall examine the given file descriptor for the event(s) specified in events.
169 # The number of pollfd structures in the fds array is specified by nfds.
170 # The poll() function shall identify those file descriptors on which an application can read or write data, or on which certain events have occurred.
171 # The fds argument specifies the file descriptors to be examined and the events of interest for each file descriptor.
172 # It is a pointer to an array with one member for each open file descriptor of interest.
173 # The array's members are pollfd structures within which fd specifies an open file descriptor and events and revents are bitmasks constructed by
174 # OR'ing a combination of the pollfd flags.
175 private fun native_poll(filedesc: NativeSocketPollFD, timeout: Int): Int `{
176 int poll_return
= poll
(&filedesc
, 1, timeout
);
180 private fun native_accept(addrIn: NativeSocketAddrIn): NativeSocket `{
181 socklen_t s
= sizeof
(struct sockaddr
);
183 d
= malloc
(sizeof
(int
));
184 *d
= accept
(*recv
,(struct sockaddr
*)addrIn
, &s
);
188 fun accept: nullable SocketAcceptResult
190 var addrIn = new NativeSocketAddrIn
191 var s = native_accept(addrIn)
192 return new SocketAcceptResult(s, addrIn)
196 # Result of a call to `NativeSocket::accept
`
197 class SocketAcceptResult
200 var socket: NativeSocket
202 # Address of the remote client
203 var addr_in: NativeSocketAddrIn
206 extern class NativeSocketAddrIn `{ struct sockaddr_in* `}
208 struct sockaddr_in *sai = NULL;
209 sai = malloc(sizeof(struct sockaddr_in));
213 new with
(port
: Int, family
: NativeSocketAddressFamilies) `{
214 struct sockaddr_in *sai = NULL;
215 sai = malloc(sizeof(struct sockaddr_in));
216 sai->sin_family = family;
217 sai->sin_port = htons(port);
218 sai->sin_addr.s_addr = INADDR_ANY;
222 new with_hostent
(hostent
: NativeSocketHostent, port
: Int) `{
223 struct sockaddr_in *sai = NULL;
224 sai = malloc(sizeof(struct sockaddr_in));
225 sai->sin_family = hostent->h_addrtype;
226 sai->sin_port = htons(port);
227 memcpy((char*)&sai->sin_addr.s_addr, (char*)hostent->h_addr, hostent->h_length);
231 fun address
: String import NativeString.to_s
`{ return NativeString_to_s((char*)inet_ntoa(recv->sin_addr)); `}
233 fun family: NativeSocketAddressFamilies `{ return recv->sin_family; `}
235 fun port
: Int `{ return ntohs(recv->sin_port); `}
237 fun destroy `{ free(recv); `}
240 extern class NativeSocketHostent `{ struct hostent* `}
241 private fun native_h_aliases(i: Int): String import NativeString.to_s `{ return NativeString_to_s(recv->h_aliases[i]); `}
243 private fun native_h_aliases_reachable
(i
: Int): Bool `{ return (recv->h_aliases[i] != NULL); `}
245 fun h_aliases: Array[String]
248 var d=new Array[String]
250 d.add(native_h_aliases(i))
251 if native_h_aliases_reachable(i+1) == false then break
257 fun h_addr: String import NativeString.to_s `{ return NativeString_to_s((char*)inet_ntoa(*(struct in_addr*)recv->h_addr)); `}
259 fun h_addrtype
: Int `{ return recv->h_addrtype; `}
261 fun h_length: Int `{ return recv->h_length; `}
263 fun h_name
: String import NativeString.to_s
`{ return NativeString_to_s(recv->h_name); `}
266 extern class NativeTimeval `{ struct timeval* `}
267 new (seconds
: Int, microseconds
: Int) `{
268 struct timeval* tv = NULL;
269 tv = malloc(sizeof(struct timeval));
270 tv->tv_sec = seconds;
271 tv->tv_usec = microseconds;
275 fun seconds
: Int `{ return recv->tv_sec; `}
277 fun microseconds: Int `{ return recv->tv_usec; `}
279 fun destroy
`{ free(recv); `}
282 extern class NativeSocketSet `{ fd_set* `}
285 f = malloc(sizeof(fd_set));
289 fun set
(s
: NativeSocket) `{ FD_SET(*s, recv); `}
291 fun is_set(s: NativeSocket): Bool `{ return FD_ISSET(*s, recv); `}
293 fun zero
`{ FD_ZERO(recv); `}
295 fun clear(s: NativeSocket) `{ FD_CLR(*s, recv); `}
297 fun destroy
`{ free(recv); `}
300 class NativeSocketObserver
301 fun select(max: NativeSocket, reads: nullable NativeSocketSet, write: nullable NativeSocketSet,
302 except: nullable NativeSocketSet, timeout: NativeTimeval): Int `{
303 fd_set
*rds
, *wts
, *exs
= NULL;
304 struct timeval
*tm
= NULL;
305 if (reads
!= NULL) rds
= (fd_set
*)reads
;
306 if (write
!= NULL) wts
= (fd_set
*)write
;
307 if (except
!= NULL) exs
= (fd_set
*)except
;
308 if (timeout
!= NULL) tm
= (struct timeval
*)timeout
;
309 return select
(*max
, rds
, wts
, exs
, tm
);
313 extern class NativeSocketTypes `{ int `}
314 new sock_stream
`{ return SOCK_STREAM; `}
315 new sock_dgram `{ return SOCK_DGRAM; `}
316 new sock_raw
`{ return SOCK_RAW; `}
317 new sock_seqpacket `{ return SOCK_SEQPACKET; `}
320 extern class NativeSocketAddressFamilies `{ int `}
321 new af_null `{ return 0; `}
324 new af_unspec
`{ return AF_UNSPEC; `}
326 # Local to host (pipes)
327 new af_unix `{ return AF_UNIX; `}
329 # For backward compatibility
330 new af_local
`{ return AF_LOCAL; `}
332 # Internetwork: UDP, TCP, etc.
333 new af_inet `{ return AF_INET; `}
336 new af_sna
`{ return AF_SNA; `}
339 new af_decnet `{ return AF_DECnet; `}
341 # Internal Routing Protocol
342 new af_route
`{ return AF_ROUTE; `}
344 # Novell Internet Protocol
345 new af_ipx `{ return AF_IPX; `}
347 # Integrated Services Digital Network
348 new af_isdn
`{ return AF_ISDN; `}
351 new af_inet6 `{ return AF_INET6; `}
353 new af_max
`{ return AF_MAX; `}
356 extern class NativeSocketProtocolFamilies `{ int `}
357 new pf_null
`{ return 0; `}
358 new pf_unspec `{ return PF_UNSPEC; `}
359 new pf_local
`{ return PF_LOCAL; `}
360 new pf_unix `{ return PF_UNIX; `}
361 new pf_inet
`{ return PF_INET; `}
362 new pf_sna `{ return PF_SNA; `}
363 new pf_decnet
`{ return PF_DECnet; `}
364 new pf_route `{ return PF_ROUTE; `}
365 new pf_ipx
`{ return PF_IPX; `}
366 new pf_isdn `{ return PF_ISDN; `}
367 new pf_key
`{ return PF_KEY; `}
368 new pf_inet6 `{ return PF_INET6; `}
369 new pf_max
`{ return PF_MAX; `}
372 # Level on which to set options
373 extern class NativeSocketOptLevels `{ int `}
375 # Dummy for IP (As defined in C)
376 new ip
`{ return IPPROTO_IP;`}
378 # Control message protocol
379 new icmp `{ return IPPROTO_ICMP;`}
382 new tcp
`{ return IPPROTO_TCP; `}
384 # Socket level options
385 new socket `{ return SOL_SOCKET; `}
388 # Options for socket, use with setsockopt
389 extern class NativeSocketOptNames `{ int `}
391 # Enables debugging information
392 new debug `{ return SO_DEBUG; `}
394 # Authorizes the broadcasting of messages
395 new broadcast
`{ return SO_BROADCAST; `}
397 # Authorizes the reuse of the local address
398 new reuseaddr `{ return SO_REUSEADDR; `}
400 # Authorizes the use of keep-alive packets in a connection
401 new keepalive
`{ return SO_KEEPALIVE; `}
404 # Used for the poll function of a socket, mix several Poll values to check for events on more than one type of event
405 extern class NativeSocketPollValues `{ int `}
407 # Data other than high-priority data may be read without blocking.
408 new pollin
`{ return POLLIN; `}
410 # Normal data may be read without blocking.
411 new pollrdnorm `{ return POLLRDNORM; `}
413 # Priority data may be read without blocking.
414 new pollrdband
`{ return POLLRDBAND; `}
416 # High-priority data may be read without blocking.
417 new pollpri `{ return POLLPRI; `}
419 # Normal data may be written without blocking.
420 new pollout
`{ return POLLOUT; `}
422 # Equivalent to POLLOUT
423 new pollwrnorm `{ return POLLWRNORM; `}
425 # Priority data may be written.
426 new pollwrband
`{ return POLLWRBAND; `}
428 # An error has occurred on the device or stream.
430 # This flag is only valid in the revents bitmask; it shall be ignored in the events member.
431 new pollerr `{ return POLLERR; `}
433 # The device has been disconnected.
435 # This event and POLLOUT are mutually-exclusive; a stream can never be
436 # writable if a hangup has occurred. However, this event and POLLIN,
437 # POLLRDNORM, POLLRDBAND, or POLLPRI are not mutually-exclusive.
439 # This flag is only valid in the revents bitmask; it shall be ignored in the events member.
440 new pollhup
`{ return POLLHUP; `}
442 # The specified fd value is invalid.
444 # This flag is only valid in the revents member; it shall ignored in the events member.
445 new pollnval `{ return POLLNVAL; `}
447 # Combines two NativeSocketPollValues
448 private fun +(other
: NativeSocketPollValues): NativeSocketPollValues `{