log.h

Go to the documentation of this file.

// Copyright (c) 2015-2017, Satoshi Tanda. All rights reserved.
// Use of this source code is governed by a MIT-style license that can be
// found in the LICENSE file.


#ifndef HYPERPLATFORM_LOG_H_
#define HYPERPLATFORM_LOG_H_

#include <fltKernel.h>

extern "C" {
//
// macro utilities
//

#define HYPERPLATFORM_LOG_DEBUG(format, ...) \
  LogpPrint(kLogpLevelDebug, __FUNCTION__, (format), __VA_ARGS__)

#define HYPERPLATFORM_LOG_INFO(format, ...) \
  LogpPrint(kLogpLevelInfo, __FUNCTION__, (format), __VA_ARGS__)

#define HYPERPLATFORM_LOG_WARN(format, ...) \
  LogpPrint(kLogpLevelWarn, __FUNCTION__, (format), __VA_ARGS__)

#define HYPERPLATFORM_LOG_ERROR(format, ...) \
  LogpPrint(kLogpLevelError, __FUNCTION__, (format), __VA_ARGS__)

#define HYPERPLATFORM_LOG_DEBUG_SAFE(format, ...)                        \
  LogpPrint(kLogpLevelDebug | kLogpLevelOptSafe, __FUNCTION__, (format), \
            __VA_ARGS__)

#define HYPERPLATFORM_LOG_INFO_SAFE(format, ...)                        \
  LogpPrint(kLogpLevelInfo | kLogpLevelOptSafe, __FUNCTION__, (format), \
            __VA_ARGS__)

#define HYPERPLATFORM_LOG_WARN_SAFE(format, ...)                        \
  LogpPrint(kLogpLevelWarn | kLogpLevelOptSafe, __FUNCTION__, (format), \
            __VA_ARGS__)

#define HYPERPLATFORM_LOG_ERROR_SAFE(format, ...)                        \
  LogpPrint(kLogpLevelError | kLogpLevelOptSafe, __FUNCTION__, (format), \
            __VA_ARGS__)

//
// constants and macros
//

static const auto kLogpLevelOptSafe = 0x1ul;

static const auto kLogpLevelDebug = 0x10ul;  
static const auto kLogpLevelInfo = 0x20ul;   
static const auto kLogpLevelWarn = 0x40ul;   
static const auto kLogpLevelError = 0x80ul;  

static const auto kLogPutLevelDebug =
    kLogpLevelError | kLogpLevelWarn | kLogpLevelInfo | kLogpLevelDebug;

static const auto kLogPutLevelInfo =
    kLogpLevelError | kLogpLevelWarn | kLogpLevelInfo;

static const auto kLogPutLevelWarn = kLogpLevelError | kLogpLevelWarn;

static const auto kLogPutLevelError = kLogpLevelError;

static const auto kLogPutLevelDisable = 0x00ul;

static const auto kLogOptDisableTime = 0x100ul;

static const auto kLogOptDisableFunctionName = 0x200ul;

static const auto kLogOptDisableProcessorNumber = 0x400ul;

static const auto kLogOptDisableDbgPrint = 0x800ul;

//
// types
//

//
// prototypes
//

_IRQL_requires_max_(PASSIVE_LEVEL) NTSTATUS
    LogInitialization(_In_ ULONG flag, _In_opt_ const wchar_t *file_path);

_IRQL_requires_max_(PASSIVE_LEVEL) void LogRegisterReinitialization(
    _In_ PDRIVER_OBJECT driver_object);

_IRQL_requires_max_(PASSIVE_LEVEL) void LogIrpShutdownHandler();

_IRQL_requires_max_(PASSIVE_LEVEL) void LogTermination();

NTSTATUS LogpPrint(_In_ ULONG level, _In_z_ const char *function_name,
                   _In_z_ _Printf_format_string_ const char *format, ...);

//
// variables
//

//
// implementations
//

}  // extern "C"

#endif  // HYPERPLATFORM_LOG_H_