summaryrefslogtreecommitdiffstats
path: root/private/ntos/rtl/trace.c
blob: b2e826e99e288f569794ac9e5c6000201d39cb5b (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
/*++

Copyright (c) 1992  Microsoft Corporation

Module Name:

    trace.c

Abstract:

    This is the source file that implements the a general purpose trace
    package.  The trace package is a debug facility for generating
    arbitrary events into a circular buffer.  The debugger than has a
    !trace command to dump out the last N events from a trace buffer.

Author:

    Steve Wood (stevewo) 12-Apr-1994

Revision History:

--*/

#include "ntrtlp.h"
#include "heap.h"

#ifndef THEAP
#define DPRINTF DbgPrint
#endif

NTSYSAPI
PRTL_TRACE_BUFFER
RtlCreateTraceBuffer(
    IN ULONG BufferSize,
    IN ULONG NumberOfEventIds
    )
{
    NTSTATUS Status;
    PRTL_TRACE_BUFFER TraceBuffer;

    TraceBuffer = NULL;
    BufferSize += FIELD_OFFSET( RTL_TRACE_BUFFER, EventIdFormatString ) +
                  (NumberOfEventIds * sizeof( PCHAR ));

    Status = NtAllocateVirtualMemory( NtCurrentProcess(),
                                      &TraceBuffer,
                                      0,
                                      &BufferSize,
                                      MEM_COMMIT,
                                      PAGE_READWRITE
                                    );
    if (!NT_SUCCESS( Status )) {
        KdPrint(( "RTL: Unable to allocate trace buffer (%x bytes) - Status == %x\n", BufferSize, Status ));
        return NULL;
        }

    TraceBuffer->Signature = RTL_TRACE_SIGNATURE;
    TraceBuffer->NumberOfRecords = 0;
    TraceBuffer->NumberOfEventIds = (USHORT)NumberOfEventIds;
    TraceBuffer->StartBuffer = (PRTL_TRACE_RECORD)(&TraceBuffer->EventIdFormatString[ NumberOfEventIds ]);
    TraceBuffer->EndBuffer = (PRTL_TRACE_RECORD)((PCHAR)TraceBuffer + BufferSize);
    TraceBuffer->ReadRecord = NULL;
    TraceBuffer->WriteRecord = TraceBuffer->StartBuffer;
    return TraceBuffer;
}


NTSYSAPI
void
RtlDestroyTraceBuffer(
    IN PRTL_TRACE_BUFFER TraceBuffer
    )
{
    ULONG RegionSize;

    RegionSize = 0;
    NtFreeVirtualMemory( NtCurrentProcess(),
                         &TraceBuffer,
                         &RegionSize,
                         MEM_RELEASE
                       );
    return;
}


NTSYSAPI
void
RtlTraceEvent(
    IN PRTL_TRACE_BUFFER TraceBuffer,
    IN ULONG EventId,
    IN ULONG NumberOfArguments,
    ...
    )
{
    va_list arglist;
    ULONG i, Size;
    PRTL_TRACE_RECORD p, p1;

    if (TraceBuffer == NULL ||
        EventId >= TraceBuffer->NumberOfEventIds ||
        NumberOfArguments > RTL_TRACE_MAX_ARGUMENTS_FOR_EVENT
       ) {
        return;
        }

    Size = FIELD_OFFSET( RTL_TRACE_RECORD, Arguments ) +
           (NumberOfArguments * sizeof( ULONG ));

    // DPRINTF( "Trace - R: %x  W: %x  Size: %u", TraceBuffer->ReadRecord, TraceBuffer->WriteRecord, Size );

    p = TraceBuffer->WriteRecord;
    p1 = (PRTL_TRACE_RECORD)((PCHAR)p + Size);
    while (TraceBuffer->ReadRecord >= p && TraceBuffer->ReadRecord <= p1) {
        TraceBuffer->ReadRecord = (PRTL_TRACE_RECORD)((PCHAR)TraceBuffer->ReadRecord + TraceBuffer->ReadRecord->Size);
        if (TraceBuffer->ReadRecord >= TraceBuffer->EndBuffer) {
            TraceBuffer->ReadRecord = TraceBuffer->StartBuffer;
            }
        }

    if (p1 >= TraceBuffer->EndBuffer) {
        if (p != TraceBuffer->EndBuffer) {
            p->Size = (PCHAR)TraceBuffer->EndBuffer - (PCHAR)p;
            p->EventId = RTL_TRACE_FILLER_EVENT_ID;
            }
        p = TraceBuffer->StartBuffer;
        }
    p1 = (PRTL_TRACE_RECORD)((PCHAR)p + Size);
    if (((PCHAR)TraceBuffer->EndBuffer - (PCHAR)p1) < FIELD_OFFSET( RTL_TRACE_RECORD, Arguments )) {
        Size += (PCHAR)TraceBuffer->EndBuffer - (PCHAR)p1;
        p1 = (PRTL_TRACE_RECORD)((PCHAR)p + Size);
        }

    while (TraceBuffer->ReadRecord >= p && TraceBuffer->ReadRecord <= p1) {
        TraceBuffer->ReadRecord = (PRTL_TRACE_RECORD)((PCHAR)TraceBuffer->ReadRecord + TraceBuffer->ReadRecord->Size);
        if (TraceBuffer->ReadRecord >= TraceBuffer->EndBuffer) {
            TraceBuffer->ReadRecord = TraceBuffer->StartBuffer;
            }
        }

    p->Size = Size;
    p->EventId = (USHORT)EventId;
    p->NumberOfArguments = (USHORT)NumberOfArguments;
    va_start( arglist, NumberOfArguments );
    for (i=0; i<NumberOfArguments; i++) {
        p->Arguments[ i ] = va_arg( arglist, ULONG );
        }
    va_end( arglist );

    if (TraceBuffer->ReadRecord == NULL) {
        TraceBuffer->ReadRecord = p;
        }
    TraceBuffer->WriteRecord = p1;

    // DPRINTF( "  R: %x  W: %x  O: %d  N: %d\n", TraceBuffer->ReadRecord, TraceBuffer->WriteRecord, OldReadWriteDifference, NewReadWriteDifference );

    return;
}