Skip to content

[PATCH v1] abi: time: change odp_time_t abi type to uint64_t #2343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MatiasElo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[PATCH v1] abi: time: change odp_time_t abi type to uint64_t #2343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 2 additions & 21 deletions include/odp/api/abi-default/time_types.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,13 @@
extern "C" {
#endif

/**
* @internal Time structure used for both POSIX timespec and HW counter
* implementations.
*/
struct odp_time_s {
/** @internal Variant mappings for time type */
union {
/** @internal Used with generic 64 bit operations */
uint64_t u64;

/** @internal Nanoseconds */
uint64_t nsec;

/** @internal HW timer counter value */
uint64_t count;

};
};

/** @addtogroup odp_time
* @{
**/

typedef struct odp_time_s odp_time_t;
typedef uint64_t odp_time_t;
Copy link
Copy Markdown
Collaborator

@JannePeltonen JannePeltonen Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The struct wrapped uint64_t has the benefit that it better enforces proper API usage as variables of odp_time_t cannot be used directly in time calculation and comparisons. It also makes odp_time_t type unique. I wonder if the implementation simplifications are big enough to outweigh the reduction of API safety.

Copy link
Copy Markdown
Collaborator Author

@MatiasElo MatiasElo Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps the biggest benefit of changing this would be that it enables applications to compare odp_time_t values directly to ODP_TIME_NULL. Currently, odp_time_t is a bit of an exception compared to other ODP handles.


#define ODP_TIME_NULL ((odp_time_t){.u64 = 0})
#define ODP_TIME_NULL ((odp_time_t)0)

/**
* @}
Expand Down
35 changes: 18 additions & 17 deletions platform/linux-generic/arch/common/odp/api/abi/time_cpu_inlines.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) 2013-2018 Linaro Limited
* Copyright (c) 2020-2023 Nokia
* Copyright (c) 2020-2026 Nokia
*/

#ifndef ODP_ARCH_TIME_CPU_INLINES_H_
Expand All @@ -20,34 +20,38 @@ extern "C" {

typedef struct _odp_time_global_t {
uint64_t freq_hz;
uint64_t start_time;
odp_time_t start_time;
uint64_t start_time_ns;

} _odp_time_global_t;

extern _odp_time_global_t _odp_time_glob;

static inline odp_time_t _odp_time_cur(void)
static inline uint64_t _odp_time_to_u64(odp_time_t time)
{
odp_time_t time;
return (uint64_t)time;
}

time.count = _odp_time_cpu_global();
return time;
static inline odp_time_t _odp_time_from_u64(uint64_t val)
{
return (odp_time_t)val;
}

static inline odp_time_t _odp_time_cur_strict(void)
static inline odp_time_t _odp_time_cur(void)
{
odp_time_t time;
return _odp_time_from_u64(_odp_time_cpu_global());
}

time.count = _odp_time_cpu_global_strict();
return time;
static inline odp_time_t _odp_time_cur_strict(void)
{
return _odp_time_from_u64(_odp_time_cpu_global_strict());
}

static inline uint64_t _odp_time_to_ns(odp_time_t time)
{
uint64_t nsec;
uint64_t freq_hz = _odp_time_glob.freq_hz;
uint64_t count = time.count;
uint64_t count = _odp_time_to_u64(time);
uint64_t sec = 0;

if (count >= freq_hz) {
Expand All @@ -62,7 +66,6 @@ static inline uint64_t _odp_time_to_ns(odp_time_t time)

static inline odp_time_t _odp_time_from_ns(uint64_t ns)
{
odp_time_t time;
uint64_t count;
uint64_t freq_hz = _odp_time_glob.freq_hz;
uint64_t sec = 0;
Expand All @@ -75,9 +78,7 @@ static inline odp_time_t _odp_time_from_ns(uint64_t ns)
count = sec * freq_hz;
count += (ns * freq_hz) / ODP_TIME_SEC_IN_NS;

time.count = count;

return time;
return _odp_time_from_u64(count);
}

static inline uint64_t _odp_time_res(void)
Expand All @@ -87,8 +88,8 @@ static inline uint64_t _odp_time_res(void)

static inline void _odp_time_startup(odp_time_startup_t *startup)
{
startup->global.count = _odp_time_glob.start_time;
startup->global_ns = _odp_time_glob.start_time_ns;
startup->global = _odp_time_glob.start_time;
startup->global_ns = _odp_time_glob.start_time_ns;
}

#ifdef __cplusplus
Expand Down
6 changes: 2 additions & 4 deletions platform/linux-generic/arch/common/odp_time_cpu.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ _odp_time_global_t _odp_time_glob;
int _odp_time_init_global(void)
{
uint64_t count, diff, years;
odp_time_t time;
_odp_time_global_t *global = &_odp_time_glob;

memset(global, 0, sizeof(_odp_time_global_t));
Expand All @@ -41,9 +40,8 @@ int _odp_time_init_global(void)
_ODP_PRINT("HW time counter freq: %" PRIu64 " hz\n\n", global->freq_hz);

count = _odp_time_cpu_global();
time.count = count;
global->start_time = count;
global->start_time_ns = _odp_time_to_ns(time);
global->start_time = _odp_time_from_u64(count);
global->start_time_ns = _odp_time_to_ns(global->start_time);

/* Make sure that counters will not wrap */
diff = UINT64_MAX - count;
Expand Down
14 changes: 10 additions & 4 deletions platform/linux-generic/arch/default/odp/api/abi/time_inlines.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,22 @@ static inline odp_time_t _odp_time_cur_strict(void)

static inline uint64_t _odp_time_to_ns(odp_time_t time)
{
return time.nsec;
return (uint64_t)time;
}

static inline odp_time_t _odp_time_from_ns(uint64_t ns)
{
odp_time_t time;
return (odp_time_t)ns;
}

time.nsec = ns;
static inline uint64_t _odp_time_to_u64(odp_time_t time)
{
return (uint64_t)time;
}

return time;
static inline odp_time_t _odp_time_from_u64(uint64_t val)
{
return (odp_time_t)val;
}

#ifdef __cplusplus
Expand Down
9 changes: 3 additions & 6 deletions platform/linux-generic/arch/default/odp_time.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,13 @@ static inline uint64_t time_nsec(struct timespec *t)
odp_time_t _odp_time_cur(void)
{
int ret;
odp_time_t time;
struct timespec sys_time;

ret = clock_gettime(CLOCK_MONOTONIC_RAW, &sys_time);
if (odp_unlikely(ret != 0))
_ODP_ABORT("clock_gettime() failed\n");

time.nsec = time_nsec(&sys_time);

return time;
return _odp_time_from_u64(time_nsec(&sys_time));
}

uint64_t _odp_time_res(void)
Expand All @@ -67,8 +64,8 @@ uint64_t _odp_time_res(void)

void _odp_time_startup(odp_time_startup_t *startup)
{
startup->global.nsec = _odp_time_glob.start_time_ns;
startup->global_ns = _odp_time_glob.start_time_ns;
startup->global = _odp_time_from_u64(_odp_time_glob.start_time_ns);
startup->global_ns = _odp_time_glob.start_time_ns;
}

#include <odp/visibility_end.h>
Expand Down
28 changes: 6 additions & 22 deletions platform/linux-generic/include/odp/api/plat/time_inlines.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,49 +100,33 @@ _ODP_INLINE uint64_t odp_time_to_ns(odp_time_t time)

_ODP_INLINE int odp_time_cmp(odp_time_t t2, odp_time_t t1)
{
if (odp_likely(t2.u64 > t1.u64))
if (odp_likely(t2 > t1))
return 1;

if (t2.u64 < t1.u64)
if (t2 < t1)
return -1;

return 0;
}

_ODP_INLINE odp_time_t odp_time_diff(odp_time_t t2, odp_time_t t1)
{
odp_time_t time;

time.u64 = t2.u64 - t1.u64;

return time;
return t2 - t1;
}

_ODP_INLINE uint64_t odp_time_diff_ns(odp_time_t t2, odp_time_t t1)
{
odp_time_t time;

time.u64 = t2.u64 - t1.u64;

return odp_time_to_ns(time);
return odp_time_to_ns(t2 - t1);
}

_ODP_INLINE odp_time_t odp_time_add_ns(odp_time_t time, uint64_t ns)
{
odp_time_t t = _odp_time_from_ns(ns);

t.u64 += time.u64;

return t;
return time + _odp_time_from_ns(ns);
}

_ODP_INLINE odp_time_t odp_time_sum(odp_time_t t1, odp_time_t t2)
{
odp_time_t time;

time.u64 = t1.u64 + t2.u64;

return time;
return t1 + t2;
}

_ODP_INLINE odp_time_t odp_time_local_from_ns(uint64_t ns)
Expand Down
5 changes: 2 additions & 3 deletions platform/linux-generic/include/odp_packet_io_internal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ extern "C" {
#include <odp/api/time.h>

#include <odp/api/plat/packet_io_inlines.h>
#include <odp/api/plat/time_inlines.h>

#include <odp/autoheader_internal.h>
#include <odp_classification_datamodel.h>
Expand Down Expand Up @@ -294,9 +295,7 @@ static inline int _odp_pktio_tx_aging_enabled(pktio_entry_t *entry)

static inline void _odp_pktio_tx_ts_set(pktio_entry_t *entry)
{
odp_time_t ts_val = odp_time_global();

odp_atomic_store_u64(&entry->tx_ts, ts_val.u64);
odp_atomic_store_u64(&entry->tx_ts, _odp_time_to_u64(odp_time_global()));
}

extern const pktio_if_ops_t _odp_dpdk_pktio_ops;
Expand Down
4 changes: 2 additions & 2 deletions platform/linux-generic/odp_packet_io.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2604,7 +2604,7 @@ int odp_pktin_recv_mq_tmo(const odp_pktin_queue_t queues[], uint32_t num_q, uint
{
uint32_t i;
int ret;
odp_time_t t1, t2;
odp_time_t t1 = ODP_TIME_NULL, t2;
struct timespec ts;
int started = 0;
uint64_t sleep_round = 0;
Expand Down Expand Up @@ -2833,7 +2833,7 @@ int odp_pktout_ts_read(odp_pktio_t hdl, odp_time_t *ts)
if (odp_unlikely(ts_val == 0))
return 1;

ts->u64 = ts_val;
*ts = _odp_time_from_u64(ts_val);
return 0;
}

Expand Down
6 changes: 3 additions & 3 deletions platform/linux-generic/odp_pcapng.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

#include <odp/api/plat/packet_inlines.h>
#include <odp/api/plat/packet_io_inlines.h>
#include <odp/api/plat/time_inlines.h>

#include <odp_config_internal.h>
#include <odp_global_data.h>
Expand Down Expand Up @@ -564,9 +565,8 @@ int _odp_pcapng_dump_pkts(pktio_entry_t *entry, int qidx,
_ODP_ROUNDUP_ALIGN(seg_len, PCAPNG_DATA_ALIGN) +
PCAPNG_DATA_ALIGN;
epb[i].interface_idx = 0;
epb[i].timestamp_high =
(uint32_t)(pkt_hdr->timestamp.u64 >> 32);
epb[i].timestamp_low = (uint32_t)(pkt_hdr->timestamp.u64);
epb[i].timestamp_high = (uint32_t)(_odp_time_to_u64(pkt_hdr->timestamp) >> 32);
epb[i].timestamp_low = (uint32_t)_odp_time_to_u64(pkt_hdr->timestamp);
epb[i].captured_len = seg_len;
epb[i].packet_len = seg_len;

Expand Down
2 changes: 1 addition & 1 deletion platform/linux-generic/odp_schedule_basic.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1884,7 +1884,7 @@ static inline int schedule_loop_sleep(odp_queue_t *out_queue, uint64_t wait,
odp_event_t out_ev[], uint32_t max_num)
{
int ret;
odp_time_t start, end, current, start_sleep;
odp_time_t start, end = ODP_TIME_NULL, current = ODP_TIME_NULL, start_sleep = ODP_TIME_NULL;
int first = 1, sleep = 0;

while (1) {
Expand Down
2 changes: 1 addition & 1 deletion test/performance/odp_packet_gen.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1794,7 +1794,7 @@ static int rx_thread(void *arg)
int i, thr, num;
uint32_t exit_test;
uint64_t bytes;
odp_time_t t1, t2, exit_time;
odp_time_t t1, t2 = ODP_TIME_NULL, exit_time;
thread_arg_t *thread_arg = arg;
test_global_t *global = thread_arg->global;
int direct_rx = global->test_options.direct_rx;
Expand Down