replace internal uses of gettimeofday with monotonic time where appropriate. make...
[lcore.git] / btime.pas
index 9bb95502b13300569be20b37194f402ab646334b..a3428e8546c6e39d0a52e1b2d92ee0e1d352df8e 100644 (file)
--- a/btime.pas
+++ b/btime.pas
@@ -9,11 +9,22 @@ works on windows/delphi, and on freepascal on unix.
 \r
 \r
 unit btime;\r
+{$ifdef fpc}\r
+  {$mode delphi}\r
+{$endif}\r
+\r
+{$include lcoreconfig.inc}\r
 \r
 interface\r
 \r
+{$ifdef mswindows}\r
+uses\r
+  ltimevalstuff;\r
+{$endif}  \r
+\r
 type\r
   float=extended;\r
+  tunixtimeint={$ifdef ver100}longint;{$else}int64;{$endif}\r
 \r
 const\r
   colorburst=39375000/11;  {3579545.4545....}\r
@@ -21,40 +32,56 @@ const
 var\r
   timezone:integer;\r
   timezonestr:string;\r
-  irctime,unixtime:integer;\r
+  irctime,unixtime:tunixtimeint;\r
   tickcount:integer;\r
-  settimebias:integer;\r
+  settimebias:tunixtimeint;\r
   performancecountfreq:extended;\r
+  btimenowin8:boolean;\r
 \r
 function irctimefloat:float;\r
-function irctimeint:integer;\r
+function irctimeint:tunixtimeint;\r
 \r
+//unix timestamp (UTC) float seconds\r
 function unixtimefloat:float;\r
-function unixtimeint:integer;\r
+function unixtimeint:tunixtimeint;\r
 \r
+//monotonic float seconds\r
+function monotimefloat:float;\r
+\r
+//monotonic (alias, old function name)\r
 function wintimefloat:float;\r
 \r
-procedure settime(newtime:integer);\r
+procedure settime(newtime:tunixtimeint);\r
 procedure gettimezone;\r
 procedure timehandler;\r
 procedure init;\r
 \r
-function timestring(i:integer):string;\r
-function timestrshort(i:integer):string;\r
+function timestring(i:tunixtimeint):string;      // Wednesday August 15 2012 -- 16:21:09 +02:00\r
+function timestrshort(i:tunixtimeint):string;    // Wed Aug 15 16:21:09 2012\r
+function timestriso(i:tunixtimeint):string;      // 2012-08-15 16:21:09\r
+function timestrisoutc(i:float):string;          // 2012-08-15T14:21:09.255553Z\r
+\r
+procedure beginhightimerrate;\r
+procedure endhightimerrate;\r
 \r
-{$ifdef win32}\r
+{$ifdef mswindows}\r
 function unixtimefloat_systemtime:float;\r
 {$endif}\r
 \r
 function oletounixfloat(t:float):float;\r
-function oletounix(t:tdatetime):integer;\r
-function unixtoole(i:integer):tdatetime;\r
+function oletounix(t:tdatetime):tunixtimeint;\r
+function unixtoole(i:float):tdatetime;\r
 \r
-{$ifdef win32}\r
+{$ifdef mswindows}\r
 function mmtimefloat:float;\r
 function qpctimefloat:float;\r
 {$endif}\r
 \r
+{$ifdef mswindows}\r
+procedure gettimeofday(var tv:ttimeval);\r
+{$endif}\r
+\r
+\r
 const\r
   mmtime_driftavgsize=32;\r
   mmtime_warmupnum=4;\r
@@ -87,15 +114,15 @@ var
 \r
 implementation\r
 \r
-{$ifdef fpc}\r
-  {$mode delphi}\r
-{$endif}\r
+\r
 \r
 uses\r
   {$ifdef UNIX}\r
     {$ifdef VER1_0}\r
       linux,\r
     {$else}\r
+      {$ifdef linux}linux,{$endif} //for clock_gettime\r
+      {$ifdef freebsd}freebsd,{$endif} //for clock_gettime\r
       baseunix,unix,unixutil,sockets, {unixutil and sockets needed by unixstuff.inc on some compiler versions}\r
     {$endif}\r
   {$else}\r
