1 ;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp -*-
3 ;; Copyright (C) 2006, 2007 Stelian Ionescu
5 ;; This code is free software; you can redistribute it and/or
6 ;; modify it under the terms of the version 2.1 of
7 ;; the GNU Lesser General Public License as published by
8 ;; the Free Software Foundation, as clarified by the
9 ;; preamble found here:
10 ;; http://opensource.franz.com/preamble.html
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU Lesser General
18 ;; Public License along with this library; if not, write to the
19 ;; Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 ;; Boston, MA 02110-1301, USA
22 (in-package :net.sockets
)
24 (defvar *socket-type-map
*
25 '(((:ipv4
:stream
:active
:default
) . socket-stream-internet-active
)
26 ((:ipv6
:stream
:active
:default
) . socket-stream-internet-active
)
27 ((:ipv4
:stream
:passive
:default
) . socket-stream-internet-passive
)
28 ((:ipv6
:stream
:passive
:default
) . socket-stream-internet-passive
)
29 ((:local
:stream
:active
:default
) . socket-stream-local-active
)
30 ((:local
:stream
:passive
:default
) . socket-stream-local-passive
)
31 ((:local
:datagram
:active
:default
) . socket-datagram-local-active
)
32 ((:ipv4
:datagram
:active
:default
) . socket-datagram-internet-active
)
33 ((:ipv6
:datagram
:active
:default
) . socket-datagram-internet-active
)))
35 (defun select-socket-type (family type connect protocol
)
36 (or (cdr (assoc (list family type connect protocol
) *socket-type-map
*
38 (error "No socket class found !!")))
41 ;;;;;;;;;;;;;;;;;;;;;;;;;
42 ;; SHARED-INITIALIZE ;;
43 ;;;;;;;;;;;;;;;;;;;;;;;;;
45 (defun translate-make-socket-keywords-to-constants (family type protocol
)
46 (let ((sf (ecase family
49 (:local et
:af-local
)))
51 (:stream et
:sock-stream
)
52 (:datagram et
:sock-dgram
)))
54 ((integerp protocol
) protocol
)
55 ((eql protocol
:default
) 0)
58 (get-protocol-by-name (string-downcase
59 (string protocol
))))))))
62 (defmethod socket-fd ((socket socket
))
64 (defmethod (setf socket-fd
) (fd (socket socket
))
65 (setf (fd-of socket
) fd
))
67 (defmethod shared-initialize :after
((socket socket
) slot-names
68 &key file-descriptor family
69 type
(protocol :default
))
70 (declare (ignore slot-names
))
71 (when (socket-open-p socket
)
73 (with-accessors ((fd fd-of
)
75 (proto socket-protocol
)) socket
76 (setf fd
(or file-descriptor
77 (multiple-value-bind (sf st sp
)
78 (translate-make-socket-keywords-to-constants family type protocol
)
79 (with-socket-error-filter
80 (et:socket sf st sp
)))))
84 (defmethod socket-type ((socket stream-socket
))
87 (defmethod socket-type ((socket datagram-socket
))
95 (defmethod print-object ((socket socket-stream-internet-active
) stream
)
96 (print-unreadable-object (socket stream
:type nil
:identity t
)
97 (format stream
"active internet stream socket" )
98 (if (socket-connected-p socket
)
99 (multiple-value-bind (addr port
) (remote-name socket
)
100 (format stream
" connected to ~A/~A"
101 (sockaddr->presentation addr
) port
))
103 (format stream
", unconnected")
104 (format stream
", closed")))))
106 (defmethod print-object ((socket socket-stream-internet-passive
) stream
)
107 (print-unreadable-object (socket stream
:type nil
:identity t
)
108 (format stream
"passive internet stream socket" )
109 (if (socket-bound-p socket
)
110 (multiple-value-bind (addr port
) (local-name socket
)
111 (format stream
" ~A ~A/~A"
112 (if (socket-listening-p socket
)
113 "waiting for connections @"
115 (sockaddr->presentation addr
) port
))
117 (format stream
", unbound")
118 (format stream
", closed")))))
120 (defmethod print-object ((socket socket-stream-local-active
) stream
)
121 (print-unreadable-object (socket stream
:type nil
:identity t
)
122 (format stream
"active local stream socket" )
123 (if (socket-connected-p socket
)
124 (format stream
" connected")
126 (format stream
", unconnected")
127 (format stream
", closed")))))
129 (defmethod print-object ((socket socket-stream-local-passive
) stream
)
130 (print-unreadable-object (socket stream
:type nil
:identity t
)
131 (format stream
"passive local stream socket" )
132 (if (socket-bound-p socket
)
133 (format stream
" ~A ~A"
134 (if (socket-listening-p socket
)
135 "waiting for connections @"
137 (sockaddr->presentation
(socket-address socket
)))
139 (format stream
", unbound")
140 (format stream
", closed")))))
142 (defmethod print-object ((socket socket-datagram-local-active
) stream
)
143 (print-unreadable-object (socket stream
:type nil
:identity t
)
144 (format stream
"local datagram socket" )
145 (if (socket-connected-p socket
)
146 (format stream
" connected")
148 (format stream
", unconnected")
149 (format stream
", closed")))))
151 (defmethod print-object ((socket socket-datagram-internet-active
) stream
)
152 (print-unreadable-object (socket stream
:type nil
:identity t
)
153 (format stream
"internet datagram socket" )
154 (if (socket-connected-p socket
)
155 (multiple-value-bind (addr port
) (remote-name socket
)
156 (format stream
" connected to ~A/~A"
157 (sockaddr->presentation addr
) port
))
159 (format stream
", unconnected")
160 (format stream
", closed")))))
167 (defmethod close :around
((socket socket
) &key abort
)
168 (declare (ignore abort
))
170 (with-socket-error-filter
171 (et:close
(fd-of socket
))))
172 (setf (fd-of socket
) nil
)
176 (defmethod close :around
((socket passive-socket
) &key abort
)
177 (declare (ignore abort
))
179 (setf (slot-value socket
'bound
) nil
)
180 (setf (slot-value socket
'listening
) nil
)
183 (defmethod close ((socket socket
) &key abort
)
184 (declare (ignore socket abort
)))
186 (defmethod socket-open-p ((socket socket
))
187 (unless (fd-of socket
)
188 (return-from socket-open-p nil
))
189 (with-socket-error-filter
191 (with-foreign-object (ss 'et
:sockaddr-storage
)
192 (et:bzero ss et
:size-of-sockaddr-storage
)
193 (with-foreign-pointer (size et
:size-of-socklen
)
194 (setf (mem-ref size
:socklen
)
195 et
:size-of-sockaddr-storage
)
196 (et:getsockname
(fd-of socket
) ss size
)
199 #+freebsd
(et:econnreset
()))))
206 (defmethod local-name ((socket internet-socket
))
207 (with-foreign-object (ss 'et
:sockaddr-storage
)
208 (et:bzero ss et
:size-of-sockaddr-storage
)
209 (with-foreign-pointer (size et
:size-of-socklen
)
210 (setf (mem-ref size
:socklen
)
211 et
:size-of-sockaddr-storage
)
212 (with-socket-error-filter
213 (et:getsockname
(fd-of socket
) ss size
))
214 (return-from local-name
215 (sockaddr-storage->sockaddr ss
)))))
217 (defmethod local-name ((socket local-socket
))
218 (with-foreign-object (sun 'et
:sockaddr-un
)
219 (et:bzero sun et
:size-of-sockaddr-un
)
220 (with-foreign-pointer (size et
:size-of-socklen
)
221 (setf (mem-ref size
:socklen
)
222 et
:size-of-sockaddr-storage
)
223 (with-socket-error-filter
224 (et:getsockname
(fd-of socket
) sun size
))
225 (return-from local-name
226 (sockaddr-un->sockaddr sun
)))))
228 (defmethod socket-address ((socket socket
))
229 (nth-value 0 (local-name socket
)))
231 (defmethod socket-port ((socket internet-socket
))
232 (nth-value 1 (local-name socket
)))
239 (defmethod remote-name ((socket internet-socket
))
240 (with-foreign-object (ss 'et
:sockaddr-storage
)
241 (et:bzero ss et
:size-of-sockaddr-storage
)
242 (with-foreign-pointer (size et
:size-of-socklen
)
243 (setf (mem-ref size
:socklen
)
244 et
:size-of-sockaddr-storage
)
245 (with-socket-error-filter
246 (et:getpeername
(fd-of socket
) ss size
))
247 (return-from remote-name
248 (sockaddr-storage->sockaddr ss
)))))
250 (defmethod remote-name ((socket local-socket
))
251 (with-foreign-object (sun 'et
:sockaddr-un
)
252 (et:bzero sun et
:size-of-sockaddr-un
)
253 (with-foreign-pointer (size et
:size-of-socklen
)
254 (setf (mem-ref size
:socklen
)
255 et
:size-of-sockaddr-storage
)
256 (with-socket-error-filter
257 (et:getpeername
(fd-of socket
) sun size
))
258 (return-from remote-name
259 (sockaddr-un->sockaddr sun
)))))
266 (defmethod bind-address :before
((socket internet-socket
)
267 address
&key
(reuse-address t
))
268 (declare (ignore address
))
270 (set-socket-option socket
:reuse-address
:value t
)))
272 (defun bind-ipv4-address (fd address port
)
273 (with-foreign-object (sin 'et
:sockaddr-in
)
274 (make-sockaddr-in sin address port
)
275 (with-socket-error-filter
276 (et:bind fd sin et
:size-of-sockaddr-in
))))
278 (defun bind-ipv6-address (fd address port
)
279 (with-foreign-object (sin6 'et
:sockaddr-in6
)
280 (make-sockaddr-in6 sin6 address port
)
281 (with-socket-error-filter
282 (et:bind fd sin6 et
:size-of-sockaddr-in6
))))
284 (defmethod bind-address ((socket internet-socket
)
287 (if (eql (socket-family socket
) :ipv6
)
288 (bind-ipv6-address (fd-of socket
)
289 (map-ipv4-vector-to-ipv6 (name address
))
291 (bind-ipv4-address (fd-of socket
) (name address
) port
))
294 (defmethod bind-address ((socket internet-socket
)
297 (bind-ipv6-address (fd-of socket
) (name address
) port
)
300 (defmethod bind-address :before
((socket local-socket
)
301 (address localaddr
) &key
)
302 (when (typep socket
'active-socket
)
303 (error "You can't bind an active Unix socket.")))
305 (defmethod bind-address ((socket local-socket
)
306 (address localaddr
) &key
)
307 (with-foreign-object (sun 'et
:sockaddr-un
)
308 (make-sockaddr-un sun
(name address
))
309 (with-socket-error-filter
310 (et:bind
(fd-of socket
) sun et
:size-of-sockaddr-un
)))
313 (defmethod bind-address :after
((socket socket
)
314 (address sockaddr
) &key
)
315 (setf (slot-value socket
'bound
) t
))
322 (defmethod socket-listen ((socket passive-socket
)
323 &key
(backlog (min *default-backlog-size
*
324 +max-backlog-size
+)))
325 (check-type backlog unsigned-byte
"a non-negative integer")
326 (with-socket-error-filter
327 (et:listen
(fd-of socket
) backlog
))
328 (setf (slot-value socket
'listening
) t
)
331 (defmethod socket-listen ((socket active-socket
)
333 (declare (ignore backlog
))
334 (error "You can't listen on active sockets."))
341 (defmethod accept-connection ((socket active-socket
)
343 (declare (ignore wait
))
344 (error "You can't accept connections on active sockets."))
346 (defmethod accept-connection ((socket passive-socket
)
348 (with-foreign-object (ss 'et
:sockaddr-storage
)
349 (et:bzero ss et
:size-of-sockaddr-storage
)
350 (with-foreign-pointer (size et
:size-of-socklen
)
351 (setf (mem-ref size
:socklen
)
352 et
:size-of-sockaddr-storage
)
353 (let (non-blocking-state
355 (with-socket-error-filter
358 ;; do a "normal" accept
359 ;; Note: the socket may already be in non-blocking mode
360 (setf client-fd
(et:accept
(fd-of socket
) ss size
))
361 ;; set the socket to non-blocking mode before calling accept()
362 ;; if there's no new connection return NIL
365 ;; saving the current non-blocking state
366 (setf non-blocking-state
(fd-non-blocking socket
))
367 ;; switch the socket to non-blocking mode
368 (setf (fd-non-blocking socket
) t
)
369 (setf client-fd
(et:accept
(fd-of socket
) ss size
)))
370 ;; restoring the socket's non-blocking state
371 (setf (fd-non-blocking socket
) non-blocking-state
)))
372 ;; the socket is marked non-blocking and there's no new connection
374 (return-from accept-connection nil
))))
377 ;; create the client socket object
378 (make-instance (active-class socket
)
379 :file-descriptor client-fd
)))
380 (return-from accept-connection client-socket
))))))
388 (defmethod connect :before
((socket active-socket
)
390 (declare (ignore sockaddr
))
392 (set-socket-option socket
:no-sigpipe
:value t
)))
394 (defun ipv4-connect (fd address port
)
395 (with-foreign-object (sin 'et
:sockaddr-in
)
396 (make-sockaddr-in sin address port
)
397 (with-socket-error-filter
398 (et:connect fd sin et
:size-of-sockaddr-in
))))
400 (defun ipv6-connect (fd address port
)
401 (with-foreign-object (sin6 'et
:sockaddr-in6
)
402 (make-sockaddr-in6 sin6 address port
)
403 (with-socket-error-filter
404 (et:connect fd sin6 et
:size-of-sockaddr-in6
))))
406 (defmethod connect ((socket internet-socket
)
407 (address ipv4addr
) &key
(port 0))
408 (if (eql (socket-family socket
) :ipv6
)
409 (ipv6-connect (fd-of socket
)
410 (map-ipv4-vector-to-ipv6 (name address
))
412 (ipv4-connect (fd-of socket
) (name address
) port
))
415 (defmethod connect ((socket internet-socket
)
416 (address ipv6addr
) &key
(port 0))
417 (ipv6-connect (fd-of socket
) (name address
) port
)
420 (defmethod connect ((socket local-socket
)
421 (address localaddr
) &key
)
422 (with-foreign-object (sun 'et
:sockaddr-un
)
423 (make-sockaddr-un sun
(name address
))
424 (with-socket-error-filter
425 (et:connect
(fd-of socket
) sun et
:size-of-sockaddr-un
)))
428 (defmethod connect ((socket passive-socket
)
430 (declare (ignore address
))
431 (error "You cannot connect passive sockets."))
433 (defmethod socket-connected-p ((socket socket
))
434 (unless (fd-of socket
)
435 (return-from socket-connected-p nil
))
436 (with-socket-error-filter
438 (with-foreign-object (ss 'et
:sockaddr-storage
)
439 (et:bzero ss et
:size-of-sockaddr-storage
)
440 (with-foreign-pointer (size et
:size-of-socklen
)
441 (setf (mem-ref size
:socklen
)
442 et
:size-of-sockaddr-storage
)
443 (et:getpeername
(fd-of socket
) ss size
)
445 (et:enotconn
() nil
))))
452 (defmethod shutdown ((socket active-socket
) direction
)
453 (check-type direction
(member :read
:write
:read-write
)
454 "valid direction specifier")
455 (with-socket-error-filter
456 (et:shutdown
(fd-of socket
)
460 (:read-write et
:shut-rdwr
))))
463 (defmethod shutdown ((socket passive-socket
) direction
)
464 (declare (ignore direction
))
465 (error "You cannot shut down passive sockets."))
472 (defun %normalize-send-buffer
(buff start end ef
)
473 (setf (values start end
) (%check-bounds buff start end
))
475 (ub8-sarray (values buff start
(- end start
)))
476 (ub8-vector (values (coerce buff
'ub8-sarray
)
477 start
(- end start
)))
478 (string (values (%to-octets buff ef start end
)
481 (defmethod socket-send ((buffer array
)
482 (socket active-socket
) &key
(start 0) end
483 remote-address remote-port end-of-record
484 dont-route dont-wait
(no-signal *no-sigpipe
*)
485 out-of-band
#+linux more
#+linux confirm
)
486 (check-type start unsigned-byte
487 "a non-negative unsigned integer")
488 (check-type end
(or unsigned-byte null
)
489 "a non-negative unsigned integer or NIL")
490 (when (or remote-port remote-address
)
491 (check-type remote-address sockaddr
"a network address")
492 (check-type remote-port
(unsigned-byte 16) "a valid IP port number"))
493 (let ((flags (logior (if end-of-record et
:msg-eor
0)
494 (if dont-route et
:msg-dontroute
0)
495 (if dont-wait et
:msg-dontwait
0)
496 (if no-signal et
:msg-nosignal
0)
497 (if out-of-band et
:msg-oob
0)
498 #+linux
(if more et
:msg-more
0)
499 #+linux
(if confirm et
:msg-confirm
0))))
500 (when (and (ipv4-address-p remote-address
)
501 (eql (socket-family socket
) :ipv6
))
502 (setf remote-address
(map-ipv4-address->ipv6 remote-address
)))
503 (multiple-value-bind (buff start-offset bufflen
)
504 (%normalize-send-buffer buffer start end
(external-format-of socket
))
505 (with-foreign-object (ss 'et
:sockaddr-storage
)
506 (et:bzero ss et
:size-of-sockaddr-storage
)
508 (sockaddr->sockaddr-storage ss remote-address remote-port
))
509 (with-pointer-to-vector-data (buff-sap buff
)
510 (incf-pointer buff-sap start-offset
)
511 (with-socket-error-filter
512 (return-from socket-send
513 (et:sendto
(fd-of socket
)
516 (if remote-address ss
(null-pointer))
517 (if remote-address et
:size-of-sockaddr-storage
0)))))))))
519 (defmethod socket-send (buffer (socket passive-socket
) &key
)
520 (declare (ignore buffer
))
521 (error "You cannot send data on a passive socket."))
528 (defun %normalize-receive-buffer
(buff start end
)
529 (setf (values start end
) (%check-bounds buff start end
))
531 ((simple-array ub8
(*)) (values buff start
(- end start
)))))
533 (defmethod socket-receive ((buffer array
)
534 (socket active-socket
) &key
(start 0) end
535 out-of-band peek wait-all
536 dont-wait
(no-signal *no-sigpipe
*))
537 (let ((flags (logior (if out-of-band et
:msg-oob
0)
538 (if peek et
:msg-peek
0)
539 (if wait-all et
:msg-waitall
0)
540 (if dont-wait et
:msg-dontwait
0)
541 (if no-signal et
:msg-nosignal
0)))
543 (multiple-value-bind (buff start-offset bufflen
)
544 (%normalize-receive-buffer buffer start end
)
545 (with-foreign-object (ss 'et
:sockaddr-storage
)
546 (et:bzero ss et
:size-of-sockaddr-storage
)
547 (with-foreign-pointer (size et
:size-of-socklen
)
548 (setf (mem-ref size
:socklen
)
549 et
:size-of-sockaddr-storage
)
550 (with-pointer-to-vector-data (buff-sap buff
)
551 (incf-pointer buff-sap start-offset
)
552 (with-socket-error-filter
554 (et:recvfrom
(fd-of socket
)
559 (return-from socket-receive
560 ;; when socket is a datagram socket
561 ;; return the sender's address as 3rd value
562 (if (typep socket
'datagram-socket
)
563 (multiple-value-bind (remote-address remote-port
)
564 (sockaddr-storage->sockaddr ss
)
565 (values buffer bytes-received remote-address remote-port
))
566 (values buffer bytes-received
)))))))
568 (defmethod socket-receive (buffer (socket passive-socket
) &key
)
569 (declare (ignore buffer
))
570 (error "You cannot receive data from a passive socket."))
574 ;; Only for datagram sockets
577 (defmethod unconnect :before
((socket active-socket
))
578 (unless (typep socket
'datagram-socket
)
579 (error "You can only unconnect active datagram sockets.")))
581 (defmethod unconnect ((socket datagram-socket
))
582 (with-socket-error-filter
583 (with-foreign-object (sin 'et
:sockaddr-in
)
584 (et:bzero sin et
:size-of-sockaddr-in
)
585 (setf (foreign-slot-value sin
'et
:sockaddr-in
'et
:addr
) et
:af-unspec
)
586 (et:connect
(fd-of socket
) sin et
:size-of-sockaddr-in
))))