rz_time.h File Reference

#include <rz_types.h>
#include <time.h>

Go to the source code of this file.

Macros
#define	RZ_NSEC_PER_SEC   1000000000ULL
#define	RZ_NSEC_PER_MSEC   1000000ULL
#define	RZ_USEC_PER_SEC   1000000ULL
#define	RZ_NSEC_PER_USEC   1000ULL
#define	RZ_USEC_PER_MSEC   1000ULL
#define	ASCTIME_BUF_MINLEN   26
#define	rz_time_date_unix_to_string   rz_time_stamp_to_str
#define	RZ_TIME_PROFILE_ENABLED   0
#define	RZ_TIME_PROFILE_BEGIN
#define	RZ_TIME_PROFILE_END

Functions
RZ_API int	rz_time_gettimeofday (struct timeval *p, struct timezone *tz)
	Get the system current time and the current time zone. More...
RZ_API ut64	rz_time_now (void)
	Returns the current time in microseconds. More...
RZ_API ut64	rz_time_now_mono (void)
	Returns the current time in microseconds, using the monotonic clock. More...
RZ_API RZ_OWN char *	rz_time_stamp_to_str (ut32 timestamp)
	Converts an unix epoch timestamp to string. More...
RZ_API ut32	rz_time_dos_time_stamp_to_posix (ut32 timestamp)
	Converts dos timestamp to posix timestamp. More...
RZ_API bool	rz_time_stamp_is_dos_format (const ut32 certainPosixTimeStamp, const ut32 possiblePosixOrDosTimeStamp)
	Verifies that the timestamp is in dos format. More...
RZ_API RZ_OWN char *	rz_time_date_dos_to_string (ut32 timestamp)
	Converts a dos date (ut32) and returns the timestamp in string format. More...
RZ_API RZ_OWN char *	rz_time_date_hfs_to_string (ut32 timestamp)
	Converts a Mac HFS+ date (ut32) and returns the timestamp in string format. More...
RZ_API RZ_OWN char *	rz_time_date_w32_to_string (ut64 timestamp)
	Converts a Win32 date (ut64) and returns the timestamp in string format. More...
RZ_API RZ_OWN char *	rz_time_date_now_to_string (void)
	Returns the timestamp in string format of the current time (now) More...
RZ_API char *	rz_asctime_r (RZ_NONNULL const struct tm *tm, RZ_NONNULL char *buf)
RZ_API char *	rz_ctime_r (RZ_NONNULL const time_t *timer, RZ_NONNULL char *buf)
RZ_API struct tm *	rz_localtime_r (RZ_NONNULL const time_t *time, RZ_NONNULL struct tm *res)
RZ_API struct tm *	rz_gmtime_r (RZ_NONNULL const time_t *time, RZ_NONNULL struct tm *res)

Macro Definition Documentation

ASCTIME_BUF_MINLEN

#define ASCTIME_BUF_MINLEN   26

Definition at line 13 of file rz_time.h.

RZ_NSEC_PER_MSEC

#define RZ_NSEC_PER_MSEC   1000000ULL

Definition at line 8 of file rz_time.h.

RZ_NSEC_PER_SEC

#define RZ_NSEC_PER_SEC   1000000000ULL

Definition at line 7 of file rz_time.h.

RZ_NSEC_PER_USEC

#define RZ_NSEC_PER_USEC   1000ULL

Definition at line 10 of file rz_time.h.

rz_time_date_unix_to_string

#define rz_time_date_unix_to_string   rz_time_stamp_to_str

Definition at line 38 of file rz_time.h.

RZ_TIME_PROFILE_BEGIN

#define RZ_TIME_PROFILE_BEGIN

Value:

    do { \
    } while (0)

Definition at line 53 of file rz_time.h.

RZ_TIME_PROFILE_ENABLED

#define RZ_TIME_PROFILE_ENABLED   0

Definition at line 47 of file rz_time.h.

RZ_TIME_PROFILE_END

#define RZ_TIME_PROFILE_END

Value:

    do { \
    } while (0)

Definition at line 56 of file rz_time.h.

RZ_USEC_PER_MSEC

#define RZ_USEC_PER_MSEC   1000ULL

Definition at line 11 of file rz_time.h.

RZ_USEC_PER_SEC

#define RZ_USEC_PER_SEC   1000000ULL

Definition at line 9 of file rz_time.h.

Function Documentation

