X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=contrib%2Fsb-posix%2Finterface.lisp;h=0995a1d23c20cf2057885d942d4391ac6a64d9f1;hb=7c75cd363da90afe334e936aad2b63437ea5905d;hp=aef75cde42a166bcc57679668863a78a1a430c4f;hpb=8e9908b6f79b7bb52a281cfcbf0712d4b914f3cf;p=sbcl.git diff --git a/contrib/sb-posix/interface.lisp b/contrib/sb-posix/interface.lisp index aef75cd..0995a1d 100644 --- a/contrib/sb-posix/interface.lisp +++ b/contrib/sb-posix/interface.lisp @@ -5,6 +5,7 @@ (let ((to-protocol (intern (format nil "ALIEN-TO-~A" name))) (to-alien (intern (format nil "~A-TO-ALIEN" name)))) `(progn + (export ',name :sb-posix) (defclass ,name ,superclasses ,(loop for slotd in slots collect (ldiff slotd (member :array-length slotd))) @@ -65,11 +66,28 @@ (defun syscall-error () (error 'sb-posix:syscall-error :errno (get-errno))) +(defun unsupported-error (lisp-name c-name) + (error "~S is unsupported by SBCL on this platform due to lack of ~A()." + lisp-name c-name)) + +(defun unsupported-warning (lisp-name c-name) + (warn "~S is unsupported by SBCL on this platform due to lack of ~A()." + lisp-name c-name)) + (declaim (inline never-fails)) (defun never-fails (&rest args) (declare (ignore args)) nil) +;;; Some systems may need C-level wrappers, which can live in the +;;; runtime (so that save-lisp-and-die can produce standalone +;;; executables). See REAL-C-NAME in macros.lisp for the use of this +;;; variable. +(eval-when (:compile-toplevel :load-toplevel) + (setf *c-functions-in-runtime* + '`(#+netbsd ,@("stat" "lstat" "fstat" "readdir" "opendir")))) + + ;;; filesystem access (defmacro define-call* (name &rest arguments) #-win32 `(define-call ,name ,@arguments) @@ -106,8 +124,19 @@ (define-call "rename" int minusp (oldpath filename) (newpath filename)) (define-call* "rmdir" int minusp (pathname filename)) (define-call* "unlink" int minusp (pathname filename)) -(define-call "opendir" (* t) null-alien (pathname filename)) -(define-call ("readdir" :options :largefile) (* dirent) +(define-call #-netbsd "opendir" #+netbsd "_opendir" + (* t) null-alien (pathname filename)) +#+inode64 +(define-call ("readdir" :c-name "readdir$INODE64" :options :largefile) + (* dirent) + ;; readdir() has the worst error convention in the world. It's just + ;; too painful to support. (return is NULL _and_ errno "unchanged" + ;; is not an error, it's EOF). + not + (dir (* t))) +#-inode64 +(define-call (#-netbsd "readdir" #+netbsd "_readdir" :options :largefile) + (* dirent) ;; readdir() has the worst error convention in the world. It's just ;; too painful to support. (return is NULL _and_ errno "unchanged" ;; is not an error, it's EOF). @@ -126,7 +155,7 @@ (define-call "fchdir" int minusp (fd file-descriptor)) (define-call "fchmod" int minusp (fd file-descriptor) (mode mode-t)) (define-call "fchown" int minusp (fd file-descriptor) - (owner uid-t) (group gid-t)) + (owner uid-t) (group gid-t)) (define-call "fdatasync" int minusp (fd file-descriptor)) (define-call ("ftruncate" :options :largefile) int minusp (fd file-descriptor) (length off-t)) @@ -134,14 +163,55 @@ (define-call "lchown" int minusp (pathname filename) (owner uid-t) (group gid-t)) (define-call "link" int minusp (oldpath filename) (newpath filename)) + (define-call "lockf" int minusp (fd file-descriptor) (cmd int) (len off-t)) (define-call "mkfifo" int minusp (pathname filename) (mode mode-t)) (define-call "symlink" int minusp (oldpath filename) (newpath filename)) (define-call "sync" void never-fails) (define-call ("truncate" :options :largefile) int minusp (pathname filename) (length off-t)) - ;; FIXME: Windows does have _mktemp, which has a slightlty different - ;; interface - (define-call "mkstemp" int minusp (template c-string)) + #-win32 + (macrolet ((def-mk*temp (lisp-name c-name result-type errorp dirp values) + (declare (ignore dirp)) + (if (sb-sys:find-foreign-symbol-address c-name) + `(progn + (defun ,lisp-name (template) + (let* ((external-format sb-alien::*default-c-string-external-format*) + (arg (sb-ext:string-to-octets + (filename template) + :external-format external-format + :null-terminate t))) + (sb-sys:with-pinned-objects (arg) + ;; accommodate for the call-by-reference + ;; nature of mks/dtemp's template strings. + (let ((result (alien-funcall (extern-alien ,c-name + (function ,result-type system-area-pointer)) + (sb-alien::vector-sap arg)))) + (when (,errorp result) + (syscall-error)) + ;; FIXME: We'd rather return pathnames, but other + ;; SB-POSIX functions like this return strings... + (let ((pathname (sb-ext:octets-to-string + arg :external-format external-format + :end (1- (length arg))))) + ,(if values + '(values result pathname) + 'pathname)))))) + (export ',lisp-name)) + `(progn + (defun ,lisp-name (template) + (declare (ignore template)) + (unsupported-error ',lisp-name ,c-name)) + (define-compiler-macro ,lisp-name (&whole form template) + (declare (ignore template)) + (unsupported-warning ',lisp-name ,c-name) + form) + (export ',lisp-name))))) + (def-mk*temp mktemp "mktemp" (* char) null-alien nil nil) + ;; FIXME: Windows does have _mktemp, which has a slightly different + ;; interface + (def-mk*temp mkstemp "mkstemp" int minusp nil t) + ;; FIXME: What about Windows? + (def-mk*temp mkdtemp "mkdtemp" (* char) null-alien t nil)) (define-call-internally ioctl-without-arg "ioctl" int minusp (fd file-descriptor) (cmd int)) (define-call-internally ioctl-with-int-arg "ioctl" int minusp @@ -162,11 +232,32 @@ (define-call-internally fcntl-with-pointer-arg "fcntl" int minusp (fd file-descriptor) (cmd int) (arg alien-pointer-to-anything-or-nil)) + (define-protocol-class flock alien-flock () + ((type :initarg :type :accessor flock-type + :documentation "Type of lock; F_RDLCK, F_WRLCK, F_UNLCK.") + (whence :initarg :whence :accessor flock-whence + :documentation "Flag for starting offset.") + (start :initarg :start :accessor flock-start + :documentation "Relative offset in bytes.") + (len :initarg :len :accessor flock-len + :documentation "Size; if 0 then until EOF.") + ;; Note: PID isn't initable, and is read-only. But other stuff in + ;; SB-POSIX right now loses when a protocol-class slot is unbound, + ;; so we initialize it to 0. + (pid :initform 0 :reader flock-pid + :documentation + "Process ID of the process holding the lock; returned with F_GETLK.")) + (:documentation "Class representing locks used in fcntl(2).")) (define-entry-point "fcntl" (fd cmd &optional (arg nil argp)) (if argp (etypecase arg ((alien int) (fcntl-with-int-arg fd cmd arg)) - ((or (alien (* t)) null) (fcntl-with-pointer-arg fd cmd arg))) + ((or (alien (* t)) null) (fcntl-with-pointer-arg fd cmd arg)) + (flock (with-alien-flock a-flock () + (flock-to-alien arg a-flock) + (let ((r (fcntl-with-pointer-arg fd cmd a-flock))) + (alien-to-flock a-flock arg) + r)))) (fcntl-without-arg fd cmd))) ;; uid, gid @@ -199,10 +290,16 @@ (define-call "setup_mach_exceptions" void never-fails) (define-call ("posix_fork" :c-name "fork") pid-t minusp) (defun fork () - (let ((pid (posix-fork))) - (when (= pid 0) - (setup-mach-exceptions)) - pid)) + (tagbody + (sb-thread::with-all-threads-lock + (when (cdr sb-thread::*all-threads*) + (go :error)) + (let ((pid (posix-fork))) + (when (= pid 0) + (setup-mach-exceptions)) + (return-from fork pid))) + :error + (error "Cannot fork with multiple threads running."))) (export 'fork :sb-posix)) #-mach-exception-handler @@ -216,9 +313,61 @@ (define-call "killpg" int minusp (pgrp int) (signal int)) (define-call "pause" int minusp) (define-call "setpgid" int minusp (pid pid-t) (pgid pid-t)) - (define-call "setpgrp" int minusp)) + (define-call "setpgrp" int minusp) + (define-call "setsid" pid-t minusp)) + +(defmacro with-growing-c-string ((buffer size) &body body) + (sb-int:with-unique-names (c-string-block) + `(block ,c-string-block + (let (,buffer) + (flet ((,buffer (&optional (size-incl-null)) + (when size-incl-null + (setf (sb-sys:sap-ref-8 (sb-alien:alien-sap ,buffer) size-incl-null) + 0)) + (return-from ,c-string-block + (sb-alien::c-string-to-string + (sb-alien:alien-sap ,buffer) + (sb-impl::default-external-format) + 'character)))) + (loop for ,size = 128 then (* 2 ,size) + do (unwind-protect + (progn + (setf ,buffer (make-alien c-string ,size)) + ,@body) + (when ,buffer + (free-alien ,buffer))))))))) -;;(define-call "readlink" int minusp (path filename) (buf (* t)) (len int)) +#-win32 +(progn + (export 'readlink :sb-posix) + (defun readlink (pathspec) + "Returns the resolved target of a symbolic link as a string." + (flet ((%readlink (path buf length) + (alien-funcall + (extern-alien "readlink" (function int c-string (* t) int)) + path buf length))) + (with-growing-c-string (buf size) + (let ((count (%readlink (filename pathspec) buf size))) + (cond ((minusp count) + (syscall-error)) + ((< 0 count size) + (buf count)))))))) + +(progn + (export 'getcwd :sb-posix) + (defun getcwd () + "Returns the process's current working directory as a string." + (flet ((%getcwd (buffer size) + (alien-funcall + (extern-alien #-win32 "getcwd" + #+win32 "_getcwd" (function c-string (* t) int)) + buffer size))) + (with-growing-c-string (buf size) + (let ((result (%getcwd buf size))) + (cond (result + (buf)) + ((/= (get-errno) sb-posix:erange) + (syscall-error)))))))) #-win32 (progn @@ -227,9 +376,10 @@ (defun wait (&optional statusptr) (declare (type (or null (simple-array (signed-byte 32) (1))) statusptr)) (let* ((ptr (or statusptr (make-array 1 :element-type '(signed-byte 32)))) - (pid (alien-funcall - (extern-alien "wait" (function pid-t (* int))) - (sb-sys:vector-sap ptr)))) + (pid (sb-sys:with-pinned-objects (ptr) + (alien-funcall + (extern-alien "wait" (function pid-t (* int))) + (sb-sys:vector-sap ptr))))) (if (minusp pid) (syscall-error) (values pid (aref ptr 0)))))) @@ -243,10 +393,11 @@ (type (sb-alien:alien int) options) (type (or null (simple-array (signed-byte 32) (1))) statusptr)) (let* ((ptr (or statusptr (make-array 1 :element-type '(signed-byte 32)))) - (pid (alien-funcall - (extern-alien "waitpid" (function pid-t - pid-t (* int) int)) - pid (sb-sys:vector-sap ptr) options))) + (pid (sb-sys:with-pinned-objects (ptr) + (alien-funcall + (extern-alien "waitpid" (function pid-t + pid-t (* int) int)) + pid (sb-sys:vector-sap ptr) options)))) (if (minusp pid) (syscall-error) (values pid (aref ptr 0))))) @@ -275,6 +426,10 @@ (define-call "msync" int minusp (addr sb-sys:system-area-pointer) (length unsigned) (flags int))) +;;; mlockall, munlockall +(define-call "mlockall" int minusp (flags int)) +(define-call "munlockall" int minusp) + #-win32 (define-call "getpagesize" int minusp) #+win32 @@ -282,17 +437,37 @@ (export (defun getpagesize () 4096)) ;;; passwd database +;; The docstrings are copied from the descriptions in SUSv3, +;; where present. #-win32 (define-protocol-class passwd alien-passwd () - ((name :initarg :name :accessor passwd-name) - (passwd :initarg :passwd :accessor passwd-passwd) - (uid :initarg :uid :accessor passwd-uid) - (gid :initarg :gid :accessor passwd-gid) - (gecos :initarg :gecos :accessor passwd-gecos) - (dir :initarg :dir :accessor passwd-dir) - (shell :initarg :shell :accessor passwd-shell))) - -(defmacro define-pw-call (name arg type) + ((name :initarg :name :accessor passwd-name + :documentation "User's login name.") + ;; Note: SUSv3 doesn't require this member. + (passwd :initarg :passwd :accessor passwd-passwd + :documentation "The account's encrypted password.") + (uid :initarg :uid :accessor passwd-uid + :documentation "Numerical user ID.") + (gid :initarg :gid :accessor passwd-gid + :documentation "Numerical group ID.") + ;; Note: SUSv3 doesn't require this member. + (gecos :initarg :gecos :accessor passwd-gecos + :documentation "User's name or comment field.") + (dir :initarg :dir :accessor passwd-dir + :documentation "Initial working directory.") + (shell :initarg :shell :accessor passwd-shell + :documentation "Program to use as shell.")) + (:documentation "Instances of this class represent entries in + the system's user database.")) + +;;; group database +#-win32 +(define-protocol-class group alien-group () + ((name :initarg :name :accessor group-name) + (passwd :initarg :passwd :accessor group-passwd) + (gid :initarg :gid :accessor group-gid))) + +(defmacro define-obj-call (name arg type conv) #-win32 ;; FIXME: this isn't the documented way of doing this, surely? (let ((lisp-name (intern (string-upcase name) :sb-posix))) @@ -301,51 +476,76 @@ (declaim (inline ,lisp-name)) (defun ,lisp-name (,arg) (let ((r (alien-funcall (extern-alien ,name ,type) ,arg))) - (if (null r) - r - (alien-to-passwd r))))))) + (if (null-alien r) + nil + (,conv r))))))) -(define-pw-call "getpwnam" login-name (function (* alien-passwd) c-string)) -(define-pw-call "getpwuid" uid (function (* alien-passwd) uid-t)) +(define-obj-call "getpwnam" login-name (function (* alien-passwd) c-string) alien-to-passwd) +(define-obj-call "getpwuid" uid (function (* alien-passwd) uid-t) alien-to-passwd) +(define-obj-call "getgrnam" login-name (function (* alien-group) c-string) alien-to-group) +(define-obj-call "getgrgid" gid (function (* alien-group) gid-t) alien-to-group) + + +#-win32 +(define-protocol-class timeval alien-timeval () + ((sec :initarg :tv-sec :accessor timeval-sec + :documentation "Seconds.") + (usec :initarg :tv-usec :accessor timeval-usec + :documentation "Microseconds.")) + (:documentation "Instances of this class represent time values.")) (define-protocol-class stat alien-stat () - ((mode :initarg :mode :accessor stat-mode) - (ino :initarg :ino :accessor stat-ino) - (dev :initarg :dev :accessor stat-dev) - (nlink :initarg :nlink :accessor stat-nlink) - (uid :initarg :uid :accessor stat-uid) - (gid :initarg :gid :accessor stat-gid) - (size :initarg :size :accessor stat-size) - (atime :initarg :atime :accessor stat-atime) - (mtime :initarg :mtime :accessor stat-mtime) - (ctime :initarg :ctime :accessor stat-ctime))) + ((mode :initarg :mode :reader stat-mode + :documentation "Mode of file.") + (ino :initarg :ino :reader stat-ino + :documentation "File serial number.") + (dev :initarg :dev :reader stat-dev + :documentation "Device ID of device containing file.") + (nlink :initarg :nlink :reader stat-nlink + :documentation "Number of hard links to the file.") + (uid :initarg :uid :reader stat-uid + :documentation "User ID of file.") + (gid :initarg :gid :reader stat-gid + :documentation "Group ID of file.") + (size :initarg :size :reader stat-size + :documentation "For regular files, the file size in + bytes. For symbolic links, the length + in bytes of the filename contained in + the symbolic link.") + (atime :initarg :atime :reader stat-atime + :documentation "Time of last access.") + (mtime :initarg :mtime :reader stat-mtime + :documentation "Time of last data modification.") + (ctime :initarg :ctime :reader stat-ctime + :documentation "Time of last status change")) + (:documentation "Instances of this class represent Posix file + metadata.")) (defmacro define-stat-call (name arg designator-fun type) ;; FIXME: this isn't the documented way of doing this, surely? - (let ((lisp-name (lisp-for-c-symbol name))) + (let ((lisp-name (lisp-for-c-symbol name)) + (real-name #+inode64 (format nil "~A$INODE64" name) + #-inode64 name)) `(progn (export ',lisp-name :sb-posix) (declaim (inline ,lisp-name)) (defun ,lisp-name (,arg &optional stat) - (declare (type (or null (sb-alien:alien (* alien-stat))) stat)) + (declare (type (or null stat) stat)) (with-alien-stat a-stat () (let ((r (alien-funcall - (extern-alien ,(real-c-name (list name :options :largefile)) ,type) + (extern-alien ,(real-c-name (list real-name :options :largefile)) ,type) (,designator-fun ,arg) a-stat))) (when (minusp r) (syscall-error)) (alien-to-stat a-stat stat))))))) -;; Note: _stat, _lstat, and _fstat for NetBSD are provided in -;; src/runtime/bsd-os.c. See comments in that file -;; for an explanation. -- RMK 2006-10-15 -(define-stat-call #-(or win32 netbsd) "stat" #+(or win32 netbsd) "_stat" +(define-stat-call #-win32 "stat" #+win32 "_stat" pathname filename (function int c-string (* alien-stat))) #-win32 -(define-stat-call #-netbsd "lstat" #+netbsd "_lstat" +(define-stat-call "lstat" pathname filename (function int c-string (* alien-stat))) ;;; No symbolic links on Windows, so use stat @@ -355,7 +555,7 @@ (export (defun lstat (filename &optional stat) (if stat (stat filename stat) (stat filename))))) -(define-stat-call #-(or win32 netbsd) "fstat" #+(or win32 netbsd) "_fstat" +(define-stat-call #-win32 "fstat" #+win32 "_fstat" fd file-descriptor (function int int (* alien-stat))) @@ -377,21 +577,29 @@ (declare (type (or null (simple-array (signed-byte 32) (2))) filedes2)) (unless filedes2 (setq filedes2 (make-array 2 :element-type '(signed-byte 32)))) - (let ((r (alien-funcall - ;; FIXME: (* INT)? (ARRAY INT 2) would be better - (extern-alien "pipe" (function int (* int))) - (sb-sys:vector-sap filedes2)))) + (let ((r (sb-sys:with-pinned-objects (filedes2) + (alien-funcall + ;; FIXME: (* INT)? (ARRAY INT 2) would be better + (extern-alien "pipe" (function int (* int))) + (sb-sys:vector-sap filedes2))))) (when (minusp r) (syscall-error))) (values (aref filedes2 0) (aref filedes2 1)))) #-win32 (define-protocol-class termios alien-termios () - ((iflag :initarg :iflag :accessor sb-posix:termios-iflag) - (oflag :initarg :oflag :accessor sb-posix:termios-oflag) - (cflag :initarg :cflag :accessor sb-posix:termios-cflag) - (lflag :initarg :lflag :accessor sb-posix:termios-lflag) - (cc :initarg :cc :accessor sb-posix:termios-cc :array-length nccs))) + ((iflag :initarg :iflag :accessor sb-posix:termios-iflag + :documentation "Input modes.") + (oflag :initarg :oflag :accessor sb-posix:termios-oflag + :documentation "Output modes.") + (cflag :initarg :cflag :accessor sb-posix:termios-cflag + :documentation "Control modes.") + (lflag :initarg :lflag :accessor sb-posix:termios-lflag + :documentation "Local modes.") + (cc :initarg :cc :accessor sb-posix:termios-cc :array-length nccs + :documentation "Control characters")) + (:documentation "Instances of this class represent I/O + characteristics of the terminal.")) #-win32 (progn @@ -424,6 +632,11 @@ (syscall-error)) (setf termios (alien-to-termios a-termios termios)))) termios) + (define-call "tcdrain" int minusp (fd file-descriptor)) + (define-call "tcflow" int minusp (fd file-descriptor) (action int)) + (define-call "tcflush" int minusp (fd file-descriptor) (queue-selector int)) + (define-call "tcgetsid" pid-t minusp (fd file-descriptor)) + (define-call "tcsendbreak" int minusp (fd file-descriptor) (duration int)) (export 'cfsetispeed :sb-posix) (declaim (inline cfsetispeed)) (defun cfsetispeed (speed &optional termios) @@ -526,7 +739,10 @@ ;;; environment -(export 'getenv :sb-posix) +(eval-when (:compile-toplevel :load-toplevel) + ;; Do this at compile-time as Win32 code below refers to it as + ;; sb-posix:getenv. + (export 'getenv :sb-posix)) (defun getenv (name) (let ((r (alien-funcall (extern-alien "getenv" (function (* char) c-string)) @@ -534,4 +750,58 @@ (declare (type (alien (* char)) r)) (unless (null-alien r) (cast r c-string)))) -(define-call "putenv" int minusp (string c-string)) +#-win32 +(progn + (define-call "setenv" int minusp (name c-string) (value c-string) (overwrite int)) + (define-call "unsetenv" int minusp (name c-string)) + (export 'putenv :sb-posix) + (defun putenv (string) + (declare (string string)) + ;; We don't want to call actual putenv: the string passed to putenv ends + ;; up in environ, and we any string we allocate GC might move. + ;; + ;; This makes our wrapper nonconformant if you squit hard enough, but + ;; users who care about that should really be calling putenv() directly in + ;; order to be able to manage memory sanely. + (let ((p (position #\= string)) + (n (length string))) + (if p + (if (= p n) + (unsetenv (subseq string 0 p)) + (setenv (subseq string 0 p) (subseq string (1+ p)) 1)) + (error "Invalid argument to putenv: ~S" string))))) +#+win32 +(progn + ;; Windows doesn't define a POSIX setenv, but happily their _putenv is sane. + (define-call* "putenv" int minusp (string c-string)) + (export 'setenv :sb-posix) + (defun setenv (name value overwrite) + (declare (string name value)) + (if (and (zerop overwrite) (sb-posix:getenv name)) + 0 + (putenv (concatenate 'string name "=" value)))) + (export 'unsetenv :sb-posix) + (defun unsetenv (name) + (declare (string name)) + (putenv (concatenate 'string name "=")))) + +;;; syslog +#-win32 +(progn + (export 'openlog :sb-posix) + (export 'syslog :sb-posix) + (export 'closelog :sb-posix) + (defun openlog (ident options &optional (facility log-user)) + (alien-funcall (extern-alien + "openlog" (function void c-string int int)) + ident options facility)) + (defun syslog (priority format &rest args) + "Send a message to the syslog facility, with severity level +PRIORITY. The message will be formatted as by CL:FORMAT (rather +than C's printf) with format string FORMAT and arguments ARGS." + (flet ((syslog1 (priority message) + (alien-funcall (extern-alien + "syslog" (function void int c-string c-string)) + priority "%s" message))) + (syslog1 priority (apply #'format nil format args)))) + (define-call "closelog" void never-fails))