sockets.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: modlisp -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          sockets.lisp
   6 ;;;; Purpose:       Socket functions
   7 ;;;; Programmer:    Kevin M. Rosenberg with excerpts from portableaserve
   8 ;;;; Date Started:  Jun 2003
   9 ;;;;
  10 ;;;; $Id: sockets.lisp,v 1.1 2003/07/08 16:12:40 kevin Exp $
  11 ;;;; *************************************************************************
  12
  13 (in-package #:kmrcl)
  14
  15 ;; Sockets
  16
  17 #+lispworks
  18 (progn
  19
  20 (define-condition lw-stream-error (error)
  21   ((stream :initarg :stream
  22            :reader stream-error-stream)
  23    (action :initarg :action
  24            :reader stream-error-action)
  25    (code :initarg :code
  26          :reader stream-error-code)
  27    (identifier :initarg :identifier
  28                :reader stream-error-identifier))
  29   (:report (lambda (condition stream)
  30              (format stream "A stream error occured (action=~A identifier=~A code=~A stream=~S)."
  31                      (stream-error-action condition)
  32                      (stream-error-identifier condition)
  33                      (stream-error-code condition)
  34                      (stream-error-stream condition)))))
  35
  36 (define-condition socket-error (lw-stream-error)
  37   ()
  38   (:report (lambda (condition stream)
  39              (format stream "A socket error occured (action=~A identifier=~A code=~A stream=~S)."
  40                      (stream-error-action condition)
  41                      (stream-error-identifier condition)
  42                      (stream-error-code condition)
  43                      (stream-error-stream condition)))))
  44
  45 (defclass socket ()
  46     ((passive-socket :type fixnum
  47                      :initarg :passive-socket
  48                      :reader socket-os-fd)))
  49
  50   (defclass passive-socket (socket)
  51     ((element-type :type (member signed-byte unsigned-byte base-char)
  52                    :initarg :element-type
  53                    :reader element-type)
  54      (port :type fixnum
  55            :initarg :port
  56            :reader local-port)))
  57
  58   (defmethod print-object ((passive-socket passive-socket) stream)
  59     (print-unreadable-object (passive-socket stream :type t :identity nil)
  60       (format stream "@~d on port ~d" (socket-os-fd passive-socket) (local-port passive-socket))))
  61
  62   (defclass binary-socket-stream (comm:socket-stream) ())
  63 (defclass input-binary-socket-stream (binary-socket-stream)())
  64 (defclass output-binary-socket-stream (binary-socket-stream)())
  65 (defclass bidirectional-binary-socket-stream (input-binary-socket-stream output-binary-socket-stream)())
  66
  67 #+unix
  68 (defun %socket-error-identifier (code)
  69   (case code
  70     (32 :x-broken-pipe)
  71     (98 :address-in-use)
  72     (99 :address-not-available)
  73     (100 :network-down)
  74     (102 :network-reset)
  75     (103 :connection-aborted)
  76     (104 :connection-reset)
  77     (105 :no-buffer-space)
  78     (108 :shutdown)
  79     (110 :connection-timed-out)
  80     (111 :connection-refused)
  81     (112 :host-down)
  82     (113 :host-unreachable)
  83     (otherwise :unknown)))
  84
  85 #+win32
  86 (defun %socket-error-identifier (code)
  87   (case code
  88     (10048 :address-in-use)
  89     (10049 :address-not-available)
  90     (10050 :network-down)
  91     (10052 :network-reset)
  92     (10053 :connection-aborted)
  93     (10054 :connection-reset)
  94     (10055 :no-buffer-space)
  95     (10058 :shutdown)
  96     (10060 :connection-timed-out)
  97     (10061 :connection-refused)
  98     (10064 :host-down)
  99     (10065 :host-unreachable)
 100     (otherwise :unknown)))
 101
 102 (defun socket-error (stream error-code action format-string &rest format-args)
 103   (let ((code (if (numberp error-code) error-code #+unix(lw:errno-value))))
 104     (error 'socket-error :stream stream :code code
 105            :identifier (if (keywordp error-code)
 106                            error-code
 107                          (%socket-error-identifier error-code))
 108            :action action
 109            :format-control "~A occured while doing socket IO (~?)"
 110            :format-arguments (list 'socket-error format-string format-args))))
 111
 112
 113 (defmethod comm::socket-error ((stream binary-socket-stream) error-code format-string &rest format-args)
 114   (apply #'socket-error stream error-code :IO format-string format-args))
 115
 116 (defmethod stream-input-available ((fd fixnum))
 117   (comm::socket-listen fd))
 118
 119 (defmethod stream-input-available ((stream stream::os-file-handle-stream))
 120   (stream-input-available (stream::os-file-handle-stream-file-handle stream)))
 121
 122 (defmethod stream-input-available ((stream comm:socket-stream))
 123   (or (comm::socket-listen (comm:socket-stream-socket stream))
 124       (listen stream)))
 125
 126 (defmethod stream-input-available ((stream passive-socket))
 127   (comm::socket-listen (socket-os-fd stream)))
 128
 129 (defun %new-passive-socket (local-port)
 130   (multiple-value-bind (socket error-location error-code)
 131       (comm::create-tcp-socket-for-service local-port)
 132     (cond (socket socket)
 133           (t (error 'socket-error :action error-location :code error-code :identifier :unknown)))))
 134
 135 ) ;; lispworks
 136
 137 #+sbcl
 138 (defun listen-to-inet-port (&key (port 0) (kind :stream) (reuse nil))
 139   "Create, bind and listen to an inet socket on *:PORT.
 140 setsockopt SO_REUSEADDR if :reuse is not nil"
 141   (let ((socket (make-instance 'sb-bsd-sockets:inet-socket
 142                                :type :stream
 143                                :protocol :tcp)))
 144     (if reuse
 145         (setf (sb-bsd-sockets:sockopt-reuse-address socket) t))
 146     (sb-bsd-sockets:socket-bind
 147      socket (sb-bsd-sockets:make-inet-address "0.0.0.0") port)
 148     (sb-bsd-sockets:socket-listen socket 15)
 149     socket))
 150
 151 (defun create-inet-listener (port &key (format :text) (reuse-address t))
 152   #+cmu (ext:create-inet-listener port)
 153   #+allegro
 154   (socket:make-socket :connect :passive :local-port port :format :binary
 155                       :address-family
 156                       (if (stringp port)
 157                           :file
 158                         (if (or (null port) (integerp port))
 159                             :internet
 160                           (error "illegal value for port: ~s" port)))
 161                       :reuse-address reuse-address)
 162   #+sbcl
 163   (listen-to-inet-port :port port :reuse reuse-address)
 164   #+clisp (ext:socket-server port)
 165   #+lispworks
 166   (let ((comm::*use_so_reuseaddr* reuse-address))
 167     (make-instance 'passive-socket
 168                    :port port
 169                    :passive-socket (%new-passive-socket port)
 170                    :element-type (case format
 171                                    (:text 'base-char))))
 172   )
 173
 174 (defun make-fd-stream (socket &key input output element-type)
 175   #+cmu
 176   (sys:make-fd-stream socket :input input :output output
 177                       :element-type element-type)
 178   #+sbcl
 179   (sb-bsd-sockets:socket-make-stream socket :input input :output output
 180                                      :element-type element-type)
 181   #-(or cmu sbcl) (declare (ignore input output element-type))
 182   #-(or cmu sbcl) socket
 183   )
 184
 185
 186 (defun accept-tcp-connection (listener)
 187   #+cmu
 188   (progn
 189     (mp:process-wait-until-fd-usable listener :input)
 190     (sys:make-fd-stream
 191      (nth-value 0 (ext:accept-tcp-connection listener))
 192      :input t :output t))
 193   #+sbcl
 194   (when (sb-sys:wait-until-fd-usable
 195          (sb-bsd-sockets:socket-file-descriptor listener) :input)
 196     (sb-bsd-sockets:socket-make-stream
 197      (sb-bsd-sockets:socket-accept listener)
 198      :element-type 'base-char
 199      :input t :output t))
 200   #+allegro
 201   (socket:accept-connection listener)
 202   #+clisp
 203   (ext:socket-accept listener)
 204   #+lispworks
 205   (progn
 206     (loop while (not (stream-input-available listener))
 207           do (sleep 1))
 208     (make-instance 'bidirectional-binary-socket-stream
 209                    :socket (comm::get-fd-from-socket
 210                             (socket-os-fd listener))
 211                    :direction :io
 212                    :element-type (element-type listener)))
 213
 214   )
 215
 216
 217 (defmacro errorset (form display)
 218   `(handler-case
 219     ,form
 220     (error (e)
 221      (declare (ignorable e))
 222      (when ,display
 223        (format t "~&Error: ~A~%" e)))))
 224
 225 (defun close-passive-socket (socket)
 226   #+allegro (close socket)
 227   #+cmu (unix:unix-close socket)
 228   #+sbcl (sb-unix:unix-close
 229           (sb-bsd-sockets:socket-file-descriptor socket))
 230   #+clisp (close socket)
 231   #+lispworks (comm::close-socket (socket-os-fd socket))
 232   )
 233
 234
 235 (defun close-active-socket (socket)
 236   (close socket))
 237
 238 #+sbcl
 239 (defun ipaddr-to-dotted (ipaddr &key values)
 240   "Convert from 32-bit integer to dotted string."
 241   (declare (type (unsigned-byte 32) ipaddr))
 242   (let ((a (logand #xff (ash ipaddr -24)))
 243         (b (logand #xff (ash ipaddr -16)))
 244         (c (logand #xff (ash ipaddr -8)))
 245         (d (logand #xff ipaddr)))
 246     (if values
 247         (values a b c d)
 248       (format nil "~d.~d.~d.~d" a b c d))))
 249
 250 #+sbcl
 251 (defun dotted-to-ipaddr (dotted &key (errorp t))
 252   "Convert from dotted string to 32-bit integer."
 253   (declare (string dotted))
 254   (if errorp
 255       (let ((ll (string-tokens (substitute #\Space #\. dotted))))
 256         (+ (ash (first ll) 24) (ash (second ll) 16)
 257            (ash (third ll) 8) (fourth ll)))
 258     (ignore-errors
 259         (let ((ll (string-tokens (substitute #\Space #\. dotted))))
 260           (+ (ash (first ll) 24) (ash (second ll) 16)
 261              (ash (third ll) 8) (fourth ll))))))
 262
 263 #+sbcl
 264 (defun ipaddr-to-hostname (ipaddr &key ignore-cache)
 265   (when ignore-cache
 266     (warn ":IGNORE-CACHE keyword in IPADDR-TO-HOSTNAME not supported."))
 267   (sb-bsd-sockets:host-ent-name
 268    (sb-bsd-sockets:get-host-by-address
 269     (sb-bsd-sockets:make-inet-address ipaddr))))
 270
 271 #+sbcl
 272 (defun lookup-hostname (host &key ignore-cache)
 273   (when ignore-cache
 274     (warn ":IGNORE-CACHE keyword in LOOKUP-HOSTNAME not supported."))
 275   (if (stringp host)
 276       (sb-bsd-sockets:host-ent-address
 277        (sb-bsd-sockets:get-host-by-name host))
 278       (dotted-to-ipaddr (ipaddr-to-dotted host))))
 279
 280
 281 (defun make-active-socket (server port)
 282   #+allegro (socket:make-socket :remote-host server
 283                                 :remote-port port)
 284   #+lispworks (comm:open-tcp-stream server port)
 285   #+sbcl (let ((socket (make-instance 'sb-bsd-sockets:inet-socket
 286                                       :type :stream
 287                                       :protocol :tcp)))
 288            (sb-bsd-sockets:socket-connect
 289             socket (lookup-hostname server) port)
 290            (sb-bsd-sockets:socket-make-stream socket
 291                                               :input t
 292                                               :output t
 293                                               :element-type 'base-char))
 294   #+cmu
 295   (sys:make-fd-stream (ext:connect-to-inet-socket host port)
 296                       :input t :output t :element-type 'base-char)
 297   )