rz_asctime_r()

RZ_API char* rz_asctime_r	(	RZ_NONNULL const struct tm *	tm,
		RZ_NONNULL char *	buf
	)

Definition at line 304 of file time.c.

                                                                                {
    rz_return_val_if_fail(tm && buf, NULL);
#if __WINDOWS__
    errno_t err = asctime_s(buf, ASCTIME_BUF_MINLEN, tm);
    return err ? NULL : buf;
#else
    return asctime_r(tm, buf);
#endif
}

References ASCTIME_BUF_MINLEN, err, NULL, and rz_return_val_if_fail.

Referenced by file_fmttime(), and rz_type_format_time().

rz_ctime_r()

RZ_API char* rz_ctime_r	(	RZ_NONNULL const time_t *	timer,
		RZ_NONNULL char *	buf
	)

Definition at line 314 of file time.c.

                                                                              {
    rz_return_val_if_fail(timer && buf, NULL);
#if __WINDOWS__
    errno_t err = ctime_s(buf, ASCTIME_BUF_MINLEN, timer);
    return err ? NULL : buf;
#else
    return ctime_r(timer, buf);
#endif
}

References ASCTIME_BUF_MINLEN, err, NULL, and rz_return_val_if_fail.

Referenced by file_fmttime(), and rz_time_stamp_to_str().

rz_gmtime_r()

RZ_API struct tm* rz_gmtime_r	(	RZ_NONNULL const time_t *	time,
		RZ_NONNULL struct tm *	res
	)

Definition at line 294 of file time.c.

                                                                                        {
    rz_return_val_if_fail(time && res, NULL);
#if __WINDOWS__
    errno_t err = gmtime_s(res, time);
    return err ? NULL : res;
#else
    return gmtime_r(time, res);
#endif
}

References err, NULL, rz_return_val_if_fail, and time.

Referenced by file_fmttime(), rz_time_stamp_to_str(), and rz_type_format_time().

rz_localtime_r()

RZ_API struct tm* rz_localtime_r	(	RZ_NONNULL const time_t *	time,
		RZ_NONNULL struct tm *	res
	)

Definition at line 284 of file time.c.

                                                                                           {
    rz_return_val_if_fail(time && res, NULL);
#if __WINDOWS__
    errno_t err = localtime_s(res, time);
    return err ? NULL : res;
#else
    return localtime_r(time, res);
#endif
}

References err, NULL, rz_return_val_if_fail, and time.

Referenced by file_fmttime(), and rz_time_stamp_to_str().

rz_time_date_dos_to_string()

RZ_API RZ_OWN char* rz_time_date_dos_to_string

(

ut32

timestamp

)

Converts a dos date (ut32) and returns the timestamp in string format.

Parameters

timestamp

The number to convert to string

Returns

The timestamp in string format

Definition at line 239 of file time.c.

                                                               {
    ut32 posix = rz_time_dos_time_stamp_to_posix(timestamp);
    return rz_time_stamp_to_str(posix);
}

References rz_time_dos_time_stamp_to_posix(), and rz_time_stamp_to_str().

Referenced by rz_cmd_print_timestamp_dos_handler().

rz_time_date_hfs_to_string()

RZ_API RZ_OWN char* rz_time_date_hfs_to_string

(

ut32

timestamp

)

Converts a Mac HFS+ date (ut32) and returns the timestamp in string format.

Parameters

timestamp

The number to convert to string

Returns

The timestamp in string format

Definition at line 250 of file time.c.

                                                               {
    timestamp += TIME_HFS_SINCE_1970; // add Mac HFS+ epoch
    return rz_time_stamp_to_str(timestamp);
}

References rz_time_stamp_to_str(), and TIME_HFS_SINCE_1970.

Referenced by rz_cmd_print_timestamp_hfs_handler().

rz_time_date_now_to_string()

RZ_API RZ_OWN char* rz_time_date_now_to_string

(

void

)

Returns the timestamp in string format of the current time (now)

Returns

The timestamp in string format

Definition at line 278 of file time.c.

                                                     {
    ut64 now = rz_time_now();
    now /= RZ_USEC_PER_SEC;
    return rz_time_stamp_to_str(now);
}

References rz_time_now(), rz_time_stamp_to_str(), RZ_USEC_PER_SEC, and ut64().

Referenced by rz_cmd_debug(), rz_cmd_print_timestamp_current_handler(), rz_diff_unified_json(), and rz_diff_unified_text().

