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

Last change on this file since 10288 was 10288, checked in by gb, 11 years ago

Fix linuxppc conditionalization in C_SETSOCKOPT.

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