Incorporate some decomposition information in ucd table
[sbcl.git] / contrib / sb-bsd-sockets / inet.lisp
index 3ea609e..ebe6e35 100644 (file)
 (in-package :sb-bsd-sockets)
 
-#|| <h2>INET-domain sockets</h2>
-
-<p>The TCP and UDP sockets that you know and love.  Some representation issues:
-<ul>
-<li>These functions do not accept hostnames directly: see <a href="#name-service">name resolution</a>
-<li>Internet <b>addresses</b> are represented by vectors of <tt>(unsigned-byte 8)</tt> - viz. <tt>#(127 0 0 1)</tt>.  <b>Ports</b> are just integers: <tt>6010</tt>.  No conversion between network- and host-order data is needed from the user of this package.
-<li><b><i>socket addresses</i></b> are represented by the two values for <b>address</b> and <b>port</b>, so for example, <tt>(<a href="#SOCKET-CONNECT">socket-connect</a> s #(192 168 1 1) 80)</tt>
-</ul>
-
-|#
-
 ;;; Our class and constructor
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass inet-socket (socket)
-    ((family :initform sockint::AF-INET))))
+    ((family :initform sockint::AF-INET))
+    (:documentation "Class representing TCP and UDP sockets.
+
+Examples:
+
+ (make-instance 'inet-socket :type :stream :protocol :tcp)
+
+ (make-instance 'inet-socket :type :datagram :protocol :udp)
+")))
 
 ;;; XXX should we *...* this?
 (defparameter inet-address-any (vector 0 0 0 0))
 
+(defmethod socket-namestring ((socket inet-socket))
+  (ignore-errors
+    (multiple-value-bind (addr port) (socket-name socket)
+      (format nil "~{~A~^.~}:~A" (coerce addr 'list) port))))
+
+(defmethod socket-peerstring ((socket inet-socket))
+  (ignore-errors
+    (multiple-value-bind (addr port) (socket-peername socket)
+      (format nil "~{~A~^.~}:~A" (coerce addr 'list) port))))
+
 ;;; binding a socket to an address and port.  Doubt that anyone's
 ;;; actually using this much, to be honest.
 
 (defun make-inet-address (dotted-quads)
   "Return a vector of octets given a string DOTTED-QUADS in the format
-\"127.0.0.1\""
-  (coerce
-   (mapcar #'parse-integer
-           (split dotted-quads nil '(#\.)))
-   'vector))
+\"127.0.0.1\". Signals an error if the string is malformed."
+  (declare (type string dotted-quads))
+  (labels ((oops ()
+             (error "~S is not a string designating an IP address."
+                    dotted-quads))
+           (check (x)
+             (if (typep x '(unsigned-byte 8))
+                 x
+                 (oops))))
+    (let* ((s1 (position #\. dotted-quads))
+           (s2 (if s1 (position #\. dotted-quads :start (1+ s1)) (oops)))
+           (s3 (if s2 (position #\. dotted-quads :start (1+ s2)) (oops)))
+           (u0 (parse-integer dotted-quads :end s1))
+           (u1 (parse-integer dotted-quads :start (1+ s1) :end s2))
+           (u2 (parse-integer dotted-quads :start (1+ s2) :end s3)))
+      (multiple-value-bind (u3 end) (parse-integer dotted-quads :start (1+ s3) :junk-allowed t)
+        (unless (= end (length dotted-quads))
+          (oops))
+        (let ((vector (make-array 4 :element-type '(unsigned-byte 8))))
+          (setf (aref vector 0) (check u0)
+                (aref vector 1) (check u1)
+                (aref vector 2) (check u2)
+                (aref vector 3) (check u3))
+          vector)))))
+
+(define-condition unknown-protocol ()
+  ((name :initarg :name
+         :reader unknown-protocol-name))
+  (:report (lambda (c s)
+             (format s "Protocol not found: ~a" (prin1-to-string
+                                                 (unknown-protocol-name c))))))
+
+#+(and sb-thread (not os-provides-getprotoby-r))
+;; Since getprotobyname is not thread-safe, we need a lock.
+(sb-ext:defglobal **getprotoby-lock** (sb-thread:make-mutex :name "getprotoby lock"))
 
 ;;; getprotobyname only works in the internet domain, which is why this
 ;;; is here
 (defun get-protocol-by-name (name)      ;exported
-  "Returns the network protocol number associated with the string NAME,
-using getprotobyname(2) which typically looks in NIS or /etc/protocols"
-  ;; for extra brownie points, could return canonical protocol name
-  ;; and aliases as extra values
-  (let ((ent (sb-grovel::foreign-vector (sockint::getprotobyname name) 1
-                                       sockint::size-of-protoent)))
-    (sockint::protoent-proto ent)))
-
-
-;;; sockaddr protocol
-;;; (1) sockaddrs are represented as the semi-foreign array-of-octets
-;;; thing
-;;; (2) a protocol provides make-sockaddr-for, size-of-sockaddr,
+  "Given a protocol name, return the protocol number, the protocol name, and
+a list of protocol aliases"
+
+  ;; Brownie Points.  Hopefully there's one person out there using
+  ;; RSPF sockets and SBCL who will appreciate the extra info
+  (labels ((protoent-to-values (protoent)
+             (values
+              (sockint::protoent-proto protoent)
+              (sockint::protoent-name protoent)
+              (let ((index 0))
+                (loop
+                  for alias = (sb-alien:deref
+                               (sockint::protoent-aliases protoent) index)
+                  while (not (sb-alien:null-alien alias))
+                  do (incf index)
+                  collect (sb-alien::c-string-to-string
+                           (sb-alien:alien-sap alias)
+                           (sb-impl::default-external-format)
+                           'character))))))
+    #+(and sb-thread os-provides-getprotoby-r)
+    (let ((buffer-length 1024)
+          (max-buffer 10000)
+          (result-buf nil)
+          (buffer nil)
+          #-solaris
+          (result nil))
+      (declare (type fixnum buffer-length)
+               (type fixnum max-buffer))
+      (loop
+        (unwind-protect
+             (progn
+               (setf result-buf (sb-alien:make-alien sockint::protoent)
+                     buffer (sb-alien:make-alien sb-alien:char buffer-length))
+               #-solaris
+               (setf result (sb-alien:make-alien (* sockint::protoent)))
+               (when (or (sb-alien:null-alien result-buf)
+                         (sb-alien:null-alien buffer)
+                         (sb-alien:null-alien result))
+                 (error "Could not allocate foreign memory."))
+               (let ((res (sockint::getprotobyname-r
+                           name result-buf buffer buffer-length #-solaris result)))
+                 (cond ((eql res 0)
+                        #-solaris
+                        (when (sb-alien::null-alien (sb-alien:deref result 0))
+                          (error 'unknown-protocol :name name))
+                        (return-from get-protocol-by-name
+                          (protoent-to-values result-buf)))
+                       (t
+                        (let ((errno (sb-unix::get-errno)))
+                          (cond ((eql errno sockint::erange)
+                                 (incf buffer-length 1024)
+                                 (when (> buffer-length max-buffer)
+                                   (error "Exceeded max-buffer of ~d" max-buffer)))
+                                (t
+                                 (error "Unexpected errno ~d" errno))))))))
+          (when result-buf
+            (sb-alien:free-alien result-buf))
+          (when buffer
+            (sb-alien:free-alien buffer))
+          #-solaris
+          (when result
+            (sb-alien:free-alien result)))))
+    #-(and sb-thread os-provides-getprotoby-r)
+    (tagbody
+       (flet ((get-it ()
+                (let ((ent (sockint::getprotobyname name)))
+                  (if (sb-alien::null-alien ent)
+                      (go :error)
+                      (return-from get-protocol-by-name (protoent-to-values ent))))))
+         #+sb-thread
+         (sb-thread::with-system-mutex (**getprotoby-lock**)
+           (get-it))
+         #-sb-thread
+         (get-it))
+     :error
+       (error 'unknown-protocol :name name))))
+
+;;; our protocol provides make-sockaddr-for, size-of-sockaddr,
 ;;; bits-of-sockaddr
 
 (defmethod make-sockaddr-for ((socket inet-socket) &optional sockaddr &rest address &aux (host (first address)) (port (second address)))
   (let ((sockaddr (or sockaddr (sockint::allocate-sockaddr-in))))
     (when (and host port)
+      (setf host (coerce host '(simple-array (unsigned-byte 8) (4))))
       ;; port and host are represented in C as "network-endian" unsigned
       ;; integers of various lengths.  This is stupid.  The value of the
       ;; integer doesn't matter (and will change depending on your
       ;; machine's endianness); what the bind(2) call is interested in
       ;; is the pattern of bytes within that integer.
-      
+
       ;; We have no truck with such dreadful type punning.  Octets to
       ;; octets, dust to dust.
-      
+
       (setf (sockint::sockaddr-in-family sockaddr) sockint::af-inet)
-      (setf (sockint::sockaddr-in-port sockaddr 0) (ldb (byte 8 8) port))
-      (setf (sockint::sockaddr-in-port sockaddr 1) (ldb (byte 8 0) port))
-      
-      (setf (sockint::sockaddr-in-addr sockaddr 0) (elt host 0))
-      (setf (sockint::sockaddr-in-addr sockaddr 1) (elt host 1))
-      (setf (sockint::sockaddr-in-addr sockaddr 2) (elt host 2))
-      (setf (sockint::sockaddr-in-addr sockaddr 3) (elt host 3)))
+      (setf (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 0) (ldb (byte 8 8) port))
+      (setf (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 1) (ldb (byte 8 0) port))
+
+      (setf (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) 0) (elt host 0))
+      (setf (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) 1) (elt host 1))
+      (setf (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) 2) (elt host 2))
+      (setf (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) 3) (elt host 3)))
     sockaddr))
 
+(defmethod free-sockaddr-for ((socket inet-socket) sockaddr)
+  (sockint::free-sockaddr-in sockaddr))
+
 (defmethod size-of-sockaddr ((socket inet-socket))
   sockint::size-of-sockaddr-in)
 
 (defmethod bits-of-sockaddr ((socket inet-socket) sockaddr)
   "Returns address and port of SOCKADDR as multiple values"
   (values
-   (vector
-    (sockint::sockaddr-in-addr sockaddr 0) 
-    (sockint::sockaddr-in-addr sockaddr 1) 
-    (sockint::sockaddr-in-addr sockaddr 2) 
-    (sockint::sockaddr-in-addr sockaddr 3))
-   (+ (* 256 (sockint::sockaddr-in-port sockaddr 0))
-      (sockint::sockaddr-in-port sockaddr 1))))  
-   
+   (coerce (loop for i from 0 below 4
+                 collect (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) i))
+           '(vector (unsigned-byte 8) 4))
+   (+ (* 256 (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 0))
+      (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 1))))
+
 (defun make-inet-socket (type protocol)
   "Make an INET socket.  Deprecated in favour of make-instance"
   (make-instance 'inet-socket :type type :protocol protocol))