0.8.7.36:
[sbcl.git] / contrib / sb-posix / interface.lisp
1 (cl:in-package :sb-posix-internal)
2
3 (define-condition sb-posix:syscall-error (error)
4   ((errno :initarg :errno :reader sb-posix:syscall-errno))
5   (:report (lambda (c s)
6              (let ((errno (sb-posix:syscall-errno c)))
7                (format s "System call error ~A (~A)"
8                        errno (sb-int:strerror errno))))))
9
10 (defun syscall-error ()
11   (error 'sb-posix:syscall-error :errno (get-errno)))
12
13 (declaim (inline never-fails))
14 (defun never-fails (&rest args)
15   (declare (ignore args))
16   nil)
17
18 ;;; filesystem access
19
20 (define-call "access" int minusp (pathname filename) (mode int))
21 (define-call "chdir" int minusp (pathname filename))
22 (define-call "chmod" int minusp (pathname filename) (mode sb-posix::mode-t))
23 (define-call "chown" int minusp (pathname filename)
24              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
25 (define-call "close" int minusp (fd file-descriptor))
26 (define-call "creat" int minusp (pathname filename) (mode sb-posix::mode-t))
27 (define-call "dup" int minusp (oldfd file-descriptor))
28 (define-call "dup2" int minusp (oldfd file-descriptor) (newfd file-descriptor))
29 (define-call "fchdir" int minusp (fd file-descriptor))
30 (define-call "fchmod" int minusp (fd file-descriptor) (mode sb-posix::mode-t))
31 (define-call "fchown" int minusp (fd file-descriptor)
32              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
33 (define-call "fdatasync" int minusp (fd file-descriptor))
34 (define-call "ftruncate" int minusp (fd file-descriptor) (length sb-posix::off-t))
35 (define-call "fsync" int minusp (fd file-descriptor))
36 (define-call "lchown" int minusp (pathname filename)
37              (owner sb-posix::uid-t)  (group sb-posix::gid-t))
38 (define-call "link" int minusp (oldpath filename) (newpath filename))
39 (define-call "lseek" sb-posix::off-t minusp (fd file-descriptor) (offset sb-posix::off-t) (whence int))
40 (define-call "mkdir" int minusp (pathname filename) (mode sb-posix::mode-t))
41 (define-call "mkfifo" int minusp (pathname filename) (mode sb-posix::mode-t))
42 (define-call-internally open-with-mode "open" int minusp (pathname filename) (flags int) (mode sb-posix::mode-t))
43 (define-call-internally open-without-mode "open" int minusp (pathname filename) (flags int))
44 (define-entry-point "open" (pathname flags &optional (mode nil mode-supplied))
45   (if mode-supplied
46       (open-with-mode pathname flags mode)
47       (open-without-mode pathname flags)))
48 ;;(define-call "readlink" int minusp (path filename) (buf (* t)) (len int))
49 (define-call "rename" int minusp (oldpath filename) (newpath filename))
50 (define-call "rmdir" int minusp (pathname filename))
51 (define-call "symlink" int minusp (oldpath filename) (newpath filename))
52 (define-call "sync" void never-fails)
53 (define-call "truncate" int minusp (pathname filename) (length sb-posix::off-t))
54 (define-call "unlink" int minusp (pathname filename))
55
56 (define-call-internally ioctl-without-arg "ioctl" int minusp (fd file-descriptor) (cmd int))
57 (define-call-internally ioctl-with-int-arg "ioctl" int minusp (fd file-descriptor) (cmd int) (arg int))
58 (define-call-internally ioctl-with-pointer-arg "ioctl" int minusp (fd file-descriptor) (cmd int) (arg alien-pointer-to-anything-or-nil))
59 (define-entry-point "ioctl" (fd cmd &optional (arg nil argp))
60   (if argp
61       (etypecase arg
62         ((alien int) (ioctl-with-int-arg fd cmd arg))
63         ((or (alien (* t)) null) (ioctl-with-pointer-arg fd cmd arg)))
64       (ioctl-without-arg fd cmd)))
65
66 (define-call-internally fcntl-without-arg "fcntl" int minusp (fd file-descriptor) (cmd int))
67 (define-call-internally fcntl-with-int-arg "fcntl" int minusp (fd file-descriptor) (cmd int) (arg int))
68 (define-call-internally fcntl-with-pointer-arg "fcntl" int minusp (fd file-descriptor) (cmd int) (arg alien-pointer-to-anything-or-nil))
69 (define-entry-point "fcntl" (fd cmd &optional (arg nil argp))
70   (if argp
71       (etypecase arg
72         ((alien int) (fcntl-with-int-arg fd cmd arg))
73         ((or (alien (* t)) null) (fcntl-with-pointer-arg fd cmd arg)))
74       (fcntl-without-arg fd cmd)))
75
76 (define-call "opendir" (* t) null-alien (pathname filename))
77 (define-call "readdir" (* t)
78   ;; readdir() has the worst error convention in the world.  It's just
79   ;; too painful to support.  (return is NULL _and_ errno "unchanged"
80   ;; is not an error, it's EOF).
81   not
82   (dir (* t)))
83 (define-call "closedir" int minusp (dir (* t)))
84
85 (define-call "umask" sb-posix::mode-t never-fails (mode sb-posix::mode-t))
86
87 ;;; uid, gid
88
89 (define-call "geteuid" sb-posix::uid-t never-fails) ; "always successful", it says
90 (define-call "getresuid" sb-posix::uid-t never-fails)
91 (define-call "getuid" sb-posix::uid-t never-fails)
92 (define-call "seteuid" int minusp (uid sb-posix::uid-t))
93 (define-call "setfsuid" int minusp (uid sb-posix::uid-t))
94 (define-call "setreuid" int minusp
95              (ruid sb-posix::uid-t) (euid sb-posix::uid-t))
96 (define-call "setresuid" int minusp
97              (ruid sb-posix::uid-t) (euid sb-posix::uid-t)
98              (suid sb-posix::uid-t))
99 (define-call "setuid" int minusp (uid sb-posix::uid-t))
100
101 (define-call "getegid" sb-posix::gid-t never-fails)
102 (define-call "getgid" sb-posix::gid-t never-fails)
103 (define-call "getresgid" sb-posix::gid-t never-fails)
104 (define-call "setegid" int minusp (gid sb-posix::gid-t))
105 (define-call "setfsgid" int minusp (gid sb-posix::gid-t))
106 (define-call "setgid" int minusp (gid sb-posix::gid-t))
107 (define-call "setregid" int minusp
108              (rgid sb-posix::gid-t) (egid sb-posix::gid-t))
109 (define-call "setresgid" int minusp
110              (rgid sb-posix::gid-t)
111              (egid sb-posix::gid-t) (sgid sb-posix::gid-t))
112
113 ;;; processes, signals
114 (define-call "alarm" int never-fails (seconds unsigned))
115 (define-call "getpgid" sb-posix::pid-t minusp (pid sb-posix::pid-t))
116 (define-call "getpid" sb-posix::pid-t never-fails)
117 (define-call "getppid" sb-posix::pid-t never-fails)
118 (define-call "getpgrp" sb-posix::pid-t never-fails)
119 (define-call "getsid" sb-posix::pid-t minusp  (pid sb-posix::pid-t))
120 (define-call "kill" int minusp (pid sb-posix::pid-t) (signal int))
121 (define-call "killpg" int minusp (pgrp int) (signal int))
122 (define-call "pause" int minusp)
123 (define-call "setpgid" int minusp
124              (pid sb-posix::pid-t) (pgid sb-posix::pid-t))
125 (define-call "setpgrp" int minusp)
126
127 ;;; mmap, msync
128 (define-call "mmap" sb-sys:system-area-pointer
129   ;; KLUDGE: #XFFFFFFFF is (void *)-1, which is the charming return
130   ;; value of mmap on failure.  Except on 64 bit systems ...
131   (lambda (res)
132     (= (sb-sys:sap-int res) #-alpha #XFFFFFFFF #+alpha #xffffffffffffffff))
133   (addr sap-or-nil) (length unsigned) (prot unsigned)
134   (flags unsigned) (fd file-descriptor) (offset sb-posix::off-t))
135
136 (define-call "munmap" int minusp
137   (start sb-sys:system-area-pointer) (length unsigned))
138
139 (define-call "msync" int minusp
140   (addr sb-sys:system-area-pointer) (length unsigned) (flags int))
141
142 (define-call "getpagesize" int minusp)
143
144 (defmacro define-stat-call (name arg designator-fun type)
145   ;; FIXME: this isn't the documented way of doing this, surely?
146   (let ((lisp-name (intern (string-upcase name) :sb-posix)))
147     `(progn
148       (export ',lisp-name :sb-posix)
149       (declaim (inline ,lisp-name))
150       (defun ,lisp-name (,arg &optional stat)
151         (declare (type (or null sb-posix::stat) stat))
152         (unless stat
153           (setq stat (sb-posix::allocate-stat)))
154         ;; FIXME: Hmm.  WITH-PINNED-OBJECTS/WITHOUT-GCING or something
155         ;; is probably needed round here.
156         (let* ((s (sb-sys:int-sap
157                    ;; FIXME: WILL NOT WORK ON 64-BIT LISP.  VECTOR-SAP
158                    ;; would be better if the STAT object were
159                    ;; guaranteed to be a vector, but it's not (and may
160                    ;; well turn into an alien soon).
161                    (+ 8 (logandc2 (sb-kernel:get-lisp-obj-address stat) 7))))
162                (r (alien-funcall
163                    (extern-alien ,name ,type)
164                    (,designator-fun ,arg)
165                    s)))
166           (when (minusp r)
167             (syscall-error)))
168         stat))))
169 (define-stat-call "stat" pathname sb-posix::filename
170                   ;; FIXME: (* T)?  Ew.  (* STAT) would be preferable
171                   (function int c-string (* t)))
172 (define-stat-call "lstat" pathname sb-posix::filename
173                   (function int c-string (* t)))
174 (define-stat-call "fstat" fd sb-posix::file-descriptor
175                   (function int int (* t)))
176
177
178 ;;; mode flags
179 (define-call "s_isreg" boolean never-fails (mode sb-posix::mode-t))
180 (define-call "s_isdir" boolean never-fails (mode sb-posix::mode-t))
181 (define-call "s_ischr" boolean never-fails (mode sb-posix::mode-t))
182 (define-call "s_isblk" boolean never-fails (mode sb-posix::mode-t))
183 (define-call "s_isfifo" boolean never-fails (mode sb-posix::mode-t))
184 (define-call "s_islnk" boolean never-fails (mode sb-posix::mode-t))
185 (define-call "s_issock" boolean never-fails (mode sb-posix::mode-t))
186
187 (export 'sb-posix::pipe :sb-posix)
188 (declaim (inline sb-posix::pipe))
189 (defun sb-posix::pipe (&optional filedes2)
190   (declare (type (or null (simple-array (signed-byte 32) (2))) filedes2))
191   (unless filedes2
192     (setq filedes2 (make-array 2 :element-type '(signed-byte 32))))
193   (let ((r (alien-funcall
194             ;; FIXME: (* INT)?  (ARRAY INT 2) would be better
195             (extern-alien "pipe" (function int (* int)))
196             (sb-sys:vector-sap filedes2))))
197     (when (minusp r)
198       (syscall-error)))
199   (values (aref filedes2 0) (aref filedes2 1)))