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 :default protocol
) 0)
56 (t (lookup-protocol protocol
)))))
59 (defmethod socket-os-fd ((socket socket
))
62 (defmethod initialize-instance :after
((socket socket
) &key
63 file-descriptor family type
65 (with-accessors ((fd fd-of
) (fam socket-family
) (proto socket-protocol
))
67 (setf fd
(or file-descriptor
68 (multiple-value-call #'%socket
69 (translate-make-socket-keywords-to-constants
70 family type protocol
))))
74 (defmethod (setf external-format-of
) (external-format (socket passive-socket
))
75 (setf (slot-value socket
'external-format
)
76 (babel:ensure-external-format external-format
)))
78 (defmethod initialize-instance :after
((socket passive-socket
)
80 (setf (external-format-of socket
) external-format
))
82 (defmethod socket-type ((socket stream-socket
))
85 (defmethod socket-type ((socket datagram-socket
))
88 (defun ipv6-socket-p (socket)
89 (eq :ipv6
(socket-family 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 (host port
) (remote-name socket
)
103 (format stream
" connected to ~A/~A"
104 (address-to-string host
) 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 (host port
) (local-name socket
)
112 (format stream
" ~:[bound to~;waiting @~] ~A/~A"
113 (socket-listening-p socket
)
114 (address-to-string host
) 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-filename 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-filename 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-filename socket
)))
141 (format stream
" waiting @ ~S" (address-to-string (local-filename 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 (host port
) (remote-name socket
)
149 (format stream
" connected to ~A/~A"
150 (address-to-string host
) port
))
152 (multiple-value-bind (host port
) (local-name socket
)
153 (format stream
" waiting @ ~A/~A"
154 (address-to-string host
) 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
))
179 (with-sockaddr-storage (ss)
180 (with-socklen (size size-of-sockaddr-storage
)
182 (%getsockname
(fd-of socket
) ss size
)
184 (nix:econnreset
() nil
)
185 (:no-error
(_) (declare (ignore _
)) t
))))))
189 (defun %local-name
(socket)
190 (with-sockaddr-storage (ss)
191 (with-socklen (size size-of-sockaddr-storage
)
192 (%getsockname
(fd-of socket
) ss size
)
193 (sockaddr-storage->sockaddr ss
))))
195 (defmethod local-name ((socket socket
))
196 (%local-name socket
))
198 (defmethod local-host ((socket internet-socket
))
199 (nth-value 0 (local-name socket
)))
201 (defmethod local-port ((socket internet-socket
))
202 (nth-value 1 (local-name socket
)))
204 (defmethod local-filename ((socket local-socket
))
205 (%local-name socket
))
209 (defun %remote-name
(socket)
210 (with-sockaddr-storage (ss)
211 (with-socklen (size size-of-sockaddr-storage
)
212 (%getpeername
(fd-of socket
) ss size
)
213 (sockaddr-storage->sockaddr ss
))))
215 (defmethod remote-name ((socket socket
))
216 (%remote-name socket
))
218 (defmethod remote-host ((socket internet-socket
))
219 (nth-value 0 (remote-name socket
)))
221 (defmethod remote-port ((socket internet-socket
))
222 (nth-value 1 (remote-name socket
)))
224 (defmethod remote-filename ((socket local-socket
))
225 (%remote-name socket
))
229 (defmethod bind-address :before
((socket internet-socket
) address
230 &key
(reuse-address t
))
231 (declare (ignore address
))
233 (setf (socket-option socket
:reuse-address
) t
)))
235 (defun bind-ipv4-address (fd address port
)
236 (with-sockaddr-in (sin address port
)
237 (%bind fd sin size-of-sockaddr-in
)))
239 (defun bind-ipv6-address (fd address port
)
240 (with-sockaddr-in6 (sin6 address port
)
241 (%bind fd sin6 size-of-sockaddr-in6
)))
243 (defmethod bind-address ((socket internet-socket
) (address ipv4-address
)
245 (if (ipv6-socket-p socket
)
246 (bind-ipv6-address (fd-of socket
)
247 (map-ipv4-vector-to-ipv6 (address-name address
))
249 (bind-ipv4-address (fd-of socket
) (address-name address
) port
))
252 (defmethod bind-address ((socket internet-socket
) (address ipv6-address
)
254 (bind-ipv6-address (fd-of socket
) (address-name address
) port
)
257 (defmethod bind-address ((socket local-socket
) (address local-address
) &key
)
258 (with-sockaddr-un (sun (address-name address
))
259 (%bind
(fd-of socket
) sun size-of-sockaddr-un
))
262 (defmethod bind-address :after
((socket socket
) (address address
) &key
)
263 (setf (slot-value socket
'bound
) t
))
267 (defmethod listen-on ((socket passive-socket
) &key backlog
)
268 (unless backlog
(setf backlog
(min *default-backlog-size
*
269 +max-backlog-size
+)))
270 (check-type backlog unsigned-byte
"a non-negative integer")
271 (%listen
(fd-of socket
) backlog
)
272 (setf (slot-value socket
'listening
) t
)
275 (defmethod listen-on ((socket active-socket
) &key
)
276 (error "You can't listen on active sockets."))
280 (defmethod accept-connection ((socket active-socket
) &key
)
281 (error "You can't accept connections on active sockets."))
283 (defmethod accept-connection ((socket passive-socket
) &key external-format
284 input-buffer-size output-buffer-size
)
285 (flet ((make-client-socket (fd)
286 (make-instance (active-class socket
)
288 :external-format
(or external-format
289 (external-format-of socket
))
290 :input-buffer-size input-buffer-size
291 :output-buffer-size output-buffer-size
)))
292 (with-sockaddr-storage (ss)
293 (with-socklen (size size-of-sockaddr-storage
)
295 (make-client-socket (%accept
(fd-of socket
) ss size
))
296 (nix:ewouldblock
()))))))
300 (defmethod connect :before
((socket active-socket
) address
&key
)
301 (declare (ignore address
))
303 (setf (socket-option socket
:no-sigpipe
) t
))
305 (defun ipv4-connect (fd address port
)
306 (with-sockaddr-in (sin address port
)
307 (%connect fd sin size-of-sockaddr-in
)))
309 (defun ipv6-connect (fd address port
)
310 (with-sockaddr-in6 (sin6 address port
)
311 (%connect fd sin6 size-of-sockaddr-in6
)))
313 (defmethod connect ((socket internet-socket
) (address ipv4-address
)
315 (if (ipv6-socket-p socket
)
316 (ipv6-connect (fd-of socket
)
317 (map-ipv4-vector-to-ipv6 (address-name address
))
319 (ipv4-connect (fd-of socket
) (address-name address
) port
))
322 (defmethod connect ((socket internet-socket
) (address ipv6-address
)
324 (ipv6-connect (fd-of socket
) (address-name address
) port
)
327 (defmethod connect ((socket local-socket
) (address local-address
) &key
)
328 (with-sockaddr-un (sun (address-name address
))
329 (%connect
(fd-of socket
) sun size-of-sockaddr-un
))
332 (defmethod connect ((socket passive-socket
) address
&key
)
333 (declare (ignore address
))
334 (error "You cannot connect passive sockets."))
336 (defmethod socket-connected-p ((socket socket
))
338 (with-sockaddr-storage (ss)
339 (with-socklen (size size-of-sockaddr-storage
)
341 (%getpeername
(fd-of socket
) ss size
)
342 (socket-not-connected-error () nil
)
343 (:no-error
(_) (declare (ignore _
)) t
))))))
347 (defmethod shutdown ((socket socket
) &key read write
)
348 (assert (or read write
) (read write
)
349 "You must select at least one direction to shut down.")
350 (%shutdown
(fd-of socket
)
351 (multiple-value-case ((read write
))
359 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
360 (defun compute-flags (flags args
)
361 (loop :with flag-combination
:= 0
362 :for cons
:on args
:by
#'cddr
363 :for flag
:= (car cons
)
364 :for val
:= (cadr cons
)
365 :for const
:= (cdr (assoc flag flags
))
367 (when (not (constantp val
)) (return-from compute-flags
))
368 (setf flag-combination
(logior flag-combination const
))
369 :finally
(return flag-combination
)))
371 (defmacro define-socket-flag
(place name value platform
)
372 (let ((val (cond ((or (not platform
)
373 (featurep platform
)) value
)
374 ((not (featurep platform
)) 0))))
375 `(push (cons ,name
,val
) ,place
))))
377 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
378 (defparameter *sendmsg-flags
* nil
)
380 (defmacro define-sendmsg-flags
(&rest forms
)
382 (destructuring-bind (name value
&optional platform
) form
383 `(define-socket-flag *sendmsg-flags
* ,name
,value
,platform
))))
385 ,@(mapcar #'dflag forms
))))
387 (define-sendmsg-flags
388 (:dont-route msg-dontroute
)
389 (:dont-wait msg-dontwait
(:not
:windows
))
390 (:out-of-band msg-oob
)
391 (:more msg-more
:linux
)
392 (:confirm msg-confirm
:linux
)))
394 (defun %normalize-send-buffer
(buff start end ef
)
395 (check-bounds buff start end
)
397 (ub8-sarray (values buff start
(- end start
)))
398 (string (let ((vector (%to-octets buff ef start end
)))
399 (values vector
0 (length vector
))))
400 (vector (values (coerce buff
'ub8-sarray
)
401 start
(- end start
)))))
403 (defun %%send-to
(fd ss got-peer buffer start end flags ef
)
404 (multiple-value-bind (buff start-offset bufflen
)
405 (%normalize-send-buffer buffer start end ef
)
406 (with-pointer-to-vector-data (buff-sap buff
)
407 (incf-pointer buff-sap start-offset
)
410 (return-from %%send-to
411 (%sendto fd buff-sap bufflen flags
412 (if got-peer ss
(null-pointer))
413 (if got-peer
(sockaddr-size ss
) 0)))
415 :report
"Ignore this socket condition"
416 (return-from %%send-to
0))
417 (continue (&optional
(wait 0))
418 :report
"Try to send data again"
419 (when (plusp wait
) (sleep wait
))))))))
421 (defun %inet-send-to
(socket buffer start end remote-host remote-port flags
)
423 (with-sockaddr-storage (ss)
425 (sockaddr->sockaddr-storage ss
(ensure-hostname remote-host
)
426 (ensure-numerical-service remote-port
))
428 (%%send-to
(fd-of socket
) ss got-peer buffer start end flags
429 (external-format-of socket
)))))
431 (defun %local-send-to
(socket buffer start end remote-filename flags
)
433 (with-sockaddr-storage (ss)
434 (when remote-filename
435 (sockaddr->sockaddr-storage ss
(ensure-address remote-filename
:family
:local
) 0)
437 (%%send-to
(fd-of socket
) ss got-peer buffer start end flags
438 (external-format-of socket
)))))
440 (defmethod send-to ((socket internet-socket
) buffer
&rest args
441 &key
(start 0) end remote-host
(remote-port 0) (ipv6 *ipv6
*))
443 (%inet-send-to socket buffer start end remote-host remote-port
444 (compute-flags *sendmsg-flags
* args
))))
446 (defmethod send-to ((socket local-socket
) buffer
&rest args
447 &key
(start 0) end remote-filename
)
448 (%local-send-to socket buffer start end remote-filename
449 (compute-flags *sendmsg-flags
* args
)))
451 (define-compiler-macro send-to
(&whole form socket buffer
&rest args
452 &key
(start 0) end remote-host
(remote-port 0)
453 remote-filename
(ipv6 '*ipv6
*) &allow-other-keys
)
454 (let ((flags (compute-flags *sendmsg-flags
* args
)))
456 (once-only (socket buffer start end remote-host
457 remote-port remote-filename flags
)
460 (let ((*ipv6
* ,ipv6
))
461 (%inet-send-to
,socket
,buffer
,start
,end
462 ,remote-host
,remote-port
,flags
)))
464 (%local-send-to
,socket
,buffer
,start
,end
465 ,remote-filename
,flags
)))))
470 (eval-when (:compile-toplevel
:load-toplevel
:execute
)
471 (defparameter *recvfrom-flags
* nil
)
473 (defmacro define-recvfrom-flags
(&rest forms
)
475 (destructuring-bind (name value
&optional platform
) form
476 `(define-socket-flag *recvfrom-flags
* ,name
,value
,platform
))))
478 ,@(mapcar #'dflag forms
))))
480 (define-recvfrom-flags
481 (:out-of-band msg-oob
)
483 (:wait-all msg-waitall
(:not
:windows
))
484 (:dont-wait msg-dontwait
(:not
:windows
))))
486 (defun allocate-ub8-buffer-for-string (length ef
)
487 (let* ((units-per-char (babel-encodings:enc-max-units-per-char
488 (babel:external-format-encoding ef
)))
489 (length (* units-per-char length
)))
490 (values (make-array length
:element-type
'ub8
)
493 (defun %normalize-receive-buffer
(buff start end ef
)
495 (ub8-sarray (values buff start
(- end start
)))
496 (string (allocate-ub8-buffer-for-string (- end start
) ef
))))
498 (defun %%receive-from
(fd ss buffer start end flags ef
)
499 (check-bounds buffer start end
)
500 (multiple-value-bind (buff start-offset bufflen
)
501 (%normalize-receive-buffer buffer start end ef
)
502 (with-socklen (size size-of-sockaddr-storage
)
503 (bzero ss size-of-sockaddr-storage
)
504 (with-pointer-to-vector-data (buff-sap buff
)
505 (incf-pointer buff-sap start-offset
)
508 (let ((nbytes (%recvfrom fd buff-sap bufflen flags ss size
)))
509 (return-from %%receive-from
511 ;; FIXME: convert the octets directly into the buffer
512 (let ((str (babel:octets-to-string buff
:start
0 :end nbytes
513 :encoding
(babel:external-format-encoding ef
)
515 (replace buffer str
:start1 start
:end1 end
)
519 :report
"Ignore this socket condition"
520 (return-from %%receive-from
0))
521 (continue (&optional
(wait 0))
522 :report
"Try to receive data again"
523 (when (plusp wait
) (sleep wait
)))))))))
525 (declaim (inline %receive-from-stream-socket
))
526 (defun %receive-from-stream-socket
(socket buffer start end flags
)
527 (with-sockaddr-storage (ss)
528 (let ((nelements (%%receive-from
(fd-of socket
) ss buffer start end
529 flags
(external-format-of socket
))))
530 (values buffer nelements
))))
532 (declaim (inline %receive-from-datagram-socket
))
533 (defun %receive-from-datagram-socket
(socket buffer start end flags
)
534 (with-sockaddr-storage (ss)
535 (let ((nelements (%%receive-from
(fd-of socket
) ss buffer start end
536 flags
(external-format-of socket
))))
537 (multiple-value-call #'values buffer nelements
538 (sockaddr-storage->sockaddr ss
)))))
540 (defun %receive-from
(socket buffer start end size flags
)
542 (check-type size unsigned-byte
"a non-negative integer")
543 (setf buffer
(make-array size
:element-type
'ub8
)
546 (stream-socket (%receive-from-stream-socket socket buffer start end flags
))
547 (datagram-socket (%receive-from-datagram-socket socket buffer start end flags
))))
549 (defmethod receive-from ((socket active-socket
) &rest args
550 &key buffer size
(start 0) end
)
551 (%receive-from socket buffer start end size
552 (compute-flags *recvfrom-flags
* args
)))
554 (define-compiler-macro receive-from
(&whole form socket
&rest args
555 &key buffer size
(start 0) end
&allow-other-keys
)
556 (let ((flags (compute-flags *recvfrom-flags
* args
)))
557 (cond (flags `(%receive-from
,socket
,buffer
,start
,end
,size
,flags
))
562 (defmethod disconnect :before
((socket socket
))
563 (unless (typep socket
'datagram-socket
)
564 (error "You can only disconnect active datagram sockets.")))
566 (defmethod disconnect ((socket datagram-socket
))
567 (with-foreign-object (sin 'sockaddr-in
)
568 (bzero sin size-of-sockaddr-in
)
569 (setf (foreign-slot-value sin
'sockaddr-in
'addr
) af-unspec
)
570 (%connect
(fd-of socket
) sin size-of-sockaddr-in
)))