summaryrefslogtreecommitdiffstats
path: root/c-user/timespec_helpers.rst
blob: f2ef5cd4d1434783f7661ac64b460d3a76fdcccc (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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
.. SPDX-License-Identifier: CC-BY-SA-4.0

.. Copyright (C) 2011.
.. COMMENT: On-Line Applications Research Corporation (OAR).

.. index:: TImespec Helpers

Timespec Helpers
****************

Introduction
============

The Timespec helpers manager provides directives to assist in manipulating
instances of the POSIX ``struct timespec`` structure.

The directives provided by the timespec helpers manager are:

- rtems_timespec_set_ - Set timespec's value

- rtems_timespec_zero_ - Zero timespec's value

- rtems_timespec_is_valid_ - Check if timespec is valid

- rtems_timespec_add_to_ - Add two timespecs

- rtems_timespec_subtract_ - Subtract two timespecs

- rtems_timespec_divide_ - Divide two timespecs

- rtems_timespec_divide_by_integer_ - Divide timespec by integer

- rtems_timespec_less_than_ - Less than operator

- rtems_timespec_greater_than_ - Greater than operator

- rtems_timespec_equal_to_ - Check if two timespecs are equal

- rtems_timespec_get_seconds_ - Obtain seconds portion of timespec

- rtems_timespec_get_nanoseconds_ - Obtain nanoseconds portion of timespec

- rtems_timespec_to_ticks_ - Convert timespec to number of ticks

- rtems_timespec_from_ticks_ - Convert ticks to timespec

Background
==========

Time Storage Conventions
------------------------

Time can be stored in many ways. One of them is the ``struct timespec`` format
which is a structure that consists of the fields ``tv_sec`` to represent
seconds and ``tv_nsec`` to represent nanoseconds.  The``struct timeval``
structure is simular and consists of seconds (stored in ``tv_sec``) and
microseconds (stored in ``tv_usec``). Either``struct timespec`` or ``struct
timeval`` can be used to represent elapsed time, time of executing some
operations, or time of day.

Operations
==========

Set and Obtain Timespec Value
-----------------------------

A user may write a specific time by passing the desired seconds and nanoseconds
values and the destination ``struct timespec`` using the ``rtems_timespec_set``
directive.

The ``rtems_timespec_zero`` directive is used to zero the seconds
and nanoseconds portions of a ``struct timespec`` instance.

Users may obtain the seconds or nanoseconds portions of a ``struct timespec``
instance with the ``rtems_timespec_get_seconds`` or
``rtems_timespec_get_nanoseconds`` methods, respectively.

Timespec Math
-------------

A user can perform multiple operations on ``struct timespec`` instances. The
helpers in this manager assist in adding, subtracting, and performing divison
on ``struct timespec`` instances.

- Adding two ``struct timespec`` can be done using the
  ``rtems_timespec_add_to`` directive. This directive is used mainly to
  calculate total amount of time consumed by multiple operations.

- The ``rtems_timespec_subtract`` is used to subtract two ``struct timespecs``
  instances and determine the elapsed time between those two points in time.

- The ``rtems_timespec_divide`` is used to use to divide one ``struct
  timespec`` instance by another. This calculates the percentage with a
  precision to three decimal points.

- The ``rtems_timespec_divide_by_integer`` is used to divide a ``struct
  timespec`` instance by an integer. It is commonly used in benchmark
  calculations to dividing duration by the number of iterations performed.

Comparing struct timespec Instances
-----------------------------------

A user can compare two ``struct timespec`` instances using the
``rtems_timespec_less_than``, ``rtems_timespec_greater_than`` or
``rtems_timespec_equal_to`` routines.

Conversions and Validity Check
------------------------------

Conversion to and from clock ticks may be performed by using the
``rtems_timespec_to_ticks`` and ``rtems_timespec_from_ticks`` directives.

User can also check validity of timespec with ``rtems_timespec_is_valid``
routine.

Directives
==========

This section details the Timespec Helpers manager's directives.  A subsection
is dedicated to each of this manager's directives and describes the calling
sequence, related constants, usage, and status codes.

.. raw:: latex

   \clearpage

.. index:: set struct timespec instance
.. index:: rtems_timespec_set

.. _rtems_timespec_set:

TIMESPEC_SET - Set struct timespec Instance
-------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_timespec_set(
            struct timespec *time,
            time_t           seconds,
            uint32_t         nanoseconds
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This directive sets the ``struct timespec`` *time* to the desired
    ``seconds`` and ``nanoseconds`` values.

NOTES:
    This method does NOT check if ``nanoseconds`` is less than the maximum
    number of nanoseconds in a second.

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_zero

.. _rtems_timespec_zero:

TIMESPEC_ZERO - Zero struct timespec Instance
---------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_timespec_zero(
            struct timespec *time
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This routine sets the contents of the ``struct timespec`` instance ``time`` to
    zero.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_is_valid

.. _rtems_timespec_is_valid:

TIMESPEC_IS_VALID - Check validity of a struct timespec instance
----------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_timespec_is_valid(
            const struct timespec *time
        );

DIRECTIVE STATUS CODES:
    This method returns ``true`` if the instance is valid, and ``false``
    otherwise.

DESCRIPTION:
    This routine check validity of a ``struct timespec`` instance. It checks if
    the nanoseconds portion of the ``struct timespec`` instanceis in allowed
    range (less than the maximum number of nanoseconds per second).

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_add_to

.. _rtems_timespec_add_to:

TIMESPEC_ADD_TO - Add Two struct timespec Instances
---------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        uint32_t rtems_timespec_add_to(
            struct timespec       *time,
            const struct timespec *add
        );

DIRECTIVE STATUS CODES:
    The method returns the number of seconds ``time`` increased by.

DESCRIPTION:
    This routine adds two ``struct timespec`` instances. The second argument is
    added to the first. The parameter ``time`` is the base time to which the
    ``add`` parameter is added.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_subtract

.. _rtems_timespec_subtract:

TIMESPEC_SUBTRACT - Subtract Two struct timespec Instances
----------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_timespec_subtract(
            const struct timespec *start,
            const struct timespec *end,
            struct timespec       *result
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This routine subtracts ``start`` from ``end`` saves the difference in
    ``result``. The primary use of this directive is to calculate elapsed time.

NOTES:
    It is possible to subtract when ``end`` is less than ``start`` and it
    produce negative ``result``. When doing this you should be careful and
    remember that only the seconds portion of a ``struct timespec`` instance is
    signed, which means that nanoseconds portion is always increasing. Due to
    that when your timespec has seconds = -1 and nanoseconds = 500,000,000 it
    means that result is -0.5 second, NOT the expected -1.5!

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_divide

.. _rtems_timespec_divide:

TIMESPEC_DIVIDE - Divide Two struct timespec Instances
------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_timespec_divide(
            const struct timespec *lhs,
            const struct timespec *rhs,
            uint32_t              *ival_percentage,
            uint32_t              *fval_percentage
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This routine divides the ``struct timespec`` instance ``lhs`` by the
    ``struct timespec`` instance ``rhs``. The result is returned in the
    ``ival_percentage`` and ``fval_percentage``, representing the integer and
    fractional results of the division respectively.

    The ``ival_percentage`` is integer value of calculated percentage and
    ``fval_percentage`` is fractional part of calculated percentage.

NOTES:
    The intended use is calculating percentges to three decimal points.

    When dividing by zero, this routine return both ``ival_percentage`` and
    ``fval_percentage`` equal zero.

    The division is performed using exclusively integer operations.

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_divide_by_integer

.. _rtems_timespec_divide_by_integer:

TIMESPEC_DIVIDE_BY_INTEGER - Divide a struct timespec Instance by an Integer
----------------------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_timespec_divide_by_integer(
            const struct timespec *time,
            uint32_t               iterations,
            struct timespec       *result
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This routine divides the ``struct timespec`` instance ``time`` by the
    integer value ``iterations``.  The result is saved in ``result``.

NOTES:
    The expected use is to assist in benchmark calculations where you typically
    divide a duration (``time``) by a number of iterations what gives average
    time.

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_less_than

.. _rtems_timespec_less_than:

TIMESPEC_LESS_THAN - Less than operator
---------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_timespec_less_than(
            const struct timespec *lhs,
            const struct timespec *rhs
        );

DIRECTIVE STATUS CODES:
    This method returns ``struct true`` if ``lhs`` is less than ``rhs`` and
    ``struct false`` otherwise.

DESCRIPTION:
    This method is the less than operator for ``struct timespec``
    instances. The first parameter is the left hand side and the second is the
    right hand side of the comparison.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_greater_than

.. _rtems_timespec_greater_than:

TIMESPEC_GREATER_THAN - Greater than operator
---------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_timespec_greater_than(
            const struct timespec *_lhs,
            const struct timespec *_rhs
        );

DIRECTIVE STATUS CODES:
    This method returns ``struct true`` if ``lhs`` is greater than ``rhs`` and
    ``struct false`` otherwise.

DESCRIPTION:
    This method is greater than operator for ``struct timespec`` instances.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_equal_to

.. _rtems_timespec_equal_to:

TIMESPEC_EQUAL_TO - Check equality of timespecs
-----------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_timespec_equal_to(
            const struct timespec *lhs,
            const struct timespec *rhs
        );

DIRECTIVE STATUS CODES:
    This method returns ``struct true`` if ``lhs`` is equal to ``rhs`` and
    ``struct false`` otherwise.

DESCRIPTION:
    This method is equality operator for ``struct timespec`` instances.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_get_seconds

.. _rtems_timespec_get_seconds:

TIMESPEC_GET_SECONDS - Get Seconds Portion of struct timespec Instance
----------------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        time_t rtems_timespec_get_seconds(
            struct timespec *time
        );

DIRECTIVE STATUS CODES:
    This method returns the seconds portion of the specified ``struct
    timespec`` instance.

DESCRIPTION:
    This method returns the seconds portion of the specified ``struct
    timespec`` instance ``time``.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_get_nanoseconds

.. _rtems_timespec_get_nanoseconds:

TIMESPEC_GET_NANOSECONDS - Get Nanoseconds Portion of the struct timespec Instance
----------------------------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        uint32_t rtems_timespec_get_nanoseconds(
            struct timespec *_time
        );

DIRECTIVE STATUS CODES:
    This method returns the nanoseconds portion of the specified ``struct
    timespec`` instance.

DESCRIPTION:
    This method returns the nanoseconds portion of the specified timespec which
    is pointed by ``_time``.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_to_ticks

.. _rtems_timespec_to_ticks:

TIMESPEC_TO_TICKS - Convert struct timespec Instance to Ticks
-------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        uint32_t rtems_timespec_to_ticks(
            const struct timespec *time
        );

DIRECTIVE STATUS CODES:
    This directive returns the number of ticks computed.

DESCRIPTION:
    This directive converts the ``time`` timespec to the corresponding number
    of clock ticks.

NOTES:
    NONE

.. raw:: latex

   \clearpage

.. index:: rtems_timespec_from_ticks

.. _rtems_timespec_from_ticks:

TIMESPEC_FROM_TICKS - Convert Ticks to struct timespec Representation
---------------------------------------------------------------------

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_timespec_from_ticks(
            uint32_t         ticks,
            struct timespec *time
        );

DIRECTIVE STATUS CODES:
    NONE

DESCRIPTION:
    This routine converts the ``ticks`` to the corresponding ``struct
    timespec`` representation and stores it in ``time``.

NOTES:
    NONE