1.0.10.31: sb-posix support for getgrnam and getgrgid
[sbcl.git] / contrib / sb-posix / interface.lisp
index 779759a..7bc574b 100644 (file)
@@ -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)))
@@ -76,7 +77,7 @@
 ;;; variable.
 (eval-when (:compile-toplevel :load-toplevel)
   (setf *c-functions-in-runtime*
-       '`(#+netbsd ,@("stat" "lstat" "fstat" "readdir" "opendir"))))
+        '`(#+netbsd ,@("stat" "lstat" "fstat" "readdir" "opendir"))))
 
 
 ;;; filesystem access
   (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 "setpgid" int minusp (pid pid-t) (pgid pid-t))
   (define-call "setpgrp" int minusp))
 
-;;(define-call "readlink" int minusp (path filename) (buf (* t)) (len int))
+(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)))))))))
+
+#-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
  (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))))))
             (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)))))
 (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)))
+  ((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."))
 
 (defmacro define-pw-call (name arg type)
   #-win32
 (define-pw-call "getpwnam" login-name (function (* alien-passwd) c-string))
 (define-pw-call "getpwuid" uid (function (* alien-passwd) uid-t))
 
+;;; 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-gr-call (name arg type)
+  #-win32
+  ;; FIXME: this isn't the documented way of doing this, surely?
+  (let ((lisp-name (intern (string-upcase name) :sb-posix)))
+    `(progn
+      (export ',lisp-name :sb-posix)
+      (declaim (inline ,lisp-name))
+      (defun ,lisp-name (,arg)
+        (let ((r (alien-funcall (extern-alien ,name ,type) ,arg)))
+          (if (null r)
+              r
+              (alien-to-group r)))))))
+
+(define-gr-call "getgrnam" login-name (function (* alien-group) c-string))
+(define-gr-call "getgrgid" gid (function (* alien-group) gid-t))
+
+
+#-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?
       (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)
    (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
@@ -581,4 +704,3 @@ than C's printf) with format string FORMAT and arguments ARGS."
                             priority "%s" message)))
       (syslog1 priority (apply #'format nil format args))))
   (define-call "closelog" void never-fails))
-