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

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

_inet_ntoa: conditionalize for 32-bit x86 linux, too. (Maybe just
#-linuxppc-target ?)

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