0.8.16.6:
[sbcl.git] / src / code / time.lisp
index 451003a..c028cb2 100644 (file)
@@ -27,8 +27,8 @@
 
 (defun get-internal-real-time ()
   #!+sb-doc
-  "Return the real time in the internal time format. This is useful for
-  finding elapsed time. See INTERNAL-TIME-UNITS-PER-SECOND."
+  "Return the real time in the internal time format. (See
+  INTERNAL-TIME-UNITS-PER-SECOND.) This is useful for finding elapsed time."
   (multiple-value-bind (ignore seconds useconds) (sb!unix:unix-gettimeofday)
     (declare (ignore ignore) (type (unsigned-byte 32) seconds useconds))
     (let ((base *internal-real-time-base-seconds*)
@@ -47,8 +47,8 @@
 
 (defun get-internal-run-time ()
   #!+sb-doc
-  "Return the run time in the internal time format. This is useful for
-  finding CPU usage."
+  "Return the run time in the internal time format. (See
+  INTERNAL-TIME-UNITS-PER-SECOND.) This is useful for finding CPU usage."
   (declare (values (unsigned-byte 32)))
   (multiple-value-bind (ignore utime-sec utime-usec stime-sec stime-usec)
       (sb!unix:unix-fast-getrusage sb!unix:rusage_self)
 \f
 ;;;; Encode and decode universal times.
 
+;;; In August 2003, work was done in this file for more plausible
+;;; timezone handling after the unix timezone database runs out in
+;;; 2038.  We assume that timezone rules are trending sane rather than
+;;; insane, so for all years after the end of time_t we apply the
+;;; rules for 2035/2036 instead of the actual date asked for.  Making
+;;; the same assumption about the early 1900s would be less
+;;; reasonable, however, so please note that we're still broken for
+;;; local time between 1900-1-1 and 1901-12-13
+
+;;; It should be noted that 64 bit machines don't actually fix this
+;;; problem, at least as of 2003, because the Unix zonefiles are
+;;; specified in terms of 32 bit fields even on, say, the Alpha.  So,
+;;; references to the range of time_t elsewhere in this file should
+;;; rightly be read as shorthand for the range of an signed 32 bit
+;;; number of seconds since 1970-01-01
+
+;;; I'm obliged to Erik Naggum's "Long, Painful History of Time" paper
+;;; <http://heim.ifi.uio.no/~enag/lugm-time.html> for the choice of epoch
+;;; here.  By starting the year in March, we avoid having to test the month
+;;; whenever deciding whether to account for a leap day.  2000 is especially
+;;; special, because it's disvisible by 400, hence the start of a 400 year
+;;; leap year cycle
+
+;;; If a universal-time is after time_t runs out, we find its offset
+;;; from 1st March of whichever year it falls in, then add that to
+;;; 2035-3-1.  This date has two relevant properties: (1) somewhere
+;;; near the end of time_t, and (2) preceding a leap year.  Thus a
+;;; date which is e.g. 365.5 days from March 1st in its year will be
+;;; treated for timezone lookup as if it were Feb 29th 2036
+
+;;; This epoch is used only for fixing the timezones-outside-time_t
+;;; problem.  Someday it would be nice to come back to this code and
+;;; see if the rest of the file and its references to Spice Lisp
+;;; history (Perq time base?) could be cleaned up any on this basis.
+;;; -- dan, 2003-08-08
+
+
 ;;; Subtract from the returned Internal-Time to get the universal
 ;;; time. The offset between our time base and the Perq one is 2145
 ;;; weeks and five days.
    (daylight savings times) or NIL (standard time), and timezone."
   (decode-universal-time (get-universal-time)))
 
+(defconstant +mar-1-2000+ #.(encode-universal-time 0 0 0 1 3 2000 0))
+(defconstant +mar-1-2035+ #.(encode-universal-time 0 0 0 1 3 2035 0))
+
+(defun years-since-mar-2000 (utime)
+  "Returns number of complete years since March 1st 2000, and remainder in seconds" 
+  (let* ((days-in-year (* 86400 365))
+        (days-in-4year (+ (* 4 days-in-year) 86400))
+        (days-in-100year (- (* 25 days-in-4year) 86400))
+        (days-in-400year (+ (* 4 days-in-100year) 86400))
+        (offset (- utime +mar-1-2000+))
+        (year 0))
+    (labels ((whole-num (x y inc max)
+              (let ((w (truncate x y)))
+                (when (and max (> w max)) (setf w max))
+                (incf year (* w inc))
+                (* w y))))
+      (decf offset (whole-num offset days-in-400year 400 nil))
+      (decf offset (whole-num offset days-in-100year 100 3))
+      (decf offset (whole-num offset days-in-4year 4 25))
+      (decf offset (whole-num offset days-in-year 1 3))
+      (values year offset))))
+
+(defun truncate-to-unix-range (utime)
+  (let ((unix-time (- utime unix-to-universal-time)))
+    (if (< unix-time (ash 1 31))
+       unix-time
+       (multiple-value-bind (year offset) (years-since-mar-2000 utime)
+         (declare (ignore year))
+         (+  +mar-1-2035+  (- unix-to-universal-time)  offset)))))
+  
 (defun decode-universal-time (universal-time &optional time-zone)
   #!+sb-doc
   "Converts a universal-time to decoded time format returning the following
    nine values: second, minute, hour, date, month, year, day of week (0 =
    Monday), T (daylight savings time) or NIL (standard time), and timezone.
    Completely ignores daylight-savings-time when time-zone is supplied."
-  (multiple-value-bind (weeks secs)
-      (truncate (+ universal-time seconds-offset)
-               seconds-in-week)
-    (let* ((weeks (+ weeks weeks-offset))
-          (second NIL)
-          (minute NIL)
-          (hour NIL)
-          (date NIL)
-          (month NIL)
-          (year NIL)
-          (day NIL)
-          (daylight NIL)
-          (timezone (cond
-                      ((null time-zone)
-                       (multiple-value-bind
-                             (ignore minwest dst)
-                           (sb!unix::get-timezone (- universal-time
-                                                     unix-to-universal-time))
-                         (declare (ignore ignore))
-                         (declare (fixnum minwest))
-                         (setf daylight dst)
-                         minwest))
-                      (t (* time-zone 60)))))
-      (declare (fixnum timezone))
-      (multiple-value-bind (t1 seconds) (truncate secs 60)
-       (setq second seconds)
-       (setq t1 (- t1 timezone))
-       (let* ((tday (if (< t1 0)
-                        (1- (truncate (1+ t1) minutes-per-day))
-                        (truncate t1 minutes-per-day))))
-         (multiple-value-setq (hour minute)
-           (truncate (- t1 (* tday minutes-per-day)) 60))
-         (let* ((t2 (1- (* (+ (* weeks 7) tday november-17-1858) 4)))
-                (tcent (truncate t2 quarter-days-per-century)))
-           (setq t2 (mod t2 quarter-days-per-century))
-           (setq t2 (+ (- t2 (mod t2 4)) 3))
-           (setq year (+ (* tcent 100) (truncate t2 quarter-days-per-year)))
-           (let ((days-since-mar0 (1+ (truncate (mod t2 quarter-days-per-year)
-                                                4))))
-             (setq day (mod (+ tday weekday-november-17-1858) 7))
-             (let ((t3 (+ (* days-since-mar0 5) 456)))
-               (cond ((>= t3 1989)
-                      (setq t3 (- t3 1836))
-                      (setq year (1+ year))))
-               (multiple-value-setq (month t3) (truncate t3 153))
-               (setq date (1+ (truncate t3 5))))))))
-      (values second minute hour date month year day
-             daylight
-             (if daylight
-                 (1+ (/ timezone 60))
-                 (/ timezone 60))))))
+  (multiple-value-bind (daylight seconds-west)
+      (if time-zone
+         (values nil (* time-zone 60 60))
+         (multiple-value-bind (ignore seconds-west daylight)
+             (sb!unix::get-timezone (truncate-to-unix-range universal-time))
+           (declare (ignore ignore))
+           (declare (fixnum seconds-west))
+           (values daylight seconds-west)))
+    (declare (fixnum seconds-west))
+    (multiple-value-bind (weeks secs)
+       (truncate (+ (- universal-time seconds-west) seconds-offset)
+                 seconds-in-week)
+      (let ((weeks (+ weeks weeks-offset)))
+       (multiple-value-bind (t1 second)
+           (truncate secs 60)
+         (let ((tday (truncate t1 minutes-per-day)))
+           (multiple-value-bind (hour minute)
+               (truncate (- t1 (* tday minutes-per-day)) 60)
+             (let* ((t2 (1- (* (+ (* weeks 7) tday november-17-1858) 4)))
+                    (tcent (truncate t2 quarter-days-per-century)))
+               (setq t2 (mod t2 quarter-days-per-century))
+               (setq t2 (+ (- t2 (mod t2 4)) 3))
+               (let* ((year (+ (* tcent 100)
+                               (truncate t2 quarter-days-per-year)))
+                      (days-since-mar0
+                       (1+ (truncate (mod t2 quarter-days-per-year) 4)))
+                      (day (mod (+ tday weekday-november-17-1858) 7))
+                      (t3 (+ (* days-since-mar0 5) 456)))
+                 (cond ((>= t3 1989)
+                        (setq t3 (- t3 1836))
+                        (setq year (1+ year))))
+                 (multiple-value-bind (month t3)
+                     (truncate t3 153)
+                   (let ((date (1+ (truncate t3 5))))
+                     (values second minute hour date month year day
+                             daylight
+                             (if daylight
+                                 (1+ (/ seconds-west 60 60))
+                                 (/ seconds-west 60 60))))))))))))))
 
 (defun pick-obvious-year (year)
   (declare (type (mod 100) year))
        (incf sum days-in-month))
       (coerce (nreverse reversed-result) 'simple-vector)))
 
+           
 (defun encode-universal-time (second minute hour date month year
                                     &optional time-zone)
   #!+sb-doc
         (hours (+ hour (* days 24))))
     (if time-zone
        (+ second (* (+ minute (* (+ hours time-zone) 60)) 60))
-       (let* ((minwest-guess
-               (sb!unix::unix-get-minutes-west (- (* hours 60 60)
-                                                 unix-to-universal-time)))
-              (guess (+ minute (* hours 60) minwest-guess))
-              (minwest
-               (sb!unix::unix-get-minutes-west (- (* guess 60)
-                                                 unix-to-universal-time))))
-         (+ second (* (+ guess (- minwest minwest-guess)) 60))))))
+       ;; can't ask unix for times after 2037: this is only a problem
+       ;; if we need to query the system timezone
+       (if (> year 2037)
+           (labels ((leap-year-p (year)
+                      (cond ((zerop (mod year 400)) t)
+                            ((zerop (mod year 100)) nil)
+                            ((zerop (mod year 4)) t)
+                            (t nil))))
+             (let* ((fake-year (if (leap-year-p year) 2036 2037))
+                    (fake-time (encode-universal-time second minute hour
+                                                      date month fake-year)))
+               (+ fake-time
+                  (* 86400 (+ (* 365 (- year fake-year))
+                              (- (leap-years-before year)
+                                 (leap-years-before fake-year)))))))
+           (let* ((secwest-guess
+                   (sb!unix::unix-get-seconds-west
+                    (- (* hours 60 60) unix-to-universal-time)))
+                  (guess (+ second (* 60 (+ minute (* hours 60)))
+                            secwest-guess))
+                  (secwest
+                   (sb!unix::unix-get-seconds-west
+                    (- guess unix-to-universal-time))))
+             (+ guess (- secwest secwest-guess)))))))
 \f
 ;;;; TIME
 
