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 (setf external-format-of
) (external-format (socket passive-socket
))
85 (setf (slot-value socket
'external-format
)
86 (ensure-external-format external-format
)))
88 (defmethod shared-initialize :after
((socket passive-socket
) slot-names
90 (declare (ignore slot-names
))
91 (setf (external-format-of socket
) external-format
))
93 (defmethod socket-type ((socket stream-socket
))
96 (defmethod socket-type ((socket datagram-socket
))
104 (defun sock-fam (socket)
105 (ecase (socket-family socket
)
109 (defmethod print-object ((socket socket-stream-internet-active
) stream
)
110 (print-unreadable-object (socket stream
:type nil
:identity t
)
111 (format stream
"active ~A stream socket" (sock-fam socket
))
112 (if (socket-connected-p socket
)
113 (multiple-value-bind (addr port
) (remote-name socket
)
114 (format stream
" connected to ~A/~A"
115 (sockaddr->presentation addr
) port
))
117 (format stream
", unconnected")
118 (format stream
", closed")))))
120 (defmethod print-object ((socket socket-stream-internet-passive
) stream
)
121 (print-unreadable-object (socket stream
:type nil
:identity t
)
122 (format stream
"passive ~A stream socket" (sock-fam socket
))
123 (if (socket-bound-p socket
)
124 (multiple-value-bind (addr port
) (local-name socket
)
125 (format stream
" ~A ~A/~A"
126 (if (socket-listening-p socket
)
127 "waiting for connections @"
129 (sockaddr->presentation addr
) port
))
131 (format stream
", unbound")
132 (format stream
", closed")))))
134 (defmethod print-object ((socket socket-stream-local-active
) stream
)
135 (print-unreadable-object (socket stream
:type nil
:identity t
)
136 (format stream
"active local stream socket")
137 (if (socket-connected-p socket
)
138 (format stream
" connected to ~A"
139 (sockaddr->presentation
(remote-name socket
)))
141 (format stream
", unconnected")
142 (format stream
", closed")))))
144 (defmethod print-object ((socket socket-stream-local-passive
) stream
)
145 (print-unreadable-object (socket stream
:type nil
:identity t
)
146 (format stream
"passive local stream socket")
147 (if (socket-bound-p socket
)
148 (format stream
" ~A ~A"
149 (if (socket-listening-p socket
)
150 "waiting for connections @"
152 (sockaddr->presentation
(socket-address socket
)))
154 (format stream
", unbound")
155 (format stream
", closed")))))
157 (defmethod print-object ((socket socket-datagram-local-active
) stream
)
158 (print-unreadable-object (socket stream
:type nil
:identity t
)
159 (format stream
"local datagram socket")
160 (if (socket-connected-p socket
)
161 (format stream
" connected to ~A"
162 (sockaddr->presentation
(remote-name socket
)))
164 (format stream
", unconnected")
165 (format stream
", closed")))))
167 (defmethod print-object ((socket socket-datagram-internet-active
) stream
)
168 (print-unreadable-object (socket stream
:type nil
:identity t
)
169 (format stream
"~A datagram socket" (sock-fam socket
))
170 (if (socket-connected-p socket
)
171 (multiple-value-bind (addr port
) (remote-name socket
)
172 (format stream
" connected to ~A/~A"
173 (sockaddr->presentation addr
) port
))
175 (format stream
", unconnected")
176 (format stream
", closed")))))
183 (defmethod close :around
((socket socket
) &key abort
)
184 (declare (ignore abort
))
187 (with-socket-error-filter
188 (et:close
(fd-of socket
))))
189 (setf (fd-of socket
) nil
190 (slot-value socket
'bound
) nil
)
193 (defmethod close :around
((socket passive-socket
) &key abort
)
194 (declare (ignore abort
))
196 (setf (slot-value socket
'listening
) nil
)
199 (defmethod close ((socket socket
) &key abort
)
200 (declare (ignore socket abort
)))
202 (defmethod socket-open-p ((socket socket
))
203 (unless (fd-of socket
)
204 (return-from socket-open-p nil
))
205 (with-socket-error-filter
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
'et
:socklen
)
211 et
:size-of-sockaddr-storage
)
212 (et:getsockname
(fd-of socket
) ss size
)
215 #+freebsd
(et:econnreset
()))))
222 (defmethod local-name ((socket internet-socket
))
223 (with-foreign-object (ss 'et
:sockaddr-storage
)
224 (et:bzero ss et
:size-of-sockaddr-storage
)
225 (with-foreign-pointer (size et
:size-of-socklen
)
226 (setf (mem-ref size
'et
:socklen
)
227 et
:size-of-sockaddr-storage
)
228 (with-socket-error-filter
229 (et:getsockname
(fd-of socket
) ss size
))
230 (return-from local-name
231 (sockaddr-storage->sockaddr ss
)))))
233 (defmethod local-name ((socket local-socket
))
234 (with-foreign-object (sun 'et
:sockaddr-un
)
235 (et:bzero sun et
:size-of-sockaddr-un
)
236 (with-foreign-pointer (size et
:size-of-socklen
)
237 (setf (mem-ref size
'et
:socklen
)
238 et
:size-of-sockaddr-storage
)
239 (with-socket-error-filter
240 (et:getsockname
(fd-of socket
) sun size
))
241 (return-from local-name
242 (sockaddr-un->sockaddr sun
)))))
244 (defmethod socket-address ((socket socket
))
245 (nth-value 0 (local-name socket
)))
247 (defmethod socket-port ((socket internet-socket
))
248 (nth-value 1 (local-name socket
)))
255 (defmethod remote-name ((socket internet-socket
))
256 (with-foreign-object (ss 'et
:sockaddr-storage
)
257 (et:bzero ss et
:size-of-sockaddr-storage
)
258 (with-foreign-pointer (size et
:size-of-socklen
)
259 (setf (mem-ref size
'et
:socklen
)
260 et
:size-of-sockaddr-storage
)
261 (with-socket-error-filter
262 (et:getpeername
(fd-of socket
) ss size
))
263 (return-from remote-name
264 (sockaddr-storage->sockaddr ss
)))))
266 (defmethod remote-name ((socket local-socket
))
267 (with-foreign-object (sun 'et
:sockaddr-un
)
268 (et:bzero sun et
:size-of-sockaddr-un
)
269 (with-foreign-pointer (size et
:size-of-socklen
)
270 (setf (mem-ref size
'et
:socklen
)
271 et
:size-of-sockaddr-storage
)
272 (with-socket-error-filter
273 (et:getpeername
(fd-of socket
) sun size
))
274 (return-from remote-name
275 (sockaddr-un->sockaddr sun
)))))
282 (defmethod bind-address :before
((socket internet-socket
)
283 address
&key
(reuse-address t
))
284 (declare (ignore address
))
286 (set-socket-option socket
:reuse-address
:value t
)))
288 (defun bind-ipv4-address (fd address port
)
289 (with-foreign-object (sin 'et
:sockaddr-in
)
290 (make-sockaddr-in sin address port
)
291 (with-socket-error-filter
292 (et:bind fd sin et
:size-of-sockaddr-in
))))
294 (defun bind-ipv6-address (fd address port
)
295 (with-foreign-object (sin6 'et
:sockaddr-in6
)
296 (make-sockaddr-in6 sin6 address port
)
297 (with-socket-error-filter
298 (et:bind fd sin6 et
:size-of-sockaddr-in6
))))
300 (defmethod bind-address ((socket internet-socket
)
303 (if (eql (socket-family socket
) :ipv6
)
304 (bind-ipv6-address (fd-of socket
)
305 (map-ipv4-vector-to-ipv6 (name address
))
307 (bind-ipv4-address (fd-of socket
) (name address
) port
))
310 (defmethod bind-address ((socket internet-socket
)
313 (bind-ipv6-address (fd-of socket
) (name address
) port
)
316 (defmethod bind-address :before
((socket local-socket
)
317 (address localaddr
) &key
)
318 (when (typep socket
'active-socket
)
319 (error "You can't bind an active Unix socket.")))
321 (defmethod bind-address ((socket local-socket
)
322 (address localaddr
) &key
)
323 (with-foreign-object (sun 'et
:sockaddr-un
)
324 (make-sockaddr-un sun
(name address
))
325 (with-socket-error-filter
326 (et:bind
(fd-of socket
) sun et
:size-of-sockaddr-un
)))
329 (defmethod bind-address :after
((socket socket
)
330 (address sockaddr
) &key
)
331 (setf (slot-value socket
'bound
) t
))
338 (defmethod socket-listen ((socket passive-socket
)
340 (unless backlog
(setf backlog
(min *default-backlog-size
*
341 +max-backlog-size
+)))
342 (check-type backlog unsigned-byte
"a non-negative integer")
343 (with-socket-error-filter
344 (et:listen
(fd-of socket
) backlog
))
345 (setf (slot-value socket
'listening
) t
)
348 (defmethod socket-listen ((socket active-socket
)
350 (declare (ignore backlog
))
351 (error "You can't listen on active sockets."))
358 (defmethod accept-connection ((socket active-socket
)
360 (declare (ignore wait
))
361 (error "You can't accept connections on active sockets."))
363 (defmethod accept-connection ((socket passive-socket
)
365 (with-foreign-object (ss 'et
:sockaddr-storage
)
366 (et:bzero ss et
:size-of-sockaddr-storage
)
367 (with-foreign-pointer (size et
:size-of-socklen
)
368 (setf (mem-ref size
'et
:socklen
)
369 et
:size-of-sockaddr-storage
)
370 (let (non-blocking-state
372 (with-socket-error-filter
375 ;; do a "normal" accept
376 ;; Note: the socket may already be in non-blocking mode
377 (setf client-fd
(et:accept
(fd-of socket
) ss size
))
378 ;; set the socket to non-blocking mode before calling accept()
379 ;; if there's no new connection return NIL
382 ;; saving the current non-blocking state
383 (setf non-blocking-state
(fd-non-blocking socket
))
384 ;; switch the socket to non-blocking mode
385 (setf (fd-non-blocking socket
) t
)
386 (setf client-fd
(et:accept
(fd-of socket
) ss size
)))
387 ;; restoring the socket's non-blocking state
388 (setf (fd-non-blocking socket
) non-blocking-state
)))
389 ;; the socket is marked non-blocking and there's no new connection
391 (return-from accept-connection nil
))))
394 ;; create the client socket object
395 (make-instance (active-class socket
)
396 :file-descriptor client-fd
)))
397 (return-from accept-connection client-socket
))))))
405 (defmethod connect :before
((socket active-socket
)
407 (declare (ignore sockaddr
))
409 (set-socket-option socket
:no-sigpipe
:value t
)))
411 (defun ipv4-connect (fd address port
)
412 (with-foreign-object (sin 'et
:sockaddr-in
)
413 (make-sockaddr-in sin address port
)
414 (with-socket-error-filter
415 (et:connect fd sin et
:size-of-sockaddr-in
))))
417 (defun ipv6-connect (fd address port
)
418 (with-foreign-object (sin6 'et
:sockaddr-in6
)
419 (make-sockaddr-in6 sin6 address port
)
420 (with-socket-error-filter
421 (et:connect fd sin6 et
:size-of-sockaddr-in6
))))
423 (defmethod connect ((socket internet-socket
)
424 (address ipv4addr
) &key
(port 0))
425 (if (eql (socket-family socket
) :ipv6
)
426 (ipv6-connect (fd-of socket
)
427 (map-ipv4-vector-to-ipv6 (name address
))
429 (ipv4-connect (fd-of socket
) (name address
) port
))
432 (defmethod connect ((socket internet-socket
)
433 (address ipv6addr
) &key
(port 0))
434 (ipv6-connect (fd-of socket
) (name address
) port
)
437 (defmethod connect ((socket local-socket
)
438 (address localaddr
) &key
)
439 (with-foreign-object (sun 'et
:sockaddr-un
)
440 (make-sockaddr-un sun
(name address
))
441 (with-socket-error-filter
442 (et:connect
(fd-of socket
) sun et
:size-of-sockaddr-un
)))
445 (defmethod connect ((socket passive-socket
)
447 (declare (ignore address
))
448 (error "You cannot connect passive sockets."))
450 (defmethod socket-connected-p ((socket socket
))
451 (unless (fd-of socket
)
452 (return-from socket-connected-p nil
))
453 (with-socket-error-filter
455 (with-foreign-object (ss 'et
:sockaddr-storage
)
456 (et:bzero ss et
:size-of-sockaddr-storage
)
457 (with-foreign-pointer (size et
:size-of-socklen
)
458 (setf (mem-ref size
'et
:socklen
)
459 et
:size-of-sockaddr-storage
)
460 (et:getpeername
(fd-of socket
) ss size
)
462 (et:enotconn
() nil
))))
469 (defmethod shutdown ((socket active-socket
) direction
)
470 (check-type direction
(member :read
:write
:read-write
)
471 "valid direction specifier")
472 (with-socket-error-filter
473 (et:shutdown
(fd-of socket
)
477 (:read-write et
:shut-rdwr
))))
480 (defmethod shutdown ((socket passive-socket
) direction
)
481 (declare (ignore direction
))
482 (error "You cannot shut down passive sockets."))
489 (defun %normalize-send-buffer
(buff start end ef
)
490 (setf (values start end
) (%check-bounds buff start end
))
492 (ub8-sarray (values buff start
(- end start
)))
493 (ub8-vector (values (coerce buff
'ub8-sarray
)
494 start
(- end start
)))
495 (string (values (%to-octets buff ef start end
)
498 (defmethod socket-send ((buffer array
)
499 (socket active-socket
) &key
(start 0) end
500 remote-address remote-port end-of-record
501 dont-route dont-wait
(no-signal *no-sigpipe
*)
502 out-of-band
#+linux more
#+linux confirm
)
503 (check-type start unsigned-byte
504 "a non-negative unsigned integer")
505 (check-type end
(or unsigned-byte null
)
506 "a non-negative unsigned integer or NIL")
507 (when (or remote-port remote-address
)
508 (check-type remote-address sockaddr
"a network address")
509 (check-type remote-port
(unsigned-byte 16) "a valid IP port number"))
510 (let ((flags (logior (if end-of-record et
:msg-eor
0)
511 (if dont-route et
:msg-dontroute
0)
512 (if dont-wait et
:msg-dontwait
0)
513 (if no-signal et
:msg-nosignal
0)
514 (if out-of-band et
:msg-oob
0)
515 #+linux
(if more et
:msg-more
0)
516 #+linux
(if confirm et
:msg-confirm
0))))
517 (when (and (ipv4-address-p remote-address
)
518 (eql (socket-family socket
) :ipv6
))
519 (setf remote-address
(map-ipv4-address->ipv6 remote-address
)))
520 (multiple-value-bind (buff start-offset bufflen
)
521 (%normalize-send-buffer buffer start end
(external-format-of socket
))
522 (with-foreign-object (ss 'et
:sockaddr-storage
)
523 (et:bzero ss et
:size-of-sockaddr-storage
)
525 (sockaddr->sockaddr-storage ss remote-address remote-port
))
526 (with-pointer-to-vector-data (buff-sap buff
)
527 (incf-pointer buff-sap start-offset
)
528 (with-socket-error-filter
529 (return-from socket-send
530 (et:sendto
(fd-of socket
)
533 (if remote-address ss
(null-pointer))
534 (if remote-address et
:size-of-sockaddr-storage
0)))))))))
536 (defmethod socket-send (buffer (socket passive-socket
) &key
)
537 (declare (ignore buffer
))
538 (error "You cannot send data on a passive socket."))
545 (defun %normalize-receive-buffer
(buff start end
)
546 (setf (values start end
) (%check-bounds buff start end
))
548 ((simple-array ub8
(*)) (values buff start
(- end start
)))))
550 (defmethod socket-receive ((buffer array
)
551 (socket active-socket
) &key
(start 0) end
552 out-of-band peek wait-all
553 dont-wait
(no-signal *no-sigpipe
*))
554 (let ((flags (logior (if out-of-band et
:msg-oob
0)
555 (if peek et
:msg-peek
0)
556 (if wait-all et
:msg-waitall
0)
557 (if dont-wait et
:msg-dontwait
0)
558 (if no-signal et
:msg-nosignal
0)))
560 (multiple-value-bind (buff start-offset bufflen
)
561 (%normalize-receive-buffer buffer start end
)
562 (with-foreign-object (ss 'et
:sockaddr-storage
)
563 (et:bzero ss et
:size-of-sockaddr-storage
)
564 (with-foreign-pointer (size et
:size-of-socklen
)
565 (setf (mem-ref size
'et
:socklen
)
566 et
:size-of-sockaddr-storage
)
567 (with-pointer-to-vector-data (buff-sap buff
)
568 (incf-pointer buff-sap start-offset
)
569 (with-socket-error-filter
571 (et:recvfrom
(fd-of socket
)
576 (return-from socket-receive
577 ;; when socket is a datagram socket
578 ;; return the sender's address as 3rd value
579 (if (typep socket
'datagram-socket
)
580 (multiple-value-bind (remote-address remote-port
)
581 (sockaddr-storage->sockaddr ss
)
582 (values buffer bytes-received remote-address remote-port
))
583 (values buffer bytes-received
)))))))
585 (defmethod socket-receive (buffer (socket passive-socket
) &key
)
586 (declare (ignore buffer
))
587 (error "You cannot receive data from a passive socket."))
591 ;; Only for datagram sockets
594 (defmethod unconnect :before
((socket active-socket
))
595 (unless (typep socket
'datagram-socket
)
596 (error "You can only unconnect active datagram sockets.")))
598 (defmethod unconnect ((socket datagram-socket
))
599 (with-socket-error-filter
600 (with-foreign-object (sin 'et
:sockaddr-in
)
601 (et:bzero sin et
:size-of-sockaddr-in
)
602 (setf (foreign-slot-value sin
'et
:sockaddr-in
'et
:addr
) et
:af-unspec
)
603 (et:connect
(fd-of socket
) sin et
:size-of-sockaddr-in
))))