@@ -115,12 +142,12 @@ begin
   result := t;\r
 end;\r
 \r
-function oletounix(t:tdatetime):integer;\r
+function oletounix(t:tdatetime):tunixtimeint;\r
 begin\r
-  result := trunc(oletounixfloat(t));\r
+  result := round(oletounixfloat(t));\r
 end;\r
 \r
-function unixtoole(i:integer):tdatetime;\r
+function unixtoole(i:float):tdatetime;\r
 begin\r
   result := ((i)/86400)+daysdifference;\r
 end;\r
@@ -148,27 +175,112 @@ end;
 function unixtimefloat:float;\r
 var\r
   tv:ttimeval;\r
+  sec:tunixtimeint;\r
 begin\r
   gettimeofday(tv);\r
-  result := tv.tv_sec+(tv.tv_usec/1000000);\r
+  sec := tv.tv_sec;\r
+  {$ifndef cpu64}\r
+  if (sec < -1) then inc(sec,$100000000); //tv_sec is 32 bits. allow -1 for invalid result\r
+  {$endif}\r
+  result := sec+(tv.tv_usec/1000000);\r
 end;\r
 \r
-function wintimefloat:extended;\r
-begin\r
-  result := unixtimefloat;\r
-end;\r
+{$ifdef linux}{$define have_clock_gettime}{$endif}\r
+{$ifdef freebsd}{$define have_clock_gettime}{$endif}\r
+\r
+{$ifdef have_clock_gettime}\r
+  {$define monotimefloat_implemented}\r
+\r
+  function monotimefloat:float;\r
+  var\r
+    ts: ttimespec;\r
+  begin\r
+    if clock_gettime(CLOCK_MONOTONIC, @ts) = 0 then begin\r
+      //note this really returns nanoseconds\r
+      result := ts.tv_sec + ts.tv_nsec / 1000000000.0;\r
+      exit;\r
+    end;\r
+    //fallback\r
+    result := unixtimefloat;\r
+  end;\r
+\r
+\r
+{$endif}\r
+\r
+{$ifdef darwin} {mac OS X}\r
+{$define monotimefloat_implemented}\r
+\r
+  type\r
+    tmach_timebase_info = packed record\r
+      numer: longint;\r
+      denom: longint;\r
+    end;\r
+    pmach_timebase_info = ^tmach_timebase_info;\r
+     \r
+    function mach_absolute_time: int64; cdecl; external;\r
+    function mach_timebase_info(info: pmach_timebase_info): integer; cdecl; external;\r
+\r
+  var\r
+    timebase_info: tmach_timebase_info;\r
+\r
+  function monotimefloat:float;\r
+  var\r
+    i:int64;\r
+  begin\r
+    if timebase_info.denom = 0 then begin\r
+      mach_timebase_info(@timebase_info);\r
+    end;\r
+    i := mach_absolute_time;\r
+    result := (i * timebase_info.numer div timebase_info.denom) / 1000000000.0;\r
+  end;\r
+\r
+{$endif} {darwin, mac OS X}\r
+\r
+\r
+{$ifndef monotimefloat_implemented} {fallback}\r
+  \r
+  function monotimefloat:extended;\r
+  begin\r
+    result := unixtimefloat;\r
+  end;\r
 \r
-function unixtimeint:integer;\r
+{$endif} {monotimefloat fallback}\r
+\r
+\r
+function unixtimeint:tunixtimeint;\r
 var\r
   tv:ttimeval;\r
+  sec:tunixtimeint;\r
 begin\r
   gettimeofday(tv);\r
-  result := tv.tv_sec;\r
+  sec := tv.tv_sec;\r
+  {$ifndef cpu64}\r
+  if (sec < 0) then inc(sec,$100000000); //tv_sec is 32 bits\r
+  {$endif}\r
+  result := sec;\r
 end;\r
 \r
