- Generated by
1.12.0
|
reactor-c
C Runtime for Lingua Franca
|
Implementation of time and tag functions for Lingua Franca programs. More...
#include <assert.h>#include <stdbool.h>#include <stdio.h>#include <string.h>#include "tag.h"#include "util.h"#include "low_level_platform.h"#include "environment.h"#include "reactor.h"#include "lf_types.h"#include "clock.h"Typedefs | |
| typedef enum _lf_time_type | _lf_time_type |
Enumerations | |
| enum | _lf_time_type { LF_LOGICAL , LF_PHYSICAL , LF_ELAPSED_LOGICAL , LF_ELAPSED_PHYSICAL , LF_START } |
Functions | |
| tag_t | lf_tag (void *env) |
| instant_t | lf_time_add (instant_t a, interval_t b) |
| Return the sum of an interval and an instant, saturating on overflow and underflow. | |
| tag_t | lf_tag_add (tag_t a, tag_t b) |
| int | lf_tag_compare (tag_t tag1, tag_t tag2) |
| tag_t | lf_delay_tag (tag_t tag, interval_t interval) |
| tag_t | lf_delay_strict (tag_t tag, interval_t interval) |
| instant_t | lf_time_logical (void *env) |
| interval_t | lf_time_logical_elapsed (void *env) |
| instant_t | lf_time_physical (void) |
| instant_t | lf_time_physical_elapsed (void) |
| instant_t | lf_time_start (void) |
| size_t | lf_readable_time (char *buffer, instant_t time) |
| size_t | lf_comma_separated_time (char *buffer, instant_t time) |
Variables | |
| instant_t | start_time = NEVER |
Implementation of time and tag functions for Lingua Franca programs.
| typedef enum _lf_time_type _lf_time_type |
An enum for specifying the desired tag when calling "lf_time"
| enum _lf_time_type |
| size_t lf_comma_separated_time | ( | char * | buffer, |
| instant_t | time ) |
Print a non-negative time value in nanoseconds with commas separating thousands into the specified buffer. Ideally, this would use the locale to use periods if appropriate, but I haven't found a sufficiently portable way to do that.
| buffer | A buffer long enough to contain a string like "9,223,372,036,854,775,807". |
| time | A time value. |
| tag_t lf_delay_strict | ( | tag_t | tag, |
| interval_t | interval ) |
Return the latest tag strictly less than the specified tag plus the interval, unless tag is NEVER or interval is negative (including NEVER), in which case return the tag unmodified. Any interval less than 0 (including NEVER) is interpreted as "no delay", whereas an interval equal to 0 is interpreted as one microstep delay. If the time sum overflows, saturate the time value at FOREVER. For example:
| tag | The tag to increment. |
| interval | The time interval. |
| tag_t lf_delay_tag | ( | tag_t | tag, |
| interval_t | interval ) |
Delay a tag by the specified time interval to realize the "after" keyword. Any interval less than 0 (including NEVER) is interpreted as "no delay", whereas an interval equal to 0 is interpreted as one microstep delay. If the time field of the tag is NEVER or the interval is negative, return the unmodified tag. If the time interval is 0LL, add one to the microstep, leave the time field alone, and return the result. Otherwise, add the interval to the time field of the tag and reset the microstep to 0. If the sum overflows, saturate the time value at FOREVER. For example:
| tag | The tag to increment. |
| interval | The time interval. |
| size_t lf_readable_time | ( | char * | buffer, |
| instant_t | time ) |
Store into the specified buffer a string giving a human-readable rendition of the specified time. The buffer must have length at least equal to LF_TIME_BUFFER_LENGTH. The format is:
where each x is a string of numbers with commas inserted if needed every three numbers and unit is ns, us, or ms.
| buffer | The buffer into which to write the string. |
| time | The time to write. |
| tag_t lf_tag | ( | void * | env | ) |
Return the current tag, a logical time, microstep pair.
| env | A pointer to the environment from which we want the current tag. |
Add two tags. If either tag has has NEVER or FOREVER in its time field, then return NEVER_TAG or FOREVER_TAG, respectively. Also return NEVER_TAG or FOREVER_TAG if the result underflows or overflows when adding the times. If the microstep overflows, also return FOREVER_TAG. If the time field of the second tag is greater than 0, then the microstep of the first tag is reset to 0 before adding. This models the delay semantics in LF and makes this addition operation non-commutative.
| a | The first tag. |
| b | The second tag. |
Compare two tags. Return -1 if the first is less than the second, 0 if they are equal, and +1 if the first is greater than the second. A tag is greater than another if its time is greater or if its time is equal and its microstep is greater.
| tag1 | |
| tag2 |
| instant_t lf_time_add | ( | instant_t | a, |
| interval_t | b ) |
Return the sum of an interval and an instant, saturating on overflow and underflow.
| a | |
| b |
| instant_t lf_time_logical | ( | void * | env | ) |
Return the current logical time in nanoseconds. On many platforms, this is the number of nanoseconds since January 1, 1970, but it is actually platform dependent.
| env | The environment from which we want the current logical time. |
| interval_t lf_time_logical_elapsed | ( | void * | env | ) |
Return the elapsed logical time in nanoseconds since the start of execution.
| env | The environment from which we want the elapsed logical time. |
| instant_t lf_time_physical | ( | void | ) |
Return the current physical time in nanoseconds. On many platforms, this is the number of nanoseconds since January 1, 1970, but it is actually platform dependent.
| instant_t lf_time_physical_elapsed | ( | void | ) |
Return the elapsed physical time in nanoseconds. This is the time returned by lf_time_physical(void) minus the physical start time as measured by lf_time_physical(void) when the program was started.
| instant_t lf_time_start | ( | void | ) |
Return the physical and logical time of the start of execution in nanoseconds. On many platforms, this is the number of nanoseconds since January 1, 1970, but it is actually platform dependent.
1.12.0