summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/attotime.h
blob: 912d2a2a138d565ff372fadcc2af472660c2e2ab (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/***************************************************************************

    attotime.h

    Support functions for working with attotime data.

    Copyright Nicola Salmoria and the MAME Team.
    Visit http://mamedev.org for licensing and usage restrictions.

****************************************************************************

    Attotime is an attosecond-accurate timing system implemented as
    96-bit integers.

        1 second      = 1e0 seconds
        1 millisecond = 1e-3 seconds
        1 microsecond = 1e-6 seconds
        1 nanosecond  = 1e-9 seconds
        1 picosecond  = 1e-12 seconds
        1 femtosecond = 1e-15 seconds
        1 attosecond  = 1e-18 seconds

    This may seem insanely accurate, but it has its uses when multiple
    clocks in the system are run by independent crystals. It is also
    useful to compute the attotime for something small, say 1 clock tick,
    and still have it be accurate and useful for scaling.

    Attotime consists of a 32-bit seconds count and a 64-bit attoseconds
    count. Because the lower bits are kept as attoseconds and not as a
    full 64-bit value, there is headroom to make some operations simpler.

***************************************************************************/

#pragma once

#ifndef __ATTOTIME_H__
#define __ATTOTIME_H__

#include "mamecore.h"
#include "eminline.h"
#include <math.h>


/***************************************************************************
    CONSTANTS
***************************************************************************/

#define ATTOSECONDS_PER_SECOND_SQRT		((attoseconds_t)1000000000)
#define ATTOSECONDS_PER_SECOND			(ATTOSECONDS_PER_SECOND_SQRT * ATTOSECONDS_PER_SECOND_SQRT)
#define ATTOSECONDS_PER_MILLISECOND		(ATTOSECONDS_PER_SECOND / 1000)
#define ATTOSECONDS_PER_MICROSECOND		(ATTOSECONDS_PER_SECOND / 1000000)
#define ATTOSECONDS_PER_NANOSECOND		(ATTOSECONDS_PER_SECOND / 1000000000)

#define ATTOTIME_MAX_SECONDS			((seconds_t)1000000000)



/***************************************************************************
    MACROS
***************************************************************************/

/* convert between a double and attoseconds */
#define ATTOSECONDS_TO_DOUBLE(x)		((double)(x) * 1e-18)
#define DOUBLE_TO_ATTOSECONDS(x)		((attoseconds_t)((x) * 1e18))

/* convert between hertz (as a double) and attoseconds */
#define ATTOSECONDS_TO_HZ(x)			((double)ATTOSECONDS_PER_SECOND / (double)(x))
#define HZ_TO_ATTOSECONDS(x)			((attoseconds_t)(ATTOSECONDS_PER_SECOND / (x)))

/* macros for converting other seconds types to attoseconds */
#define ATTOSECONDS_IN_SEC(x)			((attoseconds_t)(x) * ATTOSECONDS_PER_SECOND)
#define ATTOSECONDS_IN_MSEC(x)			((attoseconds_t)(x) * ATTOSECONDS_PER_MILLISECOND)
#define ATTOSECONDS_IN_USEC(x)			((attoseconds_t)(x) * ATTOSECONDS_PER_MICROSECOND)
#define ATTOSECONDS_IN_NSEC(x)			((attoseconds_t)(x) * ATTOSECONDS_PER_NANOSECOND)

/* macros for building attotimes from other types at runtime */
#define ATTOTIME_IN_HZ(hz)				attotime_make((0), (HZ_TO_ATTOSECONDS(hz)))
#define ATTOTIME_IN_SEC(s)				attotime_make(((s) / 1), ((s) % 1))
#define ATTOTIME_IN_MSEC(ms)			attotime_make(((ms) / 1000), (ATTOSECONDS_IN_MSEC((ms) % 1000)))
#define ATTOTIME_IN_USEC(us)			attotime_make(((us) / 1000000), (ATTOSECONDS_IN_USEC((us) % 1000000)))
#define ATTOTIME_IN_NSEC(ns)			attotime_make(((ns) / 1000000000), (ATTOSECONDS_IN_NSEC((ns) % 1000000000)))

/* macros for building attotimes from other types at compile time */
#define STATIC_ATTOTIME_IN_HZ(hz)		{ (0), (HZ_TO_ATTOSECONDS(hz)) }
#define STATIC_ATTOTIME_IN_SEC(s)		{ ((s) / 1), ((s) % 1) }
#define STATIC_ATTOTIME_IN_MSEC(ms)		{ ((ms) / 1000), (ATTOSECONDS_IN_MSEC((ms) % 1000)) }
#define STATIC_ATTOTIME_IN_USEC(us)		{ ((us) / 1000000), (ATTOSECONDS_IN_USEC((us) % 1000000)) }
#define STATIC_ATTOTIME_IN_NSEC(ns)		{ ((ns) / 1000000000), (ATTOSECONDS_IN_NSEC((ns) % 1000000000)) }

/* macros for building a reduced-resolution attotime for tokenized storage in a UINT64 */
/* this form supports up to 1000 seconds and sacrifices 1/1000 of the full attotime resolution */
#define UINT64_ATTOTIME_IN_HZ(hz)		((UINT64)((ATTOSECONDS_PER_SECOND / 1000) / (hz)))
#define UINT64_ATTOTIME_IN_SEC(s)		((UINT64)(s) * (ATTOSECONDS_PER_SECOND / 1000))
#define UINT64_ATTOTIME_IN_MSEC(ms)		((UINT64)(ms) * (ATTOSECONDS_PER_SECOND / 1000 / 1000))
#define UINT64_ATTOTIME_IN_USEC(us)		((UINT64)(us) * (ATTOSECONDS_PER_SECOND / 1000 / 1000 / 1000))
#define UINT64_ATTOTIME_IN_NSEC(ns)		((UINT64)(ns) * (ATTOSECONDS_PER_SECOND / 1000 / 1000 / 1000 / 1000))

/* macros for converting a UINT64 attotime to a full attotime */
#define UINT64_ATTOTIME_TO_ATTOTIME(v)	attotime_make((v) / (ATTOSECONDS_PER_SECOND / 1000), ((v) % (ATTOSECONDS_PER_SECOND / 1000)) * 1000)



/***************************************************************************
    TYPE DEFINITIONS
***************************************************************************/

/* core components of the attotime structure */
typedef INT64 attoseconds_t;
typedef INT32 seconds_t;


/* the attotime structure itself */
typedef struct _attotime attotime;
struct _attotime
{
	seconds_t		seconds;
	attoseconds_t	attoseconds;
};



/***************************************************************************
    GLOBAL VARIABLES
***************************************************************************/

/* constant times for zero and never */
extern const attotime 		attotime_zero;
extern const attotime 		attotime_never;



/***************************************************************************
    FUNCTION PROTOTYPES
***************************************************************************/

/* ----- core math functions ----- */

/* multiply an attotime by a constant */
attotime attotime_mul(attotime _time1, UINT32 factor);

/* divide an attotime by a constant */
attotime attotime_div(attotime _time1, UINT32 factor);


/* ----- misc utilities ----- */

/* return a temporary printable string describing an attotime */
const char *attotime_string(attotime _time, int precision);



/***************************************************************************
    INLINE FUNCTIONS
***************************************************************************/

/*-------------------------------------------------
    attotime_make - assemble an attotime from
    seconds and attoseconds components
-------------------------------------------------*/

INLINE attotime attotime_make(seconds_t _secs, attoseconds_t _subsecs)
{
	attotime result;
	result.seconds = _secs;
	result.attoseconds = _subsecs;
	return result;
}


/*-------------------------------------------------
    attotime_to_double - convert from attotime
    to double
-------------------------------------------------*/

INLINE double attotime_to_double(attotime _time)
{
	return (double)_time.seconds + ATTOSECONDS_TO_DOUBLE(_time.attoseconds);
}


/*-------------------------------------------------
    double_to_attotime - convert from double to
    attotime
-------------------------------------------------*/

INLINE attotime double_to_attotime(double _time)
{
	attotime result;

	/* set seconds to the integral part */
	result.seconds = floor(_time);

	/* set attoseconds to the fractional part */
	_time -= (double)result.seconds;
	result.attoseconds = DOUBLE_TO_ATTOSECONDS(_time);
	return result;
}


/*-------------------------------------------------
    attotime_to_attoseconds - convert a attotime
    to attoseconds, clamping to maximum positive/
    negative values
-------------------------------------------------*/

INLINE attoseconds_t attotime_to_attoseconds(attotime _time)
{
	/* positive values between 0 and 1 second */
	if (_time.seconds == 0)
		return _time.attoseconds;

	/* negative values between -1 and 0 seconds */
	else if (_time.seconds == -1)
		return _time.attoseconds - ATTOSECONDS_PER_SECOND;

	/* out-of-range positive values */
	else if (_time.seconds > 0)
		return ATTOSECONDS_PER_SECOND;

	/* out-of-range negative values */
	else
		return -ATTOSECONDS_PER_SECOND;
}


/*-------------------------------------------------
    attotime_to_ticks - convert an attotime to
    clock ticks at the given frequency
-------------------------------------------------*/

INLINE UINT64 attotime_to_ticks(attotime _time, UINT32 frequency)
{
	UINT32 fracticks = attotime_mul(attotime_make(0, _time.attoseconds), frequency).seconds;
	return mulu_32x32(_time.seconds, frequency) + fracticks;
}


/*-------------------------------------------------
    ticks_to_attotime - convert clock ticks at
    the given frequency to an attotime
-------------------------------------------------*/

INLINE attotime ticks_to_attotime(UINT64 ticks, UINT32 frequency)
{
	attoseconds_t attos_per_tick = HZ_TO_ATTOSECONDS(frequency);
	attotime result;
	
	if (ticks < frequency)
	{
		result.seconds = 0;
		result.attoseconds = ticks * attos_per_tick;
	}
	else
	{
		UINT32 remainder;
		result.seconds = divu_64x32_rem(ticks, frequency, &remainder);
		result.attoseconds = (UINT64)remainder * attos_per_tick;
	}
	return result;
}


/*-------------------------------------------------
    attotime_add - add two attotimes
-------------------------------------------------*/

INLINE attotime attotime_add(attotime _time1, attotime _time2)
{
	attotime result;

	/* if one of the items is attotime_never, return attotime_never */
	if (_time1.seconds >= ATTOTIME_MAX_SECONDS || _time2.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;

	/* add the seconds and attoseconds */
	result.attoseconds = _time1.attoseconds + _time2.attoseconds;
	result.seconds = _time1.seconds + _time2.seconds;

	/* normalize and return */
	if (result.attoseconds >= ATTOSECONDS_PER_SECOND)
	{
		result.attoseconds -= ATTOSECONDS_PER_SECOND;
		result.seconds++;
	}

	/* overflow */
	if (result.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;
	return result;
}


/*-------------------------------------------------
    attotime_add_attoseconds - add attoseconds
    to a attotime
-------------------------------------------------*/

INLINE attotime attotime_add_attoseconds(attotime _time1, attoseconds_t _attoseconds)
{
	attotime result;

	/* if one of the items is attotime_never, return attotime_never */
	if (_time1.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;

	/* add the seconds and attoseconds */
	result.attoseconds = _time1.attoseconds + _attoseconds;
	result.seconds = _time1.seconds;

	/* normalize and return */
	if (result.attoseconds >= ATTOSECONDS_PER_SECOND)
	{
		result.attoseconds -= ATTOSECONDS_PER_SECOND;
		result.seconds++;
	}

	/* overflow */
	if (result.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;
	return result;
}


/*-------------------------------------------------
    attotime_sub - subtract two attotimes
-------------------------------------------------*/

INLINE attotime attotime_sub(attotime _time1, attotime _time2)
{
	attotime result;

	/* if time1 is attotime_never, return attotime_never */
	if (_time1.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;

	/* add the seconds and attoseconds */
	result.attoseconds = _time1.attoseconds - _time2.attoseconds;
	result.seconds = _time1.seconds - _time2.seconds;

	/* normalize and return */
	if (result.attoseconds < 0)
	{
		result.attoseconds += ATTOSECONDS_PER_SECOND;
		result.seconds--;
	}
	return result;
}


/*-------------------------------------------------
    attotime_sub_attoseconds - subtract
    attoseconds from a attotime
-------------------------------------------------*/

INLINE attotime attotime_sub_attoseconds(attotime _time1, attoseconds_t _attoseconds)
{
	attotime result;

	/* if time1 is attotime_never, return attotime_never */
	if (_time1.seconds >= ATTOTIME_MAX_SECONDS)
		return attotime_never;

	/* add the seconds and attoseconds */
	result.attoseconds = _time1.attoseconds - _attoseconds;
	result.seconds = _time1.seconds;

	/* normalize and return */
	if (result.attoseconds < 0)
	{
		result.attoseconds += ATTOSECONDS_PER_SECOND;
		result.seconds--;
	}
	return result;
}


/*-------------------------------------------------
    attotime_compare - compare two attotimes
-------------------------------------------------*/

INLINE int attotime_compare(attotime _time1, attotime _time2)
{
	if (_time1.seconds > _time2.seconds)
		return 1;
	if (_time1.seconds < _time2.seconds)
		return -1;
	if (_time1.attoseconds > _time2.attoseconds)
		return 1;
	if (_time1.attoseconds < _time2.attoseconds)
		return -1;
	return 0;
}


/*-------------------------------------------------
    attotime_min - return the minimum of two
    attotimes
-------------------------------------------------*/

INLINE attotime attotime_min(attotime _time1, attotime _time2)
{
	if (_time1.seconds > _time2.seconds)
		return _time2;
	if (_time1.seconds < _time2.seconds)
		return _time1;
	if (_time1.attoseconds > _time2.attoseconds)
		return _time2;
	return _time1;
}


/*-------------------------------------------------
    attotime_max - return the maximum of two
    attotimes
-------------------------------------------------*/

INLINE attotime attotime_max(attotime _time1, attotime _time2)
{
	if (_time1.seconds > _time2.seconds)
		return _time1;
	if (_time1.seconds < _time2.seconds)
		return _time2;
	if (_time1.attoseconds > _time2.attoseconds)
		return _time1;
	return _time2;
}


#endif	/* __ATTOTIME_H__ */