1 ;;;; This file contains Unix support that SBCL needs to implement
2 ;;;; itself. It's derived from Peter Van Eynde's unix-glibc2.lisp for
3 ;;;; CMU CL, which was derived from CMU CL unix.lisp 1.56. But those
4 ;;;; files aspired to be complete Unix interfaces exported to the end
5 ;;;; user, while this file aims to be as simple as possible and is not
6 ;;;; intended for the end user.
8 ;;;; FIXME: The old CMU CL unix.lisp code was implemented as hand
9 ;;;; transcriptions from Unix headers into Lisp. It appears that this was as
10 ;;;; unmaintainable in practice as you'd expect in theory, so I really really
11 ;;;; don't want to do that. It'd be good to implement the various system calls
12 ;;;; as C code implemented using the Unix header files, and have their
13 ;;;; interface back to SBCL code be characterized by things like "32-bit-wide
14 ;;;; int" which are already in the interface between the runtime
15 ;;;; executable and the SBCL lisp code.
17 ;;;; This software is part of the SBCL system. See the README file for
18 ;;;; more information.
20 ;;;; This software is derived from the CMU CL system, which was
21 ;;;; written at Carnegie Mellon University and released into the
22 ;;;; public domain. The software is in the public domain and is
23 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
24 ;;;; files for more information.
26 (in-package "SB!UNIX")
28 (/show0 "unix.lisp 21")
30 (defmacro def-enum (inc cur &rest names)
31 (flet ((defform (name)
32 (prog1 (when name `(defconstant ,name ,cur))
33 (setf cur (funcall inc cur 1)))))
34 `(progn ,@(mapcar #'defform names))))
36 ;;; Given a C-level zero-terminated array of C strings, return a
37 ;;; corresponding Lisp-level list of SIMPLE-STRINGs.
38 (defun c-strings->string-list (c-strings)
39 (declare (type (alien (* c-string)) c-strings))
40 (let ((reversed-result nil))
41 (dotimes (i most-positive-fixnum (error "argh! can't happen"))
42 (declare (type index i))
43 (let ((c-string (deref c-strings i)))
45 (push c-string reversed-result)
46 (return (nreverse reversed-result)))))))
48 ;;;; Lisp types used by syscalls
50 (deftype unix-pathname () 'simple-string)
51 (deftype unix-fd () `(integer 0 ,most-positive-fixnum))
53 (deftype unix-file-mode () '(unsigned-byte 32))
54 (deftype unix-pid () '(unsigned-byte 32))
55 (deftype unix-uid () '(unsigned-byte 32))
56 (deftype unix-gid () '(unsigned-byte 32))
60 (/show0 "unix.lisp 74")
62 ;;; FIXME: The various FOO-SYSCALL-BAR macros, and perhaps some other
63 ;;; macros in this file, are only used in this file, and could be
64 ;;; implemented using SB!XC:DEFMACRO wrapped in EVAL-WHEN.
66 (defmacro syscall ((name &rest arg-types) success-form &rest args)
67 `(let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
70 (values nil (get-errno))
73 ;;; This is like SYSCALL, but if it fails, signal an error instead of
74 ;;; returning error codes. Should only be used for syscalls that will
75 ;;; never really get an error.
76 (defmacro syscall* ((name &rest arg-types) success-form &rest args)
77 `(let ((result (alien-funcall (extern-alien ,name (function int ,@arg-types))
80 (error "Syscall ~A failed: ~A" ,name (strerror))
83 (/show0 "unix.lisp 109")
85 (defmacro void-syscall ((name &rest arg-types) &rest args)
86 `(syscall (,name ,@arg-types) (values t 0) ,@args))
88 (defmacro int-syscall ((name &rest arg-types) &rest args)
89 `(syscall (,name ,@arg-types) (values result 0) ,@args))
91 ;;;; hacking the Unix environment
93 (def-alien-routine ("getenv" posix-getenv) c-string
94 "Return the \"value\" part of the environment string \"name=value\" which
95 corresponds to NAME, or NIL if there is none."
100 ;;; Rename the file with string NAME1 to the string NAME2. NIL and an
101 ;;; error code is returned if an error occurs.
102 (defun unix-rename (name1 name2)
103 (declare (type unix-pathname name1 name2))
104 (void-syscall ("rename" c-string c-string) name1 name2))
106 ;;; from sys/types.h and gnu/types.h
108 (/show0 "unix.lisp 220")
110 ;;; FIXME: We shouldn't hand-copy types from header files into Lisp
111 ;;; like this unless we have extreme provocation. Reading directories
112 ;;; is not extreme enough, since it doesn't need to be blindingly
113 ;;; fast: we can just implement those functions in C as a wrapper
115 (def-alien-type fd-mask unsigned-long)
117 (eval-when (:compile-toplevel :load-toplevel :execute)
118 (defconstant fd-setsize 1024))
122 (fds-bits (array fd-mask #.(/ fd-setsize 32)))))
124 (/show0 "unix.lisp 304")
129 ;;;; POSIX Standard: 6.5 File Control Operations <fcntl.h>
131 ;;; Open the file whose pathname is specified by PATH for reading
132 ;;; and/or writing as specified by the FLAGS argument. Various FLAGS
133 ;;; masks (O_RDONLY etc.) are defined in fcntlbits.h.
135 ;;; If the O_CREAT flag is specified, then the file is created with a
136 ;;; permission of argument MODE if the file doesn't exist. An integer
137 ;;; file descriptor is returned by UNIX-OPEN.
138 (defun unix-open (path flags mode)
139 (declare (type unix-pathname path)
141 (type unix-file-mode mode))
142 (int-syscall ("open" c-string int int) path flags mode))
144 ;;; UNIX-CLOSE accepts a file descriptor and attempts to close the file
145 ;;; associated with it.
146 (/show0 "unix.lisp 391")
147 (defun unix-close (fd)
148 (declare (type unix-fd fd))
149 (void-syscall ("close" int) fd))
153 ;; A time value that is accurate to the nearest
154 ;; microsecond but also has a range of years.
157 (tv-sec time-t) ; seconds
158 (tv-usec time-t))) ; and microseconds
162 (defconstant rusage_self 0) ; the calling process
163 (defconstant rusage_children -1) ; terminated child processes
164 (defconstant rusage_both -2)
168 (ru-utime (struct timeval)) ; user time used
169 (ru-stime (struct timeval)) ; system time used.
170 (ru-maxrss long) ; maximum resident set size (in kilobytes)
171 (ru-ixrss long) ; integral shared memory size
172 (ru-idrss long) ; integral unshared data size
173 (ru-isrss long) ; integral unshared stack size
174 (ru-minflt long) ; page reclaims
175 (ru-majflt long) ; page faults
176 (ru-nswap long) ; swaps
177 (ru-inblock long) ; block input operations
178 (ru-oublock long) ; block output operations
179 (ru-msgsnd long) ; messages sent
180 (ru-msgrcv long) ; messages received
181 (ru-nsignals long) ; signals received
182 (ru-nvcsw long) ; voluntary context switches
183 (ru-nivcsw long))) ; involuntary context switches
187 ;;; Given a file path (a string) and one of four constant modes,
188 ;;; return T if the file is accessible with that mode and NIL if not.
189 ;;; When NIL, also return an errno value with NIL which tells why the
190 ;;; file was not accessible.
192 ;;; The access modes are:
193 ;;; r_ok Read permission.
194 ;;; w_ok Write permission.
195 ;;; x_ok Execute permission.
196 ;;; f_ok Presence of file.
197 (defun unix-access (path mode)
198 (declare (type unix-pathname path)
200 (void-syscall ("access" c-string int) path mode))
202 ;;; values for the second argument to UNIX-LSEEK
203 (defconstant l_set 0) ; to set the file pointer
204 (defconstant l_incr 1) ; to increment the file pointer
205 (defconstant l_xtnd 2) ; to extend the file size
207 ;;; Accept a file descriptor and move the file pointer ahead
208 ;;; a certain offset for that file. WHENCE can be any of the following:
209 ;;; L_SET Set the file pointer.
210 ;;; L_INCR Increment the file pointer.
211 ;;; L_XTND Extend the file size.
212 (defun unix-lseek (fd offset whence)
213 (declare (type unix-fd fd)
214 (type (unsigned-byte 32) offset)
215 (type (integer 0 2) whence))
217 (int-syscall ("lseek" int off-t int) fd offset whence)
218 ;; Need a 64-bit return value type for this. TBD. For now,
219 ;; don't use this with any 2G+ partitions.
221 (int-syscall ("lseek" int unsigned-long unsigned-long int)
224 ;;; UNIX-READ accepts a file descriptor, a buffer, and the length to read.
225 ;;; It attempts to read len bytes from the device associated with fd
226 ;;; and store them into the buffer. It returns the actual number of
228 (defun unix-read (fd buf len)
229 (declare (type unix-fd fd)
230 (type (unsigned-byte 32) len))
232 (int-syscall ("read" int (* char) int) fd buf len))
234 ;;; UNIX-WRITE accepts a file descriptor, a buffer, an offset, and the
235 ;;; length to write. It attempts to write len bytes to the device
236 ;;; associated with fd from the the buffer starting at offset. It returns
237 ;;; the actual number of bytes written.
238 (defun unix-write (fd buf offset len)
239 (declare (type unix-fd fd)
240 (type (unsigned-byte 32) offset len))
241 (int-syscall ("write" int (* char) int)
243 (with-alien ((ptr (* char) (etypecase buf
244 ((simple-array * (*))
248 (addr (deref ptr offset)))
251 ;;; Set up a unix-piping mechanism consisting of an input pipe and an
252 ;;; output pipe. Return two values: if no error occurred the first
253 ;;; value is the pipe to be read from and the second is can be written
254 ;;; to. If an error occurred the first value is NIL and the second the
257 (with-alien ((fds (array int 2)))
258 (syscall ("pipe" (* int))
259 (values (deref fds 0) (deref fds 1))
260 (cast fds (* int)))))
262 (defun unix-mkdir (name mode)
263 (declare (type unix-pathname name)
264 (type unix-file-mode mode))
265 (void-syscall ("mkdir" c-string int) name mode))
267 ;;; Return the Unix current directory as a SIMPLE-STRING, in the
268 ;;; style returned by getcwd() (no trailing slash character).
269 (defun posix-getcwd ()
270 ;; This implementation relies on a BSD/Linux extension to getcwd()
271 ;; behavior, automatically allocating memory when a null buffer
272 ;; pointer is used. On a system which doesn't support that
273 ;; extension, it'll have to be rewritten somehow.
274 #!-(or linux openbsd freebsd) (,stub,)
275 (let* ((raw-char-ptr (alien-funcall (extern-alien "getcwd"
279 (if (null-alien raw-char-ptr)
280 (simple-perror "getcwd")
282 (cast raw-char-ptr c-string)
283 (free-alien raw-char-ptr)))))
285 ;;; Return the Unix current directory as a SIMPLE-STRING terminated
286 ;;; by a slash character.
287 (defun posix-getcwd/ ()
288 (concatenate 'string (posix-getcwd) "/"))
290 ;;; Convert at the UNIX level from a possibly relative filename to
291 ;;; an absolute filename.
293 ;;; FIXME: Do we still need this even as we switch to
294 ;;; *DEFAULT-PATHNAME-DEFAULTS*? I think maybe we do, since it seems
295 ;;; to be valid for the user to set *DEFAULT-PATHNAME-DEFAULTS* to
296 ;;; have a NIL directory component, and then this'd be the only way to
297 ;;; interpret a relative directory specification. But I don't find the
298 ;;; ANSI pathname documentation to be a model of clarity. Maybe
299 ;;; someone who understands it better can take a look at this.. -- WHN
300 (defun unix-maybe-prepend-current-directory (name)
301 (declare (simple-string name))
302 (if (and (> (length name) 0) (char= (schar name 0) #\/))
304 (concatenate 'simple-string (posix-getcwd/) name)))
306 ;;; Duplicate an existing file descriptor (given as the argument) and
307 ;;; return it. If FD is not a valid file descriptor, NIL and an error
308 ;;; number are returned.
310 (declare (type unix-fd fd))
311 (int-syscall ("dup" int) fd))
313 ;;; Terminate the current process with an optional error code. If
314 ;;; successful, the call doesn't return. If unsuccessful, the call
315 ;;; returns NIL and an error number.
316 (defun unix-exit (&optional (code 0))
317 (declare (type (signed-byte 32) code))
318 (void-syscall ("exit" int) code))
320 ;;; Return the process id of the current process.
321 (def-alien-routine ("getpid" unix-getpid) int)
323 ;;; Return the real user-id associated with the current process.
324 (def-alien-routine ("getuid" unix-getuid) int)
326 ;;; Invoke readlink(2) on the file name specified by PATH. Return
327 ;;; (VALUES LINKSTRING NIL) on success, or (VALUES NIL ERRNO) on
329 (defun unix-readlink (path)
330 (declare (type unix-pathname path))
331 (with-alien ((ptr (* char)
332 (alien-funcall (extern-alien
334 (function (* char) c-string))
337 (values nil (get-errno))
338 (multiple-value-prog1
339 (values (with-alien ((c-string c-string ptr)) c-string)
343 ;;; UNIX-UNLINK accepts a name and deletes the directory entry for that
344 ;;; name and the file if this is the last link.
345 (defun unix-unlink (name)
346 (declare (type unix-pathname name))
347 (void-syscall ("unlink" c-string) name))
349 ;;; Set the tty-process-group for the unix file-descriptor FD to PGRP.
350 ;;; If not supplied, FD defaults to "/dev/tty".
351 (defun %set-tty-process-group (pgrp &optional fd)
352 (let ((old-sigs (unix-sigblock (sigmask :sigttou
356 (declare (type (unsigned-byte 32) old-sigs))
360 (multiple-value-bind (tty-fd errno) (unix-open "/dev/tty" o_rdwr 0)
362 (multiple-value-prog1
363 (tcsetpgrp tty-fd pgrp)
364 (unix-close tty-fd)))
366 (values nil errno)))))
367 (unix-sigsetmask old-sigs))))
369 ;;; Return the name of the host machine as a string.
370 (defun unix-gethostname ()
371 (with-alien ((buf (array char 256)))
372 (syscall ("gethostname" (* char) int)
374 (cast buf (* char)) 256)))
376 ;;; Write the core image of the file described by FD to disk.
377 (defun unix-fsync (fd)
378 (declare (type unix-fd fd))
379 (void-syscall ("fsync" int) fd))
383 ;;; UNIX-IOCTL performs a variety of operations on open i/o
384 ;;; descriptors. See the UNIX Programmer's Manual for more
386 (defun unix-ioctl (fd cmd arg)
387 (declare (type unix-fd fd)
388 (type (unsigned-byte 32) cmd))
389 (void-syscall ("ioctl" int unsigned-int (* char)) fd cmd arg))
393 ;;; FIXME: All we seem to need is the RUSAGE_SELF version of this.
395 ;;; Like getrusage(2), but return only the system and user time,
396 ;;; and return the seconds and microseconds as separate values.
397 #!-sb-fluid (declaim (inline unix-fast-getrusage))
398 (defun unix-fast-getrusage (who)
399 (declare (values (member t)
400 (unsigned-byte 31) (integer 0 1000000)
401 (unsigned-byte 31) (integer 0 1000000)))
402 (with-alien ((usage (struct rusage)))
403 (syscall* ("getrusage" int (* (struct rusage)))
405 (slot (slot usage 'ru-utime) 'tv-sec)
406 (slot (slot usage 'ru-utime) 'tv-usec)
407 (slot (slot usage 'ru-stime) 'tv-sec)
408 (slot (slot usage 'ru-stime) 'tv-usec))
411 ;;; Return information about the resource usage of the process
412 ;;; specified by WHO. WHO can be either the current process
413 ;;; (rusage_self) or all of the terminated child processes
414 ;;; (rusage_children). NIL and an error number is returned if the call
416 (defun unix-getrusage (who)
417 (with-alien ((usage (struct rusage)))
418 (syscall ("getrusage" int (* (struct rusage)))
420 (+ (* (slot (slot usage 'ru-utime) 'tv-sec) 1000000)
421 (slot (slot usage 'ru-utime) 'tv-usec))
422 (+ (* (slot (slot usage 'ru-stime) 'tv-sec) 1000000)
423 (slot (slot usage 'ru-stime) 'tv-usec))
424 (slot usage 'ru-maxrss)
425 (slot usage 'ru-ixrss)
426 (slot usage 'ru-idrss)
427 (slot usage 'ru-isrss)
428 (slot usage 'ru-minflt)
429 (slot usage 'ru-majflt)
430 (slot usage 'ru-nswap)
431 (slot usage 'ru-inblock)
432 (slot usage 'ru-oublock)
433 (slot usage 'ru-msgsnd)
434 (slot usage 'ru-msgrcv)
435 (slot usage 'ru-nsignals)
436 (slot usage 'ru-nvcsw)
437 (slot usage 'ru-nivcsw))
442 (defmacro unix-fast-select (num-descriptors
443 read-fds write-fds exception-fds
444 timeout-secs &optional (timeout-usecs 0))
446 "Perform the UNIX select(2) system call."
447 (declare (type (integer 0 #.FD-SETSIZE) num-descriptors)
448 (type (or (alien (* (struct fd-set))) null)
449 read-fds write-fds exception-fds)
450 (type (or null (unsigned-byte 31)) timeout-secs)
451 (type (unsigned-byte 31) timeout-usecs) )
453 ;; (optimize (speed 3) (safety 0) (inhibit-warnings 3))
454 ;; in the declarations above. If they're important, they should
455 ;; be in a declaration inside the LET expansion, not in the
456 ;; macro compile-time code.
457 `(let ((timeout-secs ,timeout-secs))
458 (with-alien ((tv (struct timeval)))
460 (setf (slot tv 'tv-sec) timeout-secs)
461 (setf (slot tv 'tv-usec) ,timeout-usecs))
462 (int-syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
463 (* (struct fd-set)) (* (struct timeval)))
464 ,num-descriptors ,read-fds ,write-fds ,exception-fds
465 (if timeout-secs (alien-sap (addr tv)) (int-sap 0))))))
467 ;;; UNIX-SELECT accepts sets of file descriptors and waits for an event
468 ;;; to happen on one of them or to time out.
469 (defmacro num-to-fd-set (fdset num)
472 (setf (deref (slot ,fdset 'fds-bits) 0) ,num)
473 ,@(loop for index upfrom 1 below (/ fd-setsize 32)
474 collect `(setf (deref (slot ,fdset 'fds-bits) ,index) 0)))
476 ,@(loop for index upfrom 0 below (/ fd-setsize 32)
477 collect `(setf (deref (slot ,fdset 'fds-bits) ,index)
478 (ldb (byte 32 ,(* index 32)) ,num))))))
480 (defmacro fd-set-to-num (nfds fdset)
482 (deref (slot ,fdset 'fds-bits) 0)
483 (+ ,@(loop for index upfrom 0 below (/ fd-setsize 32)
484 collect `(ash (deref (slot ,fdset 'fds-bits) ,index)
487 ;;; Examine the sets of descriptors passed as arguments to see whether
488 ;;; they are ready for reading and writing. See the UNIX Programmer's
489 ;;; Manual for more information.
490 (defun unix-select (nfds rdfds wrfds xpfds to-secs &optional (to-usecs 0))
491 (declare (type (integer 0 #.FD-SETSIZE) nfds)
492 (type unsigned-byte rdfds wrfds xpfds)
493 (type (or (unsigned-byte 31) null) to-secs)
494 (type (unsigned-byte 31) to-usecs)
495 (optimize (speed 3) (safety 0) (inhibit-warnings 3)))
496 (with-alien ((tv (struct timeval))
497 (rdf (struct fd-set))
498 (wrf (struct fd-set))
499 (xpf (struct fd-set)))
501 (setf (slot tv 'tv-sec) to-secs)
502 (setf (slot tv 'tv-usec) to-usecs))
503 (num-to-fd-set rdf rdfds)
504 (num-to-fd-set wrf wrfds)
505 (num-to-fd-set xpf xpfds)
506 (macrolet ((frob (lispvar alienvar)
507 `(if (zerop ,lispvar)
509 (alien-sap (addr ,alienvar)))))
510 (syscall ("select" int (* (struct fd-set)) (* (struct fd-set))
511 (* (struct fd-set)) (* (struct timeval)))
513 (fd-set-to-num nfds rdf)
514 (fd-set-to-num nfds wrf)
515 (fd-set-to-num nfds xpf))
516 nfds (frob rdfds rdf) (frob wrfds wrf) (frob xpfds xpf)
517 (if to-secs (alien-sap (addr tv)) (int-sap 0))))))
521 ;;; This is a structure defined in src/runtime/wrap.c, to look
522 ;;; basically like "struct stat" according to stat(2). It may not
523 ;;; actually correspond to the real in-memory stat structure that the
524 ;;; syscall uses, and that's OK. Linux in particular is packed full of
525 ;;; stat macros, and trying to keep Lisp code in correspondence with
526 ;;; it is more pain than it's worth, so we just let our C runtime
527 ;;; synthesize a nice consistent structure for us.
529 ;;; Note that st-dev is a long, not a dev-t. This is because dev-t on
530 ;;; linux 32 bit archs is a 64 bit quantity, but alien doesn's support
531 ;;; those. We don't actually access that field anywhere, though, so
532 ;;; until we can get 64 bit alien support it'll do. Also note that
533 ;;; st_size is a long, not an off-t, because off-t is a 64-bit
534 ;;; quantity on Alpha. And FIXME: "No one would want a file length
535 ;;; longer than 32 bits anyway, right?":-|
538 (st-dev unsigned-long) ; would be dev-t in a real stat
544 (st-rdev unsigned-long) ; would be dev-t in a real stat
545 (st-size unsigned-long) ; would be off-t in a real stat
546 (st-blksize unsigned-long)
547 (st-blocks unsigned-long)
552 ;;; shared C-struct-to-multiple-VALUES conversion for the stat(2)
553 ;;; family of Unix system calls
555 ;;; FIXME: I think this should probably not be INLINE. However, when
556 ;;; this was not inline, it seemed to cause memory corruption
557 ;;; problems. My first guess is that it's a bug in the FFI code, where
558 ;;; the WITH-ALIEN expansion doesn't deal well with being wrapped
559 ;;; around a call to a function returning >10 values. But I didn't try
560 ;;; to figure it out, just inlined it as a quick fix. Perhaps someone
561 ;;; who's motivated to debug the FFI code can go over the DISASSEMBLE
562 ;;; output in the not-inlined case and see whether there's a problem,
563 ;;; and maybe even find a fix..
564 (declaim (inline %extract-stat-results))
565 (defun %extract-stat-results (wrapped-stat)
566 (declare (type (alien (* (struct wrapped_stat))) wrapped-stat))
568 (slot wrapped-stat 'st-dev)
569 (slot wrapped-stat 'st-ino)
570 (slot wrapped-stat 'st-mode)
571 (slot wrapped-stat 'st-nlink)
572 (slot wrapped-stat 'st-uid)
573 (slot wrapped-stat 'st-gid)
574 (slot wrapped-stat 'st-rdev)
575 (slot wrapped-stat 'st-size)
576 (slot wrapped-stat 'st-atime)
577 (slot wrapped-stat 'st-mtime)
578 (slot wrapped-stat 'st-ctime)
579 (slot wrapped-stat 'st-blksize)
580 (slot wrapped-stat 'st-blocks)))
582 ;;; Unix system calls in the stat(2) family are handled by calls to
583 ;;; C-level wrapper functions which copy all the raw "struct stat"
584 ;;; slots into the system-independent wrapped_stat format.
585 ;;; stat(2) <-> stat_wrapper()
586 ;;; fstat(2) <-> fstat_wrapper()
587 ;;; lstat(2) <-> lstat_wrapper()
588 (defun unix-stat (name)
589 (declare (type unix-pathname name))
590 (with-alien ((buf (struct wrapped_stat)))
591 (syscall ("stat_wrapper" c-string (* (struct wrapped_stat)))
592 (%extract-stat-results (addr buf))
594 (defun unix-lstat (name)
595 (declare (type unix-pathname name))
596 (with-alien ((buf (struct wrapped_stat)))
597 (syscall ("lstat_wrapper" c-string (* (struct wrapped_stat)))
598 (%extract-stat-results (addr buf))
600 (defun unix-fstat (fd)
601 (declare (type unix-fd fd))
602 (with-alien ((buf (struct wrapped_stat)))
603 (syscall ("fstat_wrapper" int (* (struct wrapped_stat)))
604 (%extract-stat-results (addr buf))
609 ;; the POSIX.4 structure for a time value. This is like a "struct
610 ;; timeval" but has nanoseconds instead of microseconds.
613 (tv-sec long) ; seconds
614 (tv-nsec long))) ; nanoseconds
616 ;; used by other time functions
619 (tm-sec int) ; Seconds. [0-60] (1 leap second)
620 (tm-min int) ; Minutes. [0-59]
621 (tm-hour int) ; Hours. [0-23]
622 (tm-mday int) ; Day. [1-31]
623 (tm-mon int) ; Month. [0-11]
624 (tm-year int) ; Year - 1900.
625 (tm-wday int) ; Day of week. [0-6]
626 (tm-yday int) ; Days in year. [0-365]
627 (tm-isdst int) ; DST. [-1/0/1]
628 (tm-gmtoff long) ; Seconds east of UTC.
629 (tm-zone c-string))) ; Timezone abbreviation.
631 (def-alien-routine get-timezone sb!c-call:void
632 (when sb!c-call:long :in)
633 (minutes-west sb!c-call:int :out)
634 (daylight-savings-p sb!alien:boolean :out))
636 (defun unix-get-minutes-west (secs)
637 (multiple-value-bind (ignore minutes dst) (get-timezone secs)
638 (declare (ignore ignore) (ignore dst))
641 (defun unix-get-timezone (secs)
642 (multiple-value-bind (ignore minutes dst) (get-timezone secs)
643 (declare (ignore ignore) (ignore minutes))
644 (values (deref unix-tzname (if dst 1 0)))))
649 ;;; Structure crudely representing a timezone. KLUDGE: This is
650 ;;; obsolete and should never be used.
653 (tz-minuteswest int) ; minutes west of Greenwich
654 (tz-dsttime int))) ; type of dst correction
656 ;;; If it works, UNIX-GETTIMEOFDAY returns 5 values: T, the seconds
657 ;;; and microseconds of the current time of day, the timezone (in
658 ;;; minutes west of Greenwich), and a daylight-savings flag. If it
659 ;;; doesn't work, it returns NIL and the errno.
660 #!-sb-fluid (declaim (inline unix-gettimeofday))
661 (defun unix-gettimeofday ()
662 (with-alien ((tv (struct timeval))
663 (tz (struct timezone)))
664 (syscall* ("gettimeofday" (* (struct timeval))
665 (* (struct timezone)))
669 (slot tz 'tz-minuteswest)
670 (slot tz 'tz-dsttime))
675 (defconstant ENOENT 2) ; Unix error code, "No such file or directory"
676 (defconstant EINTR 4) ; Unix error code, "Interrupted system call"
677 (defconstant EIO 5) ; Unix error code, "I/O error"
678 (defconstant EEXIST 17) ; Unix error code, "File exists"
679 (defconstant ESPIPE 29) ; Unix error code, "Illegal seek"
680 (defconstant EWOULDBLOCK 11) ; Unix error code, "Operation would block"
681 ;;; FIXME: Many Unix error code definitions were deleted from the old
682 ;;; CMU CL source code here, but not in the exports of SB-UNIX. I
683 ;;; (WHN) hope that someday I'll figure out an automatic way to detect
684 ;;; unused symbols in package exports, but if I don't, there are
685 ;;; enough of them all in one place here that they should probably be
689 ;;;; support routines for dealing with Unix pathnames
691 (defun unix-file-kind (name &optional check-for-links)
693 "Return either :FILE, :DIRECTORY, :LINK, :SPECIAL, or NIL."
694 (declare (simple-string name))
695 (multiple-value-bind (res dev ino mode)
696 (if check-for-links (unix-lstat name) (unix-stat name))
697 (declare (type (or fixnum null) mode)
700 (let ((kind (logand mode s-ifmt)))
701 (cond ((eql kind s-ifdir) :directory)
702 ((eql kind s-ifreg) :file)
703 ((eql kind s-iflnk) :link)
706 ;;; Is the Unix pathname PATHNAME relative, instead of absolute? (E.g.
707 ;;; "passwd" or "etc/passwd" instead of "/etc/passwd"?)
708 (defun relative-unix-pathname? (pathname)
709 (declare (type simple-string pathname))
710 (or (zerop (length pathname))
711 (char/= (schar pathname 0) #\/)))
713 ;;; Return PATHNAME with all symbolic links resolved. PATHNAME should
714 ;;; already be a complete absolute Unix pathname, since at least in
715 ;;; sbcl-0.6.12.36 we're called only from TRUENAME, and only after
716 ;;; paths have been converted to absolute paths, so we don't need to
717 ;;; try to handle any more generality than that.
718 (defun unix-resolve-links (pathname)
719 (declare (type simple-string pathname))
720 (aver (not (relative-unix-pathname? pathname)))
721 (/show "entering UNIX-RESOLVE-LINKS")
722 (loop with previous-pathnames = nil do
723 (/show pathname previous-pathnames)
724 (let ((link (unix-readlink pathname)))
726 ;; Unlike the old CMU CL code, we handle a broken symlink by
727 ;; returning the link itself. That way, CL:TRUENAME on a
728 ;; broken link returns the link itself, so that CL:DIRECTORY
729 ;; can return broken links, so that even without
730 ;; Unix-specific extensions to do interesting things with
731 ;; them, at least Lisp programs can see them and, if
732 ;; necessary, delete them. (This is handy e.g. when your
733 ;; managed-by-Lisp directories are visited by Emacs, which
734 ;; creates broken links as notes to itself.)
738 (unix-simplify-pathname
739 (if (relative-unix-pathname? link)
740 (let* ((dir-len (1+ (position #\/
743 (dir (subseq pathname 0 dir-len)))
745 (concatenate 'string dir link))
747 (if (unix-file-kind new-pathname)
748 (setf pathname new-pathname)
749 (return pathname)))))
750 ;; To generalize the principle that even if portable Lisp code
751 ;; can't do anything interesting with a broken symlink, at
752 ;; least it should be able to see and delete it, when we
753 ;; detect a cyclic link, we return the link itself. (So even
754 ;; though portable Lisp code can't do anything interesting
755 ;; with a cyclic link, at least it can see it and delete it.)
756 (if (member pathname previous-pathnames :test #'string=)
758 (push pathname previous-pathnames))))
760 (defun unix-simplify-pathname (src)
761 (declare (type simple-string src))
762 (let* ((src-len (length src))
763 (dst (make-string src-len))
767 (macrolet ((deposit (char)
769 (setf (schar dst dst-len) ,char)
771 (dotimes (src-index src-len)
772 (let ((char (schar src src-index)))
773 (cond ((char= char #\.)
780 ;; either ``/...' or ``...//...'
782 (setf last-slash dst-len)
785 ;; either ``./...'' or ``..././...''
790 ((and last-slash (not (zerop last-slash)))
791 ;; There is something before this ..
792 (let ((prev-prev-slash
793 (position #\/ dst :end last-slash :from-end t)))
794 (cond ((and (= (+ (or prev-prev-slash 0) 2)
796 (char= (schar dst (- last-slash 2)) #\.)
797 (char= (schar dst (1- last-slash)) #\.))
798 ;; The something before this .. is another ..
800 (setf last-slash dst-len))
802 ;; The something is some directory or other.
807 (setf last-slash prev-prev-slash)))))
809 ;; There is nothing before this .., so we need to keep it
810 (setf last-slash dst-len)
813 ;; something other than a dot between slashes
814 (setf last-slash dst-len)
819 (setf (schar dst dst-len) char)
821 (when (and last-slash (not (zerop last-slash)))
824 ;; We've got ``foobar/.''
827 ;; We've got ``foobar/..''
828 (unless (and (>= last-slash 2)
829 (char= (schar dst (1- last-slash)) #\.)
830 (char= (schar dst (- last-slash 2)) #\.)
832 (char= (schar dst (- last-slash 3)) #\/)))
833 (let ((prev-prev-slash
834 (position #\/ dst :end last-slash :from-end t)))
836 (setf dst-len (1+ prev-prev-slash))
837 (return-from unix-simplify-pathname "./")))))))
838 (cond ((zerop dst-len)
843 (subseq dst 0 dst-len)))))
845 ;;;; stuff not yet found in the header files
847 ;;;; Abandon all hope who enters here...
849 ;;; not checked for linux...
850 (defmacro fd-set (offset fd-set)
851 (let ((word (gensym))
853 `(multiple-value-bind (,word ,bit) (floor ,offset 32)
854 (setf (deref (slot ,fd-set 'fds-bits) ,word)
855 (logior (truly-the (unsigned-byte 32) (ash 1 ,bit))
856 (deref (slot ,fd-set 'fds-bits) ,word))))))
858 ;;; not checked for linux...
859 (defmacro fd-clr (offset fd-set)
860 (let ((word (gensym))
862 `(multiple-value-bind (,word ,bit) (floor ,offset 32)
863 (setf (deref (slot ,fd-set 'fds-bits) ,word)
864 (logand (deref (slot ,fd-set 'fds-bits) ,word)
865 (sb!kernel:32bit-logical-not
866 (truly-the (unsigned-byte 32) (ash 1 ,bit))))))))
868 ;;; not checked for linux...
869 (defmacro fd-isset (offset fd-set)
870 (let ((word (gensym))
872 `(multiple-value-bind (,word ,bit) (floor ,offset 32)
873 (logbitp ,bit (deref (slot ,fd-set 'fds-bits) ,word)))))
875 ;;; not checked for linux...
876 (defmacro fd-zero (fd-set)
878 ,@(loop for index upfrom 0 below (/ fd-setsize 32)
879 collect `(setf (deref (slot ,fd-set 'fds-bits) ,index) 0))))