1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Indent-tabs-mode: NIL -*-
3 ;;; socket-methods.lisp --- Various socket methods.
5 ;;; Copyright (C) 2006-2008, Stelian Ionescu <sionescu@common-lisp.net>
7 ;;; This code is free software; you can redistribute it and/or
8 ;;; modify it under the terms of the version 2.1 of
9 ;;; the GNU Lesser General Public License as published by
10 ;;; the Free Software Foundation, as clarified by the
11 ;;; preamble found here:
12 ;;; http://opensource.franz.com/preamble.html
14 ;;; This program is distributed in the hope that it will be useful,
15 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;;; GNU General Public License for more details.
19 ;;; You should have received a copy of the GNU Lesser General
20 ;;; Public License along with this library; if not, write to the
21 ;;; Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
22 ;;; Boston, MA 02110-1301, USA
24 (in-package :net.sockets
)
26 (defvar *socket-type-map
*
27 '(((:ipv4
:stream
:active
:default
) . socket-stream-internet-active
)
28 ((:ipv6
:stream
:active
:default
) . socket-stream-internet-active
)
29 ((:ipv4
:stream
:passive
:default
) . socket-stream-internet-passive
)
30 ((:ipv6
:stream
:passive
:default
) . socket-stream-internet-passive
)
31 ((:local
:stream
:active
:default
) . socket-stream-local-active
)
32 ((:local
:stream
:passive
:default
) . socket-stream-local-passive
)
33 ((:local
:datagram
:active
:default
) . socket-datagram-local-active
)
34 ((:ipv4
:datagram
:active
:default
) . socket-datagram-internet-active
)
35 ((:ipv6
:datagram
:active
:default
) . socket-datagram-internet-active
)))
37 ;;; FIXME: should match :default to whatever protocol is the default.
38 (defun select-socket-class (family type connect protocol
)
39 (or (cdr (assoc (list family type connect protocol
) *socket-type-map
*
41 (error "No socket class found !!")))
43 ;;;; Shared Initialization
45 (defun translate-make-socket-keywords-to-constants (family type protocol
)
46 (let ((sf (ecase family
52 (:datagram sock-dgram
)))
54 ((integerp protocol
) protocol
)
55 ((eq protocol
:default
) 0)
56 (t (lookup-protocol protocol
)))))
59 (defmethod socket-fd ((socket socket
))
62 (defmethod (setf socket-fd
) (fd (socket socket
))
63 (setf (fd-of socket
) fd
))
65 (defmethod initialize-instance :after
((socket socket
) &key
66 file-descriptor family type
68 (with-accessors ((fd fd-of
) (fam socket-family
) (proto socket-protocol
))
70 (setf fd
(or file-descriptor
71 (multiple-value-call #'socket
72 (translate-make-socket-keywords-to-constants
73 family type protocol
))))
77 (defmethod (setf external-format-of
) (external-format (socket passive-socket
))
78 (setf (slot-value socket
'external-format
)
79 (babel:ensure-external-format external-format
)))
81 (defmethod initialize-instance :after
((socket passive-socket
)
83 (setf (external-format-of socket
) external-format
))
85 (defmethod socket-type ((socket stream-socket
))
88 (defmethod socket-type ((socket datagram-socket
))
93 (defun sock-fam (socket)
94 (ecase (socket-family socket
)
98 (defmethod print-object ((socket socket-stream-internet-active
) stream
)
99 (print-unreadable-object (socket stream
:identity t
)
100 (format stream
"active ~A stream socket" (sock-fam socket
))
101 (if (socket-connected-p socket
)
102 (multiple-value-bind (addr port
) (remote-name socket
)
103 (format stream
" connected to ~A/~A"
104 (address-to-string addr
) port
))
105 (format stream
", ~:[closed~;unconnected~]" (fd-of socket
)))))
107 (defmethod print-object ((socket socket-stream-internet-passive
) stream
)
108 (print-unreadable-object (socket stream
:identity t
)
109 (format stream
"passive ~A stream socket" (sock-fam socket
))
110 (if (socket-bound-p socket
)
111 (multiple-value-bind (addr port
) (local-name socket
)
112 (format stream
" ~:[bound to~;waiting @~] ~A/~A"
113 (socket-listening-p socket
)
114 (address-to-string addr
) port
))
115 (format stream
", ~:[closed~;unbound~]" (fd-of socket
)))))
117 (defmethod print-object ((socket socket-stream-local-active
) stream
)
118 (print-unreadable-object (socket stream
:identity t
)
119 (format stream
"active local stream socket")
120 (if (socket-connected-p socket
)
121 (format stream
" connected to ~S"
122 (address-to-string (remote-address socket
)))
123 (format stream
", ~:[closed~;unconnected~]" (fd-of socket
)))))
125 (defmethod print-object ((socket socket-stream-local-passive
) stream
)
126 (print-unreadable-object (socket stream
:identity t
)
127 (format stream
"passive local stream socket")
128 (if (socket-bound-p socket
)
129 (format stream
" ~:[bound to~;waiting @~] ~S"
130 (socket-listening-p socket
)
131 (address-to-string (local-address socket
)))
132 (format stream
", ~:[closed~;unbound~]" (fd-of socket
)))))
134 (defmethod print-object ((socket socket-datagram-local-active
) stream
)
135 (print-unreadable-object (socket stream
:identity t
)
136 (format stream
"local datagram socket")
137 (if (socket-connected-p socket
)
138 (format stream
" connected to ~S"
139 (address-to-string (remote-address socket
)))
141 (format stream
" waiting @ ~S" (address-to-string (local-address socket
)))
142 (format stream
", closed" )))))
144 (defmethod print-object ((socket socket-datagram-internet-active
) stream
)
145 (print-unreadable-object (socket stream
:identity t
)
146 (format stream
"~A datagram socket" (sock-fam socket
))
147 (if (socket-connected-p socket
)
148 (multiple-value-bind (addr port
) (remote-name socket
)
149 (format stream
" connected to ~A/~A"
150 (address-to-string addr
) port
))
152 (multiple-value-bind (addr port
) (local-name socket
)
153 (format stream
" waiting @ ~A/~A"
154 (address-to-string addr
) port
))
155 (format stream
", closed" )))))
159 (defmethod close :around
((socket socket
) &key abort
)
160 (declare (ignore abort
))
163 (nix:close
(fd-of socket
)))
164 (setf (fd-of socket
) nil
165 (slot-value socket
'bound
) nil
)
168 (defmethod close :around
((socket passive-socket
) &key abort
)
169 (declare (ignore abort
))
171 (setf (slot-value socket
'listening
) nil
)
174 (defmethod close ((socket socket
) &key abort
)
175 (declare (ignore socket abort
)))
177 (defmethod socket-open-p ((socket socket
))
180 (with-foreign-object (ss 'sockaddr-storage
)
181 (bzero ss size-of-sockaddr-storage
)
182 (with-socklen (size size-of-sockaddr-storage
)
183 (getsockname (fd-of socket
) ss size
)))
185 (nix:econnreset
() nil
)
186 (:no-error
(_) (declare (ignore _
)) t
))))
190 (defmethod local-name ((socket socket
))
191 (with-foreign-object (ss 'sockaddr-storage
)
192 (bzero ss size-of-sockaddr-storage
)
193 (with-socklen (size size-of-sockaddr-storage
)
194 (getsockname (fd-of socket
) ss size
)
195 (sockaddr-storage->sockaddr ss
))))
197 (defmethod local-address ((socket socket
))
198 (nth-value 0 (local-name socket
)))
200 (defmethod local-port ((socket internet-socket
))
201 (nth-value 1 (local-name socket
)))
205 (defmethod remote-name ((socket socket
))
206 (with-foreign-object (ss 'sockaddr-storage
)
207 (bzero ss size-of-sockaddr-storage
)
208 (with-socklen (size size-of-sockaddr-storage
)
209 (getpeername (fd-of socket
) ss size
)
210 (sockaddr-storage->sockaddr ss
))))
212 (defmethod remote-address ((socket socket
))
213 (nth-value 0 (remote-name socket
)))
215 (defmethod remote-port ((socket internet-socket
))
216 (nth-value 1 (remote-name socket
)))
220 (defmethod bind-address :before
((socket internet-socket
) address
221 &key
(reuse-address t
))
222 (declare (ignore address
))
224 (set-socket-option socket
:reuse-address
:value t
)))
226 (defun bind-ipv4-address (fd address port
)
227 (with-sockaddr-in (sin address port
)
228 (bind fd sin size-of-sockaddr-in
)))
230 (defun bind-ipv6-address (fd address port
)
231 (with-sockaddr-in6 (sin6 address port
)
232 (bind fd sin6 size-of-sockaddr-in6
)))
234 (defmethod bind-address ((socket internet-socket
) (address ipv4-address
)
236 (if (eq (socket-family socket
) :ipv6
)
237 (bind-ipv6-address (fd-of socket
)
238 (map-ipv4-vector-to-ipv6 (address-name address
))
240 (bind-ipv4-address (fd-of socket
) (address-name address
) port
))
243 (defmethod bind-address ((socket internet-socket
) (address ipv6-address
)
245 (bind-ipv6-address (fd-of socket
) (address-name address
) port
)
248 (defmethod bind-address ((socket local-socket
) (address local-address
) &key
)
249 (with-sockaddr-un (sun (address-name address
))
250 (bind (fd-of socket
) sun size-of-sockaddr-un
))
253 (defmethod bind-address :after
((socket socket
) (address address
) &key
)
254 (setf (slot-value socket
'bound
) t
))
258 (defmethod socket-listen ((socket passive-socket
) &key backlog
)
259 (unless backlog
(setf backlog
(min *default-backlog-size
*
260 +max-backlog-size
+)))
261 (check-type backlog unsigned-byte
"a non-negative integer")
262 (listen (fd-of socket
) backlog
)
263 (setf (slot-value socket
'listening
) t
)
266 (defmethod socket-listen ((socket active-socket
) &key backlog
)
267 (declare (ignore backlog
))
268 (error "You can't listen on active sockets."))
272 (defmethod accept-connection ((socket active-socket
) &key external-format
)
273 (declare (ignore external-format
))
274 (error "You can't accept connections on active sockets."))
276 (defmethod accept-connection ((socket passive-socket
) &key external-format
)
277 (flet ((make-client-socket (fd)
278 (make-instance (active-class socket
)
279 :external-format
(or external-format
280 (external-format-of socket
))
281 :file-descriptor fd
)))
282 (with-foreign-object (ss 'sockaddr-storage
)
283 (bzero ss size-of-sockaddr-storage
)
284 (with-socklen (size size-of-sockaddr-storage
)
286 (make-client-socket (accept (fd-of socket
) ss size
))
287 (nix:ewouldblock
()))))))
292 (defmethod connect :before
((socket active-socket
) sockaddr
&key
)
293 (declare (ignore sockaddr
))
294 (set-socket-option socket
:no-sigpipe
:value t
))
296 (defun ipv4-connect (fd address port
)
297 (with-sockaddr-in (sin address port
)
298 (%connect fd sin size-of-sockaddr-in
)))
300 (defun ipv6-connect (fd address port
)
301 (with-sockaddr-in6 (sin6 address port
)
302 (%connect fd sin6 size-of-sockaddr-in6
)))
304 (defmethod connect ((socket internet-socket
) (address ipv4-address
)
306 (if (eq (socket-family socket
) :ipv6
)
307 (ipv6-connect (fd-of socket
)
308 (map-ipv4-vector-to-ipv6 (address-name address
))
310 (ipv4-connect (fd-of socket
) (address-name address
) port
))
313 (defmethod connect ((socket internet-socket
) (address ipv6-address
)
315 (ipv6-connect (fd-of socket
) (address-name address
) port
)
318 (defmethod connect ((socket local-socket
) (address local-address
) &key
)
319 (with-sockaddr-un (sun (address-name address
))
320 (%connect
(fd-of socket
) sun size-of-sockaddr-un
))
323 (defmethod connect ((socket passive-socket
) address
&key
)
324 (declare (ignore address
))
325 (error "You cannot connect passive sockets."))
327 (defmethod socket-connected-p ((socket socket
))
330 (with-foreign-object (ss 'sockaddr-storage
)
331 (bzero ss size-of-sockaddr-storage
)
332 (with-socklen (size size-of-sockaddr-storage
)
333 (getpeername (fd-of socket
) ss size
)))
334 (socket-not-connected-error () nil
)
335 (:no-error
(_) (declare (ignore _
)) t
))))
339 (defmethod shutdown ((socket active-socket
) direction
)
340 (check-type direction
(member :read
:write
:read-write
)
341 "one of :READ, :WRITE or :READ-WRITE")
342 (%shutdown
(fd-of socket
)
346 (:read-write shut-rdwr
)))
349 (defmethod shutdown ((socket passive-socket
) direction
)
350 (declare (ignore direction
))
351 (error "You cannot shut down passive sockets."))
355 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
356 (defun compute-flags (flags args
)
357 (loop :with flag-combination
:= 0
358 :for cons
:on args
:by
#'cddr
359 :for flag
:= (car cons
)
360 :for val
:= (cadr cons
)
361 :for const
:= (cdr (assoc flag flags
))
363 (when (not (constantp val
)) (return-from compute-flags
))
364 (setf flag-combination
(logior flag-combination const
))
365 :finally
(return flag-combination
)))
367 (defmacro define-socket-flag
(place name value platform
)
368 (let ((val (cond ((or (not platform
)
369 (featurep platform
)) value
)
370 ((not (featurep platform
)) 0))))
371 `(push (cons ,name
,val
) ,place
))))
373 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
374 (defparameter *sendmsg-flags
* nil
)
376 (defmacro define-sendmsg-flags
(&rest forms
)
378 (destructuring-bind (name value
&optional platform
) form
379 `(define-socket-flag *sendmsg-flags
* ,name
,value
,platform
))))
381 ,@(mapcar #'dflag forms
))))
383 (define-sendmsg-flags
384 (:end-of-record msg-eor
(:not
:windows
))
385 (:dont-route msg-dontroute
)
386 (:dont-wait msg-dontwait
(:not
:windows
))
387 (:no-signal msg-nosignal
(:not
(:or
:darwin
:windows
)))
388 (:out-of-band msg-oob
)
389 (:more msg-more
:linux
)
390 (:confirm msg-confirm
:linux
)))
392 (defun %normalize-send-buffer
(buff start end ef
)
393 (check-bounds buff start end
)
395 (ub8-sarray (values buff start
(- end start
)))
396 (ub8-vector (values (coerce buff
'ub8-sarray
)
397 start
(- end start
)))
398 (string (values (%to-octets buff ef start end
)
400 (vector (values (coerce buff
'ub8-sarray
)
401 start
(- end start
)))))
403 (defun %socket-send
(buffer socket start end remote-address remote-port flags
)
404 (when (typep socket
'passive-socket
)
405 (error "You cannot send data on a passive socket."))
406 (check-type start unsigned-byte
"a non-negative integer")
407 (check-type end
(or unsigned-byte null
) "a non-negative integer or NIL")
408 (check-type remote-address
(or address null
) "a network address or NIL")
409 (check-type remote-port tcp-port
"a valid TCP port number")
410 (when (and (ipv4-address-p remote-address
)
411 (eq (socket-family socket
) :ipv6
))
412 (setf remote-address
(map-ipv4-address-to-ipv6 remote-address
)))
413 (multiple-value-bind (buff start-offset bufflen
)
414 (%normalize-send-buffer buffer start end
(external-format-of socket
))
415 (with-foreign-object (ss 'sockaddr-storage
)
416 (bzero ss size-of-sockaddr-storage
)
418 (sockaddr->sockaddr-storage ss remote-address remote-port
))
419 (with-pointer-to-vector-data (buff-sap buff
)
420 (incf-pointer buff-sap start-offset
)
421 (sendto (fd-of socket
) buff-sap bufflen flags
422 (if remote-address ss
(null-pointer))
423 (if remote-address size-of-sockaddr-storage
0))))))
425 (defmethod socket-send ((buffer array
) (socket active-socket
) &rest args
426 &key
(start 0) end remote-address
(remote-port 0) &allow-other-keys
)
427 (%socket-send buffer socket start end remote-address remote-port
428 (compute-flags *sendmsg-flags
* args
)))
430 (define-compiler-macro socket-send
(&whole form buffer socket
&rest args
431 &key
(start 0) end remote-address
(remote-port 0)
433 (let ((flags (compute-flags *sendmsg-flags
* args
)))
434 (cond (flags `(%socket-send
,buffer
,socket
,start
,end
435 ,remote-address
,remote-port
,flags
))
440 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
441 (defparameter *recvfrom-flags
* nil
)
443 (defmacro define-recvfrom-flags
(&rest forms
)
445 (destructuring-bind (name value
&optional platform
) form
446 `(define-socket-flag *recvfrom-flags
* ,name
,value
,platform
))))
448 ,@(mapcar #'dflag forms
))))
450 (define-recvfrom-flags
451 (:out-of-band msg-oob
)
453 (:wait-all msg-waitall
(:not
:windows
))
454 (:dont-wait msg-dontwait
(:not
:windows
))
455 (:no-signal msg-nosignal
(:not
(:or
:darwin
:windows
)))))
457 (defun %normalize-receive-buffer
(buff start end
)
458 (check-bounds buff start end
)
460 ((simple-array ub8
(*)) (values buff start
(- end start
)))))
462 (defun %socket-receive-bytes
(buffer ss fd flags start end
)
463 (multiple-value-bind (buff start-offset bufflen
)
464 (%normalize-receive-buffer buffer start end
)
465 (with-socklen (size size-of-sockaddr-storage
)
466 (bzero ss size-of-sockaddr-storage
)
467 (with-pointer-to-vector-data (buff-sap buff
)
468 (incf-pointer buff-sap start-offset
)
469 (recvfrom fd buff-sap bufflen flags ss size
)))))
471 (declaim (inline %socket-receive-stream-socket
))
472 (defun %socket-receive-stream-socket
(buffer socket start end flags
)
473 (with-foreign-object (ss 'sockaddr-storage
)
474 (let ((bytes-received (%socket-receive-bytes buffer ss
(fd-of socket
) flags
476 (values buffer bytes-received
))))
478 (declaim (inline %socket-receive-datagram-socket
))
479 (defun %socket-receive-datagram-socket
(buffer socket start end flags
)
480 (with-foreign-object (ss 'sockaddr-storage
)
481 (let ((bytes-received (%socket-receive-bytes buffer ss
(fd-of socket
) flags
483 (multiple-value-bind (remote-address remote-port
)
484 (sockaddr-storage->sockaddr ss
)
485 (values buffer bytes-received remote-address remote-port
)))))
487 (defun %socket-receive
(buffer socket start end flags
)
488 (when (typep socket
'passive-socket
)
489 (error "You cannot receive data from a passive socket."))
491 (stream-socket (%socket-receive-stream-socket
492 buffer socket start end flags
))
493 (datagram-socket (%socket-receive-datagram-socket
494 buffer socket start end flags
))))
496 (defmethod socket-receive ((buffer array
) (socket active-socket
)
497 &rest args
&key
(start 0) end
&allow-other-keys
)
498 (%socket-receive buffer socket start end
499 (compute-flags *recvfrom-flags
* args
)))
501 (define-compiler-macro socket-receive
(&whole form buffer socket
&rest args
502 &key
(start 0) end
&allow-other-keys
)
503 (let ((flags (compute-flags *recvfrom-flags
* args
)))
504 (cond (flags `(%socket-receive
,buffer
,socket
,start
,end
,flags
))
507 ;;;; Datagram Sockets
509 (defmethod disconnect :before
((socket active-socket
))
510 (unless (typep socket
'datagram-socket
)
511 (error "You can only disconnect active datagram sockets.")))
513 (defmethod disconnect ((socket datagram-socket
))
514 (with-foreign-object (sin 'sockaddr-in
)
515 (bzero sin size-of-sockaddr-in
)
516 (setf (foreign-slot-value sin
'sockaddr-in
'addr
) af-unspec
)
517 (%connect
(fd-of socket
) sin size-of-sockaddr-in
)))