r9709: update policy
[kmrcl.git] / 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$
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 #+sbcl
22 (defun listen-to-inet-port (&key (port 0) (kind :stream) (reuse nil))
23   "Create, bind and listen to an inet socket on *:PORT.
24 setsockopt SO_REUSEADDR if :reuse is not nil"
25   (let ((socket (make-instance 'sb-bsd-sockets:inet-socket
26                                :type :stream
27                                :protocol :tcp)))
28     (if reuse
29         (setf (sb-bsd-sockets:sockopt-reuse-address socket) t))
30     (sb-bsd-sockets:socket-bind 
31      socket (sb-bsd-sockets:make-inet-address "0.0.0.0") port)
32     (sb-bsd-sockets:socket-listen socket 15)
33     socket))
34
35 (defun create-inet-listener (port &key (format :text) (reuse-address t))
36   #+cmu (ext:create-inet-listener port)
37   #+allegro
38   (socket:make-socket :connect :passive :local-port port :format format
39                       :address-family 
40                       (if (stringp port)
41                           :file
42                         (if (or (null port) (integerp port))
43                             :internet
44                           (error "illegal value for port: ~s" port)))
45                       :reuse-address reuse-address)
46   #+sbcl
47   (listen-to-inet-port :port port :reuse reuse-address)
48   #+clisp (ext:socket-server port)
49   #+openmcl 
50   (ccl:make-socket :connect :passive :local-port port
51                    :reuse-address reuse-address)
52   #-(or allegro clisp cmu sbcl openmcl)
53   (warn "create-inet-listener not supported on this implementation")
54   )
55
56 (defun make-fd-stream (socket &key input output element-type)
57   #+cmu
58   (sys:make-fd-stream socket :input input :output output
59                       :element-type element-type)
60   #+sbcl
61   (sb-bsd-sockets:socket-make-stream socket :input input :output output
62                                      :element-type element-type)
63   #-(or cmu sbcl) (declare (ignore input output element-type))
64   #-(or cmu sbcl) socket
65   )
66
67
68 (defun accept-tcp-connection (listener)
69   "Returns (VALUES stream socket)"
70   #+allegro
71   (let ((sock (socket:accept-connection listener)))
72     (values sock sock))
73   #+clisp
74   (let ((sock (ext:socket-accept listener)))
75     (values sock sock))
76   #+cmu
77   (progn
78     (mp:process-wait-until-fd-usable listener :input)
79     (let ((sock (nth-value 0 (ext:accept-tcp-connection listener))))
80       (values (sys:make-fd-stream sock :input t :output t) sock)))
81   #+sbcl
82   (when (sb-sys:wait-until-fd-usable
83          (sb-bsd-sockets:socket-file-descriptor listener) :input)
84     (let ((sock (sb-bsd-sockets:socket-accept listener)))
85       (values
86        (sb-bsd-sockets:socket-make-stream
87         sock :element-type 'base-char :input t :output t)
88        sock)))
89   #+openmcl 
90   (let ((sock (ccl:accept-connection listener :wait t)))
91     (values sock sock))
92   #-(or allegro clisp cmu sbcl openmcl)
93   (warn "accept-tcp-connection not supported on this implementation")
94   )
95
96
97 (defmacro errorset (form display)
98   `(handler-case
99     ,form
100     (error (e)
101      (declare (ignorable e))
102      (when ,display
103        (format t "~&Error: ~A~%" e)))))
104
105 (defun close-passive-socket (socket)
106   #+allegro (close socket)
107   #+clisp (close socket)
108   #+cmu (unix:unix-close socket)
109   #+sbcl (sb-unix:unix-close
110           (sb-bsd-sockets:socket-file-descriptor socket))
111   #+openmcl (close socket)
112   #-(or allegro clisp cmu sbcl openmcl)
113   (warn "close-passive-socket not supported on this implementation")
114   )
115
116
117 (defun close-active-socket (socket)
118   (close socket))
119
120 #+sbcl
121 (defun ipaddr-to-dotted (ipaddr &key values)
122   "Convert from 32-bit integer to dotted string."
123   (declare (type (unsigned-byte 32) ipaddr))
124   (let ((a (logand #xff (ash ipaddr -24)))
125         (b (logand #xff (ash ipaddr -16)))
126         (c (logand #xff (ash ipaddr -8)))
127         (d (logand #xff ipaddr)))
128     (if values
129         (values a b c d)
130       (format nil "~d.~d.~d.~d" a b c d))))
131
132 #+sbcl
133 (defun dotted-to-ipaddr (dotted &key (errorp t))
134   "Convert from dotted string to 32-bit integer."
135   (declare (string dotted))
136   (if errorp
137       (let ((ll (delimited-string-to-list dotted #\.)))
138         (+ (ash (first ll) 24) (ash (second ll) 16)
139            (ash (third ll) 8) (fourth ll)))
140     (ignore-errors
141       (let ((ll (delimited-string-to-list dotted #\.)))
142         (+ (ash (first ll) 24) (ash (second ll) 16)
143            (ash (third ll) 8) (fourth ll))))))
144
145 #+sbcl
146 (defun ipaddr-to-hostname (ipaddr &key ignore-cache)
147   (when ignore-cache
148     (warn ":IGNORE-CACHE keyword in IPADDR-TO-HOSTNAME not supported."))
149   (sb-bsd-sockets:host-ent-name
150    (sb-bsd-sockets:get-host-by-address
151     (sb-bsd-sockets:make-inet-address ipaddr))))
152
153 #+sbcl
154 (defun lookup-hostname (host &key ignore-cache)
155   (when ignore-cache
156     (warn ":IGNORE-CACHE keyword in LOOKUP-HOSTNAME not supported."))
157   (if (stringp host)
158       (sb-bsd-sockets:host-ent-address
159        (sb-bsd-sockets:get-host-by-name host))
160       (dotted-to-ipaddr (ipaddr-to-dotted host))))
161
162
163 (defun make-active-socket (server port)
164   "Returns (VALUES STREAM SOCKET)"
165   #+allegro
166   (let ((sock (socket:make-socket :remote-host server
167                                   :remote-port port)))
168     (values sock sock))
169   #+lispworks
170   (let ((sock (comm:open-tcp-stream server port)))
171     (values sock sock))
172   #+sbcl
173   (let ((sock (make-instance 'sb-bsd-sockets:inet-socket
174                              :type :stream
175                              :protocol :tcp)))
176     (sb-bsd-sockets:socket-connect sock (lookup-hostname server) port)
177     (values
178      (sb-bsd-sockets:socket-make-stream
179       sock :input t :output t :element-type 'base-char)
180      sock))
181   #+cmu
182   (let ((sock (ext:connect-to-inet-socket server port)))
183     (values
184      (sys:make-fd-stream sock :input t :output t :element-type 'base-char)
185      sock))
186   #+openmcl
187   (let ((sock (ccl:make-socket :remote-host server :remote-port port )))
188     (values sock sock))
189   )
190
191 (defun ipaddr-array-to-dotted (array)
192   (format nil "~{~D~^.~}" (coerce array 'list))
193   #+ignore
194   (format nil "~D.~D.~D.~D" 
195           (aref 0 array) (aref 1 array) (aref 2 array) (array 3 array)))
196
197 (defun remote-host (socket)
198   #+allegro (socket:ipaddr-to-dotted (socket:remote-host socket))
199   #+lispworks (nth-value 0 (comm:get-socket-peer-address socket))
200   #+sbcl (ipaddr-array-to-dotted 
201           (nth-value 0 (sb-bsd-sockets:socket-peername socket)))
202   #+cmu (nth-value 0 (ext:get-peer-host-and-port socket))
203   #+openmcl (ccl:remote-host socket)
204   )
205