rz_time_date_w32_to_string()

RZ_API RZ_OWN char* rz_time_date_w32_to_string

(

ut64

timestamp

)

Converts a Win32 date (ut64) and returns the timestamp in string format.

Parameters

timestamp

The number to convert to string

Returns

The timestamp in string format

Definition at line 261 of file time.c.

                                                               {
    timestamp /= 10000000ll; // 100 nanoseconds to seconds
    if (timestamp > TIME_W32_SINCE_1970) {
        timestamp -= TIME_W32_SINCE_1970;
    } else {
        // TODO: this usecase is not handled and defaulted to 0
        timestamp = 0;
    }
    time_t t = (time_t)timestamp;
    return rz_time_stamp_to_str(t);
}

References rz_time_stamp_to_str(), and TIME_W32_SINCE_1970.

Referenced by rz_cmd_print_timestamp_ntfs_handler().

rz_time_dos_time_stamp_to_posix()

RZ_API ut32 rz_time_dos_time_stamp_to_posix

(

ut32

timestamp

)

Converts dos timestamp to posix timestamp.

Parameters

timestamp

The timestamp in dos format to convert

Returns

The converted posix timestamp

Definition at line 190 of file time.c.

                                                            {
    ut16 date = timestamp >> 16;
    ut16 time = timestamp & 0xFFFF;
 
    /* Date */
    ut32 year = ((date & 0xfe00) >> 9) + 1980;
    ut32 month = (date & 0x01e0) >> 5;
    ut32 day = date & 0x001f;
 
    /* Time */
    ut32 hour = (time & 0xf800) >> 11;
    ut32 minutes = (time & 0x07e0) >> 5;
    ut32 seconds = (time & 0x001f) << 1;
 
    /* Convert to epoch */
    struct tm t = { 0 };
    t.tm_year = year - 1900;
    t.tm_mon = month > 0 ? month - 1 : month;
    t.tm_mday = day > 0 ? day : 1;
    t.tm_hour = hour;
    t.tm_min = minutes;
    t.tm_sec = seconds;
    t.tm_isdst = -1;
    time_t epochTime = mktime(&t);
 
    return (ut32)epochTime;
}

References time.

Referenced by _parse_resource_directory(), and rz_time_date_dos_to_string().

rz_time_gettimeofday()

RZ_API int rz_time_gettimeofday	(	struct timeval *	p,
		struct timezone *	tz
	)

Get the system current time and the current time zone.

See https://man7.org/linux/man-pages/man2/gettimeofday.2.html for more information.

Parameters

p	Pointer to a timeval structure that will be filled by this function
tz	Pointer to a timezone structure that will be filled by this function

Returns

0 if the function succeeds, -1 on error

Definition at line 78 of file time.c.

                                                                        {
    return gettimeofday(p, tz);
}

References gettimeofday, and p.

Referenced by rz_time_now().

rz_time_now()

RZ_API ut64 rz_time_now

(

void

)

Returns the current time in microseconds.

Returns

The current time

Definition at line 88 of file time.c.

                              {
    ut64 ret;
    struct timeval now;
    rz_time_gettimeofday(&now, NULL);
    ret = now.tv_sec * RZ_USEC_PER_SEC;
    ret += now.tv_usec;
    return ret;
}

References NULL, rz_time_gettimeofday(), RZ_USEC_PER_SEC, timeval::tv_sec, timeval::tv_usec, and ut64().

Referenced by hex_add_to_pkt(), hex_add_to_stale_pkt(), hex_get_instr_at_addr(), hex_to_new_pkt(), make_next_packet_valid(), rz_debug_trace_add(), rz_file_temp(), rz_num_irand(), rz_time_date_now_to_string(), sdb_now(), w32_dbg_wait(), and windbg_wait().

rz_time_now_mono()

RZ_API ut64 rz_time_now_mono

(

void

)

Returns the current time in microseconds, using the monotonic clock.

Returns

The current time

