This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Regen perlapi, perltoc.
[perl5.git] / ext / Time / HiRes / HiRes.xs
CommitLineData
dcf686c9
JH
1#ifdef __cplusplus
2extern "C" {
3#endif
4#include "EXTERN.h"
5#include "perl.h"
6#include "XSUB.h"
7#ifdef WIN32
8#include <time.h>
9#else
10#include <sys/time.h>
11#endif
12#ifdef __cplusplus
13}
14#endif
15
3c72ec00
JH
16static IV
17constant(char *name, int arg)
18{
19 errno = 0;
20 switch (*name) {
21 case 'I':
22 if (strEQ(name, "ITIMER_REAL"))
23#ifdef ITIMER_REAL
24 return ITIMER_REAL;
25#else
26 goto not_there;
27#endif
28 if (strEQ(name, "ITIMER_REALPROF"))
29#ifdef ITIMER_REALPROF
30 return ITIMER_REALPROF;
31#else
32 goto not_there;
33#endif
34 if (strEQ(name, "ITIMER_VIRTUAL"))
35#ifdef ITIMER_VIRTUAL
36 return ITIMER_VIRTUAL;
37#else
38 goto not_there;
39#endif
40 if (strEQ(name, "ITIMER_PROF"))
41#ifdef ITIMER_PROF
42 return ITIMER_PROF;
43#else
44 goto not_there;
45#endif
46 break;
47 }
48 errno = EINVAL;
49 return 0;
50
51not_there:
52 errno = ENOENT;
53 return 0;
54}
55
dcf686c9
JH
56#if !defined(HAS_GETTIMEOFDAY) && defined(WIN32)
57#define HAS_GETTIMEOFDAY
58
59/* shows up in winsock.h?
60struct timeval {
61 long tv_sec;
62 long tv_usec;
63}
64*/
65
eb1a5092
GS
66typedef union {
67 unsigned __int64 ft_i64;
68 FILETIME ft_val;
69} FT_t;
70
71/* Number of 100 nanosecond units from 1/1/1601 to 1/1/1970 */
72#define EPOCH_BIAS 116444736000000000i64
73
74/* NOTE: This does not compute the timezone info (doing so can be expensive,
75 * and appears to be unsupported even by glibc) */
dcf686c9 76int
eb1a5092 77gettimeofday (struct timeval *tp, void *not_used)
dcf686c9 78{
eb1a5092
GS
79 FT_t ft;
80
81 /* this returns time in 100-nanosecond units (i.e. tens of usecs) */
82 GetSystemTimeAsFileTime(&ft.ft_val);
83
84 /* seconds since epoch */
85 tp->tv_sec = (long)((ft.ft_i64 - EPOCH_BIAS) / 10000000i64);
86
87 /* microseconds remaining */
88 tp->tv_usec = (long)((ft.ft_i64 / 10i64) % 1000000i64);
89
90 return 0;
dcf686c9
JH
91}
92#endif
93
94#if !defined(HAS_GETTIMEOFDAY) && defined(VMS)
95#define HAS_GETTIMEOFDAY
96
9b6f56ad 97#include <lnmdef.h>
dcf686c9
JH
98#include <time.h> /* gettimeofday */
99#include <stdlib.h> /* qdiv */
100#include <starlet.h> /* sys$gettim */
101#include <descrip.h>
3785778e
PP
102#ifdef __VAX
103#include <lib$routines.h> /* lib$ediv() */
104#endif
dcf686c9
JH
105
106/*
107 VMS binary time is expressed in 100 nano-seconds since
108 system base time which is 17-NOV-1858 00:00:00.00
109*/
110
111#define DIV_100NS_TO_SECS 10000000L
112#define DIV_100NS_TO_USECS 10L
113
114/*
115 gettimeofday is supposed to return times since the epoch
116 so need to determine this in terms of VMS base time
117*/
118static $DESCRIPTOR(dscepoch,"01-JAN-1970 00:00:00.00");
119
5cdb7193 120#ifdef __VAX
3785778e 121static long base_adjust[2]={0L,0L};
5cdb7193 122#else
dcf686c9 123static __int64 base_adjust=0;
5cdb7193 124#endif
dcf686c9 125
9b6f56ad
CL
126/*
127
128 If we don't have gettimeofday, then likely we are on a VMS machine that
129 operates on local time rather than UTC...so we have to zone-adjust.
130 This code gleefully swiped from VMS.C
131
132*/
133/* method used to handle UTC conversions:
134 * 1 == CRTL gmtime(); 2 == SYS$TIMEZONE_DIFFERENTIAL; 3 == no correction
135 */
136static int gmtime_emulation_type;
137/* number of secs to add to UTC POSIX-style time to get local time */
138static long int utc_offset_secs;
139static struct dsc$descriptor_s fildevdsc =
140 { 12, DSC$K_DTYPE_T, DSC$K_CLASS_S, "LNM$FILE_DEV" };
141static struct dsc$descriptor_s *fildev[] = { &fildevdsc, NULL };
142
143static time_t toutc_dst(time_t loc) {
144 struct tm *rsltmp;
145
146 if ((rsltmp = localtime(&loc)) == NULL) return -1;
147 loc -= utc_offset_secs;
148 if (rsltmp->tm_isdst) loc -= 3600;
149 return loc;
150}
151
152static time_t toloc_dst(time_t utc) {
153 struct tm *rsltmp;
154
155 utc += utc_offset_secs;
156 if ((rsltmp = localtime(&utc)) == NULL) return -1;
157 if (rsltmp->tm_isdst) utc += 3600;
158 return utc;
159}
160
161#define _toutc(secs) ((secs) == (time_t) -1 ? (time_t) -1 : \
162 ((gmtime_emulation_type || timezone_setup()), \
163 (gmtime_emulation_type == 1 ? toutc_dst(secs) : \
164 ((secs) - utc_offset_secs))))
165
166#define _toloc(secs) ((secs) == (time_t) -1 ? (time_t) -1 : \
167 ((gmtime_emulation_type || timezone_setup()), \
168 (gmtime_emulation_type == 1 ? toloc_dst(secs) : \
169 ((secs) + utc_offset_secs))))
170
171static int
172timezone_setup(void)
173{
174 struct tm *tm_p;
175
176 if (gmtime_emulation_type == 0) {
177 int dstnow;
178 time_t base = 15 * 86400; /* 15jan71; to avoid month/year ends between */
179 /* results of calls to gmtime() and localtime() */
180 /* for same &base */
181
182 gmtime_emulation_type++;
183 if ((tm_p = gmtime(&base)) == NULL) { /* CRTL gmtime() is a fake */
184 char off[LNM$C_NAMLENGTH+1];;
185
186 gmtime_emulation_type++;
187 if (!Perl_vmstrnenv("SYS$TIMEZONE_DIFFERENTIAL",off,0,fildev,0)) {
188 gmtime_emulation_type++;
189 utc_offset_secs = 0;
190 Perl_warn(aTHX_ "no UTC offset information; assuming local time is UTC");
191 }
192 else { utc_offset_secs = atol(off); }
193 }
194 else { /* We've got a working gmtime() */
195 struct tm gmt, local;
196
197 gmt = *tm_p;
198 tm_p = localtime(&base);
199 local = *tm_p;
200 utc_offset_secs = (local.tm_mday - gmt.tm_mday) * 86400;
201 utc_offset_secs += (local.tm_hour - gmt.tm_hour) * 3600;
202 utc_offset_secs += (local.tm_min - gmt.tm_min) * 60;
203 utc_offset_secs += (local.tm_sec - gmt.tm_sec);
204 }
205 }
206 return 1;
207}
208
209
dcf686c9
JH
210int
211gettimeofday (struct timeval *tp, void *tpz)
212{
213 long ret;
5cdb7193 214#ifdef __VAX
3785778e
PP
215 long quad[2];
216 long quad1[2];
217 long div_100ns_to_secs;
218 long div_100ns_to_usecs;
219 long quo,rem;
220 long quo1,rem1;
5cdb7193 221#else
dcf686c9
JH
222 __int64 quad;
223 __qdiv_t ans1,ans2;
5cdb7193 224#endif
dcf686c9
JH
225/*
226 In case of error, tv_usec = 0 and tv_sec = VMS condition code.
227 The return from function is also set to -1.
228 This is not exactly as per the manual page.
229*/
230
231 tp->tv_usec = 0;
232
3785778e
PP
233#ifdef __VAX
234 if (base_adjust[0]==0 && base_adjust[1]==0) {
235#else
dcf686c9 236 if (base_adjust==0) { /* Need to determine epoch adjustment */
3785778e 237#endif
dcf686c9
JH
238 ret=sys$bintim(&dscepoch,&base_adjust);
239 if (1 != (ret &&1)) {
240 tp->tv_sec = ret;
241 return -1;
242 }
243 }
244
245 ret=sys$gettim(&quad); /* Get VMS system time */
246 if ((1 && ret) == 1) {
5cdb7193 247#ifdef __VAX
3785778e
PP
248 quad[0] -= base_adjust[0]; /* convert to epoch offset */
249 quad[1] -= base_adjust[1]; /* convert 2nd half of quadword */
250 div_100ns_to_secs = DIV_100NS_TO_SECS;
251 div_100ns_to_usecs = DIV_100NS_TO_USECS;
252 lib$ediv(&div_100ns_to_secs,&quad,&quo,&rem);
253 quad1[0] = rem;
254 quad1[1] = 0L;
255 lib$ediv(&div_100ns_to_usecs,&quad1,&quo1,&rem1);
256 tp->tv_sec = quo; /* Whole seconds */
257 tp->tv_usec = quo1; /* Micro-seconds */
5cdb7193 258#else
3785778e 259 quad -= base_adjust; /* convert to epoch offset */
dcf686c9
JH
260 ans1=qdiv(quad,DIV_100NS_TO_SECS);
261 ans2=qdiv(ans1.rem,DIV_100NS_TO_USECS);
262 tp->tv_sec = ans1.quot; /* Whole seconds */
263 tp->tv_usec = ans2.quot; /* Micro-seconds */
3785778e 264#endif
dcf686c9
JH
265 } else {
266 tp->tv_sec = ret;
267 return -1;
268 }
9b6f56ad
CL
269# ifdef VMSISH_TIME
270# ifdef RTL_USES_UTC
271 if (VMSISH_TIME) tp->tv_sec = _toloc(tp->tv_sec);
272# else
273 if (!VMSISH_TIME) tp->tv_sec = _toutc(tp->tv_sec);
274# endif
275# endif
dcf686c9
JH
276 return 0;
277}
278#endif
279
280#if !defined(HAS_USLEEP) && defined(HAS_SELECT)
281#ifndef SELECT_IS_BROKEN
282#define HAS_USLEEP
283#define usleep hrt_usleep /* could conflict with ncurses for static build */
284
285void
286hrt_usleep(unsigned long usec)
287{
288 struct timeval tv;
289 tv.tv_sec = 0;
290 tv.tv_usec = usec;
291 select(0, (Select_fd_set_t)NULL, (Select_fd_set_t)NULL,
292 (Select_fd_set_t)NULL, &tv);
293}
294#endif
295#endif
296
297#if !defined(HAS_USLEEP) && defined(WIN32)
298#define HAS_USLEEP
299#define usleep hrt_usleep /* could conflict with ncurses for static build */
300
301void
302hrt_usleep(unsigned long usec)
303{
304 long msec;
305 msec = usec / 1000;
306 Sleep (msec);
307}
308#endif
309
310
311#if !defined(HAS_UALARM) && defined(HAS_SETITIMER)
312#define HAS_UALARM
313#define ualarm hrt_ualarm /* could conflict with ncurses for static build */
314
315int
316hrt_ualarm(int usec, int interval)
317{
318 struct itimerval itv;
319 itv.it_value.tv_sec = usec / 1000000;
320 itv.it_value.tv_usec = usec % 1000000;
321 itv.it_interval.tv_sec = interval / 1000000;
322 itv.it_interval.tv_usec = interval % 1000000;
323 return setitimer(ITIMER_REAL, &itv, 0);
324}
325#endif
326
327#ifdef HAS_GETTIMEOFDAY
328
a2e20b18 329static int
dcf686c9
JH
330myU2time(UV *ret)
331{
332 struct timeval Tp;
333 int status;
334 status = gettimeofday (&Tp, NULL);
335 ret[0] = Tp.tv_sec;
336 ret[1] = Tp.tv_usec;
a2e20b18 337 return status;
dcf686c9
JH
338}
339
3c72ec00 340static NV
dcf686c9
JH
341myNVtime()
342{
343 struct timeval Tp;
344 int status;
345 status = gettimeofday (&Tp, NULL);
a2e20b18 346 return status == 0 ? Tp.tv_sec + (Tp.tv_usec / 1000000.) : -1.0;
dcf686c9
JH
347}
348
349#endif
350
351MODULE = Time::HiRes PACKAGE = Time::HiRes
352
353PROTOTYPES: ENABLE
354
355BOOT:
dcf686c9 356#ifdef HAS_GETTIMEOFDAY
a2e20b18
JH
357{
358 UV auv[2];
359 hv_store(PL_modglobal, "Time::NVtime", 12, newSViv((IV) myNVtime()), 0);
360 if (myU2time(auv) == 0)
361 hv_store(PL_modglobal, "Time::U2time", 12, newSViv((IV) auv[0]), 0);
362}
dcf686c9 363#endif
dcf686c9 364
3c72ec00
JH
365IV
366constant(name, arg)
367 char * name
368 int arg
369
52d72fba 370#if defined(HAS_USLEEP) && defined(HAS_GETTIMEOFDAY)
dcf686c9 371
92bc48ca 372NV
dcf686c9 373usleep(useconds)
92bc48ca 374 NV useconds
52d72fba
JH
375 PREINIT:
376 struct timeval Ta, Tb;
377 CODE:
378 gettimeofday(&Ta, NULL);
379 if (items > 0) {
92bc48ca
JH
380 if (useconds > 1E6) {
381 IV seconds = (IV) (useconds / 1E6);
f7916ddb
JH
382 /* If usleep() has been implemented using setitimer()
383 * then this contortion is unnecessary-- but usleep()
384 * may be implemented in some other way, so let's contort. */
385 if (seconds) {
386 sleep(seconds);
387 useconds -= 1E6 * seconds;
388 }
389 } else if (useconds < 0.0)
390 croak("Time::HiRes::usleep(%"NVgf"): negative time not invented yet", useconds);
92bc48ca 391 usleep((UV)useconds);
52d72fba
JH
392 } else
393 PerlProc_pause();
394 gettimeofday(&Tb, NULL);
92bc48ca
JH
395#if 0
396 printf("[%ld %ld] [%ld %ld]\n", Tb.tv_sec, Tb.tv_usec, Ta.tv_sec, Ta.tv_usec);
397#endif
398 RETVAL = 1E6*(Tb.tv_sec-Ta.tv_sec)+(NV)((IV)Tb.tv_usec-(IV)Ta.tv_usec);
dcf686c9 399
52d72fba
JH
400 OUTPUT:
401 RETVAL
402
403NV
f9d00e57 404sleep(...)
52d72fba
JH
405 PREINIT:
406 struct timeval Ta, Tb;
dcf686c9 407 CODE:
52d72fba 408 gettimeofday(&Ta, NULL);
92bc48ca
JH
409 if (items > 0) {
410 NV seconds = SvNV(ST(0));
f7916ddb
JH
411 if (seconds >= 0.0) {
412 UV useconds = 1E6 * (seconds - (UV)seconds);
413 sleep((UV)seconds);
414 usleep(useconds);
415 } else
416 croak("Time::HiRes::sleep(%"NVgf"): negative time not invented yet", seconds);
92bc48ca 417 } else
f9d00e57 418 PerlProc_pause();
52d72fba 419 gettimeofday(&Tb, NULL);
92bc48ca
JH
420#if 0
421 printf("[%ld %ld] [%ld %ld]\n", Tb.tv_sec, Tb.tv_usec, Ta.tv_sec, Ta.tv_usec);
422#endif
52d72fba
JH
423 RETVAL = (NV)(Tb.tv_sec-Ta.tv_sec)+0.000001*(NV)(Tb.tv_usec-Ta.tv_usec);
424
425 OUTPUT:
426 RETVAL
dcf686c9
JH
427
428#endif
429
430#ifdef HAS_UALARM
431
3de7a4ec 432int
dcf686c9
JH
433ualarm(useconds,interval=0)
434 int useconds
435 int interval
f7916ddb
JH
436 CODE:
437 if (useconds < 0 || interval < 0)
3de7a4ec 438 croak("Time::HiRes::ualarm(%d, %d): negative time not invented yet", useconds, interval);
f7916ddb 439 RETVAL = ualarm(useconds, interval);
dcf686c9 440
f7916ddb
JH
441 OUTPUT:
442 RETVAL
443
444NV
445alarm(seconds,interval=0)
446 NV seconds
447 NV interval
dcf686c9 448 CODE:
f7916ddb
JH
449 if (seconds < 0.0 || interval < 0.0)
450 croak("Time::HiRes::alarm(%"NVgf", %"NVgf"): negative time not invented yet", seconds, interval);
451 RETVAL = (NV)ualarm(seconds * 1000000,
452 interval * 1000000) / 1E6;
dcf686c9 453
c6c619a9
DM
454 OUTPUT:
455 RETVAL
456
dcf686c9
JH
457#endif
458
459#ifdef HAS_GETTIMEOFDAY
db835671
JH
460# ifdef MACOS_TRADITIONAL /* fix epoch TZ and use unsigned time_t */
461void
462gettimeofday()
463 PREINIT:
464 struct timeval Tp;
465 struct timezone Tz;
466 PPCODE:
467 int status;
468 status = gettimeofday (&Tp, &Tz);
469 Tp.tv_sec += Tz.tz_minuteswest * 60; /* adjust for TZ */
470
471 if (GIMME == G_ARRAY) {
472 EXTEND(sp, 2);
473 /* Mac OS (Classic) has unsigned time_t */
474 PUSHs(sv_2mortal(newSVuv(Tp.tv_sec)));
475 PUSHs(sv_2mortal(newSViv(Tp.tv_usec)));
476 } else {
477 EXTEND(sp, 1);
478 PUSHs(sv_2mortal(newSVnv(Tp.tv_sec + (Tp.tv_usec / 1000000.0))));
479 }
480
481NV
482time()
483 PREINIT:
484 struct timeval Tp;
485 struct timezone Tz;
486 CODE:
487 int status;
488 status = gettimeofday (&Tp, &Tz);
489 Tp.tv_sec += Tz.tz_minuteswest * 60; /* adjust for TZ */
490 RETVAL = Tp.tv_sec + (Tp.tv_usec / 1000000.0);
491 OUTPUT:
492 RETVAL
dcf686c9 493
db835671 494# else /* MACOS_TRADITIONAL */
dcf686c9
JH
495void
496gettimeofday()
497 PREINIT:
498 struct timeval Tp;
499 PPCODE:
500 int status;
501 status = gettimeofday (&Tp, NULL);
502 if (GIMME == G_ARRAY) {
503 EXTEND(sp, 2);
504 PUSHs(sv_2mortal(newSViv(Tp.tv_sec)));
505 PUSHs(sv_2mortal(newSViv(Tp.tv_usec)));
506 } else {
507 EXTEND(sp, 1);
508 PUSHs(sv_2mortal(newSVnv(Tp.tv_sec + (Tp.tv_usec / 1000000.0))));
509 }
510
3c72ec00 511NV
dcf686c9
JH
512time()
513 PREINIT:
514 struct timeval Tp;
515 CODE:
516 int status;
517 status = gettimeofday (&Tp, NULL);
518 RETVAL = Tp.tv_sec + (Tp.tv_usec / 1000000.);
519 OUTPUT:
520 RETVAL
521
db835671 522# endif /* MACOS_TRADITIONAL */
dcf686c9
JH
523#endif
524
3c72ec00
JH
525#if defined(HAS_GETITIMER) && defined(HAS_SETITIMER)
526
527#define TV2NV(tv) ((NV)((tv).tv_sec) + 0.000001 * (NV)((tv).tv_usec))
528
529void
530setitimer(which, seconds, interval = 0)
531 int which
532 NV seconds
533 NV interval
534 PREINIT:
535 struct itimerval newit;
536 struct itimerval oldit;
537 PPCODE:
f7916ddb
JH
538 if (seconds < 0.0 || interval < 0.0)
539 croak("Time::HiRes::setitimer(%"IVdf", %"NVgf", %"NVgf"): negative time not invented yet", which, seconds, interval);
3c72ec00
JH
540 newit.it_value.tv_sec = seconds;
541 newit.it_value.tv_usec =
542 (seconds - (NV)newit.it_value.tv_sec) * 1000000.0;
543 newit.it_interval.tv_sec = interval;
544 newit.it_interval.tv_usec =
545 (interval - (NV)newit.it_interval.tv_sec) * 1000000.0;
546 if (setitimer(which, &newit, &oldit) == 0) {
547 EXTEND(sp, 1);
548 PUSHs(sv_2mortal(newSVnv(TV2NV(oldit.it_value))));
549 if (GIMME == G_ARRAY) {
550 EXTEND(sp, 1);
551 PUSHs(sv_2mortal(newSVnv(TV2NV(oldit.it_interval))));
552 }
553 }
554
555void
556getitimer(which)
557 int which
558 PREINIT:
559 struct itimerval nowit;
560 PPCODE:
561 if (getitimer(which, &nowit) == 0) {
562 EXTEND(sp, 1);
563 PUSHs(sv_2mortal(newSVnv(TV2NV(nowit.it_value))));
564 if (GIMME == G_ARRAY) {
565 EXTEND(sp, 1);
566 PUSHs(sv_2mortal(newSVnv(TV2NV(nowit.it_interval))));
567 }
568 }
569
570#endif
571
dcf686c9
JH
572# $Id: HiRes.xs,v 1.11 1999/03/16 02:27:38 wegscd Exp wegscd $
573
574# $Log: HiRes.xs,v $
575# Revision 1.11 1999/03/16 02:27:38 wegscd
576# Add U2time, NVtime. Fix symbols for static link.
577#
578# Revision 1.10 1998/09/30 02:36:25 wegscd
579# Add VMS changes.
580#
581# Revision 1.9 1998/07/07 02:42:06 wegscd
582# Win32 usleep()
583#
584# Revision 1.8 1998/07/02 01:47:26 wegscd
585# Add Win32 code for gettimeofday.
586#
587# Revision 1.7 1997/11/13 02:08:12 wegscd
588# Add missing EXTEND in gettimeofday() scalar code.
589#
590# Revision 1.6 1997/11/11 02:32:35 wegscd
591# Do something useful when calling gettimeofday() in a scalar context.
592# The patch is courtesy of Gisle Aas.
593#
594# Revision 1.5 1997/11/06 03:10:47 wegscd
595# Fake ualarm() if we have setitimer.
596#
597# Revision 1.4 1997/11/05 05:41:23 wegscd
598# Turn prototypes ON (suggested by Gisle Aas)
599#
600# Revision 1.3 1997/10/13 20:56:15 wegscd
601# Add PROTOTYPES: DISABLE
602#
603# Revision 1.2 1997/05/23 01:01:38 wegscd
604# Conditional compilation, depending on what the OS gives us.
605#
606# Revision 1.1 1996/09/03 18:26:35 wegscd
607# Initial revision
608#
609#