contrib/sb-posix/interface.lisp

   1 (cl:in-package :sb-posix-internal)
   2
   3 (defun make-alien-slot-name (alien-type slot-name)
   4   (intern (format nil "~A-~A" alien-type slot-name)
   5           (symbol-package slot-name)))
   6
   7 (declaim (inline alien-to-protocol-class))
   8 (defun alien-to-protocol-class (alien alien-type instance protocol-class slots)
   9   "Copy SLOTS from the alien object ALIEN of type ALIEN-TYPE to INSTANCE, an instance of PROTOCOL-CLASS.
  10 We assume that SLOT names are the same in the alien object and in
  11 the protocol-class."
  12   (unless instance
  13     (setf instance (make-instance protocol-class)))
  14   (loop for slot in slots
  15         do (setf (slot-value instance slot)
  16                  (sb-alien:slot alien slot)))
  17   instance)
  18
  19 (defun protocol-class-to-alien (instance protocol-class alien alien-type slots)
  20   (loop for slot in slots
  21         do (setf (sb-alien:slot alien slot) (slot-value instance slot)))
  22   instance)
  23
  24 (define-condition sb-posix:syscall-error (error)
  25   ((errno :initarg :errno :reader sb-posix:syscall-errno))
  26   (:report (lambda (c s)
  27              (let ((errno (sb-posix:syscall-errno c)))
  28                (format s "System call error ~A (~A)"
  29                        errno (sb-int:strerror errno))))))
  30
  31 (defun syscall-error ()
  32   (error 'sb-posix:syscall-error :errno (get-errno)))
  33
  34 (declaim (inline never-fails))
  35 (defun never-fails (&rest args)
  36   (declare (ignore args))
  37   nil)
  38
  39 ;;; filesystem access
  40
  41 (define-call "access" int minusp (pathname filename) (mode int))
  42 (define-call "chdir" int minusp (pathname filename))
  43 (define-call "chmod" int minusp (pathname filename) (mode sb-posix::mode-t))
  44 (define-call "chown" int minusp (pathname filename)
  45              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
  46 (define-call "close" int minusp (fd file-descriptor))
  47 (define-call "creat" int minusp (pathname filename) (mode sb-posix::mode-t))
  48 (define-call "dup" int minusp (oldfd file-descriptor))
  49 (define-call "dup2" int minusp (oldfd file-descriptor) (newfd file-descriptor))
  50 (define-call "fchdir" int minusp (fd file-descriptor))
  51 (define-call "fchmod" int minusp (fd file-descriptor) (mode sb-posix::mode-t))
  52 (define-call "fchown" int minusp (fd file-descriptor)
  53              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
  54 (define-call "fdatasync" int minusp (fd file-descriptor))
  55 (define-call "ftruncate" int minusp (fd file-descriptor) (length sb-posix::off-t))
  56 (define-call "fsync" int minusp (fd file-descriptor))
  57 (define-call "lchown" int minusp (pathname filename)
  58              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
  59 (define-call "link" int minusp (oldpath filename) (newpath filename))
  60 (define-call "lseek" sb-posix::off-t minusp (fd file-descriptor) (offset sb-posix::off-t) (whence int))
  61 (define-call "mkdir" int minusp (pathname filename) (mode sb-posix::mode-t))
  62 (define-call "mkfifo" int minusp (pathname filename) (mode sb-posix::mode-t))
  63 (define-call-internally open-with-mode "open" int minusp (pathname filename) (flags int) (mode sb-posix::mode-t))
  64 (define-call-internally open-without-mode "open" int minusp (pathname filename) (flags int))
  65 (define-entry-point "open" (pathname flags &optional (mode nil mode-supplied))
  66   (if mode-supplied
  67       (open-with-mode pathname flags mode)
  68       (open-without-mode pathname flags)))
  69 ;;(define-call "readlink" int minusp (path filename) (buf (* t)) (len int))
  70 (define-call "rename" int minusp (oldpath filename) (newpath filename))
  71 (define-call "rmdir" int minusp (pathname filename))
  72 (define-call "symlink" int minusp (oldpath filename) (newpath filename))
  73 (define-call "sync" void never-fails)
  74 (define-call "truncate" int minusp (pathname filename) (length sb-posix::off-t))
  75 (define-call "unlink" int minusp (pathname filename))
  76
  77 (define-call-internally ioctl-without-arg "ioctl" int minusp (fd file-descriptor) (cmd int))
  78 (define-call-internally ioctl-with-int-arg "ioctl" int minusp (fd file-descriptor) (cmd int) (arg int))
  79 (define-call-internally ioctl-with-pointer-arg "ioctl" int minusp (fd file-descriptor) (cmd int) (arg alien-pointer-to-anything-or-nil))
  80 (define-entry-point "ioctl" (fd cmd &optional (arg nil argp))
  81   (if argp
  82       (etypecase arg
  83         ((alien int) (ioctl-with-int-arg fd cmd arg))
  84         ((or (alien (* t)) null) (ioctl-with-pointer-arg fd cmd arg)))
  85       (ioctl-without-arg fd cmd)))
  86
  87 (define-call-internally fcntl-without-arg "fcntl" int minusp (fd file-descriptor) (cmd int))
  88 (define-call-internally fcntl-with-int-arg "fcntl" int minusp (fd file-descriptor) (cmd int) (arg int))
  89 (define-call-internally fcntl-with-pointer-arg "fcntl" int minusp (fd file-descriptor) (cmd int) (arg alien-pointer-to-anything-or-nil))
  90 (define-entry-point "fcntl" (fd cmd &optional (arg nil argp))
  91   (if argp
  92       (etypecase arg
  93         ((alien int) (fcntl-with-int-arg fd cmd arg))
  94         ((or (alien (* t)) null) (fcntl-with-pointer-arg fd cmd arg)))
  95       (fcntl-without-arg fd cmd)))
  96
  97 (define-call "opendir" (* t) null-alien (pathname filename))
  98 (define-call "readdir" sb-posix::dirent
  99   ;; readdir() has the worst error convention in the world.  It's just
 100   ;; too painful to support.  (return is NULL _and_ errno "unchanged"
 101   ;; is not an error, it's EOF).
 102   not
 103   (dir (* t)))
 104 (define-call "closedir" int minusp (dir (* t)))
 105
 106 (define-call "umask" sb-posix::mode-t never-fails (mode sb-posix::mode-t))
 107
 108 ;;; uid, gid
 109
 110 (define-call "geteuid" sb-posix::uid-t never-fails) ; "always successful", it says
 111 (define-call "getresuid" sb-posix::uid-t never-fails)
 112 (define-call "getuid" sb-posix::uid-t never-fails)
 113 (define-call "seteuid" int minusp (uid sb-posix::uid-t))
 114 (define-call "setfsuid" int minusp (uid sb-posix::uid-t))
 115 (define-call "setreuid" int minusp
 116              (ruid sb-posix::uid-t) (euid sb-posix::uid-t))
 117 (define-call "setresuid" int minusp
 118              (ruid sb-posix::uid-t) (euid sb-posix::uid-t)
 119              (suid sb-posix::uid-t))
 120 (define-call "setuid" int minusp (uid sb-posix::uid-t))
 121
 122 (define-call "getegid" sb-posix::gid-t never-fails)
 123 (define-call "getgid" sb-posix::gid-t never-fails)
 124 (define-call "getresgid" sb-posix::gid-t never-fails)
 125 (define-call "setegid" int minusp (gid sb-posix::gid-t))
 126 (define-call "setfsgid" int minusp (gid sb-posix::gid-t))
 127 (define-call "setgid" int minusp (gid sb-posix::gid-t))
 128 (define-call "setregid" int minusp
 129              (rgid sb-posix::gid-t) (egid sb-posix::gid-t))
 130 (define-call "setresgid" int minusp
 131              (rgid sb-posix::gid-t)
 132              (egid sb-posix::gid-t) (sgid sb-posix::gid-t))
 133
 134 ;;; processes, signals
 135 (define-call "alarm" int never-fails (seconds unsigned))
 136 (define-call "getpgid" sb-posix::pid-t minusp (pid sb-posix::pid-t))
 137 (define-call "getpid" sb-posix::pid-t never-fails)
 138 (define-call "getppid" sb-posix::pid-t never-fails)
 139 (define-call "getpgrp" sb-posix::pid-t never-fails)
 140 (define-call "getsid" sb-posix::pid-t minusp  (pid sb-posix::pid-t))
 141 (define-call "kill" int minusp (pid sb-posix::pid-t) (signal int))
 142 (define-call "killpg" int minusp (pgrp int) (signal int))
 143 (define-call "pause" int minusp)
 144 (define-call "setpgid" int minusp
 145              (pid sb-posix::pid-t) (pgid sb-posix::pid-t))
 146 (define-call "setpgrp" int minusp)
 147
 148 ;;; mmap, msync
 149 (define-call "mmap" sb-sys:system-area-pointer
 150   ;; KLUDGE: #XFFFFFFFF is (void *)-1, which is the charming return
 151   ;; value of mmap on failure.  Except on 64 bit systems ...
 152   (lambda (res)
 153     (= (sb-sys:sap-int res) #-alpha #XFFFFFFFF #+alpha #xffffffffffffffff))
 154   (addr sap-or-nil) (length unsigned) (prot unsigned)
 155   (flags unsigned) (fd file-descriptor) (offset sb-posix::off-t))
 156
 157 (define-call "munmap" int minusp
 158   (start sb-sys:system-area-pointer) (length unsigned))
 159
 160 (define-call "msync" int minusp
 161   (addr sb-sys:system-area-pointer) (length unsigned) (flags int))
 162
 163 (define-call "getpagesize" int minusp)
 164
 165 (defclass sb-posix::stat ()
 166      ((sb-posix::mode :initarg :mode :accessor sb-posix:stat-mode)
 167       (sb-posix::ino :initarg :ino :accessor sb-posix:stat-ino)
 168       (sb-posix::dev :initarg :dev :accessor sb-posix:stat-dev)
 169       (sb-posix::nlink :initarg :nlink :accessor sb-posix:stat-nlink)
 170       (sb-posix::uid :initarg :uid :accessor sb-posix:stat-uid)
 171       (sb-posix::gid :initarg :gid :accessor sb-posix:stat-gid)
 172       (sb-posix::size :initarg :size :accessor sb-posix:stat-size)
 173       (sb-posix::atime :initarg :atime :accessor sb-posix:stat-atime)
 174       (sb-posix::mtime :initarg :mtime :accessor sb-posix:stat-mtime)
 175       (sb-posix::ctime :initarg :ctime :accessor sb-posix:stat-ctime)))
 176
 177 (defmacro define-stat-call (name arg designator-fun type)
 178   ;; FIXME: this isn't the documented way of doing this, surely?
 179   (let ((lisp-name (intern (string-upcase name) :sb-posix)))
 180     `(progn
 181       (export ',lisp-name :sb-posix)
 182       (declaim (inline ,lisp-name))
 183       (defun ,lisp-name (,arg &optional stat)
 184         (declare (type (or null (sb-alien:alien (* sb-posix::alien-stat))) stat))
 185         (sb-posix::with-alien-stat a-stat ()
 186           (let ((r (alien-funcall
 187                     (extern-alien ,name ,type)
 188                     (,designator-fun ,arg)
 189                     a-stat)))
 190             (when (minusp r)
 191               (syscall-error))
 192             (alien-to-protocol-class a-stat 'sb-posix::alien-stat
 193                                      stat 'sb-posix::stat
 194                                      '(sb-posix::mode sb-posix::ino sb-posix::dev
 195                                        sb-posix::nlink sb-posix::uid sb-posix::gid
 196                                        sb-posix::size sb-posix::atime
 197                                        sb-posix::mtime sb-posix::ctime))))))))
 198
 199 (define-stat-call "stat" pathname sb-posix::filename
 200                   (function int c-string (* sb-posix::alien-stat)))
 201 (define-stat-call "lstat" pathname sb-posix::filename
 202                   (function int c-string (* sb-posix::alien-stat)))
 203 (define-stat-call "fstat" fd sb-posix::file-descriptor
 204                   (function int int (* sb-posix::alien-stat)))
 205
 206
 207 ;;; mode flags
 208 (define-call "s_isreg" boolean never-fails (mode sb-posix::mode-t))
 209 (define-call "s_isdir" boolean never-fails (mode sb-posix::mode-t))
 210 (define-call "s_ischr" boolean never-fails (mode sb-posix::mode-t))
 211 (define-call "s_isblk" boolean never-fails (mode sb-posix::mode-t))
 212 (define-call "s_isfifo" boolean never-fails (mode sb-posix::mode-t))
 213 (define-call "s_islnk" boolean never-fails (mode sb-posix::mode-t))
 214 (define-call "s_issock" boolean never-fails (mode sb-posix::mode-t))
 215
 216 (export 'sb-posix::pipe :sb-posix)
 217 (declaim (inline sb-posix::pipe))
 218 (defun sb-posix::pipe (&optional filedes2)
 219   (declare (type (or null (simple-array (signed-byte 32) (2))) filedes2))
 220   (unless filedes2
 221     (setq filedes2 (make-array 2 :element-type '(signed-byte 32))))
 222   (let ((r (alien-funcall
 223             ;; FIXME: (* INT)?  (ARRAY INT 2) would be better
 224             (extern-alien "pipe" (function int (* int)))
 225             (sb-sys:vector-sap filedes2))))
 226     (when (minusp r)
 227       (syscall-error)))
 228   (values (aref filedes2 0) (aref filedes2 1)))
 229
 230 (defclass sb-posix::termios ()
 231      ((sb-posix::iflag :initarg :iflag :accessor sb-posix:termios-iflag)
 232       (sb-posix::oflag :initarg :oflag :accessor sb-posix:termios-oflag)
 233       (sb-posix::cflag :initarg :cflag :accessor sb-posix:termios-cflag)
 234       (sb-posix::lflag :initarg :lflag :accessor sb-posix:termios-lflag)
 235       (sb-posix::cc :initarg :cc :accessor sb-posix:termios-cc)))
 236
 237 (export 'sb-posix::tcsetattr :sb-posix)
 238 (declaim (inline sb-posix::tcsetattr))
 239 (defun sb-posix::tcsetattr (fd actions termios)
 240   (sb-posix::with-alien-termios a-termios ()
 241     (protocol-class-to-alien termios 'sb-posix::termios
 242                              a-termios 'sb-posix::alien-termios
 243                              '(sb-posix::iflag sb-posix::oflag
 244                                sb-posix::cflag sb-posix::lflag))
 245     (loop with ccs = (sb-posix::alien-termios-cc a-termios)
 246             for i from 0 below sb-posix::nccs
 247             do (setf (sb-alien:deref ccs i)
 248                      (aref (sb-posix::termios-cc termios) i)))
 249     (let ((fd (sb-posix::file-descriptor fd)))
 250       (let* ((r (alien-funcall
 251                  (extern-alien "tcsetattr" (function int int int sb-posix::alien-termios))
 252                  fd actions termios)))
 253         (when (minusp r)
 254           (syscall-error)))
 255       (values))))
 256 (export 'sb-posix::tcgetattr :sb-posix)
 257 (declaim (inline sb-posix::tcgetattr))
 258 (defun sb-posix::tcgetattr (fd &optional termios)
 259   (sb-posix::with-alien-termios a-termios ()
 260     (let ((r (alien-funcall
 261               (extern-alien "tcgetattr" (function int int sb-posix::alien-termios))
 262               (sb-posix::file-descriptor fd)
 263               a-termios)))
 264       (when (minusp r)
 265         (syscall-error))
 266       (setf termios
 267             (alien-to-protocol-class a-termios 'alien-termios
 268                                      termios 'termios
 269                                      '(sb-posix::iflag sb-posix::oflag
 270                                        sb-posix::cflag sb-posix::lflag)))
 271       (setf (sb-posix::termios-cc termios) (make-array sb-posix::nccs))
 272       (loop with ccs = (sb-posix::alien-termios-cc a-termios)
 273             for i from 0 below sb-posix::nccs
 274             do (setf (aref (sb-posix::termios-cc termios) i)
 275                      (sb-alien:deref ccs i)))))
 276   termios)