source: trunk/source/level-1/l1-sockets.lisp @ 8265

Last change on this file since 8265 was 8265, checked in by gb, 12 years ago

More socket-timeout stuff, still not complete/tested.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 53.5 KB
Line 
1;;;-*- Mode: Lisp; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2001 Clozure Associates
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17(in-package "CCL")
18
19
20
21;;; basic socket API
22(eval-when (:compile-toplevel :load-toplevel :execute)
23  (export '(MAKE-SOCKET
24            ACCEPT-CONNECTION
25            DOTTED-TO-IPADDR
26            IPADDR-TO-DOTTED
27            IPADDR-TO-HOSTNAME
28            LOOKUP-HOSTNAME
29            LOOKUP-PORT
30            ;;with-pending-connect
31            RECEIVE-FROM
32            SEND-TO
33            SHUTDOWN
34            ;;socket-control
35            SOCKET-OS-FD
36            REMOTE-HOST
37            REMOTE-PORT
38            REMOTE-FILENAME
39            LOCAL-HOST
40            LOCAL-PORT
41            LOCAL-FILENAME
42            SOCKET-ADDRESS-FAMILY
43            SOCKET-CONNECT
44            SOCKET-FORMAT
45            SOCKET-TYPE
46            SOCKET-ERROR
47            SOCKET-ERROR-CODE
48            SOCKET-ERROR-IDENTIFIER
49            SOCKET-ERROR-SITUATION
50            WITH-OPEN-SOCKET)))
51
52;;; The PPC is big-endian (uses network byte order), which makes
53;;; things like #_htonl and #_htonl no-ops.  These functions aren't
54;;; necessarily defined as functions in some header files (I'm sure
55;;; that that either complies with or violates some C standard), and
56;;; it doesn't seem to make much sense to fight that to do ff-calls
57;;; to a couple of identity functions.
58
59#+big-endian-target
60(progn
61  (defmacro HTONL (x) x)
62  (defmacro HTONS (x) x)
63  (defmacro NTOHL (x) x)
64  (defmacro NTOHS (x) x))
65
66#+little-endian-target
67(progn
68  (declaim (inline %bswap32 %bswap16))
69  (defun %bswap32 (x)
70    (declare (type (unsigned-byte 32) x))
71    (%swap-u32 x))
72  (defun %bswap16 (x)
73    (declare (type (unsigned-byte 16) x))
74    (%swap-u16 x))
75  (defmacro HTONL (x) `(%bswap32 ,x))
76  (defmacro HTONS (x) `(%bswap16 ,x))
77  (defmacro NTOHL (x) `(%bswap32 ,x))
78  (defmacro NTOHS (x) `(%bswap16 ,x)))
79
80(defparameter *default-socket-character-encoding*
81  nil)
82
83(defmethod default-character-encoding ((domain (eql :socket)))
84  *default-socket-character-encoding*)
85 
86
87;;; On some (hypothetical) little-endian platform, we might want to
88;;; define HTONL and HTONS to actually swap bytes around.
89
90(defpackage "OPENMCL-SOCKET"
91  (:use "CL")
92  (:import-from "CCL"
93                "MAKE-SOCKET"
94                "ACCEPT-CONNECTION"
95                "DOTTED-TO-IPADDR"
96                "IPADDR-TO-DOTTED"
97                "IPADDR-TO-HOSTNAME"
98                "LOOKUP-HOSTNAME"
99                "LOOKUP-PORT"
100                ;;with-pending-connect
101                "RECEIVE-FROM"
102                "SEND-TO"
103                "SHUTDOWN"
104                ;;socket-control
105                "SOCKET-OS-FD"
106                "REMOTE-HOST"
107                "REMOTE-PORT"
108                "REMOTE-FILENAME"
109                "LOCAL-HOST"
110                "LOCAL-PORT"
111                "LOCAL-FILENAME"
112                "SOCKET-ADDRESS-FAMILY"
113                "SOCKET-CONNECT"
114                "SOCKET-FORMAT"
115                "SOCKET-TYPE"
116                "SOCKET-ERROR"
117                "SOCKET-ERROR-CODE"
118                "SOCKET-ERROR-IDENTIFIER"
119                "SOCKET-ERROR-SITUATION"
120                "WITH-OPEN-SOCKET")
121  (:export  "MAKE-SOCKET"
122            "ACCEPT-CONNECTION"
123            "DOTTED-TO-IPADDR"
124            "IPADDR-TO-DOTTED"
125            "IPADDR-TO-HOSTNAME"
126            "LOOKUP-HOSTNAME"
127            "LOOKUP-PORT"
128            ;;with-pending-connect
129            "RECEIVE-FROM"
130            "SEND-TO"
131            "SHUTDOWN"
132            ;;socket-control
133            "SOCKET-OS-FD"
134            "REMOTE-HOST"
135            "REMOTE-PORT"
136            "REMOTE-FILENAME"
137            "LOCAL-HOST"
138            "LOCAL-PORT"
139            "LOCAL-FILENAME"
140            "SOCKET-ADDRESS-FAMILY"
141            "SOCKET-CONNECT"
142            "SOCKET-FORMAT"
143            "SOCKET-TYPE"
144            "SOCKET-ERROR"
145            "SOCKET-ERROR-CODE"
146            "SOCKET-ERROR-IDENTIFIER"
147            "SOCKET-ERROR-SITUATION"
148            "WITH-OPEN-SOCKET"))
149
150(eval-when (:compile-toplevel :execute)
151  #+linuxppc-target
152  (require "PPC-LINUX-SYSCALLS")
153  #+linuxx8664-target
154  (require "X8664-LINUX-SYSCALLS")
155  #+darwinppc-target
156  (require "DARWINPPC-SYSCALLS")
157  #+darwinx8664-target
158  (require "DARWINX8664-SYSCALLS")
159  #+freebsdx8664-target
160  (require "X8664-FREEBSD-SYSCALLS")
161  )
162
163(define-condition socket-error (simple-stream-error)
164  ((code :initarg :code :reader socket-error-code)
165   (identifier :initform :unknown :initarg :identifier :reader socket-error-identifier)
166   (Situation :initarg :situation :reader socket-error-situation)))
167
168(define-condition socket-creation-error (simple-error)
169  ((code :initarg :code :reader socket-creation-error-code)
170   (identifier :initform :unknown :initarg :identifier :reader socket-creation-error-identifier)
171   (situation :initarg :situation :reader socket-creation-error-situation)))
172
173(defvar *socket-error-identifiers*
174  (list #$EADDRINUSE :address-in-use
175        #$ECONNABORTED :connection-aborted
176        #$ENOBUFS :no-buffer-space
177        #$ENOMEM :no-buffer-space
178        #$ENFILE :no-buffer-space
179        #$ETIMEDOUT :connection-timed-out
180        #$ECONNREFUSED :connection-refused
181        #$ENETUNREACH :host-unreachable
182        #$EHOSTUNREACH :host-unreachable
183        #$EHOSTDOWN :host-down
184        #$ENETDOWN :network-down
185        #$EADDRNOTAVAIL :address-not-available
186        #$ENETRESET :network-reset
187        #$ECONNRESET :connection-reset
188        #$ESHUTDOWN :shutdown
189        #$EACCES :access-denied
190        #$EPERM :access-denied))
191
192
193(declaim (inline socket-call))
194(defun socket-call (stream where res)
195  (if (< res 0)
196    (socket-error stream where res)
197    res))
198
199(defun %hstrerror (h_errno)
200  (with-macptrs ((p (#_hstrerror (abs h_errno))))
201    (if p
202      (%get-cstring p)
203      (format nil "Nameserver error ~d" (abs h_errno)))))
204   
205
206
207
208(defun socket-error (stream where errno &optional nameserver-p)
209  "Creates and signals (via error) one of two socket error
210conditions, based on the state of the arguments."
211  (when (< errno 0)
212    (setq errno (- errno)))
213  (if stream
214    (error (make-condition 'socket-error
215                           :stream stream
216                           :code errno
217                           :identifier (getf *socket-error-identifiers* errno :unknown)
218                           :situation where
219                           ;; TODO: this is a constant arg, there is a way to put this
220                           ;; in the class definition, just need to remember how...
221                           :format-control "~a (error #~d) during ~a"
222                           :format-arguments (list
223                                              (if nameserver-p
224                                                (%hstrerror errno)
225                                                (%strerror errno))
226                                              errno where)))
227    (error (make-condition 'socket-creation-error
228                           :code errno
229                           :identifier (getf *socket-error-identifiers* errno :unknown)
230                           :situation where
231                           ;; TODO: this is a constant arg, there is a way to put this
232                           ;; in the class definition, just need to remember how...
233                           :format-control "~a (error #~d) during socket creation in ~a"
234                           :format-arguments (list
235                                              (if nameserver-p
236                                                (%hstrerror errno)
237                                                (%strerror errno))
238                                              errno where)))))
239   
240
241
242;; If true, this will try to allow other cooperative processes to run
243;; while socket io is happening.  Since CCL threads are preemptively
244;; scheduled, this isn't particularly meaningful.
245(defvar *multiprocessing-socket-io* nil)
246
247(defclass socket ()
248  ())
249
250(defmacro with-open-socket ((var . args) &body body
251                            &aux (socket (make-symbol "socket"))
252                                 (done (make-symbol "done")))
253  "Execute body with var bound to the result of applying make-socket to
254make-socket-args. The socket gets closed on exit."
255  `(let (,socket ,done)
256     (unwind-protect
257         (multiple-value-prog1
258           (let ((,var (setq ,socket (make-socket ,@args))))
259             ,@body)
260           (setq ,done t))
261       (when ,socket (close ,socket :abort (not ,done))))))
262
263(defgeneric socket-address-family (socket)
264  (:documentation "Return :internet or :file, as appropriate."))
265
266(defclass ip-socket (socket)
267  ())
268
269(defmethod socket-address-family ((socket ip-socket)) :internet)
270
271(defclass file-socket (socket)
272  ())
273
274(defmethod socket-address-family ((socket file-socket)) :file)
275
276(defclass tcp-socket (ip-socket)
277  ())
278
279(defgeneric socket-type (socket)
280  (:documentation
281   "Return :stream for tcp-stream and listener-socket, and :datagram
282for udp-socket."))
283
284(defmethod socket-type ((socket tcp-socket)) :stream)
285
286(defclass stream-file-socket (file-socket)
287  ())
288
289(defmethod socket-type ((socket stream-file-socket)) :stream)
290
291
292;;; An active TCP socket is an honest-to-goodness stream.
293(defclass tcp-stream (tcp-socket)
294  ())
295
296(defclass fundamental-tcp-stream (tcp-stream
297                                  fd-stream
298                                  buffered-binary-io-stream-mixin
299                                  buffered-character-io-stream-mixin)
300    ())
301
302(make-built-in-class 'basic-tcp-stream
303                     'tcp-stream
304                     'basic-binary-io-stream
305                     'basic-character-io-stream)
306
307(defgeneric socket-connect (stream)
308 (:documentation
309   "Return :active for tcp-stream, :passive for listener-socket, and NIL
310for udp-socket"))
311
312(defmethod socket-connect ((stream tcp-stream)) :active)
313
314(defgeneric socket-format (stream)
315  (:documentation
316   "Return the socket format as specified by the :format argument to
317make-socket."))
318
319(defmethod socket-format ((stream tcp-stream))
320  (if (eq (stream-element-type stream) 'character)
321    :text
322    ;; Should distinguish between :binary and :bivalent, but hardly
323    ;; seems worth carrying around an extra slot just for that.
324    :bivalent))
325
326(defmethod socket-device ((stream tcp-stream))
327  (let ((ioblock (stream-ioblock stream nil)))
328    (and ioblock (ioblock-device ioblock))))
329
330(defmethod select-stream-class ((class tcp-stream) in-p out-p char-p)
331  (declare (ignore char-p)) ; TODO: is there any real reason to care about this?
332  ;; Yes, in general.  There is.
333  (assert (and in-p out-p) () "Non-bidirectional tcp stream?")
334  'fundamental-tcp-stream)
335
336(defmethod map-to-basic-stream-class-name ((name (eql 'tcp-stream)))
337  'basic-tcp-stream)
338
339(defmethod select-stream-class ((s (eql 'basic-tcp-stream)) in-p out-p char-p)
340  (declare (ignore char-p))
341  (assert (and in-p out-p) () "Non-bidirectional tcp stream?")
342  'basic-tcp-stream)
343
344;;; A FILE-SOCKET-STREAM is also honest. To goodness.
345(defclass file-socket-stream (stream-file-socket)
346  ())
347
348(defclass fundamental-file-socket-stream (file-socket-stream
349                                          fd-stream
350                                          buffered-binary-io-stream-mixin
351                                          buffered-character-io-stream-mixin)
352    ())
353
354(make-built-in-class 'basic-file-socket-stream
355                     'file-socket-stream
356                     'basic-binary-io-stream
357                     'basic-character-io-stream)
358
359
360(defmethod map-to-basic-stream-class-name ((name (eql 'file-socket-stream)))
361  'basic-file-socket-stream)
362
363(defmethod select-stream-class ((class file-socket-stream) in-p out-p char-p)
364  (declare (ignore char-p)) ; TODO: is there any real reason to care about this?
365  (assert (and in-p out-p) () "Non-bidirectional file-socket stream?")
366  'fundamental-file-socket-stream)
367
368(defmethod select-stream-class ((s (eql 'basic-file-socket-stream)) in-p out-p char-p)
369  (declare (ignore char-p))
370  (assert (and in-p out-p) () "Non-bidirectional file-socket stream?")
371  'basic-file-socket-stream)
372
373(defclass unconnected-socket (socket)
374  ((device :initarg :device :accessor socket-device)
375   (keys :initarg :keys :reader socket-keys)))
376
377(defmethod socket-format ((socket unconnected-socket))
378  (or (getf (socket-keys socket) :format) :text))
379
380(defgeneric close (socket &key abort)
381  (:documentation
382   "The close generic function can be applied to sockets. It releases the
383operating system resources associated with the socket."))
384
385(defmethod close ((socket unconnected-socket) &key abort)
386  (declare (ignore abort))
387  (when (socket-device socket)
388    (fd-close (socket-device socket))
389    (setf (socket-device socket) nil)
390    t))
391
392;; A passive tcp socket just generates connection streams
393(defclass listener-socket (tcp-socket unconnected-socket) ())
394
395(defmethod SOCKET-CONNECT ((stream listener-socket)) :passive)
396
397(defclass file-listener-socket (stream-file-socket unconnected-socket) ())
398
399(defmethod SOCKET-CONNECT ((stream file-listener-socket)) :passive)
400
401;;; A FILE-LISTENER-SOCKET should try to delete the filesystem
402;;; entity when closing.
403
404(defmethod close :before ((s file-listener-socket) &key abort)
405  (declare (ignore abort))
406  (let* ((path (local-socket-filename (socket-device s) s)))
407    (when path (%delete-file path))))
408
409
410;; A udp socket just sends and receives packets.
411(defclass udp-socket (ip-socket unconnected-socket) ())
412
413(defmethod socket-type ((stream udp-socket)) :datagram)
414(defmethod socket-connect ((stream udp-socket)) nil)
415
416(defgeneric socket-os-fd (socket)
417  (:documentation
418   "Return the native OS's representation of the socket, or NIL if the
419socket is closed. On Unix, this is the Unix 'file descriptor', a small
420non-negative integer. Note that it is rather dangerous to mess around
421with tcp-stream fd's, as there is all sorts of buffering and asynchronous
422I/O going on above the OS level. listener-socket and udp-socket fd's are
423safer to mess with directly as there is less magic going on."))
424
425;; Returns nil for closed stream...
426(defmethod socket-os-fd ((socket socket))
427  (socket-device socket))
428
429;; Returns nil for closed stream
430(defun local-socket-info (fd type socket)
431  (and fd
432       (rlet ((sockaddr :sockaddr_in)
433              (namelen :signed))
434             (setf (pref namelen :signed) (record-length :sockaddr_in))
435             (socket-call socket "getsockname" (c_getsockname fd sockaddr namelen))
436             (when (= #$AF_INET (pref sockaddr :sockaddr_in.sin_family))
437               (ecase type
438                 (:host (ntohl (pref sockaddr :sockaddr_in.sin_addr.s_addr)))
439                 (:port (ntohs (pref sockaddr :sockaddr_in.sin_port))))))))
440
441(defun path-from-unix-address (addr)
442  (when (= #$AF_LOCAL (pref addr :sockaddr_un.sun_family))
443    #+darwin-target
444    (%str-from-ptr (pref addr :sockaddr_un.sun_path)
445                   (- (pref addr :sockaddr_un.sun_len) 2))
446    #-darwin-target
447    (%get-cstring (pref addr :sockaddr_un.sun_path))))
448
449(defun local-socket-filename (fd socket)
450  (and fd
451       (rlet ((addr :sockaddr_un)
452              (namelen :signed))
453         (setf (pref namelen :signed) (record-length :sockaddr_un))
454         (socket-call socket "getsockname" (c_getsockname fd addr namelen))
455         (path-from-unix-address addr))))
456
457(defmacro with-if ((var expr) &body body)
458  `(let ((,var ,expr))
459     (if ,var
460         (progn
461           ,@body))))     
462
463(defun remote-socket-info (socket type)
464  (with-if (fd (socket-device socket))
465    (rlet ((sockaddr :sockaddr_in)
466           (namelen :signed))
467          (setf (pref namelen :signed) (record-length :sockaddr_in))
468          (let ((err (c_getpeername fd sockaddr namelen)))
469            (cond ((eql err (- #$ENOTCONN)) nil)
470                  ((< err 0) (socket-error socket "getpeername" err))
471                  (t
472                   (when (= #$AF_INET (pref sockaddr :sockaddr_in.sin_family))
473                     (ecase type
474                       (:host (ntohl (pref sockaddr :sockaddr_in.sin_addr.s_addr)))
475                       (:port (ntohs  (pref sockaddr :sockaddr_in.sin_port)))))))))))
476
477(defun remote-socket-filename (socket)
478  (with-if (fd (socket-device socket))
479    (rlet ((addr :sockaddr_un)
480           (namelen :signed))
481          (setf (pref namelen :signed) (record-length :sockaddr_un))
482          (let* ((err (c_getsockname fd addr namelen)))
483            (cond ((eql err (- #$ENOTCONN)) nil)
484                  ((< err 0) (socket-error socket "getpeername" err))
485                  (t (path-from-unix-address addr)))))))
486
487(defgeneric local-port (socket)
488  (:documentation "Return the local port number."))
489
490(defmethod local-port ((socket socket))
491  (local-socket-info (socket-device socket) :port socket))
492
493(defgeneric local-host (socket)
494  (:documentation
495   "Return 32-bit unsigned IP address of the local host."))
496
497(defmethod local-host ((socket socket))
498  (local-socket-info (socket-device socket) :host socket))
499
500(defmethod local-filename ((socket socket))
501  (local-socket-filename socket))
502
503(defgeneric remote-host (socket)
504  (:documentation
505   "Return the 32-bit unsigned IP address of the remote host, or NIL if
506the socket is not connected."))
507
508;; Returns NIL if socket is not connected
509(defmethod remote-host ((socket socket))
510  (remote-socket-info socket :host))
511
512(defgeneric remote-port (socket)
513  (:documentation
514   "Return the remote port number, or NIL if the socket is not connected."))
515
516(defmethod remote-port ((socket socket))
517  (remote-socket-info socket :port))
518
519(defmethod remote-filename ((socket socket))
520  (remote-socket-filename socket))
521 
522(defun set-socket-options (fd-or-socket &key 
523                           keepalive
524                           reuse-address
525                           nodelay
526                           broadcast
527                           linger
528                           address-family
529                           local-port
530                           local-host
531                           local-filename
532                           type
533                           connect
534                           out-of-band-inline
535                           receive-timeout
536                           send-timeout
537                           &allow-other-keys)
538  ;; see man socket(7) tcp(7) ip(7)
539  (multiple-value-bind (socket fd) (etypecase fd-or-socket
540                                     (socket (values fd-or-socket (socket-device fd-or-socket)))
541                                     (integer (values nil fd-or-socket)))
542   
543    (if (null address-family)
544        (setq address-family :internet))
545    (when keepalive
546      (int-setsockopt fd #$SOL_SOCKET #$SO_KEEPALIVE 1))
547    (when reuse-address
548      (int-setsockopt fd #$SOL_SOCKET #$SO_REUSEADDR 1))
549    (when broadcast
550      (int-setsockopt fd #$SOL_SOCKET #$SO_BROADCAST 1))
551    (when out-of-band-inline
552      (int-setsockopt fd #$SOL_SOCKET #$SO_OOBINLINE 1))
553    (rlet ((plinger :linger))
554          (setf (pref plinger :linger.l_onoff) (if linger 1 0)
555                (pref plinger :linger.l_linger) (or linger 0))
556          (socket-call socket "setsockopt"
557                       (c_setsockopt fd #$SOL_SOCKET #$SO_LINGER plinger (record-length :linger))))
558    (when (eq address-family :internet)
559      (when nodelay
560        (int-setsockopt fd
561                        #+linux-target #$SOL_TCP
562                        #+(or freebsd-target darwin-target) #$IPPROTO_TCP
563                        #$TCP_NODELAY 1))
564      (when (and receive-timeout (> receive-timeout 0))
565        (timeval-setsockopt fd
566                            #$SOL_SOCKET
567                            #$SO_RCVTIMEO
568                            receive-timeout))
569      (when (and send-timeout (> send-timeout 0))
570        (timeval-setsockopt fd
571                            #$SOL_SOCKET
572                            #$SO_SNDTIMEO
573                            send-timeout))
574      (when (or local-port local-host)
575        (let* ((proto (if (eq type :stream) "tcp" "udp"))
576               (port-n (if local-port (port-as-inet-port local-port proto) 0))
577               (host-n (if local-host (host-as-inet-host local-host) #$INADDR_ANY)))
578          ;; Darwin includes the SIN_ZERO field of the sockaddr_in when
579          ;; comparing the requested address to the addresses of configured
580          ;; interfaces (as if the zeros were somehow part of either address.)
581          ;; "rletz" zeros out the stack-allocated structure, so those zeros
582          ;; will be 0.
583          (rletz ((sockaddr :sockaddr_in))
584                 (setf (pref sockaddr :sockaddr_in.sin_family) #$AF_INET
585                       (pref sockaddr :sockaddr_in.sin_port) port-n
586                       (pref sockaddr :sockaddr_in.sin_addr.s_addr) host-n)
587                 (socket-call socket "bind" (c_bind fd sockaddr (record-length :sockaddr_in)))))))
588    (when (and (eq address-family :file)
589               (eq connect :passive)
590               local-filename)
591      (bind-unix-socket fd local-filename))   
592    (when (and nil *multiprocessing-socket-io*)
593      (socket-call socket "fcntl" (fd-set-flag fd #$O_NONBLOCK)))))
594
595;; I hope the inline declaration makes the &rest/apply's go away...
596(declaim (inline make-ip-socket))
597(defun make-ip-socket (&rest keys &key type &allow-other-keys)
598  (declare (dynamic-extent keys))
599  (ecase type
600    ((nil :stream) (apply #'make-tcp-socket keys))
601    ((:datagram) (apply #'make-udp-socket keys))))
602
603(declaim (inline make-file-socket))
604(defun make-file-socket (&rest keys &key type &allow-other-keys)
605  (declare (dynamic-extent keys))
606  (ecase type
607    ((nil :stream) (apply #'make-stream-file-socket keys))
608    (:datagram (apply #'make-datagram-file-socket keys))))
609
610(defun make-socket (&rest keys
611                    &key address-family
612                    ;; List all keys here just for error checking...
613                    ;; &allow-other-keys
614                    type connect remote-host remote-port eol format
615                    keepalive reuse-address nodelay broadcast linger
616                    local-port local-host backlog class out-of-band-inline
617                    local-filename remote-filename sharing basic
618                    external-format (auto-close t)
619                    receive-timeout send-timeout)
620  "Create and return a new socket."
621  (declare (dynamic-extent keys))
622  (declare (ignore type connect remote-host remote-port eol format
623                   keepalive reuse-address nodelay broadcast linger
624                   local-port local-host backlog class out-of-band-inline
625                   local-filename remote-filename sharing basic external-format
626                   auto-close receive-timeout send-timeout))
627  (ecase address-family
628    ((:file) (apply #'make-file-socket keys))
629    ((nil :internet) (apply #'make-ip-socket keys))))
630
631
632
633(defun make-udp-socket (&rest keys &aux (fd -1))
634  (unwind-protect
635    (let (socket)
636      (setq fd (socket-call nil "socket"
637                            (c_socket #$AF_INET #$SOCK_DGRAM #$IPPROTO_UDP)))
638      (apply #'set-socket-options fd keys)
639      (setq socket (make-instance 'udp-socket
640                                  :device fd
641                                  :keys keys))
642      (setq fd -1)
643      socket)
644    (unless (< fd 0)
645      (fd-close fd))))
646
647(defun make-tcp-socket (&rest keys &key connect &allow-other-keys &aux (fd -1))
648  (unwind-protect
649    (let (socket)
650      (setq fd (socket-call nil "socket"
651                            (c_socket #$AF_INET #$SOCK_STREAM #$IPPROTO_TCP)))
652      (apply #'set-socket-options fd keys)
653      (setq socket
654            (ecase connect
655              ((nil :active) (apply #'make-tcp-stream-socket fd keys))
656              ((:passive) (apply #'make-tcp-listener-socket fd keys))))
657      (setq fd -1)
658      socket)
659    (unless (< fd 0)
660      (fd-close fd))))
661
662(defun make-stream-file-socket (&rest keys &key connect &allow-other-keys &aux (fd -1))
663  (unwind-protect
664    (let (socket)
665      (setq fd (socket-call nil "socket" (c_socket #$PF_LOCAL #$SOCK_STREAM 0)))
666      (apply #'set-socket-options fd keys)
667      (setq socket
668            (ecase connect
669              ((nil :active) (apply #'make-file-stream-socket fd keys))
670              ((:passive) (apply #'make-file-listener-socket fd keys))))
671      (setq fd -1)
672      socket)
673    (unless (< fd 0)
674      (fd-close fd))))
675
676(defun %socket-connect (fd addr addrlen &optional timeout)
677  (let* ((err (c_connect fd addr addrlen timeout)))
678    (declare (fixnum err))
679    (unless (eql err 0) (socket-error nil "connect" err))))
680   
681(defun inet-connect (fd host-n port-n)
682  (rlet ((sockaddr :sockaddr_in))
683    (setf (pref sockaddr :sockaddr_in.sin_family) #$AF_INET
684          (pref sockaddr :sockaddr_in.sin_port) port-n
685          (pref sockaddr :sockaddr_in.sin_addr.s_addr) host-n)
686    (%socket-connect fd sockaddr (record-length :sockaddr_in))))
687               
688(defun file-socket-connect (fd remote-filename)
689  (rletz ((sockaddr :sockaddr_un))
690    (init-unix-sockaddr sockaddr remote-filename)
691    (%socket-connect fd sockaddr (record-length :sockaddr_un))))
692         
693 
694(defun make-tcp-stream-socket (fd &rest keys
695                                  &key remote-host
696                                  remote-port                             
697                                  &allow-other-keys)
698  (inet-connect fd
699                (host-as-inet-host remote-host)
700                (port-as-inet-port remote-port "tcp"))
701  (apply #'make-tcp-stream fd keys))
702
703(defun make-file-stream-socket (fd &rest keys
704                                   &key remote-filename
705                                   &allow-other-keys)
706  (file-socket-connect fd remote-filename)
707  (apply #'make-file-socket-stream fd keys))
708
709
710(defun make-tcp-stream (fd &key (format :bivalent) external-format (class 'tcp-stream) sharing (basic t) (auto-close t) (receive-timeout 0) &allow-other-keys)
711  (let* ((external-format (normalize-external-format :socket external-format)))
712    (let ((element-type (ecase format
713                          ((nil :text) 'character)
714                          ((:binary :bivalent) '(unsigned-byte 8)))))
715      ;; TODO: check out fd-stream-advance, -listen, -eofp, -force-output, -close
716      ;; See if should specialize any of 'em.
717      (make-fd-stream fd
718                      :class class
719                      :direction :io
720                      :element-type element-type
721                      :sharing sharing
722                      :character-p (not (eq format :binary))
723                      :encoding (external-format-character-encoding external-format)
724                      :line-termination (external-format-line-termination external-format)
725                      :basic basic
726                      :auto-close auto-close
727                      :interactive (zerop receive-timeout)))))
728
729(defun make-file-socket-stream (fd &key (format :bivalent) external-format (class 'file-socket-stream)  sharing basic (auto-close t) &allow-other-keys)
730  (let* ((external-format (normalize-external-format :socket external-format)))
731 
732    (let ((element-type (ecase format
733                          ((nil :text) 'character)
734                          ((:binary :bivalent) '(unsigned-byte 8)))))
735      ;; TODO: check out fd-stream-advance, -listen, -eofp, -force-output, -close
736      ;; See if should specialize any of 'em.
737      (make-fd-stream fd
738                      :class class
739                      :direction :io
740                      :element-type element-type
741                      :encoding (external-format-character-encoding external-format)
742                      :line-termination (external-format-line-termination external-format)
743                      :sharing sharing
744                      :character-p (not (eq format :binary))
745                      :basic basic
746                      :auto-close auto-close))))
747
748(defun make-tcp-listener-socket (fd &rest keys &key backlog &allow-other-keys)
749  (socket-call nil "listen" (c_listen fd (or backlog 5)))
750  (make-instance 'listener-socket
751                 :device fd
752                 :keys keys))
753
754(defun make-file-listener-socket (fd &rest keys &key backlog &allow-other-keys)
755  (socket-call nil "listen" (c_listen fd (or backlog 5)))
756  (make-instance 'file-listener-socket
757                 :device fd
758                 :keys keys))
759
760(defun socket-accept (fd wait socket)
761  (flet ((_accept (fd async)
762           (let ((res (c_accept fd (%null-ptr) (%null-ptr))))
763             (declare (fixnum res))
764             ;; See the inscrutable note under ERROR HANDLING in
765             ;; man accept(2). This is my best guess at what they mean...
766             (if (and async (< res 0)
767                      (or (eql res (- #$ENETDOWN))
768                          (eql res (- #+linux-target #$EPROTO
769                                      #+(or darwin-target freebsd-target) #$EPROTOTYPE))
770                          (eql res (- #$ENOPROTOOPT))
771                          (eql res (- #$EHOSTDOWN))
772                          (eql res (- #+linux-target #$ENONET
773                                      #+(or darwin-target freebsd-target) #$ENETDOWN))
774                          (eql res (- #$EHOSTUNREACH))
775                          (eql res (- #$EOPNOTSUPP))
776                          (eql res (- #$ENETUNREACH))))
777               (- #$EAGAIN)
778               res))))
779    (cond (wait
780            (with-eagain fd :input
781              (_accept fd *multiprocessing-socket-io*)))
782          (*multiprocessing-socket-io*
783            (_accept fd t))
784          (t
785            (let ((old (socket-call socket "fcntl" (fd-get-flags fd))))
786              (unwind-protect
787                  (progn
788                    (socket-call socket "fcntl" (fd-set-flags fd (logior old #$O_NONBLOCK)))
789                    (_accept fd t))
790                (socket-call socket "fcntl" (fd-set-flags fd old))))))))
791
792(defun accept-socket-connection (socket wait stream-create-function)
793  (let ((listen-fd (socket-device socket))
794        (fd -1))
795    (unwind-protect
796      (progn
797        (setq fd (socket-accept listen-fd wait socket))
798        (cond ((>= fd 0)
799               (prog1 (apply stream-create-function fd (socket-keys socket))
800                 (setq fd -1)))
801              ((eql fd (- #$EAGAIN)) nil)
802              (t (socket-error socket "accept" fd))))
803      (when (>= fd 0)
804        (fd-close fd)))))
805
806(defgeneric accept-connection (socket &key wait)
807  (:documentation
808  "Extract the first connection on the queue of pending connections,
809accept it (i.e. complete the connection startup protocol) and return a new
810tcp-stream or file-socket-stream representing the newly established
811connection.  The tcp stream inherits any properties of the listener socket
812that are relevant (e.g. :keepalive, :nodelay, etc.) The original listener
813socket continues to be open listening for more connections, so you can call
814accept-connection on it again."))
815
816(defmethod accept-connection ((socket listener-socket) &key (wait t))
817  (accept-socket-connection socket wait #'make-tcp-stream))
818
819(defmethod accept-connection ((socket file-listener-socket) &key (wait t))
820  (accept-socket-connection socket wait #'make-file-socket-stream))
821
822(defun verify-socket-buffer (buf offset size)
823  (unless offset (setq offset 0))
824  (unless (<= (+ offset size) (length buf))
825    (report-bad-arg size `(integer 0 ,(- (length buf) offset))))
826  (multiple-value-bind (arr start) (array-data-and-offset buf)
827    (setq buf arr offset (+ offset start)))
828  ;; TODO: maybe should allow any raw vector
829  (let ((subtype (typecode buf)))
830    (unless #+ppc32-target (and (<= ppc32::min-8-bit-ivector-subtag subtype)
831                                (<= subtype ppc32::max-8-bit-ivector-subtag))
832            #+ppc64-target (= (the fixnum (logand subtype ppc64::fulltagmask))
833                              ppc64::ivector-class-8-bit)
834            #+x8664-target (and (>= subtype x8664::min-8-bit-ivector-subtag)
835                                (<= subtype x8664::max-8-bit-ivector-subtag))
836      (report-bad-arg buf `(or (array character)
837                               (array (unsigned-byte 8))
838                               (array (signed-byte 8))))))
839  (values buf offset))
840
841(defmethod send-to ((socket udp-socket) msg size
842                    &key remote-host remote-port offset)
843  "Send a UDP packet over a socket."
844  (let ((fd (socket-device socket)))
845    (multiple-value-setq (msg offset) (verify-socket-buffer msg offset size))
846    (unless remote-host
847      (setq remote-host (or (getf (socket-keys socket) :remote-host)
848                            (remote-socket-info socket :host))))
849    (unless remote-port
850      (setq remote-port (or (getf (socket-keys socket) :remote-port)
851                            (remote-socket-info socket :port))))
852    (rlet ((sockaddr :sockaddr_in))
853      (setf (pref sockaddr :sockaddr_in.sin_family) #$AF_INET)
854      (setf (pref sockaddr :sockaddr_in.sin_addr.s_addr)
855            (if remote-host (host-as-inet-host remote-host) #$INADDR_ANY))
856      (setf (pref sockaddr :sockaddr_in.sin_port)
857            (if remote-port (port-as-inet-port remote-port "udp") 0))
858      (%stack-block ((bufptr size))
859        (%copy-ivector-to-ptr msg offset bufptr 0 size)
860        (socket-call socket "sendto"
861          (with-eagain fd :output
862            (c_sendto fd bufptr size 0 sockaddr (record-length :sockaddr_in))))))))
863
864(defmethod receive-from ((socket udp-socket) size &key buffer extract offset)
865  "Read a UDP packet from a socket. If no packets are available, wait for
866a packet to arrive. Returns four values:
867  The buffer with the data
868  The number of bytes read
869  The 32-bit unsigned IP address of the sender of the data
870  The port number of the sender of the data."
871  (let ((fd (socket-device socket))
872        (vec-offset offset)
873        (vec buffer)
874        (ret-size -1))
875    (when vec
876      (multiple-value-setq (vec vec-offset)
877        (verify-socket-buffer vec vec-offset size)))
878    (rlet ((sockaddr :sockaddr_in)
879           (namelen :signed))
880      (setf (pref sockaddr :sockaddr_in.sin_family) #$AF_INET)
881      (setf (pref sockaddr :sockaddr_in.sin_addr.s_addr) #$INADDR_ANY)
882      (setf (pref sockaddr :sockaddr_in.sin_port) 0)
883      (setf (pref namelen :signed) (record-length :sockaddr_in))
884      (%stack-block ((bufptr size))
885        (setq ret-size (socket-call socket "recvfrom"
886                         (with-eagain fd :input
887                           (c_recvfrom fd bufptr size 0 sockaddr namelen))))
888        (unless vec
889          (setq vec (make-array ret-size
890                                :element-type
891                                (ecase (socket-format socket)
892                                  ((:text) 'base-char)
893                                  ((:binary :bivalent) '(unsigned-byte 8))))
894                vec-offset 0))
895        (%copy-ptr-to-ivector bufptr 0 vec vec-offset ret-size))
896      (values (cond ((null buffer)
897                     vec)
898                    ((or (not extract)
899                         (and (eql 0 (or offset 0))
900                              (eql ret-size (length buffer))))
901                     buffer)
902                    (t 
903                     (subseq vec vec-offset (+ vec-offset ret-size))))
904              ret-size
905              (ntohl (pref sockaddr :sockaddr_in.sin_addr.s_addr))
906              (ntohs (pref sockaddr :sockaddr_in.sin_port))))))
907
908(defgeneric shutdown (socket &key direction)
909  (:documentation
910   "Shut down part of a bidirectional connection. This is useful if e.g.
911you need to read responses after sending an end-of-file signal."))
912
913(defmethod shutdown (socket &key direction)
914  ;; TODO: should we ignore ENOTCONN error?  (at least make sure it
915  ;; is a distinct, catchable error type).
916  (let ((fd (socket-device socket)))
917    (socket-call socket "shutdown"
918      (c_shutdown fd (ecase direction
919                       (:input 0)
920                       (:output 1))))))
921
922;; Accepts port as specified by user, returns port number in network byte
923;; order.  Protocol should be one of "tcp" or "udp".  Error if not known.
924(defun port-as-inet-port (port proto)
925  (or (etypecase port
926        (fixnum (htons port))
927        (string (_getservbyname port proto))
928        (symbol (_getservbyname (string-downcase (symbol-name port)) proto)))
929      (socket-error nil "getservbyname" (- #$ENOENT))))
930
931(defun lookup-port (port proto)
932  "Find the port number for the specified port and protocol."
933  (if (fixnump port)
934    port
935    (ntohs (port-as-inet-port port proto))))
936
937;; Accepts host as specified by user, returns host number in network byte
938;; order.
939(defun host-as-inet-host (host)
940  (etypecase host
941    (integer (htonl host))
942    (string (or (and (every #'(lambda (c) (position c ".0123456789")) host)
943                     (_inet_aton host))
944                (multiple-value-bind (addr err) (c_gethostbyname host)
945                  (or addr
946                      (socket-error nil "gethostbyname" err t)))))))
947
948
949(defun dotted-to-ipaddr (name &key (errorp t))
950  "Convert a dotted-string representation of a host address to a 32-bit
951unsigned IP address."
952  (let ((addr (_inet_aton name)))
953    (if addr (ntohl addr)
954      (and errorp (error "Invalid dotted address ~s" name)))))
955   
956(defun lookup-hostname (host)
957  "Convert a host spec in any of the acceptable formats into a 32-bit
958unsigned IP address."
959  (if (typep host 'integer)
960    host
961    (ntohl (host-as-inet-host host))))
962
963(defun ipaddr-to-dotted (addr &key values)
964  "Convert a 32-bit unsigned IP address into octets."
965  (if values
966      (values (ldb (byte 8 24) addr)
967              (ldb (byte 8 16) addr)
968              (ldb (byte 8  8) addr)
969              (ldb (byte 8  0) addr))
970    (_inet_ntoa (htonl addr))))
971
972(defun ipaddr-to-hostname (ipaddr &key ignore-cache)
973  "Convert a 32-bit unsigned IP address into a host name string."
974  (declare (ignore ignore-cache))
975  (multiple-value-bind (name err) (c_gethostbyaddr (htonl ipaddr))
976    (or name (socket-error nil "gethostbyaddr" err t))))
977 
978
979(defun int-getsockopt (socket level optname)
980  (rlet ((valptr :signed)
981         (vallen :signed))
982    (setf (pref vallen :signed) 4)
983    (let* ((err (c_getsockopt socket level optname valptr vallen)))
984      (if (and (eql 0 err)
985               (eql 4 (pref vallen :signed)))
986        (pref valptr :signed)
987        (socket-error socket "getsockopt" err)))))
988
989(defun timeval-setsockopt (socket level optname timeout)
990    (multiple-value-bind (seconds micros)
991        (microseconds timeout)
992      (rlet ((valptr :timeval :tv_sec seconds :tv_usec micros))
993        (socket-call socket "setsockopt"
994          (c_setsockopt socket level optname valptr (record-length :timeval))))))
995                   
996(defun int-setsockopt (socket level optname optval)
997  (rlet ((valptr :signed))
998    (setf (pref valptr :signed) optval)
999    (socket-call socket "setsockopt"
1000      (c_setsockopt socket level optname valptr (record-length :signed)))))
1001
1002#+(or darwin-target linux-target)
1003(defloadvar *h-errno-variable-address* nil)
1004#+linux-target
1005(defloadvar *h-errno-function-address* nil)
1006
1007(defun h-errno-location ()
1008  #+darwin-target
1009  ;; As of Tiger, Darwin doesn't seem to have grasped the concept
1010  ;; of thread-local storage for h_errno.
1011  (or *h-errno-variable-address*
1012      (setq *h-errno-variable-address* (foreign-symbol-address "_h_errno")))
1013  ;; Supported versions of FreeBSD seem to have grasped that concept.
1014  #+freebsd-target
1015  (#_ __h_error)
1016  #+linux-target
1017  ;; Current versions of Linux support thread-specific h_errno,
1018  ;; but older versions may not.
1019  (if *h-errno-function-address*
1020    (ff-call *h-errno-function-address* :address)
1021    (or *h-errno-variable-address*
1022        (let* ((entry (foreign-symbol-entry "__h_errno_location")))
1023          (if entry
1024            (ff-call (setq *h-errno-function-address* entry) :address)
1025            (setq *h-errno-variable-address*
1026                  (foreign-symbol-address  "h_errno")))))))
1027           
1028
1029#+(or darwin-target freebsd-target)
1030(defun c_gethostbyaddr (addr)
1031  (rlet ((addrp :unsigned))
1032    (setf (pref addrp :unsigned) addr)
1033    (without-interrupts
1034     (let* ((hp (#_gethostbyaddr addrp (record-length :unsigned) #$AF_INET)))
1035       (declare (dynamic-extent hp))
1036       (if (not (%null-ptr-p hp))
1037         (%get-cstring (pref hp :hostent.h_name))
1038         (values nil (pref (h-errno-location) :signed)))))))
1039
1040#+linux-target
1041(defun c_gethostbyaddr (addr)
1042  (rlet ((hostent :hostent)
1043         (hp (* (struct :hostent)))
1044         (herr :signed)
1045         (addrp :unsigned))
1046    (setf (pref addrp :unsigned) addr)
1047    (do* ((buflen 1024 (+ buflen buflen))) ()
1048      (declare (fixnum buflen))
1049      (%stack-block ((buf buflen))
1050        (let* ((res (#_gethostbyaddr_r addrp (record-length :unsigned) #$AF_INET
1051                                       hostent buf buflen hp herr)))
1052          (declare (fixnum res))
1053          (unless (eql res #$ERANGE)
1054            (return
1055             (if (and (eql res 0) (not (%null-ptr-p (%get-ptr hp))))
1056                 (%get-cstring (pref (%get-ptr hp) :hostent.h_name))
1057               (values nil (- (pref herr :signed)))))))))))
1058
1059#+(or darwin-target freebsd-target)
1060(defun c_gethostbyname (name)
1061  (with-cstrs ((name (string name)))
1062    (without-interrupts
1063     (let* ((hp (#_gethostbyname  name)))
1064       (declare (dynamic-extent hp))
1065       (if (not (%null-ptr-p hp))
1066         (%get-unsigned-long
1067          (%get-ptr (pref hp :hostent.h_addr_list)))
1068         (values nil (pref (h-errno-location) :signed)))))))
1069
1070#+linux-target
1071(defun c_gethostbyname (name)
1072  (with-cstrs ((name (string name)))
1073    (rlet ((hostent :hostent)
1074           (hp (* (struct :hostent)))
1075           (herr :signed 0))
1076       (do* ((buflen 1024 (+ buflen buflen))) ()
1077         (declare (fixnum buflen))
1078         (%stack-block ((buf buflen))
1079           (let* ((res (#_gethostbyname_r name hostent buf buflen hp herr)))
1080             (declare (fixnum res))
1081             (unless (eql res #$ERANGE)
1082               (return
1083                 (let* ((err (pref herr :signed)))
1084                 (if (and (eql res 0) (eql err 0))
1085                   (%get-unsigned-long
1086                    (%get-ptr (pref (%get-ptr hp) :hostent.h_addr_list)))
1087                   (values nil (- err))))))))))))
1088
1089(defun _getservbyname (name proto)
1090  (with-cstrs ((name (string name))
1091               (proto (string proto)))
1092    (let* ((servent-ptr (%null-ptr)))
1093      (declare (dynamic-extent servent-ptr))
1094      (%setf-macptr servent-ptr (#_getservbyname name proto))
1095      (unless (%null-ptr-p servent-ptr)
1096        (pref servent-ptr :servent.s_port)))))
1097
1098#+linuxppc-target
1099(defun _inet_ntoa (addr)
1100  (rlet ((addrp :unsigned))
1101    (setf (pref addrp :unsigned) addr)
1102    (with-macptrs ((p))
1103      (%setf-macptr p (#_inet_ntoa addrp))
1104      (unless (%null-ptr-p p) (%get-cstring p)))))
1105
1106;;; On all of these platforms, the argument is a (:struct :in_addr),
1107;;; a single word that should be passed by value.  The FFI translator
1108;;; seems to lose the :struct, so just using #_ doesn't work (that
1109;;; sounds like a bug in the FFI translator.)
1110#+(or darwin-target linuxx8664-target freebsd-target)
1111(defun _inet_ntoa (addr)
1112  (with-macptrs ((p))
1113    (%setf-macptr p (external-call #+darwin-target "_inet_ntoa"
1114                                   #-darwin-target "inet_ntoa"
1115                                   :unsigned-fullword addr
1116                                   :address))
1117    (unless (%null-ptr-p p) (%get-cstring p))))                           
1118
1119
1120(defun _inet_aton (string)
1121  (with-cstrs ((name string))
1122    (rlet ((addr :in_addr))
1123      (let* ((result #+freebsd-target (#___inet_aton name addr)
1124                     #-freebsd-target (#_inet_aton name addr)))
1125        (unless (eql result 0)
1126          (pref addr :in_addr.s_addr))))))
1127
1128(defun c_socket_1 (domain type protocol)
1129  #-linuxppc-target
1130  (syscall syscalls::socket domain type protocol)
1131  #+linuxppc-target
1132  (rlet ((params (:array :unsigned-long 3)))
1133    (setf (paref params (:* :unsigned-long) 0) domain
1134          (paref params (:* :unsigned-long) 1) type
1135          (paref params (:* :unsigned-long) 2) protocol)
1136    (syscall syscalls::socketcall 1 params)))
1137
1138(defun c_socket (domain type protocol)
1139  (let* ((fd (c_socket_1 domain type protocol)))
1140    (when (or (eql fd (- #$EMFILE))
1141              (eql fd (- #$ENFILE)))
1142      (gc)
1143      (drain-termination-queue)
1144      (setq fd (c_socket_1 domain type protocol)))
1145    fd))
1146     
1147
1148(defun init-unix-sockaddr (addr path)
1149  (macrolet ((sockaddr_un-path-len ()
1150               (/ (ensure-foreign-type-bits
1151                   (foreign-record-field-type 
1152                    (%find-foreign-record-type-field
1153                     (parse-foreign-type '(:struct :sockaddr_un)) :sun_path)))
1154                  8)))
1155    (let* ((name (native-translated-namestring path))
1156           (namelen (length name))
1157           (pathlen (sockaddr_un-path-len))
1158           (copylen (min (1- pathlen) namelen)))
1159      (setf (pref addr :sockaddr_un.sun_family) #$AF_LOCAL)
1160      (let* ((sun-path (pref addr :sockaddr_un.sun_path)))
1161        (dotimes (i copylen)
1162          (setf (%get-unsigned-byte sun-path i)
1163                (let* ((code (char-code (schar name i))))
1164                  (if (> code 255)
1165                    (char-code #\Sub)
1166                    code))))))))
1167
1168(defun bind-unix-socket (socketfd path)
1169  (rletz ((addr :sockaddr_un))
1170    (init-unix-sockaddr addr path)
1171    (socket-call
1172     nil
1173     "bind"
1174     (c_bind socketfd
1175             addr
1176             (+ 2
1177                (#_strlen
1178                 (pref addr :sockaddr_un.sun_path)))))))
1179     
1180
1181(defun c_bind (sockfd sockaddr addrlen)
1182  #+(or darwin-target linuxx8664-target freebsd-target)
1183  (progn
1184    #+(or darwin-target freebsd-target)
1185    (setf (pref sockaddr :sockaddr_in.sin_len) addrlen)
1186    (syscall syscalls::bind sockfd sockaddr addrlen))
1187  #+linuxppc-target
1188  (progn
1189    #+ppc32-target
1190    (%stack-block ((params 12))
1191      (setf (%get-long params 0) sockfd
1192            (%get-ptr params 4) sockaddr
1193            (%get-long params 8) addrlen)
1194      (syscall syscalls::socketcall 2 params))
1195    #+ppc64-target
1196    (%stack-block ((params 24))
1197      (setf (%%get-unsigned-longlong params 0) sockfd
1198            (%get-ptr params 8) sockaddr
1199            (%%get-unsigned-longlong params 16) addrlen)
1200      (syscall syscalls::socketcall 2 params))))
1201
1202
1203;;; If attempts to connnect are interrupted, we basically have to
1204;;; wait in #_select (or the equivalent).  There's a good rant
1205;;; about these issues in:
1206;;; <http://www.madore.org/~david/computers/connect-intr.html>
1207(defun c_connect (sockfd addr len &optional timeout)
1208  (let* ((err 
1209          #+(or darwin-target linuxx8664-target freebsd-target)
1210          (syscall syscalls::connect sockfd addr len)
1211          #+linuxppc-target
1212          (progn
1213            #+ppc32-target
1214            (%stack-block ((params 12))
1215              (setf (%get-long params 0) sockfd
1216                    (%get-ptr params 4) addr
1217                    (%get-long params 8) len)
1218              (syscall syscalls::socketcall 3 params))
1219            #+ppc64-target
1220            (%stack-block ((params 24))
1221              (setf (%%get-unsigned-longlong params 0) sockfd
1222                    (%get-ptr params 8) addr
1223                    (%%get-unsigned-longlong params 16) len)
1224              (syscall syscalls::socketcall 3 params)))))
1225    (cond ((or (eql err (- #$EINPROGRESS)) (eql err (- #$EINTR)))
1226           (if (process-output-wait fd timeout)
1227             (- (int-getsockopt fd #$SOL_SOCKET #$SO_ERROR))
1228             (- #$ETIMEDOUT)))
1229          (t err))))
1230
1231(defun c_listen (sockfd backlog)
1232  #+(or darwin-target linuxx8664-target freebsd-target)
1233  (syscall syscalls::listen sockfd backlog)
1234  #+linuxppc-target
1235  (progn
1236    #+ppc32-target
1237    (%stack-block ((params 8))
1238      (setf (%get-long params 0) sockfd
1239            (%get-long params 4) backlog)
1240      (syscall syscalls::socketcall 4 params))
1241    #+ppc64-target
1242    (%stack-block ((params 16))
1243      (setf (%%get-unsigned-longlong params 0) sockfd
1244            (%%get-unsigned-longlong params 8) backlog)
1245      (syscall syscalls::socketcall 4 params))))
1246
1247(defun c_accept (sockfd addrp addrlenp)
1248  (ignoring-eintr 
1249   #+(or darwin-target linuxx8664-target freebsd-target)
1250   (syscall syscalls::accept sockfd addrp addrlenp)
1251   #+linuxppc-target
1252   (progn
1253     #+ppc32-target
1254     (%stack-block ((params 12))
1255       (setf (%get-long params 0) sockfd
1256             (%get-ptr params 4) addrp
1257             (%get-ptr params 8) addrlenp)
1258       (syscall syscalls::socketcall 5 params))
1259     #+ppc64-target
1260     (%stack-block ((params 24))
1261       (setf (%%get-unsigned-longlong params 0) sockfd
1262             (%get-ptr params 8) addrp
1263             (%get-ptr params 16) addrlenp)
1264       (syscall syscalls::socketcall 5 params)))))
1265
1266(defun c_getsockname (sockfd addrp addrlenp)
1267  #+(or darwin-target linuxx8664-target freebsd-target)
1268  (syscall syscalls::getsockname sockfd addrp addrlenp)
1269  #+linuxppc-target
1270  (progn
1271    #+ppc32-target
1272    (%stack-block ((params 12))
1273      (setf (%get-long params 0) sockfd
1274            (%get-ptr params 4) addrp
1275            (%get-ptr params 8) addrlenp)
1276      (syscall syscalls::socketcall 6 params))
1277    #+ppc64-target
1278    (%stack-block ((params 24))
1279      (setf (%%get-unsigned-longlong params 0) sockfd
1280            (%get-ptr params 8) addrp
1281            (%get-ptr params 16) addrlenp)
1282      (syscall syscalls::socketcall 6 params))))
1283
1284(defun c_getpeername (sockfd addrp addrlenp)
1285  #+(or darwin-target linuxx8664-target freebsd-target)
1286  (syscall syscalls::getpeername sockfd addrp addrlenp)
1287  #+linuxppc-target
1288  (progn
1289    #+ppc32-target
1290    (%stack-block ((params 12))
1291      (setf (%get-long params 0) sockfd
1292            (%get-ptr params 4) addrp
1293            (%get-ptr params 8) addrlenp)
1294      (syscall syscalls::socketcall 7 params))
1295    #+ppc64-target
1296    (%stack-block ((params 24))
1297      (setf (%%get-unsigned-longlong params 0) sockfd
1298            (%get-ptr params 8) addrp
1299            (%get-ptr params 16) addrlenp)
1300      (syscall syscalls::socketcall 7 params))))
1301
1302(defun c_socketpair (domain type protocol socketsptr)
1303  #+(or darwin-target linuxx8664-target freebsd-target)
1304  (syscall syscalls::socketpair domain type protocol socketsptr)
1305  #+linuxppc-target
1306  (progn
1307    #+ppc32-target
1308    (%stack-block ((params 16))
1309      (setf (%get-long params 0) domain
1310            (%get-long params 4) type
1311            (%get-long params 8) protocol
1312            (%get-ptr params 12) socketsptr)
1313      (syscall syscalls::socketcall 8 params))
1314    #+ppc64-target
1315    (%stack-block ((params 32))
1316      (setf (%%get-unsigned-longlong params 0) domain
1317            (%%get-unsigned-longlong params 8) type
1318            (%%get-unsigned-longlong params 16) protocol
1319            (%get-ptr params 24) socketsptr)
1320      (syscall syscalls::socketcall 8 params))))
1321
1322
1323
1324(defun c_sendto (sockfd msgptr len flags addrp addrlen)
1325  #+(or darwin-target linuxx8664-target freebsd-target)
1326  (syscall syscalls::sendto sockfd msgptr len flags addrp addrlen)
1327  #+linuxppc-target
1328  (progn
1329    #+ppc32-target
1330    (%stack-block ((params 24))
1331      (setf (%get-long params 0) sockfd
1332            (%get-ptr params  4) msgptr
1333            (%get-long params 8) len
1334            (%get-long params 12) flags
1335            (%get-ptr params  16) addrp
1336            (%get-long params 20) addrlen)
1337      (syscall syscalls::socketcall 11 params))
1338    #+ppc64-target
1339    (%stack-block ((params 48))
1340      (setf (%%get-unsigned-longlong params 0) sockfd
1341            (%get-ptr params  8) msgptr
1342            (%%get-unsigned-longlong params 16) len
1343            (%%get-unsigned-longlong params 24) flags
1344            (%get-ptr params  32) addrp
1345            (%%get-unsigned-longlong params 40) addrlen)
1346      (syscall syscalls::socketcall 11 params))))
1347
1348(defun c_recvfrom (sockfd bufptr len flags addrp addrlenp)
1349  #+(or darwin-target linuxx8664-target freebsd-target)
1350  (syscall syscalls::recvfrom sockfd bufptr len flags addrp addrlenp)
1351  #+linuxppc-target
1352  (progn
1353    #+ppc32-target
1354    (%stack-block ((params 24))
1355      (setf (%get-long params 0) sockfd
1356            (%get-ptr params  4) bufptr
1357            (%get-long params 8) len
1358            (%get-long params 12) flags
1359            (%get-ptr params  16) addrp
1360            (%get-ptr params  20) addrlenp)
1361      (syscall syscalls::socketcall 12 params))
1362    #+ppc64-target
1363    (%stack-block ((params 48))
1364      (setf (%get-long params 0) sockfd
1365            (%get-ptr params  8) bufptr
1366            (%get-long params 16) len
1367            (%get-long params 24) flags
1368            (%get-ptr params  32) addrp
1369            (%get-ptr params  40) addrlenp)
1370      (syscall syscalls::socketcall 12 params))))
1371
1372(defun c_shutdown (sockfd how)
1373  #+(or darwin-target linuxx8664-target freebsd-target)
1374  (syscall syscalls::shutdown sockfd how)
1375  #+linuxppc-target
1376  (progn
1377    #+ppc32-target
1378    (%stack-block ((params 8))
1379      (setf (%get-long params 0) sockfd
1380            (%get-long params 4) how)
1381      (syscall syscalls::socketcall 13 params))
1382    #+ppc64-target
1383    (%stack-block ((params 16))
1384      (setf (%%get-unsigned-longlong params 0) sockfd
1385            (%%get-unsigned-longlong params 8) how)
1386      (syscall syscalls::socketcall 13 params))))
1387
1388(defun c_setsockopt (sockfd level optname optvalp optlen)
1389  #+(or darwin-target linuxx8664-target freebsd-target)
1390  (syscall syscalls::setsockopt sockfd level optname optvalp optlen)
1391  #+linuxppc-target
1392  (progn
1393    #+ppc32-target
1394    (%stack-block ((params 20))
1395      (setf (%get-long params 0) sockfd
1396            (%get-long params 4) level
1397            (%get-long params 8) optname
1398            (%get-ptr params 12) optvalp
1399            (%get-long params 16) optlen)
1400      (syscall syscalls::socketcall 14 params))
1401    #+ppc64-target
1402    (%stack-block ((params 40))
1403      (setf (%%get-unsigned-longlong params 0) sockfd
1404            (%%get-unsigned-longlong params 8) level
1405            (%%get-unsigned-longlong params 16) optname
1406            (%get-ptr params 24) optvalp
1407            (%%get-unsigned-longlong params 32) optlen)
1408      (syscall syscalls::socketcall 14 params))))
1409
1410(defun c_getsockopt (sockfd level optname optvalp optlenp)
1411  #+(or darwin-target linuxx8664-target freebsd-target)
1412  (syscall syscalls::getsockopt sockfd level optname optvalp optlenp)
1413  #+linuxppc-target
1414  (progn
1415    #+ppc32-target
1416    (%stack-block ((params 20))
1417      (setf (%get-long params 0) sockfd
1418            (%get-long params 4) level
1419            (%get-long params 8) optname
1420            (%get-ptr params 12) optvalp
1421            (%get-ptr params 16) optlenp)
1422      (syscall syscalls::socketcall 15 params))
1423    #+ppc64-target
1424    (%stack-block ((params 40))
1425      (setf (%%get-unsigned-longlong params 0) sockfd
1426            (%%get-unsigned-longlong params 8) level
1427            (%%get-unsigned-longlong params 16) optname
1428            (%get-ptr params 24) optvalp
1429            (%get-ptr params 32) optlenp)
1430      (syscall syscalls::socketcall 15 params))))
1431
1432(defun c_sendmsg (sockfd msghdrp flags)
1433  #+(or darwin-target linuxx8664-target freebsd-target)
1434  (syscall syscalls::sendmsg sockfd msghdrp flags)
1435  #+linuxppc-target
1436  (progn
1437    #+ppc32-target
1438    (%stack-block ((params 12))
1439      (setf (%get-long params 0) sockfd
1440            (%get-ptr params 4) msghdrp
1441            (%get-long params 8) flags)
1442      (syscall syscalls::socketcall 16 params))
1443    #+ppc64-target
1444    (%stack-block ((params 24))
1445      (setf (%%get-unsigned-longlong params 0) sockfd
1446            (%get-ptr params 8) msghdrp
1447            (%%get-unsigned-longlong params 16) flags)
1448      (syscall syscalls::socketcall 16 params))))
1449
1450(defun c_recvmsg (sockfd msghdrp flags)
1451  #+(or darwin-target linuxx8664-target freebsd-target)
1452  (syscall syscalls::recvmsg sockfd msghdrp flags)
1453  #+linuxppc-target
1454  (progn
1455    #+ppc32-target
1456    (%stack-block ((params 12))
1457      (setf (%get-long params 0) sockfd
1458            (%get-ptr params 4) msghdrp
1459            (%get-long params 8) flags)
1460      (syscall syscalls::socketcall 17 params))
1461    #+ppc64-target
1462    (%stack-block ((params 24))
1463      (setf (%%get-unsigned-longlong params 0) sockfd
1464            (%get-ptr params 8) msghdrp
1465            (%%get-unsigned-longlong params 16) flags)
1466      (syscall syscalls::socketcall 17 params))))
1467
1468;;; Return a list of currently configured interfaces, a la ifconfig.
1469(defstruct ip-interface
1470  name
1471  addr
1472  netmask
1473  flags
1474  address-family)
1475
1476(defun dump-buffer (p n)
1477  (dotimes (i n (progn (terpri) (terpri)))
1478    (unless (logtest i 15)
1479      (format t "~&~8,'0x: " (%ptr-to-int (%inc-ptr p i))))
1480    (format t " ~2,'0x" (%get-byte p i))))
1481
1482(defun %get-ip-interfaces ()
1483  (rlet ((p :address (%null-ptr)))
1484    (if (zerop (#_getifaddrs p))
1485      (unwind-protect
1486           (do* ((q (%get-ptr p) (pref q :ifaddrs.ifa_next))
1487                 (res ()))
1488                ((%null-ptr-p q) (nreverse res))
1489             (let* ((addr (pref q :ifaddrs.ifa_addr)))
1490               (when (and (not (%null-ptr-p addr))
1491                          (eql (pref addr :sockaddr.sa_family) #$AF_INET))
1492                 (push (make-ip-interface
1493                                   :name (%get-cstring (pref q :ifaddrs.ifa_name))
1494                                   :addr (pref addr :sockaddr_in.sin_addr.s_addr)
1495                                   :netmask (pref (pref q :ifaddrs.ifa_netmask)
1496                                                  :sockaddr_in.sin_addr.s_addr)
1497                                   :flags (pref q :ifaddrs.ifa_flags)
1498                                   :address-family #$AF_INET)
1499                       res))))
1500        (#_freeifaddrs (pref p :address))))))
1501
1502
1503(defloadvar *ip-interfaces* ())
1504
1505(defun ip-interfaces ()
1506  (or *ip-interfaces*
1507      (setq *ip-interfaces* (%get-ip-interfaces))))
1508
1509;;; This should presumably happen after a configuration change.
1510;;; How do we detect a configuration change ?
1511(defun %reset-ip-interfaces ()
1512  (setq *ip-interfaces* ()))
1513
1514;;; Return the first non-loopback interface that's up and whose address
1515;;; family is #$AF_INET.  If no such interface exists, return
1516;;; the loopback interface.
1517(defun primary-ip-interface ()
1518  (let* ((ifaces (ip-interfaces)))
1519    (or (find-if #'(lambda (i)
1520                     (and (eq #$AF_INET (ip-interface-address-family i))
1521                          (ip-interface-addr i)
1522                          (let* ((flags (ip-interface-flags i)))
1523                            (and (not (logtest #$IFF_LOOPBACK flags))
1524                                 (logtest #$IFF_UP flags)))))
1525                 ifaces)
1526        (car ifaces))))
1527
1528(defun primary-ip-interface-address ()
1529  (let* ((iface (primary-ip-interface)))
1530    (if iface
1531      (ip-interface-addr iface)
1532      (error "Can't determine primary IP interface"))))
1533         
1534         
1535(defmethod stream-io-error ((stream socket) errno where)
1536  (socket-error stream where errno))
Note: See TracBrowser for help on using the repository browser.