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
|
/*
Unix SMB/CIFS implementation.
Samba debug functions
Copyright (C) Andrew Tridgell 2003
Copyright (C) James J Myers 2003
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "includes.h"
#include "system/filesys.h"
#include "system/time.h"
#include "dynconfig.h"
/**
* @file
* @brief Debug logging
**/
/**
* this global variable determines what messages are printed
*/
_PUBLIC_ int DEBUGLEVEL;
/* the registered mutex handlers */
static struct {
const char *name;
struct debug_ops ops;
} debug_handlers;
/* state variables for the debug system */
static struct {
int fd;
enum debug_logtype logtype;
const char *prog_name;
} state;
static BOOL reopen_logs_scheduled;
static BOOL check_reopen_logs(void)
{
if (state.fd == 0 || reopen_logs_scheduled) {
reopen_logs_scheduled = False;
reopen_logs();
}
if (state.fd <= 0) return False;
return True;
}
_PUBLIC_ void debug_schedule_reopen_logs(void)
{
reopen_logs_scheduled = True;
}
static void log_timestring(int level, const char *location, const char *func)
{
char *t = NULL;
char *s = NULL;
if (!check_reopen_logs()) return;
if (state.logtype != DEBUG_FILE) return;
t = timestring(NULL, time(NULL));
if (!t) return;
asprintf(&s, "[%s, %d %s:%s()]\n", t, level, location, func);
talloc_free(t);
if (!s) return;
write(state.fd, s, strlen(s));
free(s);
}
/**
the backend for debug messages. Note that the DEBUG() macro has already
ensured that the log level has been met before this is called
*/
_PUBLIC_ void do_debug_header(int level, const char *location, const char *func)
{
log_timestring(level, location, func);
log_task_id();
}
/**
the backend for debug messages. Note that the DEBUG() macro has already
ensured that the log level has been met before this is called
@note You should never have to call this function directly. Call the DEBUG()
macro instead.
*/
_PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2)
{
va_list ap;
char *s = NULL;
if (!check_reopen_logs()) return;
va_start(ap, format);
vasprintf(&s, format, ap);
va_end(ap);
write(state.fd, s, strlen(s));
free(s);
}
_PUBLIC_ const char *logfile = NULL;
/**
reopen the log file (usually called because the log file name might have changed)
*/
_PUBLIC_ void reopen_logs(void)
{
char *fname = NULL;
int old_fd = state.fd;
switch (state.logtype) {
case DEBUG_STDOUT:
state.fd = 1;
break;
case DEBUG_STDERR:
state.fd = 2;
break;
case DEBUG_FILE:
if ((*logfile) == '/') {
fname = strdup(logfile);
} else {
asprintf(&fname, "%s/%s.log", dyn_LOGFILEBASE, state.prog_name);
}
if (fname) {
int newfd = open(fname, O_CREAT|O_APPEND|O_WRONLY, 0600);
if (newfd == -1) {
DEBUG(1, ("Failed to open new logfile: %s\n", fname));
old_fd = -1;
} else {
state.fd = newfd;
}
free(fname);
} else {
DEBUG(1, ("Failed to find name for file-based logfile!\n"));
}
break;
}
if (old_fd > 2) {
close(old_fd);
}
}
/**
control the name of the logfile and whether logging will be to stdout, stderr
or a file
*/
_PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype)
{
if (state.logtype < new_logtype) {
state.logtype = new_logtype;
}
if (prog_name) {
state.prog_name = prog_name;
}
reopen_logs();
}
/**
return a string constant containing n tabs
no more than 10 tabs are returned
*/
_PUBLIC_ const char *do_debug_tab(int n)
{
const char *tabs[] = {"", "\t", "\t\t", "\t\t\t", "\t\t\t\t", "\t\t\t\t\t",
"\t\t\t\t\t\t", "\t\t\t\t\t\t\t", "\t\t\t\t\t\t\t\t",
"\t\t\t\t\t\t\t\t\t", "\t\t\t\t\t\t\t\t\t\t"};
return tabs[MIN(n, 10)];
}
/**
log suspicious usage - print comments and backtrace
*/
_PUBLIC_ void log_suspicious_usage(const char *from, const char *info)
{
if (!debug_handlers.ops.log_suspicious_usage) return;
debug_handlers.ops.log_suspicious_usage(from, info);
}
/**
print suspicious usage - print comments and backtrace
*/
_PUBLIC_ void print_suspicious_usage(const char* from, const char* info)
{
if (!debug_handlers.ops.print_suspicious_usage) return;
debug_handlers.ops.print_suspicious_usage(from, info);
}
_PUBLIC_ uint32_t get_task_id(void)
{
if (debug_handlers.ops.get_task_id) {
return debug_handlers.ops.get_task_id();
}
return getpid();
}
_PUBLIC_ void log_task_id(void)
{
if (!debug_handlers.ops.log_task_id) return;
if (!check_reopen_logs()) return;
debug_handlers.ops.log_task_id(state.fd);
}
/**
register a set of debug handlers.
*/
_PUBLIC_ void register_debug_handlers(const char *name, struct debug_ops *ops)
{
debug_handlers.name = name;
debug_handlers.ops = *ops;
}
|