+(defvar *gc-run-time* 0
+  #!+sb-doc
+  "the total CPU time spent doing garbage collection (as reported by
+   GET-INTERNAL-RUN-TIME)")
+(declaim (type index *gc-run-time*))
+
 (defmacro time (form)
   #!+sb-doc
   "Execute FORM and print timing information on *TRACE-OUTPUT*."
 ;;; The guts of the TIME macro. Compute overheads, run the (compiled)
 ;;; function, report the times.
 (defun %time (fun)
+  (declare (type function fun))
   (let (old-run-utime
        new-run-utime
        old-run-stime
       (let ((gc-run-time (max (- *gc-run-time* start-gc-run-time) 0)))
        (format *trace-output*
                "~&Evaluation took:~%  ~
-                ~S second~:P of real time~%  ~
-                ~S second~:P of user run time~%  ~
-                ~S second~:P of system run time~%  ~
+                 ~S second~:P of real time~%  ~
+                 ~S second~:P of user run time~%  ~
+                 ~S second~:P of system run time~%  ~
 ~@[                 [Run times include ~S second~:P GC run time.]~%  ~]~
-                ~S page fault~:P and~%  ~
-                ~S bytes consed.~%"
+                 ~S page fault~:P and~%  ~
+                 ~:D bytes consed.~%"
                (max (/ (- new-real-time old-real-time)
                        (float sb!xc:internal-time-units-per-second))
                     0.0)