-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathBNLogListener.cs
More file actions
451 lines (363 loc) · 10.5 KB
/
Copy pathBNLogListener.cs
File metadata and controls
451 lines (363 loc) · 10.5 KB
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using Microsoft.Win32.SafeHandles;
namespace BinaryNinja
{
/// <summary>
///
/// </summary>
[StructLayout(LayoutKind.Sequential)]
public unsafe struct BNLogListener
{
/// <summary>
/// void (*log)(void* ctxt, size_t sessionId, BNLogLevel level, const char* msg, const char* logger_name, size_t tid);
/// </summary>
[UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.Cdecl)]
internal unsafe delegate void LogDelegate(
IntPtr ctxt,
ulong sessionId,
LogLevel level,
IntPtr msg,
IntPtr loggerName,
ulong tid
);
/// <summary>
/// void (*logWithStackTrace)(void* ctxt, size_t sessionId, BNLogLevel level, const char* stackTrace,const char* msg, const char* logger_name, size_t tid);
/// </summary>
[UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.Cdecl)]
internal unsafe delegate void LogWithStackTraceDelegate(
IntPtr ctxt,
ulong sessionId,
LogLevel level,
IntPtr stackTrace,
IntPtr msg,
IntPtr loggerName,
ulong tid
);
/// <summary>
/// void (*close)(void* ctxt);
/// </summary>
[UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.Cdecl)]
internal unsafe delegate void LogCloseDelegate(IntPtr ctxt);
/// <summary>
/// BNLogLevel (*getLogLevel)(void* ctxt);
/// </summary>
[UnmanagedFunctionPointer(System.Runtime.InteropServices.CallingConvention.Cdecl)]
internal unsafe delegate LogLevel GetLogLevelDelegate(IntPtr ctxt);
/// <summary>
/// void* context
/// </summary>
internal IntPtr context;
/// <summary>
/// void (*log)(void* ctxt, size_t sessionId, BNLogLevel level, const char* msg, const char* logger_name, size_t tid);
/// </summary>
internal IntPtr log;
/// <summary>
/// void (*logWithStackTrace)(void* ctxt, size_t sessionId, BNLogLevel level, const char* stackTrace,const char* msg, const char* logger_name, size_t tid);
/// </summary>
internal IntPtr logWithStackTrace;
/// <summary>
/// void (*close)(void* ctxt);
/// </summary>
internal IntPtr close;
/// <summary>
/// BNLogLevel (*getLogLevel)(void* ctxt);
/// </summary>
internal IntPtr getLogLevel;
}
public sealed class LogListener
{
public delegate void LogDelegate(
ulong sessionId,
LogLevel level,
string msg,
string loggerName,
ulong tid
);
public delegate void LogWithStackTraceDelegate(
ulong sessionId,
LogLevel level,
string stackTrace,
string msg,
string loggerName,
ulong tid
);
public delegate void LogCloseDelegate();
public delegate LogLevel GetLogLevelDelegate();
public LogDelegate? Log { get; private set; } = null;
public LogWithStackTraceDelegate? LogWithStackTrace { get; private set; } = null;
public LogCloseDelegate? LogClose { get; private set; } = null;
public GetLogLevelDelegate? GetLogLevel { get; private set; } = null;
// keep ref to delegate
private BNLogListener.LogDelegate? m_log = null;
private BNLogListener.LogWithStackTraceDelegate? m_logWithStackTrace = null;
private BNLogListener.LogCloseDelegate? m_logClose = null;
private BNLogListener.GetLogLevelDelegate? m_getLogLevel = null;
public LogListener()
{
}
internal static LogListener FromNative(BNLogListener native)
{
LogListener listener = new LogListener();
if (IntPtr.Zero != native.log)
{
listener.m_log = Marshal.GetDelegateForFunctionPointer<BNLogListener.LogDelegate>(
native.log
);
listener.Log = listener.BridgeLog;
}
if (IntPtr.Zero != native.logWithStackTrace)
{
listener.m_logWithStackTrace =
Marshal.GetDelegateForFunctionPointer<BNLogListener.LogWithStackTraceDelegate>(
native.logWithStackTrace
);
listener.LogWithStackTrace = listener.BridgeLogWithStackTrace;
}
if (IntPtr.Zero != native.close)
{
// Read the close callback from native.close, not native.log (a copy-paste
// error would otherwise bind the log function as the close callback).
listener.m_logClose = Marshal.GetDelegateForFunctionPointer<BNLogListener.LogCloseDelegate>(
native.close
);
listener.LogClose = listener.BridgeLogClose;
}
if (IntPtr.Zero != native.getLogLevel)
{
// Read the log-level callback from native.getLogLevel, not native.log.
listener.m_getLogLevel = Marshal.GetDelegateForFunctionPointer<BNLogListener.GetLogLevelDelegate>(
native.getLogLevel
);
listener.GetLogLevel = listener.BridgeGetLogLevel;
}
return listener;
}
private void BridgeLog(
ulong sessionId ,
LogLevel level ,
string msg ,
string loggerName ,
ulong tid)
{
if (null == this.m_log)
{
throw new NullReferenceException();
}
using (ScopedAllocator allocator = new ScopedAllocator())
{
this.m_log(
IntPtr.Zero,
sessionId,
level,
allocator.AllocAnsiString(msg),
allocator.AllocAnsiString(loggerName),
tid
);
}
}
private void BridgeLogWithStackTrace(
ulong sessionId,
LogLevel level,
string stackTrace,
string msg,
string loggerName,
ulong tid)
{
if (null == this.m_logWithStackTrace)
{
throw new NullReferenceException();
}
using (ScopedAllocator allocator = new ScopedAllocator())
{
this.m_logWithStackTrace(
IntPtr.Zero,
sessionId,
level,
allocator.AllocAnsiString(stackTrace),
allocator.AllocAnsiString(msg),
allocator.AllocAnsiString(loggerName),
tid
);
}
}
private void BridgeLogClose()
{
if (null == this.m_logClose)
{
throw new NullReferenceException();
}
this.m_logClose(IntPtr.Zero);
}
private LogLevel BridgeGetLogLevel()
{
if (null == this.m_getLogLevel)
{
throw new NullReferenceException();
}
return this.m_getLogLevel(IntPtr.Zero);
}
}
public abstract class CustomLogListener : IDisposable
{
private bool m_disposed = false;
private bool m_registered = false;
private IntPtr m_pointer = IntPtr.Zero;
// Cached thunk delegates for the ToNative() direction. A function pointer returned by
// GetFunctionPointerForDelegate stays valid only while its source delegate is alive; the
// inline method-group delegates (this.LogThunk) would otherwise be collectible the moment
// ToNative() returns, and the next native callback into this registered listener would
// dereference freed memory (AccessViolation).
private BNLogListener.LogDelegate? m_logThunk = null;
private BNLogListener.LogWithStackTraceDelegate? m_logWithStackTraceThunk = null;
private BNLogListener.LogCloseDelegate? m_logCloseThunk = null;
private BNLogListener.GetLogLevelDelegate? m_getLogLevelThunk = null;
public CustomLogListener()
{
this.m_pointer = Marshal.AllocHGlobal(
Marshal.SizeOf<BNLogListener>()
);
Marshal.StructureToPtr<BNLogListener>(
this.ToNative(),
this.m_pointer,
false
);
}
~CustomLogListener()
{
Dispose(false);
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (this.m_disposed)
{
return;
}
this.m_disposed = true;
if (this.m_registered)
{
this.m_registered = false;
NativeMethods.BNUnregisterLogListener(this.m_pointer);
}
if (this.m_pointer != IntPtr.Zero)
{
Marshal.DestroyStructure<BNLogListener>(this.m_pointer);
Marshal.FreeHGlobal(this.m_pointer);
this.m_pointer = IntPtr.Zero;
}
}
public BNLogListener ToNative()
{
// Build the thunk delegates once and store them in fields so they stay rooted for the
// lifetime of this listener. The core keeps the function pointers after Register(), so
// the delegate objects must outlive every native callback.
BNLogListener.LogDelegate logThunk = new BNLogListener.LogDelegate(this.LogThunk);
BNLogListener.LogWithStackTraceDelegate logWithStackTraceThunk =
new BNLogListener.LogWithStackTraceDelegate(this.LogWithStackTraceThunk);
BNLogListener.LogCloseDelegate logCloseThunk =
new BNLogListener.LogCloseDelegate(this.CloseLogThunk);
BNLogListener.GetLogLevelDelegate getLogLevelThunk =
new BNLogListener.GetLogLevelDelegate(this.GetLogLevelThunk);
this.m_logThunk = logThunk;
this.m_logWithStackTraceThunk = logWithStackTraceThunk;
this.m_logCloseThunk = logCloseThunk;
this.m_getLogLevelThunk = getLogLevelThunk;
return new BNLogListener()
{
context = IntPtr.Zero,
log = Marshal.GetFunctionPointerForDelegate(logThunk),
logWithStackTrace = Marshal.GetFunctionPointerForDelegate(logWithStackTraceThunk),
close = Marshal.GetFunctionPointerForDelegate(logCloseThunk),
getLogLevel = Marshal.GetFunctionPointerForDelegate(getLogLevelThunk),
};
}
public void Register()
{
if (this.m_disposed)
{
return;
}
if (this.m_registered)
{
return;
}
NativeMethods.BNRegisterLogListener(this.m_pointer);
this.m_registered = true;
}
#region thunk
private void LogThunk(
IntPtr ctxt ,
ulong sessionId ,
LogLevel level ,
IntPtr msg ,
IntPtr loggerName ,
ulong tid
)
{
this.Log(
(ulong)sessionId,
level,
UnsafeUtils.ReadAnsiString(msg),
UnsafeUtils.ReadAnsiString(loggerName),
(ulong)tid
);
}
private void LogWithStackTraceThunk(
IntPtr ctxt,
ulong sessionId,
LogLevel level,
IntPtr stackTrace,
IntPtr msg,
IntPtr loggerName,
ulong tid)
{
this.LogWithStackTrace(
(ulong)sessionId,
level,
UnsafeUtils.ReadAnsiString(stackTrace),
UnsafeUtils.ReadAnsiString(msg),
UnsafeUtils.ReadAnsiString(loggerName),
(ulong)tid
);
}
private void CloseLogThunk(IntPtr ctxt)
{
this.CloseLog();
}
private LogLevel GetLogLevelThunk(IntPtr ctxt)
{
return this.GetLogLevel();
}
#endregion thunk
public virtual void Log(
ulong sessionId ,
LogLevel level ,
string msg ,
string loggerName ,
ulong tid)
{
}
public virtual void LogWithStackTrace(
ulong sessionId,
LogLevel level,
string stackTrace,
string msg,
string loggerName,
ulong tid)
{
}
public virtual void CloseLog()
{
}
public virtual LogLevel GetLogLevel()
{
return LogLevel.InfoLog;
}
}
}