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
|
//**********************************************************************;
// Copyright (c) 2017, Intel Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// 3. Neither the name of Intel Corporation nor the names of its contributors
// may be used to endorse or promote products derived from this software without
// specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//**********************************************************************;
#ifndef SRC_LOG_H_
#define SRC_LOG_H_
#include <stdbool.h>
#include <stdio.h>
#include <tss2/tss2_sys.h>
#include "tpm2_error.h"
#include "tpm2_util.h"
typedef enum log_level log_level;
enum log_level {
log_level_error,
log_level_warning,
log_level_verbose
};
void _log (log_level level, const char *file, unsigned lineno, const char *fmt, ...)
COMPILER_ATTR(format (printf, 4, 5));
/*
* Prints an error message. The fmt and variadic arguments mirror printf.
*
* Use this to log all error conditions.
*/
#define LOG_ERR(fmt, ...) _log(log_level_error, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
/**
* Prints an error message for a TSS2_Sys call to the TPM.
* The format is <function-name>(0x<rc>) - <error string>
* @param func
* The function that caused the error
* @param rc
* The return code to print.
*/
#define LOG_PERR(func, rc) _LOG_PERR(xstr(func), rc)
/**
* Internal use only.
*
* Handles the expanded LOG_PERR call checking argument values
* and handing them off to LOG_ERR.
* @param func
* The function name.
* @param rc
* The rc to decode.
*/
static inline void _LOG_PERR(const char *func, TSS2_RC rc) {
LOG_ERR("%s(0x%X) - %s", func, rc, tpm2_error_str(rc));
}
/*
* Prints an warning message. The fmt and variadic arguments mirror printf.
*
* Use this to log a warning. A warning is when something is wrong, but it is not a fatal
* issue.
*/
#define LOG_WARN(fmt, ...) _log(log_level_warning, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
/*
* Prints an informational message. The fmt and variadic arguments mirror printf.
*
* Informational messages are only shown when verboseness is increased. Valid messages
* would be debugging type messages where additional, extraneous information is printed.
*/
#define LOG_INFO(fmt, ...) _log(log_level_verbose, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
/**
* Sets the log level so only messages <= to it print.
* @param level
* The logging level to set.
*/
void log_set_level (log_level level);
#endif /* SRC_LOG_H_ */
|
