lsquic_util.c revision 8c1565cb
17d09751dSDmitri Tikhonov/* Copyright (c) 2017 - 2020 LiteSpeed Technologies Inc.  See LICENSE. */
250aadb33SDmitri Tikhonov/*
350aadb33SDmitri Tikhonov * Utility functions
450aadb33SDmitri Tikhonov */
550aadb33SDmitri Tikhonov
650aadb33SDmitri Tikhonov#include <ctype.h>
750aadb33SDmitri Tikhonov#include <stdint.h>
850aadb33SDmitri Tikhonov#include <stdio.h>
950aadb33SDmitri Tikhonov#include <string.h>
1083287402SDmitri Tikhonov#include <time.h>
11461e84d8SAmol Deshpande#ifndef WIN32
12461e84d8SAmol Deshpande#include <sys/time.h>
1383287402SDmitri Tikhonov#include <unistd.h>
14461e84d8SAmol Deshpande#else
15461e84d8SAmol Deshpande#include <vc_compat.h>
16461e84d8SAmol Deshpande#endif
178c1565cbSDmitri Tikhonov#include <netinet/in.h>
1883287402SDmitri Tikhonov
1983287402SDmitri Tikhonov#if !(defined(_POSIX_TIMERS) && _POSIX_TIMERS > 0) && defined(__APPLE__)
2083287402SDmitri Tikhonov#include <mach/mach_time.h>
2183287402SDmitri Tikhonov#endif
2250aadb33SDmitri Tikhonov
2350aadb33SDmitri Tikhonov#include "lsquic_int_types.h"
2450aadb33SDmitri Tikhonov#include "lsquic_util.h"
255392f7a3SLiteSpeed Tech#if LSQUIC_COUNT_TIME_CALLS
265392f7a3SLiteSpeed Tech#include <stdlib.h>
275392f7a3SLiteSpeed Tech#include "lsquic_types.h"
285392f7a3SLiteSpeed Tech#include "lsquic_logger.h"
295392f7a3SLiteSpeed Tech#endif
3050aadb33SDmitri Tikhonov
3150aadb33SDmitri Tikhonov
3283287402SDmitri Tikhonov#if defined(__APPLE__)
3383287402SDmitri Tikhonovstatic mach_timebase_info_data_t timebase;
3483287402SDmitri Tikhonov#endif
35461e84d8SAmol Deshpande#if defined(WIN32)
36461e84d8SAmol Deshpandestatic LARGE_INTEGER perf_frequency;
37461e84d8SAmol Deshpande#endif
3883287402SDmitri Tikhonov
395392f7a3SLiteSpeed Tech
405392f7a3SLiteSpeed Tech#if LSQUIC_COUNT_TIME_CALLS
415392f7a3SLiteSpeed Techstatic volatile unsigned long n_time_now_calls;
425392f7a3SLiteSpeed Tech
435392f7a3SLiteSpeed Tech
445392f7a3SLiteSpeed Techstatic void
455392f7a3SLiteSpeed Techprint_call_stats (void)
465392f7a3SLiteSpeed Tech{
475392f7a3SLiteSpeed Tech    LSQ_NOTICE("number of lsquic_time_now() calls: %lu", n_time_now_calls);
485392f7a3SLiteSpeed Tech}
495392f7a3SLiteSpeed Tech#endif
505392f7a3SLiteSpeed Tech
515392f7a3SLiteSpeed Tech
5283287402SDmitri Tikhonovvoid
5383287402SDmitri Tikhonovlsquic_init_timers (void)
5483287402SDmitri Tikhonov{
555392f7a3SLiteSpeed Tech#if LSQUIC_COUNT_TIME_CALLS
565392f7a3SLiteSpeed Tech    atexit(print_call_stats);
575392f7a3SLiteSpeed Tech#endif
5883287402SDmitri Tikhonov#if defined(__APPLE__)
5983287402SDmitri Tikhonov    mach_timebase_info(&timebase);
6083287402SDmitri Tikhonov#endif
61461e84d8SAmol Deshpande#if defined(WIN32)
62461e84d8SAmol Deshpande    QueryPerformanceFrequency(&perf_frequency);
63461e84d8SAmol Deshpande#endif
6483287402SDmitri Tikhonov}
6583287402SDmitri Tikhonov
6683287402SDmitri Tikhonov
6750aadb33SDmitri Tikhonovlsquic_time_t
6850aadb33SDmitri Tikhonovlsquic_time_now (void)
6950aadb33SDmitri Tikhonov{
705392f7a3SLiteSpeed Tech#if LSQUIC_COUNT_TIME_CALLS
715392f7a3SLiteSpeed Tech    ++n_time_now_calls;
725392f7a3SLiteSpeed Tech#endif
7383287402SDmitri Tikhonov#if defined(_POSIX_TIMERS) && _POSIX_TIMERS > 0
7483287402SDmitri Tikhonov    struct timespec ts;
7583287402SDmitri Tikhonov    (void) clock_gettime(CLOCK_MONOTONIC, &ts);
7683287402SDmitri Tikhonov    return (lsquic_time_t) ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
7783287402SDmitri Tikhonov#elif defined(__APPLE__)
7883287402SDmitri Tikhonov    lsquic_time_t t = mach_absolute_time();
7983287402SDmitri Tikhonov    t *= timebase.numer;
8083287402SDmitri Tikhonov    t /= timebase.denom;
8183287402SDmitri Tikhonov    t /= 1000;
8283287402SDmitri Tikhonov    return t;
83461e84d8SAmol Deshpande#elif defined(WIN32)
84461e84d8SAmol Deshpande    LARGE_INTEGER counter;
85461e84d8SAmol Deshpande    lsquic_time_t t;
86461e84d8SAmol Deshpande    QueryPerformanceCounter(&counter);
87461e84d8SAmol Deshpande    t = counter.QuadPart;
88461e84d8SAmol Deshpande    t *= 1000000;
89461e84d8SAmol Deshpande    t /= perf_frequency.QuadPart;
90461e84d8SAmol Deshpande    return t;
9183287402SDmitri Tikhonov#else
9283287402SDmitri Tikhonov#   warn Monotonically increasing clock is not available on this platform
9350aadb33SDmitri Tikhonov    struct timeval tv;
9450aadb33SDmitri Tikhonov    (void) gettimeofday(&tv, NULL);
9550aadb33SDmitri Tikhonov    return (lsquic_time_t) tv.tv_sec * 1000000 + tv.tv_usec;
9683287402SDmitri Tikhonov#endif
9750aadb33SDmitri Tikhonov}
9850aadb33SDmitri Tikhonov
9950aadb33SDmitri Tikhonov
10050aadb33SDmitri Tikhonovint
10150aadb33SDmitri Tikhonovlsquic_is_zero (const void *pbuf, size_t bufsz)
10250aadb33SDmitri Tikhonov{
10350aadb33SDmitri Tikhonov    const unsigned char *buf, *end;
10450aadb33SDmitri Tikhonov    const unsigned long *buf_ul;
10550aadb33SDmitri Tikhonov    unsigned n_ul;
10650aadb33SDmitri Tikhonov    unsigned long n_non_zero;
10750aadb33SDmitri Tikhonov
10850aadb33SDmitri Tikhonov    buf = pbuf;
10950aadb33SDmitri Tikhonov    end = buf + bufsz;
11050aadb33SDmitri Tikhonov    buf_ul = (unsigned long *) buf;
11150aadb33SDmitri Tikhonov    n_ul = bufsz / sizeof(buf_ul[0]);
11250aadb33SDmitri Tikhonov    buf += n_ul * sizeof(buf_ul[0]);
11350aadb33SDmitri Tikhonov    n_non_zero = 0;
11450aadb33SDmitri Tikhonov
11550aadb33SDmitri Tikhonov    while (n_ul--)
11650aadb33SDmitri Tikhonov        n_non_zero |= buf_ul[n_ul];
11750aadb33SDmitri Tikhonov
11850aadb33SDmitri Tikhonov    while (buf < end)
11950aadb33SDmitri Tikhonov        n_non_zero |= *buf++;
12050aadb33SDmitri Tikhonov
12150aadb33SDmitri Tikhonov    return n_non_zero == 0;
12250aadb33SDmitri Tikhonov}
12350aadb33SDmitri Tikhonov
12450aadb33SDmitri Tikhonov
1255392f7a3SLiteSpeed Tech/* XXX this function uses static buffer.  Replace it with lsquic_hexdump() if possible */
12650aadb33SDmitri Tikhonovchar *get_bin_str(const void *s, size_t len, size_t max_display_len)
12750aadb33SDmitri Tikhonov{
12850aadb33SDmitri Tikhonov    const unsigned char *p, *pEnd;
12950aadb33SDmitri Tikhonov    char *pOutput;
13050aadb33SDmitri Tikhonov    size_t lenOrg = len;
13150aadb33SDmitri Tikhonov    static char str[512 * 2 + 40] = {0};
13250aadb33SDmitri Tikhonov
13350aadb33SDmitri Tikhonov    /**
13450aadb33SDmitri Tikhonov     * We alloc fixed size buffer, at most max_display_len is 512
13550aadb33SDmitri Tikhonov     */
13650aadb33SDmitri Tikhonov    size_t fit_display_len = (max_display_len > 512 ? 512 : max_display_len);
13750aadb33SDmitri Tikhonov    if (len > fit_display_len)
13850aadb33SDmitri Tikhonov        len = fit_display_len;
13950aadb33SDmitri Tikhonov
14050aadb33SDmitri Tikhonov    pOutput = &str[0] + sprintf(str, "(%zd/%zd)=0x", len, lenOrg);
14150aadb33SDmitri Tikhonov
142461e84d8SAmol Deshpande    for(p = s, pEnd = (unsigned char*)s + len; p < pEnd; ++p)
14350aadb33SDmitri Tikhonov    {
14450aadb33SDmitri Tikhonov        sprintf(pOutput, "%02X", *p);
14550aadb33SDmitri Tikhonov        pOutput += 2;
14650aadb33SDmitri Tikhonov    }
14750aadb33SDmitri Tikhonov    if (lenOrg > len)
14850aadb33SDmitri Tikhonov    {
14950aadb33SDmitri Tikhonov        sprintf(pOutput, "...");
15050aadb33SDmitri Tikhonov        pOutput += 3;
15150aadb33SDmitri Tikhonov    }
15250aadb33SDmitri Tikhonov    return str;
15350aadb33SDmitri Tikhonov}
15450aadb33SDmitri Tikhonov
15550aadb33SDmitri Tikhonov
15655cd0b38SDmitri Tikhonovstatic char
15755cd0b38SDmitri Tikhonovhex_digit(uint8_t n)
15855cd0b38SDmitri Tikhonov{
15955cd0b38SDmitri Tikhonov    return (n < 10) ? (n + '0') : ((n - 10) + 'a');
16055cd0b38SDmitri Tikhonov}
16155cd0b38SDmitri Tikhonov
16255cd0b38SDmitri Tikhonov
16355cd0b38SDmitri Tikhonovsize_t
16455cd0b38SDmitri Tikhonovlsquic_hex_encode (const void *src, size_t src_sz, void *dst, size_t dst_sz)
16555cd0b38SDmitri Tikhonov{
16655cd0b38SDmitri Tikhonov    size_t src_cur, dst_cur;
16755cd0b38SDmitri Tikhonov    const uint8_t *src_hex;
16855cd0b38SDmitri Tikhonov    char *dst_char;
16955cd0b38SDmitri Tikhonov
17055cd0b38SDmitri Tikhonov    src_hex = (const uint8_t *)src;
17155cd0b38SDmitri Tikhonov    dst_char = (char *)dst;
17255cd0b38SDmitri Tikhonov    src_cur = dst_cur = 0;
17355cd0b38SDmitri Tikhonov
17455cd0b38SDmitri Tikhonov    while (src_cur < src_sz && dst_cur < (dst_sz - 2))
17555cd0b38SDmitri Tikhonov    {
17655cd0b38SDmitri Tikhonov        dst_char[dst_cur++] = hex_digit((src_hex[src_cur] & 0xf0) >> 4);
17755cd0b38SDmitri Tikhonov        dst_char[dst_cur++] = hex_digit(src_hex[src_cur++] & 0x0f);
17855cd0b38SDmitri Tikhonov    }
17955cd0b38SDmitri Tikhonov    dst_char[dst_cur++] = '\0';
18055cd0b38SDmitri Tikhonov    return dst_cur;
18155cd0b38SDmitri Tikhonov}
18255cd0b38SDmitri Tikhonov
18355cd0b38SDmitri Tikhonov
1845392f7a3SLiteSpeed Techvoid
1855392f7a3SLiteSpeed Techlsquic_hexstr (const unsigned char *buf, size_t bufsz, char *out, size_t outsz)
1865392f7a3SLiteSpeed Tech{
1875392f7a3SLiteSpeed Tech    static const char b2c[16] = "0123456789ABCDEF";
1885392f7a3SLiteSpeed Tech    const unsigned char *const end_input = buf + bufsz;
1895392f7a3SLiteSpeed Tech    char *const end_output = out + outsz;
1905392f7a3SLiteSpeed Tech
1915392f7a3SLiteSpeed Tech    while (buf < end_input && out + 2 < end_output)
1925392f7a3SLiteSpeed Tech    {
1935392f7a3SLiteSpeed Tech        *out++ = b2c[ *buf >> 4 ];
1945392f7a3SLiteSpeed Tech        *out++ = b2c[ *buf & 0xF ];
1955392f7a3SLiteSpeed Tech        ++buf;
1965392f7a3SLiteSpeed Tech    }
1975392f7a3SLiteSpeed Tech
1985392f7a3SLiteSpeed Tech    if (buf < end_input)
1995392f7a3SLiteSpeed Tech        out[-1] = '!';
2005392f7a3SLiteSpeed Tech
2015392f7a3SLiteSpeed Tech    *out = '\0';
2025392f7a3SLiteSpeed Tech}
2035392f7a3SLiteSpeed Tech
2045392f7a3SLiteSpeed Tech
20550aadb33SDmitri Tikhonovsize_t
2065392f7a3SLiteSpeed Techlsquic_hexdump (const void *src_void, size_t src_sz, char *out, size_t out_sz)
20750aadb33SDmitri Tikhonov{
20850aadb33SDmitri Tikhonov/* Ruler:
20950aadb33SDmitri Tikhonov *
21050aadb33SDmitri Tikhonov      6                       31                        57              73
21150aadb33SDmitri Tikhonov      |                        |                         |               |
21250aadb33SDmitri Tikhonov0000  00 01 02 03 04 05 06 07  08 09 0A 0B 0C 0D 0E 0F  |................|
21350aadb33SDmitri Tikhonov *
21450aadb33SDmitri Tikhonov */
21550aadb33SDmitri Tikhonov#define LINE_SIZE (74 + 1 /* newline */)
21650aadb33SDmitri Tikhonov    const unsigned char       *src     = src_void;
21750aadb33SDmitri Tikhonov    const unsigned char *const src_end = src + src_sz;
21850aadb33SDmitri Tikhonov    char *const                out_end = out + out_sz;
21950aadb33SDmitri Tikhonov    unsigned line = 0;
22050aadb33SDmitri Tikhonov
22150aadb33SDmitri Tikhonov    while (src < src_end && out_end - out >= LINE_SIZE)
22250aadb33SDmitri Tikhonov    {
22350aadb33SDmitri Tikhonov        const unsigned char *limit = src + 16;
22450aadb33SDmitri Tikhonov        if (limit > src_end)
22550aadb33SDmitri Tikhonov            limit = src_end;
22650aadb33SDmitri Tikhonov        unsigned hex_off   = 6;
22750aadb33SDmitri Tikhonov        unsigned alpha_off = 57;
2285392f7a3SLiteSpeed Tech        sprintf(out, "%03X0", line++);
22950aadb33SDmitri Tikhonov        out[4] = ' ';
23050aadb33SDmitri Tikhonov        out[5] = ' ';
23150aadb33SDmitri Tikhonov        while (src < limit)
23250aadb33SDmitri Tikhonov        {
23350aadb33SDmitri Tikhonov            sprintf(out + hex_off, "%02X ", *src);
23450aadb33SDmitri Tikhonov            sprintf(out + alpha_off, "%c", isprint(*src) ? *src : '.');
23550aadb33SDmitri Tikhonov            hex_off += 3;
23650aadb33SDmitri Tikhonov            out[hex_off] = ' ';
23750aadb33SDmitri Tikhonov            hex_off += 30 == hex_off;
23850aadb33SDmitri Tikhonov            out[hex_off] = ' ';
23950aadb33SDmitri Tikhonov            ++alpha_off;
24050aadb33SDmitri Tikhonov            out[alpha_off] = ' ';
24150aadb33SDmitri Tikhonov            ++src;
24250aadb33SDmitri Tikhonov        }
24350aadb33SDmitri Tikhonov        memset(out + hex_off,   ' ', 56 - hex_off);
24450aadb33SDmitri Tikhonov        memset(out + alpha_off, '.', 73 - alpha_off);
24550aadb33SDmitri Tikhonov        out[56] = '|';
24650aadb33SDmitri Tikhonov        out[73] = '|';
24750aadb33SDmitri Tikhonov        out[74] = '\n';
24850aadb33SDmitri Tikhonov        out += LINE_SIZE;
24950aadb33SDmitri Tikhonov    }
25050aadb33SDmitri Tikhonov
25150aadb33SDmitri Tikhonov    if (out < out_end)
25250aadb33SDmitri Tikhonov        *out = '\0';
25350aadb33SDmitri Tikhonov    else
25450aadb33SDmitri Tikhonov        out_end[-1] = '\0';
25550aadb33SDmitri Tikhonov
25650aadb33SDmitri Tikhonov    return out + out_sz - out_end;
25750aadb33SDmitri Tikhonov}
2588c1565cbSDmitri Tikhonov
2598c1565cbSDmitri Tikhonov
2608c1565cbSDmitri Tikhonov/* Returns true if socket addresses are equal, false otherwise.  Only
2618c1565cbSDmitri Tikhonov * families, IP addresses, and ports are compared.
2628c1565cbSDmitri Tikhonov */
2638c1565cbSDmitri Tikhonovint
2648c1565cbSDmitri Tikhonovlsquic_sockaddr_eq (const struct sockaddr *a, const struct sockaddr *b)
2658c1565cbSDmitri Tikhonov{
2668c1565cbSDmitri Tikhonov    if (a->sa_family == AF_INET)
2678c1565cbSDmitri Tikhonov        return a->sa_family == b->sa_family
2688c1565cbSDmitri Tikhonov            && ((struct sockaddr_in *) a)->sin_addr.s_addr
2698c1565cbSDmitri Tikhonov                            == ((struct sockaddr_in *) b)->sin_addr.s_addr
2708c1565cbSDmitri Tikhonov            && ((struct sockaddr_in *) a)->sin_port
2718c1565cbSDmitri Tikhonov                            == ((struct sockaddr_in *) b)->sin_port;
2728c1565cbSDmitri Tikhonov    else
2738c1565cbSDmitri Tikhonov        return a->sa_family == b->sa_family
2748c1565cbSDmitri Tikhonov            && ((struct sockaddr_in6 *) a)->sin6_port ==
2758c1565cbSDmitri Tikhonov                                ((struct sockaddr_in6 *) b)->sin6_port
2768c1565cbSDmitri Tikhonov            && 0 == memcmp(&((struct sockaddr_in6 *) a)->sin6_addr,
2778c1565cbSDmitri Tikhonov                            &((struct sockaddr_in6 *) b)->sin6_addr,
2788c1565cbSDmitri Tikhonov                            sizeof(((struct sockaddr_in6 *) b)->sin6_addr));
2798c1565cbSDmitri Tikhonov}
280