1 (cl:in-package :sb-posix)
3 (defmacro define-protocol-class
4 (name alien-type superclasses slots &rest options)
5 (let ((to-protocol (intern (format nil "ALIEN-TO-~A" name)))
6 (to-alien (intern (format nil "~A-TO-ALIEN" name))))
8 (defclass ,name ,superclasses
9 ,(loop for slotd in slots
10 collect (ldiff slotd (member :array-length slotd)))
12 (declaim (inline ,to-alien ,to-protocol))
13 (declaim (inline ,to-protocol ,to-alien))
14 (defun ,to-protocol (alien &optional instance)
15 (declare (type (sb-alien:alien (* ,alien-type)) alien)
16 (type (or null ,name) instance))
18 (setf instance (make-instance ',name)))
19 ,@(loop for slotd in slots
20 ;; FIXME: slotds in source are more complicated in general
22 ;; FIXME: baroque construction of intricate fragility
23 for array-length = (getf (cdr slotd) :array-length)
26 (let ((array (make-array ,array-length)))
27 (setf (slot-value instance ',(car slotd))
29 (dotimes (i ,array-length)
32 (sb-alien:slot alien ',(car slotd))
35 collect `(setf (slot-value instance ',(car slotd))
36 (sb-alien:slot alien ',(car slotd))))
38 (defun ,to-alien (instance &optional alien)
39 (declare (type (or null (sb-alien:alien (* ,alien-type))) alien)
40 (type ,name instance))
42 (setf alien (sb-alien:make-alien ,alien-type)))
43 ,@(loop for slotd in slots
44 for array-length = (getf (cdr slotd) :array-length)
47 (let ((array (slot-value instance ',(car slotd))))
48 (dotimes (i ,array-length)
50 (sb-alien:slot alien ',(car slotd))
54 collect `(setf (sb-alien:slot alien ',(car slotd))
55 (slot-value instance ',(car slotd)))))
56 (find-class ',name))))
58 (define-condition sb-posix:syscall-error (error)
59 ((errno :initarg :errno :reader sb-posix:syscall-errno))
60 (:report (lambda (c s)
61 (let ((errno (sb-posix:syscall-errno c)))
62 (format s "System call error ~A (~A)"
63 errno (sb-int:strerror errno))))))
65 (defun syscall-error ()
66 (error 'sb-posix:syscall-error :errno (get-errno)))
68 (declaim (inline never-fails))
69 (defun never-fails (&rest args)
70 (declare (ignore args))
73 ;;; Some systems may need C-level wrappers, which can live in the
74 ;;; runtime (so that save-lisp-and-die can produce standalone
75 ;;; executables). See REAL-C-NAME in macros.lisp for the use of this
77 (eval-when (:compile-toplevel :load-toplevel)
78 (setf *c-functions-in-runtime*
79 '`(#+netbsd ,@("stat" "lstat" "fstat" "readdir" "opendir"))))
83 (defmacro define-call* (name &rest arguments)
84 #-win32 `(define-call ,name ,@arguments)
85 #+win32 `(define-call ,(if (consp name)
86 `(,(concatenate 'string "_" (car name))
88 (concatenate 'string "_" name))
91 (define-call* "access" int minusp (pathname filename) (mode int))
92 (define-call* "chdir" int minusp (pathname filename))
93 (define-call* "chmod" int minusp (pathname filename) (mode mode-t))
94 (define-call* "close" int minusp (fd file-descriptor))
95 (define-call* "creat" int minusp (pathname filename) (mode mode-t))
96 (define-call* "dup" int minusp (oldfd file-descriptor))
97 (define-call* "dup2" int minusp (oldfd file-descriptor)
98 (newfd file-descriptor))
99 (define-call* ("lseek" :options :largefile)
100 off-t minusp (fd file-descriptor) (offset off-t)
102 (define-call* "mkdir" int minusp (pathname filename) (mode mode-t))
105 (define-call-internally open-with-mode ,x int minusp
106 (pathname filename) (flags int) (mode mode-t))
107 (define-call-internally open-without-mode ,x int minusp
108 (pathname filename) (flags int))
109 (define-entry-point ,x
110 (pathname flags &optional (mode nil mode-supplied))
112 (open-with-mode pathname flags mode)
113 (open-without-mode pathname flags))))))
114 (def #-win32 "open" #+win32 "_open"))
115 (define-call "rename" int minusp (oldpath filename) (newpath filename))
116 (define-call* "rmdir" int minusp (pathname filename))
117 (define-call* "unlink" int minusp (pathname filename))
118 (define-call #-netbsd "opendir" #+netbsd "_opendir"
119 (* t) null-alien (pathname filename))
120 (define-call (#-netbsd "readdir" #+netbsd "_readdir" :options :largefile)
122 ;; readdir() has the worst error convention in the world. It's just
123 ;; too painful to support. (return is NULL _and_ errno "unchanged"
124 ;; is not an error, it's EOF).
127 (define-call "closedir" int minusp (dir (* t)))
128 ;; need to do this here because we can't do it in the DEFPACKAGE
129 (define-call* "umask" mode-t never-fails (mode mode-t))
130 (define-call* "getpid" pid-t never-fails)
134 (define-call "chown" int minusp (pathname filename)
135 (owner uid-t) (group gid-t))
136 (define-call "chroot" int minusp (pathname filename))
137 (define-call "fchdir" int minusp (fd file-descriptor))
138 (define-call "fchmod" int minusp (fd file-descriptor) (mode mode-t))
139 (define-call "fchown" int minusp (fd file-descriptor)
140 (owner uid-t) (group gid-t))
141 (define-call "fdatasync" int minusp (fd file-descriptor))
142 (define-call ("ftruncate" :options :largefile)
143 int minusp (fd file-descriptor) (length off-t))
144 (define-call "fsync" int minusp (fd file-descriptor))
145 (define-call "lchown" int minusp (pathname filename)
146 (owner uid-t) (group gid-t))
147 (define-call "link" int minusp (oldpath filename) (newpath filename))
148 (define-call "mkfifo" int minusp (pathname filename) (mode mode-t))
149 (define-call "symlink" int minusp (oldpath filename) (newpath filename))
150 (define-call "sync" void never-fails)
151 (define-call ("truncate" :options :largefile)
152 int minusp (pathname filename) (length off-t))
153 ;; FIXME: Windows does have _mktemp, which has a slightlty different
155 (defun mkstemp (template)
156 ;; we are emulating sb-alien's charset conversion for strings
157 ;; here, to accommodate for the call-by-reference nature of
158 ;; mkstemp's template strings.
159 (let ((arg (sb-ext:string-to-octets
161 :external-format sb-alien::*default-c-string-external-format*)))
162 (sb-sys:with-pinned-objects (arg)
163 (let ((result (alien-funcall (extern-alien "mkstemp"
164 (function int c-string))
165 (sap-alien (sb-alien::vector-sap arg)
167 (when (minusp result)
170 (sb-ext:octets-to-string
172 :external-format sb-alien::*default-c-string-external-format*))))))
173 (define-call-internally ioctl-without-arg "ioctl" int minusp
174 (fd file-descriptor) (cmd int))
175 (define-call-internally ioctl-with-int-arg "ioctl" int minusp
176 (fd file-descriptor) (cmd int) (arg int))
177 (define-call-internally ioctl-with-pointer-arg "ioctl" int minusp
178 (fd file-descriptor) (cmd int)
179 (arg alien-pointer-to-anything-or-nil))
180 (define-entry-point "ioctl" (fd cmd &optional (arg nil argp))
183 ((alien int) (ioctl-with-int-arg fd cmd arg))
184 ((or (alien (* t)) null) (ioctl-with-pointer-arg fd cmd arg)))
185 (ioctl-without-arg fd cmd)))
186 (define-call-internally fcntl-without-arg "fcntl" int minusp
187 (fd file-descriptor) (cmd int))
188 (define-call-internally fcntl-with-int-arg "fcntl" int minusp
189 (fd file-descriptor) (cmd int) (arg int))
190 (define-call-internally fcntl-with-pointer-arg "fcntl" int minusp
191 (fd file-descriptor) (cmd int)
192 (arg alien-pointer-to-anything-or-nil))
193 (define-entry-point "fcntl" (fd cmd &optional (arg nil argp))
196 ((alien int) (fcntl-with-int-arg fd cmd arg))
197 ((or (alien (* t)) null) (fcntl-with-pointer-arg fd cmd arg)))
198 (fcntl-without-arg fd cmd)))
201 (define-call "geteuid" uid-t never-fails) ; "always successful", it says
202 (define-call "getresuid" uid-t never-fails)
203 (define-call "getuid" uid-t never-fails)
204 (define-call "seteuid" int minusp (uid uid-t))
205 (define-call "setfsuid" int minusp (uid uid-t))
206 (define-call "setreuid" int minusp (ruid uid-t) (euid uid-t))
207 (define-call "setresuid" int minusp (ruid uid-t) (euid uid-t) (suid uid-t))
208 (define-call "setuid" int minusp (uid uid-t))
209 (define-call "getegid" gid-t never-fails)
210 (define-call "getgid" gid-t never-fails)
211 (define-call "getresgid" gid-t never-fails)
212 (define-call "setegid" int minusp (gid gid-t))
213 (define-call "setfsgid" int minusp (gid gid-t))
214 (define-call "setgid" int minusp (gid gid-t))
215 (define-call "setregid" int minusp (rgid gid-t) (egid gid-t))
216 (define-call "setresgid" int minusp (rgid gid-t) (egid gid-t) (sgid gid-t))
218 ;; processes, signals
219 (define-call "alarm" int never-fails (seconds unsigned))
223 #+mach-exception-handler
225 ;; FIXME this is a lie, of course this can fail, but there's no
226 ;; error handling here yet!
227 (define-call "setup_mach_exceptions" void never-fails)
228 (define-call ("posix_fork" :c-name "fork") pid-t minusp)
230 (let ((pid (posix-fork)))
232 (setup-mach-exceptions))
234 (export 'fork :sb-posix))
236 #-mach-exception-handler
237 (define-call "fork" pid-t minusp)
239 (define-call "getpgid" pid-t minusp (pid pid-t))
240 (define-call "getppid" pid-t never-fails)
241 (define-call "getpgrp" pid-t never-fails)
242 (define-call "getsid" pid-t minusp (pid pid-t))
243 (define-call "kill" int minusp (pid pid-t) (signal int))
244 (define-call "killpg" int minusp (pgrp int) (signal int))
245 (define-call "pause" int minusp)
246 (define-call "setpgid" int minusp (pid pid-t) (pgid pid-t))
247 (define-call "setpgrp" int minusp))
251 (export 'readlink :sb-posix)
252 (defun readlink (pathspec)
253 (flet ((%readlink (path buf length)
255 (extern-alien "readlink" (function int c-string (* t) int))
257 (loop for size = 128 then (* 2 size)
258 for buf = (make-alien c-string size)
260 (let ((count (%readlink (filename pathspec) buf size)))
261 (cond ((minusp count)
264 (setf (sb-sys:sap-ref-8 (sb-alien:alien-sap buf)
268 (sb-alien::c-string-to-string
269 (sb-alien:alien-sap buf)
270 (sb-impl::default-external-format)
272 (free-alien buf))))))
276 (export 'wait :sb-posix)
277 (declaim (inline wait))
278 (defun wait (&optional statusptr)
279 (declare (type (or null (simple-array (signed-byte 32) (1))) statusptr))
280 (let* ((ptr (or statusptr (make-array 1 :element-type '(signed-byte 32))))
282 (extern-alien "wait" (function pid-t (* int)))
283 (sb-sys:vector-sap ptr))))
286 (values pid (aref ptr 0))))))
290 (export 'waitpid :sb-posix)
291 (declaim (inline waitpid))
292 (defun waitpid (pid options &optional statusptr)
293 (declare (type (sb-alien:alien pid-t) pid)
294 (type (sb-alien:alien int) options)
295 (type (or null (simple-array (signed-byte 32) (1))) statusptr))
296 (let* ((ptr (or statusptr (make-array 1 :element-type '(signed-byte 32))))
298 (extern-alien "waitpid" (function pid-t
300 pid (sb-sys:vector-sap ptr) options)))
303 (values pid (aref ptr 0)))))
305 (define-call "wifexited" boolean never-fails (status int))
306 (define-call "wexitstatus" int never-fails (status int))
307 (define-call "wifsignaled" boolean never-fails (status int))
308 (define-call "wtermsig" int never-fails (status int))
309 (define-call "wifstopped" boolean never-fails (status int))
310 (define-call "wstopsig" int never-fails (status int))
311 #+nil ; see alien/waitpid-macros.c
312 (define-call "wifcontinued" boolean never-fails (status int)))
317 (define-call ("mmap" :options :largefile) sb-sys:system-area-pointer
319 (= (sb-sys:sap-int res) #.(1- (expt 2 sb-vm::n-machine-word-bits))))
320 (addr sap-or-nil) (length unsigned) (prot unsigned)
321 (flags unsigned) (fd file-descriptor) (offset off-t))
323 (define-call "munmap" int minusp
324 (start sb-sys:system-area-pointer) (length unsigned))
326 (define-call "msync" int minusp
327 (addr sb-sys:system-area-pointer) (length unsigned) (flags int)))
330 (define-call "getpagesize" int minusp)
332 ;;; KLUDGE: This could be taken from GetSystemInfo
333 (export (defun getpagesize () 4096))
337 (define-protocol-class passwd alien-passwd ()
338 ((name :initarg :name :accessor passwd-name)
339 (passwd :initarg :passwd :accessor passwd-passwd)
340 (uid :initarg :uid :accessor passwd-uid)
341 (gid :initarg :gid :accessor passwd-gid)
342 (gecos :initarg :gecos :accessor passwd-gecos)
343 (dir :initarg :dir :accessor passwd-dir)
344 (shell :initarg :shell :accessor passwd-shell)))
346 (defmacro define-pw-call (name arg type)
348 ;; FIXME: this isn't the documented way of doing this, surely?
349 (let ((lisp-name (intern (string-upcase name) :sb-posix)))
351 (export ',lisp-name :sb-posix)
352 (declaim (inline ,lisp-name))
353 (defun ,lisp-name (,arg)
354 (let ((r (alien-funcall (extern-alien ,name ,type) ,arg)))
357 (alien-to-passwd r)))))))
359 (define-pw-call "getpwnam" login-name (function (* alien-passwd) c-string))
360 (define-pw-call "getpwuid" uid (function (* alien-passwd) uid-t))
363 (define-protocol-class timeval alien-timeval ()
364 ((sec :initarg :tv-sec :accessor timeval-sec)
365 (usec :initarg :tv-usec :accessor timeval-usec)))
367 (define-protocol-class stat alien-stat ()
368 ((mode :initarg :mode :accessor stat-mode)
369 (ino :initarg :ino :accessor stat-ino)
370 (dev :initarg :dev :accessor stat-dev)
371 (nlink :initarg :nlink :accessor stat-nlink)
372 (uid :initarg :uid :accessor stat-uid)
373 (gid :initarg :gid :accessor stat-gid)
374 (size :initarg :size :accessor stat-size)
375 (atime :initarg :atime :accessor stat-atime)
376 (mtime :initarg :mtime :accessor stat-mtime)
377 (ctime :initarg :ctime :accessor stat-ctime)))
379 (defmacro define-stat-call (name arg designator-fun type)
380 ;; FIXME: this isn't the documented way of doing this, surely?
381 (let ((lisp-name (lisp-for-c-symbol name)))
383 (export ',lisp-name :sb-posix)
384 (declaim (inline ,lisp-name))
385 (defun ,lisp-name (,arg &optional stat)
386 (declare (type (or null (sb-alien:alien (* alien-stat))) stat))
387 (with-alien-stat a-stat ()
388 (let ((r (alien-funcall
389 (extern-alien ,(real-c-name (list name :options :largefile)) ,type)
390 (,designator-fun ,arg)
394 (alien-to-stat a-stat stat)))))))
396 (define-stat-call #-win32 "stat" #+win32 "_stat"
398 (function int c-string (* alien-stat)))
401 (define-stat-call "lstat"
403 (function int c-string (* alien-stat)))
404 ;;; No symbolic links on Windows, so use stat
407 (declaim (inline lstat))
408 (export (defun lstat (filename &optional stat)
409 (if stat (stat filename stat) (stat filename)))))
411 (define-stat-call #-win32 "fstat" #+win32 "_fstat"
413 (function int int (* alien-stat)))
417 (define-call "s_isreg" boolean never-fails (mode mode-t))
418 (define-call "s_isdir" boolean never-fails (mode mode-t))
419 (define-call "s_ischr" boolean never-fails (mode mode-t))
420 (define-call "s_isblk" boolean never-fails (mode mode-t))
421 (define-call "s_isfifo" boolean never-fails (mode mode-t))
422 (define-call "s_islnk" boolean never-fails (mode mode-t))
423 (define-call "s_issock" boolean never-fails (mode mode-t))
427 (export 'pipe :sb-posix)
428 (declaim (inline pipe))
429 (defun pipe (&optional filedes2)
430 (declare (type (or null (simple-array (signed-byte 32) (2))) filedes2))
432 (setq filedes2 (make-array 2 :element-type '(signed-byte 32))))
433 (let ((r (alien-funcall
434 ;; FIXME: (* INT)? (ARRAY INT 2) would be better
435 (extern-alien "pipe" (function int (* int)))
436 (sb-sys:vector-sap filedes2))))
439 (values (aref filedes2 0) (aref filedes2 1))))
442 (define-protocol-class termios alien-termios ()
443 ((iflag :initarg :iflag :accessor sb-posix:termios-iflag)
444 (oflag :initarg :oflag :accessor sb-posix:termios-oflag)
445 (cflag :initarg :cflag :accessor sb-posix:termios-cflag)
446 (lflag :initarg :lflag :accessor sb-posix:termios-lflag)
447 (cc :initarg :cc :accessor sb-posix:termios-cc :array-length nccs)))
451 (export 'tcsetattr :sb-posix)
452 (declaim (inline tcsetattr))
453 (defun tcsetattr (fd actions termios)
454 (declare (type termios termios))
455 (with-alien-termios a-termios ()
456 (termios-to-alien termios a-termios)
457 (let ((fd (file-descriptor fd)))
458 (let* ((r (alien-funcall
461 (function int int int (* alien-termios)))
462 fd actions a-termios)))
466 (export 'tcgetattr :sb-posix)
467 (declaim (inline tcgetattr))
468 (defun tcgetattr (fd &optional termios)
469 (declare (type (or null termios) termios))
470 (with-alien-termios a-termios ()
471 (let ((r (alien-funcall
472 (extern-alien "tcgetattr"
473 (function int int (* alien-termios)))
478 (setf termios (alien-to-termios a-termios termios))))
480 (export 'cfsetispeed :sb-posix)
481 (declaim (inline cfsetispeed))
482 (defun cfsetispeed (speed &optional termios)
483 (declare (type (or null termios) termios))
484 (with-alien-termios a-termios ()
485 (let ((r (alien-funcall
486 (extern-alien "cfsetispeed"
487 (function int (* alien-termios) speed-t))
492 (setf termios (alien-to-termios a-termios termios))))
494 (export 'cfsetospeed :sb-posix)
495 (declaim (inline cfsetospeed))
496 (defun cfsetospeed (speed &optional termios)
497 (declare (type (or null termios) termios))
498 (with-alien-termios a-termios ()
499 (let ((r (alien-funcall
500 (extern-alien "cfsetospeed"
501 (function int (* alien-termios) speed-t))
506 (setf termios (alien-to-termios a-termios termios))))
508 (export 'cfgetispeed :sb-posix)
509 (declaim (inline cfgetispeed))
510 (defun cfgetispeed (termios)
511 (declare (type termios termios))
512 (with-alien-termios a-termios ()
513 (termios-to-alien termios a-termios)
514 (alien-funcall (extern-alien "cfgetispeed"
515 (function speed-t (* alien-termios)))
517 (export 'cfgetospeed :sb-posix)
518 (declaim (inline cfgetospeed))
519 (defun cfgetospeed (termios)
520 (declare (type termios termios))
521 (with-alien-termios a-termios ()
522 (termios-to-alien termios a-termios)
523 (alien-funcall (extern-alien "cfgetospeed"
524 (function speed-t (* alien-termios)))
530 (export 'time :sb-posix)
532 (let ((result (alien-funcall (extern-alien "time"
533 (function time-t (* time-t)))
538 (export 'utime :sb-posix)
539 (defun utime (filename &optional access-time modification-time)
540 (let ((fun (extern-alien "utime" (function int c-string
542 (name (filename filename)))
543 (if (not (and access-time modification-time))
544 (alien-funcall fun name nil)
545 (with-alien ((utimbuf (struct alien-utimbuf)))
546 (setf (slot utimbuf 'actime) (or access-time 0)
547 (slot utimbuf 'modtime) (or modification-time 0))
548 (let ((result (alien-funcall fun name (alien-sap utimbuf))))
552 (export 'utimes :sb-posix)
553 (defun utimes (filename &optional access-time modification-time)
554 (flet ((seconds-and-useconds (time)
555 (multiple-value-bind (integer fractional)
557 (values integer (cl:truncate (* fractional 1000000)))))
558 (maybe-syscall-error (value)
562 (let ((fun (extern-alien "utimes" (function int c-string
563 (* (array alien-timeval 2)))))
564 (name (filename filename)))
565 (if (not (and access-time modification-time))
566 (maybe-syscall-error (alien-funcall fun name nil))
567 (with-alien ((buf (array alien-timeval 2)))
568 (let ((actime (deref buf 0))
569 (modtime (deref buf 1)))
570 (setf (values (slot actime 'sec)
572 (seconds-and-useconds (or access-time 0))
573 (values (slot modtime 'sec)
574 (slot modtime 'usec))
575 (seconds-and-useconds (or modification-time 0)))
576 (maybe-syscall-error (alien-funcall fun name
577 (alien-sap buf))))))))))
582 (export 'getenv :sb-posix)
584 (let ((r (alien-funcall
585 (extern-alien "getenv" (function (* char) c-string))
587 (declare (type (alien (* char)) r))
588 (unless (null-alien r)
590 (define-call "putenv" int minusp (string c-string))
595 (export 'openlog :sb-posix)
596 (export 'syslog :sb-posix)
597 (export 'closelog :sb-posix)
598 (defun openlog (ident options &optional (facility log-user))
599 (alien-funcall (extern-alien
600 "openlog" (function void c-string int int))
601 ident options facility))
602 (defun syslog (priority format &rest args)
603 "Send a message to the syslog facility, with severity level
604 PRIORITY. The message will be formatted as by CL:FORMAT (rather
605 than C's printf) with format string FORMAT and arguments ARGS."
606 (flet ((syslog1 (priority message)
607 (alien-funcall (extern-alien
608 "syslog" (function void int c-string c-string))
609 priority "%s" message)))
610 (syslog1 priority (apply #'format nil format args))))
611 (define-call "closelog" void never-fails))