summaryrefslogtreecommitdiff
path: root/network/ndis/filter/flt_dbg.c
blob: a65c4312453b2faaacc5f5c0ba6342dabfe87076 (plain)
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*++

Copyright (c) 2001  Microsoft Corporation

Module Name:

    flt_dbg.c

Abstract:

    This module contains all debug-related code.

Revision History:

    Who         When        What
    --------    --------    ----------------------------------------------

Notes:

--*/

#include  "precomp.h"

#define __FILENUMBER 'GBED'

#if DBG

INT                 filterDebugLevel = DL_WARN;

NDIS_SPIN_LOCK        filterDbgLogLock;

PFILTERD_ALLOCATION    filterdMemoryHead = (PFILTERD_ALLOCATION)NULL;
PFILTERD_ALLOCATION    filterdMemoryTail = (PFILTERD_ALLOCATION)NULL;
ULONG                filterdAllocCount = 0;    // how many allocated so far (unfreed)

NDIS_SPIN_LOCK        filterdMemoryLock;
BOOLEAN                filterdInitDone = FALSE;


PVOID
filterAuditAllocMem(
    NDIS_HANDLE  NdisHandle,
    ULONG         Size,
    ULONG         FileNumber,
    ULONG         LineNumber
)
{
    PVOID                pBuffer;
    PFILTERD_ALLOCATION    pAllocInfo;

    if (!filterdInitDone)
    {
        NdisAllocateSpinLock(&(filterdMemoryLock));
        filterdInitDone = TRUE;
    }

    //
    // Integer overflow check
    //
    if ((Size + (ULONG) sizeof(FILTERD_ALLOCATION)) < Size)
    {
        DEBUGP(DL_VERY_LOUD+50,
               "filterAuditAllocMem: Integer overflow error file %d, line %d, Size %d \n",
               FileNumber, LineNumber, Size);

        pBuffer = NULL;
    }
    else
    {

        pAllocInfo = NdisAllocateMemoryWithTagPriority(
            NdisHandle,
            Size+sizeof(FILTERD_ALLOCATION),
            (ULONG)'gdTF',
            LowPoolPriority
        );

        if (pAllocInfo == (PFILTERD_ALLOCATION)NULL)
        {
            DEBUGP(DL_VERY_LOUD+50,
                "filterAuditAllocMem: file %d, line %d, Size %d failed!\n",
                    FileNumber, LineNumber, Size);
            pBuffer = NULL;
        }
        else
        {
            pBuffer = (PVOID)&(pAllocInfo->UserData);
            NdisFillMemory(pBuffer, Size, 0xaf);
            pAllocInfo->Signature = FILTERD_MEMORY_SIGNATURE;
            pAllocInfo->FileNumber = FileNumber;
            pAllocInfo->LineNumber = LineNumber;
            pAllocInfo->Size = Size;
            pAllocInfo->OwnerHandle = NdisHandle;
            pAllocInfo->Next = (PFILTERD_ALLOCATION)NULL;

            NdisAcquireSpinLock(&(filterdMemoryLock));

            pAllocInfo->Prev = filterdMemoryTail;
            if (filterdMemoryTail == (PFILTERD_ALLOCATION)NULL)
            {
                //
                // empty list
                //
                filterdMemoryHead = filterdMemoryTail = pAllocInfo;
            }
            else
            {
                filterdMemoryTail->Next = pAllocInfo;
            }
            filterdMemoryTail = pAllocInfo;

            filterdAllocCount++;
            NdisReleaseSpinLock(&(filterdMemoryLock));
        }
    }

    DEBUGP(DL_VERY_LOUD+100,
     "filterAuditAllocMem: file %c%c%c%c, line %d, %d bytes, OwnerHandle %p, Memory 0x%p\n",
                 (CHAR)(FileNumber & 0xff),
                 (CHAR)((FileNumber >> 8) & 0xff),
                 (CHAR)((FileNumber >> 16) & 0xff),
                 (CHAR)((FileNumber >> 24) & 0xff),
                LineNumber, Size, NdisHandle, pBuffer);

    return (pBuffer);

}


