aboutsummaryrefslogtreecommitdiffstats
path: root/driver/queueing.c
blob: c1b7afe7c222bff0e7ae221e4cbcc4fdfcf0f78d (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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/* SPDX-License-Identifier: GPL-2.0
 *
 * Copyright (C) 2015-2021 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
 */

#include "interlocked.h"
#include "queueing.h"

static KSTART_ROUTINE WorkerThread;
_Use_decl_annotations_
static VOID
WorkerThread(PVOID StartContext)
{
    MULTICORE_WORKTHREAD *WorkThread = StartContext;
    MULTICORE_WORKQUEUE *WorkQueue = WorkThread->WorkQueue;
    PMULTICORE_WORKQUEUE_ROUTINE Func = WorkQueue->Func;
    GROUP_AFFINITY Affinity = { .Mask = (KAFFINITY)1 << WorkThread->Processor.Number,
                                .Group = WorkThread->Processor.Group };
    KeSetSystemGroupAffinityThread(&Affinity, NULL);
    PVOID Handles[] = { &WorkQueue->NewWork, &WorkQueue->Dead };
    for (;;)
    {
        if (KeWaitForMultipleObjects(ARRAYSIZE(Handles), Handles, WaitAny, Executive, KernelMode, FALSE, NULL, NULL) !=
            STATUS_WAIT_0)
            break;
        Func(WorkQueue);
    }
}

static KSTART_ROUTINE NewThreadSpawner;
_Use_decl_annotations_
static VOID
NewThreadSpawner(PVOID StartContext)
{
    MULTICORE_WORKQUEUE *WorkQueue = StartContext;
    OBJECT_ATTRIBUTES ObjectAttributes;
    InitializeObjectAttributes(&ObjectAttributes, NULL, OBJ_KERNEL_HANDLE, NULL, NULL);
    PVOID Handles[] = { &WorkQueue->NewCpus, &WorkQueue->Dead };
    for (;;)
    {
        if (KeWaitForMultipleObjects(ARRAYSIZE(Handles), Handles, WaitAny, Executive, KernelMode, FALSE, NULL, NULL) !=
            STATUS_WAIT_0)
            break;
        for (MULTICORE_WORKTHREAD *Thread = ReadPointerAcquire(&WorkQueue->FirstThread); Thread && !Thread->Thread;
             Thread = Thread->NextThread)
        {
            HANDLE Handle;
            if (!NT_SUCCESS(PsCreateSystemThread(
                    &Handle, THREAD_ALL_ACCESS, &ObjectAttributes, NULL, NULL, WorkerThread, Thread)))
                break;
            ObReferenceObjectByHandle(Handle, SYNCHRONIZE, NULL, KernelMode, &Thread->Thread, NULL);
            ZwClose(Handle);
        }
    }
}

static PROCESSOR_CALLBACK_FUNCTION NewCpuArrival;
_Use_decl_annotations_
static VOID
NewCpuArrival(PVOID CallbackContext, PKE_PROCESSOR_CHANGE_NOTIFY_CONTEXT ChangeContext, PNTSTATUS OperationStatus)
{
    if (ChangeContext->State != KeProcessorAddCompleteNotify)
        return;
    MULTICORE_WORKQUEUE *WorkQueue = CallbackContext;
    MULTICORE_WORKTHREAD *WorkThread = MemAllocateAndZero(sizeof(*WorkThread));
    if (!WorkThread)
        return;
    WorkThread->Processor = ChangeContext->ProcNumber;
    WorkThread->NextThread = WorkQueue->FirstThread;
    WorkThread->WorkQueue = WorkQueue;
    WritePointerRelease(&WorkQueue->FirstThread, WorkThread);
    KeSetEvent(&WorkQueue->NewCpus, IO_NETWORK_INCREMENT, FALSE);
}

_Use_decl_annotations_
NTSTATUS
MulticoreWorkQueueInit(MULTICORE_WORKQUEUE *WorkQueue, PMULTICORE_WORKQUEUE_ROUTINE Func)
{
    KeInitializeEvent(&WorkQueue->NewWork, SynchronizationEvent, FALSE);
    KeInitializeEvent(&WorkQueue->NewCpus, SynchronizationEvent, FALSE);
    KeInitializeEvent(&WorkQueue->Dead, NotificationEvent, FALSE);
    WorkQueue->FirstThread = NULL;
    WorkQueue->Func = Func;
    OBJECT_ATTRIBUTES ObjectAttributes;
    InitializeObjectAttributes(&ObjectAttributes, NULL, OBJ_KERNEL_HANDLE, NULL, NULL);
    HANDLE Handle;
    NTSTATUS Status =
        PsCreateSystemThread(&Handle, THREAD_ALL_ACCESS, &ObjectAttributes, NULL, NULL, NewThreadSpawner, WorkQueue);
    if (!NT_SUCCESS(Status))
        return Status;
    ObReferenceObjectByHandle(Handle, SYNCHRONIZE, NULL, KernelMode, &WorkQueue->WorkerSpawnerThread, NULL);
    ZwClose(Handle);
    WorkQueue->NewCpuNotifier =
        KeRegisterProcessorChangeCallback(NewCpuArrival, WorkQueue, KE_PROCESSOR_CHANGE_ADD_EXISTING);
    Status = WorkQueue->NewCpuNotifier ? STATUS_SUCCESS : STATUS_INSUFFICIENT_RESOURCES;
    if (!NT_SUCCESS(Status))
        MulticoreWorkQueueDestroy(WorkQueue);
    return Status;
}

_Use_decl_annotations_
BOOLEAN
MulticoreWorkQueueBump(MULTICORE_WORKQUEUE *WorkQueue)
{
    return KeSetEvent(&WorkQueue->NewWork, IO_NETWORK_INCREMENT, FALSE) == 0;
}

_Use_decl_annotations_
VOID
MulticoreWorkQueueDestroy(MULTICORE_WORKQUEUE *WorkQueue)
{
    if (WorkQueue->NewCpuNotifier)
        KeDeregisterProcessorChangeCallback(WorkQueue->NewCpuNotifier);
    KeSetEvent(&WorkQueue->Dead, IO_NETWORK_INCREMENT, FALSE);
    KeWaitForSingleObject(WorkQueue->WorkerSpawnerThread, Executive, KernelMode, FALSE, NULL);
    ObDereferenceObject(WorkQueue->WorkerSpawnerThread);

    PKTHREAD Threads[MAXIMUM_WAIT_OBJECTS];
    static_assert(sizeof(Threads) <= 512, "Must move thread handle allocation to heap");
    PKWAIT_BLOCK WaitBlock = MemAllocateArray(MAXIMUM_WAIT_OBJECTS, sizeof(KWAIT_BLOCK));
    ULONG MaxPerWait = WaitBlock ? MAXIMUM_WAIT_OBJECTS : THREAD_WAIT_OBJECTS;

    MULTICORE_WORKTHREAD *Thread = WorkQueue->FirstThread, *Next;
    while (Thread)
    {
        ULONG Count = 0;
        for (; Thread; Thread = Thread->NextThread)
        {
            if (Count >= MaxPerWait)
                break;
            if (Thread->Thread)
                Threads[Count++] = Thread->Thread;
        }
        KeWaitForMultipleObjects(Count, Threads, WaitAll, Executive, KernelMode, FALSE, NULL, WaitBlock);
    }
    for (Thread = WorkQueue->FirstThread; Thread; Thread = Next)
    {
        Next = Thread->NextThread;
        if (Thread->Thread)
            ObDereferenceObject(Thread->Thread);
        MemFree(Thread);
    }
    MemFree(WaitBlock);
}

#define NEXT(Nbl) NET_BUFFER_LIST_PER_PEER_LIST_LINK(Nbl)
#define STUB(Queue) (&(Queue)->Empty)

_Use_decl_annotations_
VOID
PrevQueueInit(PREV_QUEUE *Queue)
{
    NEXT(STUB(Queue)) = NULL;
    Queue->Head = Queue->Tail = STUB(Queue);
    Queue->Peeked = NULL;
    WriteRaw(&Queue->Count, 0);
}

static VOID
__PrevQueueEnqueue(_Inout_ PREV_QUEUE *Queue, _In_ __drv_aliasesMem NET_BUFFER_LIST *Nbl)
{
    WritePointerNoFence(&NEXT(Nbl), NULL);
    WritePointerNoFence(&NEXT((NET_BUFFER_LIST *)InterlockedExchangePointerRelease(&Queue->Head, Nbl)), Nbl);
}

_Use_decl_annotations_
BOOLEAN
PrevQueueEnqueue(PREV_QUEUE *Queue, NET_BUFFER_LIST *Nbl)
{
    if (!InterlockedIncrementUnless(&Queue->Count, MAX_QUEUED_PACKETS))
        return FALSE;
    __PrevQueueEnqueue(Queue, Nbl);
    return TRUE;
}

_Use_decl_annotations_
NET_BUFFER_LIST *
PrevQueueDequeue(PREV_QUEUE *Queue)
{
    NET_BUFFER_LIST *Tail = Queue->Tail, *Next = ReadPointerAcquire(&NEXT(Tail));

    if (Tail == STUB(Queue))
    {
        if (!Next)
            return NULL;
        Queue->Tail = Next;
        Tail = Next;
        Next = ReadPointerAcquire(&NEXT(Next));
    }
    if (Next)
    {
        Queue->Tail = Next;
        InterlockedDecrement(&Queue->Count);
        return Tail;
    }
    if (Tail != ReadPointerNoFence(&Queue->Head))
        return NULL;
    __PrevQueueEnqueue(Queue, STUB(Queue));
    Next = ReadPointerAcquire(&NEXT(Tail));
    if (Next)
    {
        Queue->Tail = Next;
        InterlockedDecrement(&Queue->Count);
        return Tail;
    }
    return NULL;
}

#undef NEXT
#undef STUB