forked from osmocom/wireshark
147 lines
4.4 KiB
C
147 lines
4.4 KiB
C
/* nstime.h
|
|
* Definition of data structure to hold time values with nanosecond resolution
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef __NSTIME_H__
|
|
#define __NSTIME_H__
|
|
|
|
#include <glib.h>
|
|
#include <time.h>
|
|
|
|
#include "ws_symbol_export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/** @file
|
|
* Definition of data structure to hold time values with nanosecond resolution
|
|
*/
|
|
|
|
/** data structure to hold time values with nanosecond resolution*/
|
|
typedef struct {
|
|
time_t secs;
|
|
int nsecs;
|
|
} nstime_t;
|
|
|
|
/* Macros that expand to nstime_t initializers */
|
|
|
|
/* Initialize to zero */
|
|
#define NSTIME_INIT_ZERO {0, 0}
|
|
|
|
/* Initialize to unset */
|
|
#define NSTIME_INIT_UNSET {0, G_MAXINT}
|
|
|
|
/* Initialize to a specified number of seconds and nanoseconds */
|
|
#define NSTIME_INIT_SECS_NSECS(secs, nsecs) {secs, nsecs}
|
|
|
|
/* Initialize to a specified number of seconds and microseconds */
|
|
#define NSTIME_INIT_SECS_USECS(secs, usecs) {secs, usecs*1000}
|
|
|
|
/* Initialize to a specified number of seconds and milliseconds */
|
|
#define NSTIME_INIT_SECS_MSECS(secs, msecs) {secs, msecs*1000000}
|
|
|
|
/* Initialize to a specified number of seconds */
|
|
#define NSTIME_INIT_SECS(secs) {secs, 0}
|
|
|
|
/* Initialize to the maxximum possible value */
|
|
#define NSTIME_INIT_MAX {sizeof(time_t) > sizeof(int) ? LONG_MAX : INT_MAX, INT_MAX}
|
|
|
|
/* functions */
|
|
|
|
/** set the given nstime_t to zero */
|
|
WS_DLL_PUBLIC void nstime_set_zero(nstime_t *nstime);
|
|
|
|
/** is the given nstime_t currently zero? */
|
|
WS_DLL_PUBLIC gboolean nstime_is_zero(const nstime_t *nstime);
|
|
|
|
/** set the given nstime_t to (0,maxint) to mark it as "unset"
|
|
* That way we can find the first frame even when a timestamp
|
|
* is zero (fix for bug 1056)
|
|
*/
|
|
WS_DLL_PUBLIC void nstime_set_unset(nstime_t *nstime);
|
|
|
|
/* is the given nstime_t currently (0,maxint)? */
|
|
WS_DLL_PUBLIC gboolean nstime_is_unset(const nstime_t *nstime);
|
|
|
|
/** duplicate the current time
|
|
*
|
|
* a = b
|
|
*/
|
|
WS_DLL_PUBLIC void nstime_copy(nstime_t *a, const nstime_t *b);
|
|
|
|
/** calculate the delta between two times (can be negative!)
|
|
*
|
|
* delta = b-a
|
|
*
|
|
* Note that it is acceptable for two or more of the arguments to point at the
|
|
* same structure.
|
|
*/
|
|
WS_DLL_PUBLIC void nstime_delta(nstime_t *delta, const nstime_t *b, const nstime_t *a );
|
|
|
|
/** calculate the sum of two times
|
|
*
|
|
* sum = a+b
|
|
*
|
|
* Note that it is acceptable for two or more of the arguments to point at the
|
|
* same structure.
|
|
*/
|
|
WS_DLL_PUBLIC void nstime_sum(nstime_t *sum, const nstime_t *a, const nstime_t *b );
|
|
|
|
/** sum += a */
|
|
#define nstime_add(sum, a) nstime_sum(sum, sum, a)
|
|
|
|
/** sum -= a */
|
|
#define nstime_subtract(sum, a) nstime_delta(sum, sum, a)
|
|
|
|
/** compare two times are return a value similar to memcmp() or strcmp().
|
|
*
|
|
* a > b : > 0
|
|
* a = b : 0
|
|
* a < b : < 0
|
|
*/
|
|
WS_DLL_PUBLIC int nstime_cmp (const nstime_t *a, const nstime_t *b );
|
|
|
|
/** converts nstime to double, time base is milli seconds */
|
|
WS_DLL_PUBLIC double nstime_to_msec(const nstime_t *nstime);
|
|
|
|
/** converts nstime to double, time base is seconds */
|
|
WS_DLL_PUBLIC double nstime_to_sec(const nstime_t *nstime);
|
|
|
|
/** converts Windows FILETIME to nstime, returns TRUE on success,
|
|
FALSE on failure */
|
|
WS_DLL_PUBLIC gboolean filetime_to_nstime(nstime_t *nstime, guint64 filetime);
|
|
|
|
/** converts time like Windows FILETIME, but expressed in nanoseconds
|
|
rather than tenths of microseconds, to nstime, returns TRUE on success,
|
|
FALSE on failure */
|
|
WS_DLL_PUBLIC gboolean nsfiletime_to_nstime(nstime_t *nstime, guint64 nsfiletime);
|
|
|
|
typedef enum {
|
|
ISO8601_DATETIME, /** e.g. 2014-07-04T12:34:56.789+00:00 */
|
|
ISO8601_DATETIME_BASIC, /** ISO8601 Basic format, i.e. no - : separators */
|
|
ISO8601_DATETIME_AUTO, /** Autodetect the presence of separators */
|
|
} iso8601_fmt_e;
|
|
|
|
/** parse an ISO 8601 format datetime string to nstime, returns number of
|
|
chars parsed on success, 0 on failure.
|
|
Note that nstime is set to unset in the case of failure */
|
|
WS_DLL_PUBLIC guint8 iso8601_to_nstime(nstime_t *nstime, const char *ptr, iso8601_fmt_e format);
|
|
|
|
/** parse an Unix epoch timestamp format datetime string to nstime, returns
|
|
number of chars parsed on success, 0 on failure.
|
|
Note that nstime is set to unset in the case of failure */
|
|
WS_DLL_PUBLIC guint8 unix_epoch_to_nstime(nstime_t *nstime, const char *ptr);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __NSTIME_H__ */
|