VOID
filterAuditFreeMem(
    PVOID    Pointer
)
{
    PFILTERD_ALLOCATION    pAllocInfo;

    NdisAcquireSpinLock(&(filterdMemoryLock));

    pAllocInfo = CONTAINING_RECORD(Pointer, FILTERD_ALLOCATION, UserData);

    if (pAllocInfo->Signature != FILTERD_MEMORY_SIGNATURE)
    {
        DEBUGP(DL_ERROR,
         "filterAuditFreeMem: unknown buffer 0x%p!\n", Pointer);
        NdisReleaseSpinLock(&(filterdMemoryLock));
#if DBG
        DbgBreakPoint();
#endif
        return;
    }

    pAllocInfo->Signature = (ULONG)'DEAD';
    if (pAllocInfo->Prev != (PFILTERD_ALLOCATION)NULL)
    {
        pAllocInfo->Prev->Next = pAllocInfo->Next;
    }
    else
    {
        filterdMemoryHead = pAllocInfo->Next;
    }
    if (pAllocInfo->Next != (PFILTERD_ALLOCATION)NULL)
    {
        pAllocInfo->Next->Prev = pAllocInfo->Prev;
    }
    else
    {
        filterdMemoryTail = pAllocInfo->Prev;
    }
    filterdAllocCount--;
    NdisReleaseSpinLock(&(filterdMemoryLock));

    NdisFreeMemory(pAllocInfo, 0, 0);
}


VOID
filterAuditShutdown(
    VOID
)
{
    if (filterdInitDone)
    {
        if (filterdAllocCount != 0)
        {
            DEBUGP(DL_ERROR, "AuditShutdown: unfreed memory, %d blocks!\n",
                    filterdAllocCount);
            DEBUGP(DL_ERROR, "MemoryHead: 0x%p, MemoryTail: 0x%p\n",
                    filterdMemoryHead, filterdMemoryTail);
            DbgBreakPoint();
            {
                PFILTERD_ALLOCATION        pAllocInfo;

                while (filterdMemoryHead != (PFILTERD_ALLOCATION)NULL)
                {
                    pAllocInfo = filterdMemoryHead;
                    DEBUGP(DL_INFO, "AuditShutdown: will free 0x%p\n", pAllocInfo);
                    filterAuditFreeMem(&(pAllocInfo->UserData));
                }
            }
        }
        filterdInitDone = FALSE;
    }
}

#define MAX_HD_LENGTH        128

VOID
DbgPrintHexDump(
    IN    PUCHAR            pBuffer,
    IN    ULONG            Length
)
/*++

Routine Description:

    Print a hex dump of the given contiguous buffer. If the length
    is too long, we truncate it.

Arguments:

    pBuffer            - Points to start of data to be dumped
    Length            - Length of above.

Return Value:

    None

--*/
{
    ULONG        i;

    if (Length > MAX_HD_LENGTH)
    {
        Length = MAX_HD_LENGTH;
    }

    for (i = 0; i < Length; i++)
    {
        //
        //  Check if we are at the end of a line
        //
        if ((i > 0) && ((i & 0xf) == 0))
        {
            DbgPrint("\n");
        }

        //
        //  Print addr if we are at start of a new line
        //
        if ((i & 0xf) == 0)
        {
            DbgPrint("%08p ", pBuffer);
        }

        DbgPrint(" %02x", *pBuffer++);
    }

    //
    //  Terminate the last line.
    //
    if (Length > 0)
    {
        DbgPrint("\n");
    }
}
#endif // DBG


#if DBG_SPIN_LOCK
ULONG    filterdSpinLockInitDone = 0;
NDIS_SPIN_LOCK    filterdLockLock;