+{------------------------------ end of *nix/freepascal section}\r
+\r
 {$else} {delphi 3}\r
 {------------------------------ windows/delphi code to read time}\r
 \r
+\r
+{simulate gettimeofday on windows so one can always use gettimeofday if preferred}\r
+\r
+procedure gettimeofday(var tv:ttimeval);\r
+var\r
+  e:extended;\r
+begin\r
+  e := unixtimefloat;\r
+  tv.tv_sec := round(int(e));\r
+  tv.tv_usec := trunc(frac(e)*1000000);\r
+  {just in case}\r
+  if (tv.tv_usec < 0) then tv.tv_usec := 0;\r
+  if (tv.tv_usec > 999999) then tv.tv_usec := 999999;\r
+end;\r
+\r
+\r
 {\r
 time float: gettickcount\r
 resolution: 9x: ~55 ms NT: 1/64th of a second\r
@@ -184,6 +296,7 @@ const
   wrapduration=highdwordconst * 0.001;\r
 var\r
   i:integer;\r
+  temp:float;\r
 begin\r
   i := gettickcount; {timegettime}\r
   if i < mmtime_last then begin\r
@@ -192,7 +305,17 @@ begin
   mmtime_last := i;\r
   result := mmtime_wrapadd + i * 0.001;\r
 \r
-  if (ticks_freq <> 0) and ticks_freq_known then result := int((result / ticks_freq)+0.5) * ticks_freq; //turn the float into an exact multiple of 1/64th sec to improve accuracy of things using this\r
+  if (ticks_freq <> 0) and ticks_freq_known then begin\r
+    {the value we get is rounded to 1 ms, but the ticks are not a multiple of 1 ms\r
+    this makes the value noisy. use the known ticks frequency to restore the original value}\r
+    temp := int((result / ticks_freq)+0.5) * ticks_freq;\r
+\r
+    {if the known ticks freq is wrong (can happen), disable the un-rounding behavior\r
+    this will be a bit less accurate but it prevents problems}\r
+    if abs(temp - result) > 0.002 then begin\r
+      ticks_freq := 0;\r
+    end else result := temp;\r
+  end;\r
 end;\r
 \r
 procedure measure_ticks_freq;\r
@@ -200,7 +323,9 @@ var
   f,g:float;\r
   o:tosversioninfo;\r
   isnt:boolean;\r
-  is9x:boolean;\r
+{  is9x:boolean;}\r
+  adjust1,adjust2:cardinal;\r
+  adjustbool:longbool;\r
 begin\r
   if (performancecountfreq = 0) then qpctimefloat;\r
   ticks_freq_known := false;\r
@@ -213,43 +338,23 @@ begin
   o.dwOSVersionInfoSize := sizeof(o);\r
   getversionex(o);\r
   isnt := o.dwPlatformId = VER_PLATFORM_WIN32_NT;\r
-  is9x := o.dwPlatformId = VER_PLATFORM_WIN32_WINDOWS;\r
+{  is9x := o.dwPlatformId = VER_PLATFORM_WIN32_WINDOWS;}\r
 \r
   ticks_freq2 := f;\r
   mmtime_synchedqpc := false;\r
-  {\r
-  NT 64 Hz\r
-  identify mode as: nt64\r
-  QPC rate: either 3579545 or TSC freq\r
-  QPC synched to gettickcount: no\r
-  duration between 2 ticks is constant: yes\r
-  gettickcount tick duration: 64 Hz\r
-  }\r
-  if (f >= 0.014) and (f <= 0.018) and isnt then begin\r
-    ticks_freq_known := true;\r
-    ticks_freq := 1/64;\r
-    mmtime_synchedqpc := false;\r
-  end;\r
 \r
-  {\r
-  NT 100 Hz\r
-  identify mode as: nt100\r
-  QPC rate: 1193182\r
-  QPC synched to gettickcount: yes\r
-  duration between 2 ticks is constant: no?\r
-  gettickcount tick duration: ~99.85 Hz\r
-  }\r
-  if (performancecountfreq = 1193182) and (f >= 0.008) and (f <= 0.012) and isnt then begin\r
-    ticks_freq_known := true;\r
-    ticks_freq2 := 11949 / (colorburst / 3);\r
-   //  ticks_freq2 := 11949 / 1193182;\r
-    ticks_freq := 0;\r
-    {the ticks freq should be very close to the real one but if it's not exact, it will cause drift and correction jumps}\r
-    mmtime_synchedqpc := true;\r
+  if (isnt and (o.dwMajorVersion >= 5)) then begin\r
+    {windows 2000 and later: query tick rate from OS in 100 ns units\r
+    typical rates: XP: 156250 or 100144, windows 7: 156001}\r
+    if GetSystemTimeAdjustment(adjust1,adjust2,adjustbool) then begin\r
+      ticks_freq := adjust1 / 10000000.0;\r
+      ticks_freq_known := true;\r
+      mmtime_synchedqpc := false;\r
+    end;\r
   end;\r
 \r
   {9x}\r
-  if (performancecountfreq = 1193182) and (g >= 0.050) and (g <= 0.060) then begin\r
+  if (performancecountfreq = 1193182) and (f >= 0.050) and (f <= 0.060) then begin\r
     ticks_freq_known := true;\r
     ticks_freq := 65536 / (colorburst / 3);\r
     mmtime_synchedqpc := true;\r
@@ -301,14 +406,14 @@ const
   maxretries=5;\r
   margin=0.002;\r
 var\r
-  jump:float;\r
-  mm,f,qpc,newdrift,f1,f2:float;\r
+{  jump:float;}\r
+  mm,f,qpc,newdrift:float;\r
   qpcjumped:boolean;\r
-  a,b,c:integer;\r
-  retrycount:integer;\r
+  a,b:integer;\r
+{  retrycount:integer;}\r
 begin\r
   if not ticks_freq_known then measure_ticks_freq;\r
-  retrycount := maxretries;\r
+{  retrycount := maxretries;}\r
 \r
   qpc := qpctimefloat;\r
   mm := mmtimefloat;\r
@@ -325,7 +430,7 @@ begin
       mmtime_prev_lastsyncqpc := mmtime_lastsyncqpc;\r
 \r
       mm := mmtimefloat;\r
-      dec(retrycount);\r
+    {  dec(retrycount);}\r
       settc;\r
       result := qpctimefloat;\r
       f := mmtimefloat;\r
@@ -356,6 +461,7 @@ begin
 {          mmtime_drift := mmtime_drift + mmtime_driftavg[a];}\r
         end;\r
 {        mmtime_drift := mmtime_drift / b;}\r
+        a := 5;\r
         if (b = 1) then a := 5 else if (b = 2) then a := 15 else if (b = 3) then a := 30 else if (b = 4) then a := 60 else if (b = 5) then a := 120 else if (b >= 5) then a := 120;\r
         mmtime_nextdriftcorrection := qpc + a;\r
         if (b >= 2) then warmup_finished := true;\r
@@ -373,21 +479,21 @@ begin
     qpc := qpctimefloat;\r
 \r
     result := (qpc - mmtime_lastsyncqpc) * mmtime_drift + mmtime_lastsyncmm;\r
-    f := (qpc - mmtime_prev_lastsyncqpc) * mmtime_prev_drift + mmtime_prev_lastsyncmm;\r
 \r
+    {f := (qpc - mmtime_prev_lastsyncqpc) * mmtime_prev_drift + mmtime_prev_lastsyncmm;\r
     jump := result-f;\r
-    {writeln('jump ',formatfloat('0.000000',jump),'   drift ',formatfloat('0.00000000',mmtime_drift),' duration ',formatfloat('0.000',(mmtime_lastsyncqpc-mmtime_prev_lastsyncqpc)),' ',formatfloat('0.00000000',jump/(mmtime_lastsyncqpc-mmtime_prev_lastsyncqpc)));}\r
+    writeln('jump ',formatfloat('0.000000',jump),'   drift ',formatfloat('0.00000000',mmtime_drift),' duration ',formatfloat('0.000',(mmtime_lastsyncqpc-mmtime_prev_lastsyncqpc)),' ',formatfloat('0.00000000',jump/(mmtime_lastsyncqpc-mmtime_prev_lastsyncqpc)));}\r
 \r
     f := result;\r
   end;\r
 \r
   result := f;\r
 \r
-  if (result < mmtime_lastresult) then result := mmtime_lastresult + 0.000001;\r
+  if (result < mmtime_lastresult) then result := mmtime_lastresult;\r
   mmtime_lastresult := result;\r
 end;\r
 \r
-{ free pascals tsystemtime is incomaptible with windows api calls\r
+{ free pascals tsystemtime is incompatible with windows api calls\r
  so we declare it ourselves - plugwash\r
 }\r
 {$ifdef fpc}\r
@@ -441,24 +547,65 @@ begin
   result := oletounixfloat(int(date_utc+0.5))+time_utc*86400;\r
 end;\r
 \r
-function wintimefloat:extended;\r
+function monotimefloat:extended;\r
 begin\r
   result := mmqpctimefloat;\r
 end;\r
 \r
+\r
+\r
+var\r
+  GetSystemTimePreciseAsFileTime:procedure(var v:tfiletime); stdcall;\r
+  win8inited:boolean;\r
+\r
+procedure initwin8;\r
+var\r
+  dllhandle:thandle;\r
+\r
+begin\r
+  win8inited := true;\r
+  dllhandle := loadlibrary('kernel32.dll');\r
+  if (dllhandle <> 0) then begin\r
+    GetSystemTimePreciseAsFileTime := getprocaddress(dllhandle,'GetSystemTimePreciseAsFileTime');\r
+  end;\r
+end;\r
+\r
+\r
+function unixtimefloat_win8:float;\r
+var\r
+  ft:tfiletime;\r
+  i:int64 absolute ft;\r
+begin\r
+  GetSystemTimePreciseAsFileTime(ft);\r
+  {change from windows 1601-01-01 to unix 1970-01-01.\r
+  use integer math for this, to preserve precision}\r
+  dec(i, 116444736000000000);\r
+  result := (i / 10000000);\r
+end;\r
+\r
+\r
+\r
 function unixtimefloat:float;\r
 const\r
   margin = 0.0012;\r
 var\r
   f,g,h:float;\r
 begin\r
-  result := wintimefloat+timefloatbias;\r
+  if not btimenowin8 then begin\r
+    if not win8inited then initwin8;\r
+    if assigned(@GetSystemTimePreciseAsFileTime) then begin\r
+      result := unixtimefloat_win8;\r
+      exit;\r
+    end;  \r
+  end;\r
+\r
+  result := monotimefloat+timefloatbias;\r
   f := result-unixtimefloat_systemtime;\r
   if ((f > ticks_freq2+margin) or (f < -margin)) or (timefloatbias = 0) then begin\r
 //    writeln('unixtimefloat init');\r
     f := unixtimefloat_systemtime;\r
     settc;\r
-    repeat g := unixtimefloat_systemtime; h := wintimefloat until g > f;\r
+    repeat g := unixtimefloat_systemtime; h := monotimefloat until g > f;\r
     unsettc;\r
     timefloatbias := g-h;\r
     result := unixtimefloat;\r
@@ -469,7 +616,7 @@ begin
   lastunixtimefloat := result;\r
 end;\r
 \r
-function unixtimeint:integer;\r
+function unixtimeint:tunixtimeint;\r
 begin\r
   result := trunc(unixtimefloat);\r
 end;\r
@@ -477,20 +624,25 @@ end;
 {$endif}\r
 {-----------------------------------------------end of platform specific}\r
 \r
+function wintimefloat:float;\r
+begin\r
+  result := monotimefloat;\r
+end;\r
+\r
 function irctimefloat:float;\r
 begin\r
   result := unixtimefloat+settimebias;\r
 end;\r
 \r
-function irctimeint:integer;\r
+function irctimeint:tunixtimeint;\r
 begin\r
   result := unixtimeint+settimebias;\r
 end;\r
 \r
 \r
-procedure settime(newtime:integer);\r
+procedure settime(newtime:tunixtimeint);\r
 var\r
-  a:integer;\r
+  a:tunixtimeint;\r
 begin\r
   a := irctimeint-settimebias;\r
   if newtime = 0 then settimebias := 0 else settimebias := newtime-a;\r
@@ -546,7 +698,7 @@ begin
   timezonestr := timezonestr + char(l div 600 mod 10+48)+char(l div 60 mod 10+48)+':'+char(l div 10 mod 6+48)+char(l mod 10+48);\r
 end;\r
 \r
-function timestrshort(i:integer):string;\r
+function timestrshort(i:tunixtimeint):string;\r
 const\r
   weekday:array[0..6] of string[4]=('Thu','Fri','Sat','Sun','Mon','Tue','Wed');\r
   month:array[0..11] of string[4]=('Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec');\r
@@ -562,7 +714,7 @@ begin
   inttostr(y);\r
 end;\r
 \r
-function timestring(i:integer):string;\r
+function timestring(i:tunixtimeint):string;\r
 const\r
   weekday:array[0..6] of string[10]=('Thursday','Friday','Saturday','Sunday','Monday','Tuesday','Wednesday');\r
   month:array[0..11] of string[10]=('January','February','March','April','May','June','July','August','September','October','November','December');\r
@@ -578,9 +730,52 @@ begin
   timezonestr;\r
 end;\r
 \r
+function timestriso(i:tunixtimeint):string;\r
+var\r
+  y,m,d,h,min,sec,ms:word;\r
+  t:tdatetime;\r
+begin\r
+  t := unixtoole(i+timezone);\r
+  decodedate(t,y,m,d);\r
+  decodetime(t,h,min,sec,ms);\r
+  result := inttostr(y)+'-'+inttostr(m div 10)+inttostr(m mod 10)+'-'+inttostr(d div 10)+inttostr(d mod 10)+' '+inttostr(h div 10)+inttostr(h mod 10)+':'+inttostr(min div 10)+inttostr(min mod 10)+':'+inttostr(sec div 10)+inttostr(sec mod 10);\r
+end;\r
+\r
+function timestrisoutc(i:float):string;\r
+var\r
+  y,m,d,h,min,sec,ms:word;\r
+  t:tdatetime;\r
+  fr:float;\r
+begin\r
+  t := unixtoole(i);\r
+  decodedate(t,y,m,d);\r
+  decodetime(t,h,min,sec,ms);\r
+  result := inttostr(y)+'-'+inttostr(m div 10)+inttostr(m mod 10)+'-'+inttostr(d div 10)+inttostr(d mod 10)+'T'+inttostr(h div 10)+inttostr(h mod 10)+':'+inttostr(min div 10)+inttostr(min mod 10)+':'+inttostr(sec div 10)+inttostr(sec mod 10);\r
+  fr := frac(i);\r
+\r
+  result := result + '.'+\r
+  inttostr(trunc(fr*10) mod 10)+\r
+  inttostr(trunc(fr*100) mod 10)+\r
+  inttostr(trunc(fr*1000) mod 10)+\r
+  inttostr(trunc(fr*10000) mod 10)+\r
+  inttostr(trunc(fr*100000) mod 10)+\r
+  inttostr(trunc(fr*1000000) mod 10)+'Z';\r
+\r
+end;\r
+\r
+procedure beginhightimerrate;\r
+begin\r
+  {$ifdef mswindows}timebeginperiod(1);{$endif}\r
+end;\r
+\r
+procedure endhightimerrate;\r
+begin\r
+  {$ifdef mswindows}timeendperiod(1);{$endif}\r
+end;\r
+\r
 procedure init;\r
 begin\r
-  {$ifdef win32}timebeginperiod(1);{$endif} //ensure stable unchanging clock\r
+  {$ifdef btimehighrate}beginhightimerrate;{$endif}\r
   fillchar(mmtime_driftavg,sizeof(mmtime_driftavg),0);\r
   settimebias := 0;\r
   gettimezone;\r