Definition at line 102 of file time.c.

                                   {
#if __WINDOWS__
    LARGE_INTEGER f;
    if (!QueryPerformanceFrequency(&f)) {
        return 0;
    }
    LARGE_INTEGER v;
    if (!QueryPerformanceCounter(&v)) {
        return 0;
    }
    v.QuadPart *= 1000000;
    v.QuadPart /= f.QuadPart;
    return v.QuadPart;
#elif __APPLE__ && !defined(MAC_OS_X_VERSION_10_12)
    ut64 ticks = mach_absolute_time();
    mach_timebase_info_data_t tb;
    mach_timebase_info(&tb);
    return ((ticks * tb.numer) / tb.denom) / RZ_NSEC_PER_USEC;
#else
    struct timespec now;
    clock_gettime(CLOCK_MONOTONIC, &now);
    return now.tv_sec * RZ_USEC_PER_SEC + now.tv_nsec / RZ_NSEC_PER_USEC;
#endif
}

References f, RZ_NSEC_PER_USEC, RZ_USEC_PER_SEC, timespec::tv_nsec, timespec::tv_sec, ut64(), and v.

Referenced by rz_cmd_help(), rz_cons_break_timeout(), rz_cons_is_breaked(), rz_core_esil_step(), rz_core_file_open(), rz_core_loadlibs(), rz_core_loadlibs_init(), rz_test_main(), rz_test_run_test(), search_collisions(), and subprocess_wait().

rz_time_stamp_is_dos_format()

RZ_API bool rz_time_stamp_is_dos_format	(	const ut32	certainPosixTimeStamp,
		const ut32	possiblePosixOrDosTimeStamp
	)

Verifies that the timestamp is in dos format.

Parameters

certainPosixTimeStamp	Certain posix timestamp
possiblePosixOrDosTimeStamp	Possible posix or dos timestamp to test

Returns

true if format is in dos format, otherwise false

Definition at line 225 of file time.c.

                                                                                                                  {
    /* We assume they're both POSIX timestamp and thus the higher bits would be equal if they're close to each other */
    if ((certainPosixTimeStamp >> 16) == (possiblePosixOrDosTimeStamp >> 16)) {
        return false;
    }
    return true;
}

Referenced by _parse_resource_directory().

rz_time_stamp_to_str()

RZ_API RZ_OWN char* rz_time_stamp_to_str

(

ut32

timestamp

)

Converts an unix epoch timestamp to string.

Parameters

timestamp

The unix epoch timestamp

Returns

The timestamp in string format

Definition at line 143 of file time.c.

                                                         {
    char timestr_buf[ASCTIME_BUF_MINLEN];
    time_t ts = (time_t)timestamp;
    struct tm gmt_tm;
    rz_gmtime_r(&ts, &gmt_tm);
    struct tm local_tm;
    rz_localtime_r(&ts, &local_tm);
    time_t gmt_time;
    time_t local_time;
    long diff;
    if (gmt_tm.tm_mday == 1 && gmt_tm.tm_mon == 0 && gmt_tm.tm_year == 70) {
        gmt_time = get_seconds_since_12am31Dec1969(&gmt_tm);
        local_time = get_seconds_since_12am31Dec1969(&local_tm);
        diff = local_time - gmt_time;
    } else {
        gmt_time = mktime(&gmt_tm);
        local_time = mktime(&local_tm);
        diff = (long)difftime(local_time, gmt_time);
    }
    bool err = gmt_time == -1 || local_time == -1;
    char *timestr = rz_ctime_r(&ts, timestr_buf);
    if (timestr) {
        rz_str_trim(timestr);
        long hours = diff / 3600;
        long minutes = labs(diff % 3600 / 60);
        long seconds = labs(diff % 3600 % 60);
        if (err) {
            timestr = rz_str_newf("%s ERR", timestr);
        } else if (seconds) {
            timestr = rz_str_newf("%s UTC%+ld:%ld:%ld", timestr, hours, minutes, seconds);
        } else if (minutes) {
            timestr = rz_str_newf("%s UTC%+ld:%ld", timestr, hours, minutes);
        } else if (hours) {
            timestr = rz_str_newf("%s UTC%+ld", timestr, hours);
        } else {
            timestr = rz_str_newf("%s UTC", timestr);
        }
    }
    return timestr;
}

References ASCTIME_BUF_MINLEN, err, get_seconds_since_12am31Dec1969(), long, rz_ctime_r(), rz_gmtime_r(), rz_localtime_r(), rz_str_newf(), and rz_str_trim().

Referenced by _parse_resource_directory(), bin_pe_init_hdr(), rz_time_date_dos_to_string(), rz_time_date_hfs_to_string(), rz_time_date_now_to_string(), and rz_time_date_w32_to_string().