VOID
filterAllocateSpinLock(
    _In_    PFILTER_LOCK         pLock,
    _In_    ULONG                FileNumber,
    _In_    ULONG                LineNumber
)
{
    if (filterdSpinLockInitDone == 0)
    {
        filterdSpinLockInitDone = 1;
        NdisAllocateSpinLock(&(filterdLockLock));
    }

    NdisAcquireSpinLock(&(filterdLockLock));
    pLock->Signature = FILT_LOCK_SIG;
    pLock->TouchedByFileNumber = FileNumber;
    pLock->TouchedInLineNumber = LineNumber;
    pLock->IsAcquired = 0;
    pLock->OwnerThread = 0;
    NdisAllocateSpinLock(&(pLock->NdisLock));
    NdisReleaseSpinLock(&(filterdLockLock));
}

VOID
filterFreeSpinLock(
    _In_    PFILTER_LOCK        pLock
    )
{
    ASSERT(filterdSpinLockInitDone == 1);


    NdisFreeSpinLock(&(filterdLockLock));
    filterdSpinLockInitDone = 0;
    NdisFreeSpinLock(&(pLock->NdisLock));

}



VOID
filterAcquireSpinLock(
    _In_    PFILTER_LOCK         pLock,
    _In_    ULONG                FileNumber,
    _In_    ULONG                LineNumber,
    _In_  BOOLEAN                DispatchLevel
)
{
    if (DispatchLevel)
    {
        NdisDprAcquireSpinLock(&(filterdLockLock));
    }
    else
    {
        NdisAcquireSpinLock(&(filterdLockLock));
    }
    if (pLock->Signature != FILT_LOCK_SIG)
    {
        DbgPrint("Trying to acquire uninited lock 0x%x, File %c%c%c%c, Line %d\n",
                pLock,
                (CHAR)(FileNumber & 0xff),
                (CHAR)((FileNumber >> 8) & 0xff),
                (CHAR)((FileNumber >> 16) & 0xff),
                (CHAR)((FileNumber >> 24) & 0xff),
                LineNumber);
        DbgBreakPoint();
    }


    pLock->IsAcquired++;

    if (DispatchLevel)
    {
        NdisDprReleaseSpinLock(&(filterdLockLock));
        NdisDprAcquireSpinLock(&(pLock->NdisLock));
    }
    else
    {
        NdisReleaseSpinLock(&(filterdLockLock));
        NdisAcquireSpinLock(&(pLock->NdisLock));
    }

    //
    //  Mark this lock.
    //
    pLock->TouchedByFileNumber = FileNumber;
    pLock->TouchedInLineNumber = LineNumber;
}


VOID
filterReleaseSpinLock(
    _In_    PFILTER_LOCK         pLock,
    _In_    ULONG                FileNumber,
    _In_    ULONG                LineNumber,
    _In_  BOOLEAN                DispatchLevel
)
{
    NdisDprAcquireSpinLock(&(filterdLockLock));
    if (pLock->Signature != FILT_LOCK_SIG)
    {
        DbgPrint("Trying to release uninited lock 0x%x, File %c%c%c%c, Line %d\n",
                pLock,
                (CHAR)(FileNumber & 0xff),
                (CHAR)((FileNumber >> 8) & 0xff),
                (CHAR)((FileNumber >> 16) & 0xff),
                (CHAR)((FileNumber >> 24) & 0xff),
                LineNumber);
        DbgBreakPoint();
    }

    if (pLock->IsAcquired == 0)
    {
        DbgPrint("Detected release of unacquired lock 0x%x, File %c%c%c%c, Line %d\n",
                pLock,
                (CHAR)(FileNumber & 0xff),
                (CHAR)((FileNumber >> 8) & 0xff),
                (CHAR)((FileNumber >> 16) & 0xff),
                (CHAR)((FileNumber >> 24) & 0xff),
                LineNumber);
        DbgBreakPoint();
    }
    pLock->TouchedByFileNumber = FileNumber;
    pLock->TouchedInLineNumber = LineNumber;
    pLock->IsAcquired--;
    NdisDprReleaseSpinLock(&(filterdLockLock));

    if (DispatchLevel)
    {
        NdisDprReleaseSpinLock(&(pLock->NdisLock));
    }
    else
    {
        NdisReleaseSpinLock(&(pLock->NdisLock));
    }
}
#endif // DBG_SPIN_LOCK