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