aboutsummaryrefslogtreecommitdiffstats
path: root/driver/logging.h
blob: 91380a32626abd140e3d6e36a0a1012a4a0f4810 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/* SPDX-License-Identifier: GPL-2.0
 *
 * Copyright (C) 2015-2021 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
 */

#pragma once

#include <ntifs.h> /* Must be included before <wdm.h> */
#include <wdm.h>
#include <ndis.h>
#include <wsk.h>
#include "ioctl.h"

#define LOG_DRIVER_PREFIX "wireguard: "
#define LOG_DEVICE_PREFIX "%u: "

#if DBG
#    define LogErr(Device, Fmt, ...) \
        do \
        { \
            DbgPrintEx( \
                DPFLTR_IHVNETWORK_ID, \
                1, \
                LOG_DRIVER_PREFIX LOG_DEVICE_PREFIX Fmt "\n", \
                (Device)->InterfaceIndex, \
                ##__VA_ARGS__); \
            LogRingWrite(&(Device)->Log, "1" Fmt, ##__VA_ARGS__); \
        } while (0)
#    define LogWarn(Device, Fmt, ...) \
        do \
        { \
            DbgPrintEx( \
                DPFLTR_IHVNETWORK_ID, \
                2, \
                LOG_DRIVER_PREFIX LOG_DEVICE_PREFIX Fmt "\n", \
                (Device)->InterfaceIndex, \
                ##__VA_ARGS__); \
            LogRingWrite(&(Device)->Log, "2" Fmt, ##__VA_ARGS__); \
        } while (0)
#    define LogInfo(Device, Fmt, ...) \
        do \
        { \
            DbgPrintEx( \
                DPFLTR_IHVNETWORK_ID, \
                3, \
                LOG_DRIVER_PREFIX LOG_DEVICE_PREFIX Fmt "\n", \
                (Device)->InterfaceIndex, \
                ##__VA_ARGS__); \
            LogRingWrite(&(Device)->Log, "3" Fmt, ##__VA_ARGS__); \
        } while (0)
#    define LogDebug(Fmt, ...) DbgPrintEx(DPFLTR_IHVNETWORK_ID, 4, LOG_DRIVER_PREFIX Fmt "\n", ##__VA_ARGS__)
#else
#    define LogErr(Device, Fmt, ...) LogRingWrite(&(Device)->Log, "1" Fmt, ##__VA_ARGS__)
#    define LogWarn(Device, Fmt, ...) LogRingWrite(&(Device)->Log, "2" Fmt, ##__VA_ARGS__)
#    define LogInfo(Device, Fmt, ...) LogRingWrite(&(Device)->Log, "3" Fmt, ##__VA_ARGS__)
#    define LogDebug(Fmt, ...)
#endif

#define LogInfoRatelimited(Device, Fmt, ...) \
    do \
    { \
        if (!LogRingIsRatelimited(&(Device)->Log)) \
            LogInfo(Device, Fmt, ##__VA_ARGS__); \
    } while (0)

#define LogInfoNblRatelimited(Device, Fmt, Nbl, ...) \
    do \
    { \
        ENDPOINT __Endpoint; \
        CHAR __EndpointStr[SOCKADDR_STR_MAX_LEN]; \
        SocketEndpointFromNbl(&__Endpoint, Nbl); \
        SockaddrToString(__EndpointStr, &__Endpoint.Addr); \
        LogInfoRatelimited(Device, Fmt, __EndpointStr, ##__VA_ARGS__); \
    } while (0)

enum
{
    BUFFERED_LOG_ENTRIES = 64,
    BUFFERED_LOG_ENTRIES_MASK = BUFFERED_LOG_ENTRIES - 1,
};

typedef struct _LOG_RING
{
    WG_IOCTL_LOG_ENTRY Entries[BUFFERED_LOG_ENTRIES];
    LONG FirstAndLength;
    LONG CurrentWriters;
    KEVENT NewEntry;
    LONG RatelimitChecking;
    ULONG RatelimitPrinted, RatelimitMissed;
    ULONG64 RatelimitStart;
} LOG_RING;

_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
LogRingWrite(_Inout_ LOG_RING *Log, _In_z_ _Printf_format_string_ PCSTR Format, ...);

_IRQL_requires_max_(PASSIVE_LEVEL)
VOID
LogRingInit(_Inout_ LOG_RING *Log);

_IRQL_requires_max_(APC_LEVEL)
NTSTATUS
LogRingRead(
    _Inout_ LOG_RING *Log,
    _Out_ WG_IOCTL_LOG_ENTRY *Entry,
    _In_ BOOLEAN *WhileFalse);

_IRQL_requires_max_(DISPATCH_LEVEL)
BOOLEAN
LogRingIsRatelimited(_Inout_ LOG_RING *Log);

#define SOCKADDR_STR_MAX_LEN max(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)
VOID
SockaddrToString(_Out_z_cap_c_(SOCKADDR_STR_MAX_LEN) PSTR Buffer, _In_ CONST SOCKADDR_INET *Addr);

#if DBG
_IRQL_requires_max_(DISPATCH_LEVEL)
VOID
DumpNetBuffer(_In_ NET_BUFFER *Nb, _In_z_ CHAR *Prefix);
#endif