(in-package :sb-bsd-sockets)
-#||
-<H2> Socket Options </h2>
-<a name="sockopt"> </a>
-<p> A subset of socket options are supported, using a fairly
-general framework which should make it simple to add more as required
-- see sockopt.lisp for details. The name mapping from C is fairly
-straightforward: <tt>SO_RCVLOWAT</tt> becomes
-<tt>sockopt-receive-low-water</tt> and <tt>(setf
-sockopt-receive-low-water)</tt>.
-||#
-
#|
getsockopt(socket, level, int optname, void *optval, socklen_t *optlen)
setsockopt(socket, level, int optname, void *optval, socklen_t optlen)
fact that most of these take different data types - some are integers,
some are booleans, some are foreign struct instances, etc etc
-(define-socket-option lisp-name level number mangle-arg size mangle-return)
+ (define-socket-option lisp-name doc level number mangle-arg size mangle-return)
macro-expands to two functions that define lisp-name and (setf ,lisp-name)
and calls the functions mangle-arg and mangle-return on outgoing and incoming
Code for options that not every system has should be conditionalised:
-(if (boundp 'sockint::IP_RECVIF)
- (define-socket-option so-receive-interface (getprotobyname "ip")
- sockint::IP_RECVIF ... ))
-
-
+ (if (boundp 'sockint::IP_RECVIF)
+ (define-socket-option so-receive-interface nil (getprotobyname "ip")
+ sockint::IP_RECVIF ... ))
|#
(defmacro define-socket-option
- (lisp-name level number mangle-arg size mangle-return)
+ (lisp-name documentation
+ level number buffer-type mangle-arg mangle-return mangle-setf-buffer
+ &optional features info)
(let ((find-level
(if (numberp (eval level))
level
- `(get-protocol-by-name ,(string-downcase (symbol-name level))))))
+ `(get-protocol-by-name ,(string-downcase (symbol-name level)))))
+ (supportedp (or (null features) (featurep features))))
`(progn
(export ',lisp-name)
- (defun ,lisp-name (socket &aux (fd (socket-file-descriptor socket)))
- (let ((buf (make-array sockint::size-of-int
- :element-type '(unsigned-byte 8)
- :initial-element 0)))
- (sb-sys:with-pinned-objects (buf)
- (if (= -1 (sockint::getsockopt
- fd ,find-level ,number (sockint::array-data-address buf) ,size))
- (socket-error "getsockopt")
- (,mangle-return buf ,size)))))
- (defun (setf ,lisp-name) (new-val socket
- &aux (fd (socket-file-descriptor socket)))
- (if (= -1
- (sb-sys:without-gcing
- (sockint::setsockopt
- fd ,find-level ,number (funcall (function ,mangle-arg) new-val ,size)
- ,size)))
- (socket-error "setsockopt"))))))
+ (defun ,lisp-name (socket)
+ ,@(when documentation (list (concatenate 'string documentation " " info)))
+ ,(if supportedp
+ `(sb-alien:with-alien ((size sb-alien:int)
+ (buffer ,buffer-type))
+ (setf size (sb-alien:alien-size ,buffer-type :bytes))
+ (if (= -1 (sockint::getsockopt (socket-file-descriptor socket)
+ ,find-level ,number
+ (sb-alien:addr buffer)
+ (sb-alien:addr size)))
+ (socket-error "getsockopt")
+ (,mangle-return buffer size)))
+ `(error 'unsupported-operator
+ :format-control "Socket option ~S is not supported in this platform."
+ :format-arguments (list ',lisp-name))))
+ (defun (setf ,lisp-name) (new-val socket)
+ ,(if supportedp
+ `(sb-alien:with-alien ((buffer ,buffer-type))
+ (setf buffer ,(if mangle-arg
+ `(,mangle-arg new-val)
+ `new-val))
+ (when (= -1 (sockint::setsockopt (socket-file-descriptor socket)
+ ,find-level ,number
+ (,mangle-setf-buffer buffer)
+ ,(if (eql buffer-type 'sb-alien:c-string)
+ `(length new-val)
+ `(sb-alien:alien-size ,buffer-type :bytes))))
+ (socket-error "setsockopt")))
+ `(error 'unsupported-operator
+ :format-control "Socket option ~S is not supported on this platform."
+ :format-arguments (list ',lisp-name)))))))
;;; sockopts that have integer arguments
-(defun int-to-foreign (x size)
- ;; can't use with-alien, as the variables it creates only have
- ;; dynamic scope. can't use the passed-in size because sap-alien
- ;; is a macro and evaluates its second arg at read time
- (let* ((v (make-array size :element-type '(unsigned-byte 8)
- :initial-element 0))
- (d (sockint::array-data-address v))
- (alien (sb-alien:sap-alien
- d; (sb-sys:int-sap d)
- (* (sb-alien:signed #.(* 8 sockint::size-of-int))))))
- (setf (sb-alien:deref alien 0) x)
- alien))
-
-(defun buffer-to-int (x size)
- (declare (ignore size))
- (let ((alien (sb-alien:sap-alien
- (sockint::array-data-address x)
- (* (sb-alien:signed #.(* 8 sockint::size-of-int))))))
- (sb-alien:deref alien)))
-
-(defmacro define-socket-option-int (name level number)
- `(define-socket-option ,name ,level ,number
- int-to-foreign sockint::size-of-int buffer-to-int))
+(defun foreign-int-to-integer (buffer size)
+ (assert (= size (sb-alien:alien-size sb-alien:int :bytes)))
+ buffer)
+
+(defmacro define-socket-option-int (name level number &optional features (info ""))
+ `(define-socket-option ,name nil ,level ,number
+ sb-alien:int nil foreign-int-to-integer sb-alien:addr ,features ,info))
(define-socket-option-int
sockopt-receive-low-water sockint::sol-socket sockint::so-rcvlowat)
(define-socket-option-int
sockopt-receive-buffer sockint::sol-socket sockint::so-rcvbuf)
(define-socket-option-int
- sockopt-priority sockint::sol-socket sockint::so-priority)
+ sockopt-priority sockint::sol-socket sockint::so-priority :linux
+ "Available only on Linux.")
;;; boolean options are integers really
-(defun bool-to-foreign (x size)
- (int-to-foreign (if x 1 0) size))
+(defun foreign-int-to-bool (x size)
+ (if (zerop (foreign-int-to-integer x size))
+ nil
+ t))
-(defun buffer-to-bool (x size)
- (not (= (buffer-to-int x size) 0)))
+(defun bool-to-foreign-int (val)
+ (if val 1 0))
-(defmacro define-socket-option-bool (name level number)
- `(define-socket-option ,name ,level ,number
- bool-to-foreign sockint::size-of-int buffer-to-bool))
+(defmacro define-socket-option-bool (name level c-name &optional features (info ""))
+ `(define-socket-option ,name
+ ,(format nil "~@<Return the value of the ~A socket option for SOCKET. ~
+ This can also be updated with SETF.~:@>"
+ (symbol-name c-name))
+ ,level ,c-name
+ sb-alien:int bool-to-foreign-int foreign-int-to-bool sb-alien:addr
+ ,features ,info))
(define-socket-option-bool
sockopt-reuse-address sockint::sol-socket sockint::so-reuseaddr)
(define-socket-option-bool
sockopt-oob-inline sockint::sol-socket sockint::so-oobinline)
(define-socket-option-bool
- sockopt-bsd-compatible sockint::sol-socket sockint::so-bsdcompat)
+ sockopt-bsd-compatible sockint::sol-socket sockint::so-bsdcompat :linux
+ "Available only on Linux.")
(define-socket-option-bool
- sockopt-pass-credentials sockint::sol-socket sockint::so-passcred)
+ sockopt-pass-credentials sockint::sol-socket sockint::so-passcred :linux
+ "Available only on Linux.")
(define-socket-option-bool
sockopt-debug sockint::sol-socket sockint::so-debug)
(define-socket-option-bool
(define-socket-option-bool sockopt-tcp-nodelay :tcp sockint::tcp-nodelay)
-(defun string-to-foreign (string size)
- (declare (ignore size))
- (let ((data (sockint::array-data-address string)))
- (sb-alien:sap-alien data (* t))))
-
-(defun buffer-to-string (x size)
- (declare (ignore size))
- (sb-c-call::%naturalize-c-string
- (sockint::array-data-address x)))
-
-(define-socket-option sockopt-bind-to-device sockint::sol-socket
- sockint::so-bindtodevice string-to-foreign sockint::ifnamsiz
- buffer-to-string)
+(defun identity-1 (x &rest args)
+ (declare (ignore args))
+ x)
+
+(define-socket-option sockopt-bind-to-device nil sockint::sol-socket
+ sockint::so-bindtodevice sb-alien:c-string identity identity-1 identity
+ :linux "Available only on Linux")
;;; other kinds of socket option
projects / sbcl.git / blobdiff