X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=contrib%2Fsb-bsd-sockets%2Fsockets.lisp;h=ed863ae226233c7c0230c3e69e4986fb545fce9b;hb=b27852e74e11ccc9808305a73d815a4a67d77963;hp=6cff161b583e0909a86d891b2fc0db9215c928f3;hpb=c03ebb54770cfa613d4b706a80e5be231786a5d0;p=sbcl.git diff --git a/contrib/sb-bsd-sockets/sockets.lisp b/contrib/sb-bsd-sockets/sockets.lisp index 6cff161..ed863ae 100644 --- a/contrib/sb-bsd-sockets/sockets.lisp +++ b/contrib/sb-bsd-sockets/sockets.lisp @@ -5,9 +5,12 @@ (eval-when (:load-toplevel :compile-toplevel :execute) -#+win32 -(defvar *wsa-startup-call* - (sockint::wsa-startup (sockint::make-wsa-version 2 2))) + +;;; Winsock is different w.r.t errno +(defun socket-errno () + "Get socket error code, usually from errno, but see #+win32." + #+win32 (sockint::wsa-get-last-error) + #-win32 (sb-unix::get-errno)) (defclass socket () ((file-descriptor :initarg :descriptor @@ -23,15 +26,28 @@ protocol. Other values are used as-is.") (type :initarg :type :reader socket-type :documentation "Type of the socket: :STREAM or :DATAGRAM.") + #+win32 + (non-blocking-p :type (member t nil) :initform nil) (stream)) - (:documentation "Common base class of all sockets, not ment to be + (:documentation "Common base class of all sockets, not meant to be directly instantiated."))) (defmethod print-object ((object socket) stream) (print-unreadable-object (object stream :type t :identity t) - (princ "descriptor " stream) - (princ (slot-value object 'file-descriptor) stream))) + (format stream "~@[~A, ~]~@[peer: ~A, ~]fd: ~A" + (socket-namestring object) + (socket-peerstring object) + (slot-value object 'file-descriptor)))) + +(defgeneric socket-namestring (socket)) + +(defmethod socket-namestring (socket) + nil) + +(defgeneric socket-peerstring (socket)) +(defmethod socket-peerstring (socket) + nil) (defmethod shared-initialize :after ((socket socket) slot-names &key protocol type @@ -52,7 +68,8 @@ directly instantiated."))) (setf (slot-value socket 'file-descriptor) fd (slot-value socket 'protocol) proto-num (slot-value socket 'type) type) - (sb-ext:finalize socket (lambda () (sockint::close fd))))) + (sb-ext:finalize socket (lambda () (sockint::close fd)) + :dont-save t))) @@ -100,7 +117,9 @@ values")) sockaddr (size-of-sockaddr socket)))) (cond - ((and (= fd -1) (= sockint::EAGAIN (sb-unix::get-errno))) + ((and (= fd -1) + (member (socket-errno) + (list sockint::EAGAIN sockint::EINTR))) nil) ((= fd -1) (socket-error "accept")) (t (apply #'values @@ -108,7 +127,8 @@ values")) :type (socket-type socket) :protocol (socket-protocol socket) :descriptor fd))) - (sb-ext:finalize s (lambda () (sockint::close fd)))) + (sb-ext:finalize s (lambda () (sockint::close fd)) + :dont-save t)) (multiple-value-list (bits-of-sockaddr socket sockaddr)))))))) (defgeneric socket-connect (socket &rest address) @@ -158,25 +178,27 @@ values")) (defgeneric socket-receive (socket buffer length &key - oob peek waitall element-type) - (:documentation "Read LENGTH octets from SOCKET into BUFFER (or a freshly-consed buffer if -NIL), using recvfrom(2). If LENGTH is NIL, the length of BUFFER is -used, so at least one of these two arguments must be non-NIL. If -BUFFER is supplied, it had better be of an element type one octet wide. -Returns the buffer, its length, and the address of the peer -that sent it, as multiple values. On datagram sockets, sets MSG_TRUNC -so that the actual packet length is returned even if the buffer was too -small")) + oob peek waitall dontwait element-type) + (:documentation + "Read LENGTH octets from SOCKET into BUFFER (or a freshly-consed +buffer if NIL), using recvfrom(2). If LENGTH is NIL, the length of +BUFFER is used, so at least one of these two arguments must be +non-NIL. If BUFFER is supplied, it had better be of an element type +one octet wide. Returns the buffer, its length, and the address of the +peer that sent it, as multiple values. On datagram sockets, sets +MSG_TRUNC so that the actual packet length is returned even if the +buffer was too small.")) (defmethod socket-receive ((socket socket) buffer length &key - oob peek waitall + oob peek waitall dontwait (element-type 'character)) (with-sockaddr-for (socket sockaddr) (let ((flags (logior (if oob sockint::MSG-OOB 0) (if peek sockint::MSG-PEEK 0) (if waitall sockint::MSG-WAITALL 0) + (if dontwait sockint::MSG-DONTWAIT 0) #+linux sockint::MSG-NOSIGNAL ;don't send us SIGPIPE (if (eql (socket-type socket) :datagram) sockint::msg-TRUNC 0)))) @@ -204,9 +226,12 @@ small")) sockaddr (sb-alien:addr sa-len)))) (cond - ((and (= len -1) (= sockint::EAGAIN (sb-unix::get-errno))) nil) + ((and (= len -1) + (member (socket-errno) + (list sockint::EAGAIN sockint::EINTR))) + nil) ((= len -1) (socket-error "recvfrom")) - (t (loop for i from 0 below len + (t (loop for i from 0 below (min len length) do (setf (elt buffer i) (cond ((or (eql element-type 'character) (eql element-type 'base-char)) @@ -216,6 +241,76 @@ small")) (bits-of-sockaddr socket sockaddr))))))) (sb-alien:free-alien copy-buffer)))))) +(defmacro with-vector-sap ((name vector) &body body) + `(sb-sys:with-pinned-objects (,vector) + (let ((,name (sb-sys:vector-sap ,vector))) + ,@body))) + +(defgeneric socket-send (socket buffer length + &key + address + external-format + oob eor dontroute dontwait nosignal + #+linux confirm #+linux more) + (:documentation + "Send LENGTH octets from BUFFER into SOCKET, using sendto(2). If BUFFER +is a string, it will converted to octets according to EXTERNAL-FORMAT. If +LENGTH is NIL, the length of the octet buffer is used. The format of ADDRESS +depends on the socket type (for example for INET domain sockets it would +be a list of an IP address and a port). If no socket address is provided, +send(2) will be called instead. Returns the number of octets written.")) + +(defmethod socket-send ((socket socket) buffer length + &key + address + (external-format :default) + oob eor dontroute dontwait nosignal + #+linux confirm #+linux more) + (let* ((flags + (logior (if oob sockint::MSG-OOB 0) + (if eor sockint::MSG-EOR 0) + (if dontroute sockint::MSG-DONTROUTE 0) + (if dontwait sockint::MSG-DONTWAIT 0) + #-darwin (if nosignal sockint::MSG-NOSIGNAL 0) + #+linux (if confirm sockint::MSG-CONFIRM 0) + #+linux (if more sockint::MSG-MORE 0))) + (buffer (etypecase buffer + (string + (sb-ext:string-to-octets buffer + :external-format external-format + :null-terminate nil)) + ((simple-array (unsigned-byte 8)) + buffer) + ((array (unsigned-byte 8)) + (make-array (length buffer) + :element-type '(unsigned-byte 8) + :initial-contents buffer)))) + (len (with-vector-sap (buffer-sap buffer) + (unless length + (setf length (length buffer))) + (if address + (with-sockaddr-for (socket sockaddr address) + (sb-alien:with-alien ((sa-len sockint::socklen-t + (size-of-sockaddr socket))) + (sockint::sendto (socket-file-descriptor socket) + buffer-sap + length + flags + sockaddr + sa-len))) + (sockint::send (socket-file-descriptor socket) + buffer-sap + length + flags))))) + (cond + ((and (= len -1) + (member (socket-errno) + (list sockint::EAGAIN sockint::EINTR))) + nil) + ((= len -1) + (socket-error "sendto")) + (t len)))) + (defgeneric socket-listen (socket backlog) (:documentation "Mark SOCKET as willing to accept incoming connections. BACKLOG defines the maximum length that the queue of pending connections may @@ -236,12 +331,14 @@ grow to before new connection attempts are refused. See also listen(2)")) (open-stream-p (slot-value socket 'stream)) (/= -1 (socket-file-descriptor socket)))) -(defgeneric socket-close (socket) - (:documentation "Close SOCKET. May throw any kind of error that -write(2) would have thrown. If SOCKET-MAKE-STREAM has been called, -calls CLOSE on that stream instead")) +(defgeneric socket-close (socket &key abort) + (:documentation + "Close SOCKET, unless it was already closed. + +If SOCKET-MAKE-STREAM has been called, calls CLOSE using ABORT on that stream. +Otherwise closes the socket file descriptor using close(2).")) -(defmethod socket-close ((socket socket)) +(defmethod socket-close ((socket socket) &key abort) ;; the close(2) manual page has all kinds of warning about not ;; checking the return value of close, on the grounds that an ;; earlier write(2) might have returned successfully w/o actually @@ -254,42 +351,111 @@ calls CLOSE on that stream instead")) ;; the socket will avoid doing anything to close the fd in case ;; the stream has done it already - if so, it may have been ;; reassigned to some other file, and closing it would be bad - (let ((fd (socket-file-descriptor socket))) - (cond ((eql fd -1) ; already closed - nil) - ((slot-boundp socket 'stream) - (unwind-protect (close (slot-value socket 'stream)) ;; closes fd + (flet ((drop-it (&optional streamp) (setf (slot-value socket 'file-descriptor) -1) - (slot-makunbound socket 'stream))) - (t - (sb-ext:cancel-finalization socket) - (handler-case - (if (= (sockint::close fd) -1) - (socket-error "close")) - (bad-file-descriptor-error (c) (declare (ignore c)) nil) - (:no-error (c) - (declare (ignore c)) - (setf (slot-value socket 'file-descriptor) -1) - nil)))))) - - -(defgeneric socket-make-stream (socket &rest args) + (if streamp + (slot-makunbound socket 'stream) + (sb-ext:cancel-finalization socket)) + t)) + (cond ((eql fd -1) + ;; already closed + nil) + ((slot-boundp socket 'stream) + (close (slot-value socket 'stream) :abort abort) + ;; Don't do this if there was an error from CLOSE -- the stream is + ;; still live. + (drop-it t)) + (t + (handler-case + (when (minusp (sockint::close fd)) + (socket-error "close")) + (bad-file-descriptor-error () + (drop-it)) + (:no-error (r) + (declare (ignore r)) + (drop-it)))))))) + +(defgeneric socket-shutdown (socket &key direction) + (:documentation + "Indicate that no communication in DIRECTION will be performed on SOCKET. + +DIRECTION has to be one of :INPUT, :OUTPUT or :IO. + +After a shutdown, no input and/or output of the indicated DIRECTION +can be performed on SOCKET.")) + +(defmethod socket-shutdown ((socket socket) &key direction) + (let* ((fd (socket-file-descriptor socket)) + (how (ecase direction + (:input sockint::SHUT_RD) + (:output sockint::SHUT_WR) + (:io sockint::SHUT_RDWR)))) + (when (minusp (sockint::shutdown fd how)) + (socket-error "shutdown")))) + +(defgeneric socket-make-stream (socket &key input output + element-type external-format + buffering + timeout) (:documentation "Find or create a STREAM that can be used for IO on -SOCKET (which must be connected). ARGS are passed onto -SB-SYS:MAKE-FD-STREAM.")) - -(defmethod socket-make-stream ((socket socket) &rest args) +SOCKET \(which must be connected\). Specify whether the stream is for +INPUT, OUTPUT, or both \(it is an error to specify neither\). ELEMENT-TYPE +and EXTERNAL-FORMAT are as per OPEN. TIMEOUT specifies a read timeout +for the stream.")) + +(defmethod socket-make-stream ((socket socket) + &key input output + (element-type 'character) + (buffering :full) + (external-format :default) + timeout + auto-close + serve-events) + "Default method for SOCKET objects. + +ELEMENT-TYPE defaults to CHARACTER, to construct a bivalent stream, +capable of both binary and character IO use :DEFAULT. + +Acceptable values for BUFFERING are :FULL, :LINE and :NONE, default +is :FULL, ie. output is buffered till it is explicitly flushed using +CLOSE or FINISH-OUTPUT. (FORCE-OUTPUT forces some output to be +flushed: to ensure all buffered output is flused use FINISH-OUTPUT.) + +Streams have no TIMEOUT by default. If one is provided, it is the +number of seconds the system will at most wait for input to appear on +the socket stream when trying to read from it. + +If AUTO-CLOSE is true, the underlying OS socket is automatically +closed after the stream and the socket have been garbage collected. +Default is false. + +If SERVE-EVENTS is true, blocking IO on the socket will dispatch to +the recursive event loop. Default is false. + +The stream for SOCKET will be cached, and a second invocation of this +method will return the same stream. This may lead to oddities if this +function is invoked with inconsistent arguments \(e.g., one might +request an input stream and get an output stream in response\)." (let ((stream (and (slot-boundp socket 'stream) (slot-value socket 'stream)))) (unless stream - (setf stream (apply #'sb-sys:make-fd-stream - (socket-file-descriptor socket) - :name "a constant string" - :dual-channel-p t - args)) - (setf (slot-value socket 'stream) stream) - (sb-ext:cancel-finalization socket)) + (setf stream (sb-sys:make-fd-stream + (socket-file-descriptor socket) + :name (format nil "socket~@[ ~A~]~@[, peer: ~A~]" + (socket-namestring socket) + (socket-peerstring socket)) + :dual-channel-p t + :input input + :output output + :element-type element-type + :buffering buffering + :external-format external-format + :timeout timeout + :auto-close auto-close + :serve-events (and serve-events #+win32 nil))) + (setf (slot-value socket 'stream) stream)) + (sb-ext:cancel-finalization socket) stream)) @@ -308,7 +474,9 @@ SB-SYS:MAKE-FD-STREAM.")) (socket-error-syscall c) (or (socket-error-symbol c) (socket-error-errno c)) #+cmu (sb-unix:get-unix-error-msg num) - #+sbcl (sb-int:strerror num))))) + #+sbcl + #+win32 (sb-win32:format-system-message num) + #-win32 (sb-int:strerror num))))) (:documentation "Common base class of socket related conditions.")) ;;; watch out for slightly hacky symbol punning: we use both the value @@ -360,7 +528,7 @@ SB-SYS:MAKE-FD-STREAM.")) ;; FIXME: Our Texinfo documentation extracter need at least his to spit ;; out the signature. Real documentation would be better... "" - (let* ((errno (sb-unix::get-errno)) + (let* ((errno (socket-errno)) (condition (condition-for-errno errno))) (error condition :errno errno :syscall where)))