-
Notifications
You must be signed in to change notification settings - Fork 796
/
logcat.cc
346 lines (297 loc) · 9.91 KB
/
logcat.cc
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
/** @file
Contains main function definition for logcat
@section license License
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "ink_config.h"
#include "ink_file.h"
#include "I_Layout.h"
#include "I_Version.h"
#define PROGRAM_NAME "traffic_logcat"
#define MAX_LOGBUFFER_SIZE 65536
#include <poll.h>
#include "LogStandalone.cc"
#include "LogAccess.h"
#include "LogField.h"
#include "LogFilter.h"
#include "LogFormat.h"
#include "LogFile.h"
#include "LogHost.h"
#include "LogObject.h"
#include "LogConfig.h"
#include "LogBuffer.h"
#include "LogUtils.h"
#include "LogSock.h"
#include "LogPredefined.h"
#include "Log.h"
// logcat-specific command-line flags
static int version_flag = 0;
static int help = 0;
static int squid_flag = 0;
static int follow_flag = 0;
static int clf_flag = 0;
static int elf_flag = 0;
static int elf2_flag = 0;
static int auto_filenames = 0;
static int overwrite_existing_file = 0;
static char output_file[1024];
int auto_clear_cache_flag = 0;
static const ArgumentDescription argument_descriptions[] = {
{"output_file", 'o', "Specify output file", "S1023", &output_file, NULL, NULL},
{"auto_filenames", 'a', "Automatically generate output names",
"T", &auto_filenames, NULL, NULL},
{"follow", 'f', "Follow the log file as it grows", "T", &follow_flag, NULL, NULL},
{"clf", 'C', "Convert to Common Logging Format", "T", &clf_flag, NULL, NULL},
{"elf", 'E', "Convert to Extended Logging Format", "T", &elf_flag, NULL, NULL},
{"help", 'h', "Give this help", "T", &help, NULL, NULL},
{"squid", 'S', "Convert to Squid Logging Format", "T", &squid_flag, NULL, NULL},
{"debug_tags", 'T', "Colon-Separated Debug Tags", "S1023", error_tags, NULL, NULL},
{"version", 'V', "Print Version Id", "T", &version_flag, NULL, NULL},
{"overwrite_output", 'w', "Overwrite existing output file(s)", "T",
&overwrite_existing_file, NULL, NULL},
{"elf2", '2', "Convert to Extended2 Logging Format", "T", &elf2_flag, NULL,
NULL}
};
static const char *USAGE_LINE = "Usage: " PROGRAM_NAME " [-o output-file | -a] [-CEhS"
#ifdef DEBUG
"T"
#endif
"Vw2] [input-file ...]";
static int
process_file(int in_fd, int out_fd)
{
char buffer[MAX_LOGBUFFER_SIZE];
int nread, buffer_bytes;
unsigned bytes = 0;
while (true) {
// read the next buffer from file descriptor
//
Debug("logcat", "Reading buffer ...");
memset(buffer, 0, sizeof(buffer));
// read the first 8 bytes of the header, which will give us the
// cookie and the version number.
//
unsigned first_read_size = sizeof(uint32_t) + sizeof(uint32_t);
unsigned header_size = sizeof(LogBufferHeader);
LogBufferHeader *header = (LogBufferHeader *) & buffer[0];
nread = read(in_fd, buffer, first_read_size);
if (!nread || nread == EOF)
return 0;
// ensure that this is a valid logbuffer header
//
if (header->cookie != LOG_SEGMENT_COOKIE) {
fprintf(stderr, "Bad LogBuffer!\n");
return 1;
}
// read the rest of the header
//
unsigned second_read_size = header_size - first_read_size;
nread = read(in_fd, &buffer[first_read_size], second_read_size);
if (!nread || nread == EOF) {
if (follow_flag)
return 0;
fprintf(stderr, "Bad LogBufferHeader read!\n");
return 1;
}
// read the rest of the buffer
//
uint32_t byte_count = header->byte_count;
if (byte_count > sizeof(buffer)) {
fprintf(stderr, "Buffer too large!\n");
return 1;
}
buffer_bytes = byte_count - header_size;
if (buffer_bytes == 0)
return 0;
if (buffer_bytes < 0) {
fprintf(stderr, "No buffer body!\n");
return 1;
}
// Read the next full buffer (allowing for "partial" reads)
nread = 0;
while (nread < buffer_bytes) {
int rc = read(in_fd, &buffer[header_size] + nread, buffer_bytes - nread);
if ((rc == EOF) && (!follow_flag)) {
fprintf(stderr, "Bad LogBuffer read!\n");
return 1;
}
if (rc > 0)
nread += rc;
}
if (nread > buffer_bytes) {
fprintf(stderr, "Read too many bytes!\n");
return 1;
}
// see if there is an alternate format request from the command
// line
//
const char * alt_format = NULL;
if (squid_flag)
alt_format = PreDefinedFormatInfo::squid;
if (clf_flag)
alt_format = PreDefinedFormatInfo::common;
if (elf_flag)
alt_format = PreDefinedFormatInfo::extended;
if (elf2_flag)
alt_format = PreDefinedFormatInfo::extended2;
// convert the buffer to ascii entries and place onto stdout
//
if (header->fmt_fieldlist()) {
bytes += LogFile::write_ascii_logbuffer(header, out_fd, ".", alt_format);
} else {
// TODO investigate why this buffer goes wonky
}
}
}
static int
open_output_file(char *output_file)
{
int file_desc = 0;
if (!overwrite_existing_file) {
if (access(output_file, F_OK)) {
if (errno != ENOENT) {
fprintf(stderr, "Error accessing output file %s: ", output_file);
perror(0);
file_desc = -1;
}
} else {
fprintf(stderr, "Error, output file %s already exists.\n" "Select a different filename or use the -w flag\n",
output_file);
file_desc = -1;
}
}
if (file_desc == 0) {
file_desc = open(output_file, O_WRONLY | O_TRUNC | O_CREAT, 0640);
if (file_desc < 0) {
fprintf(stderr, "Error while opening output file %s: ", output_file);
perror(0);
}
}
return file_desc;
}
/*-------------------------------------------------------------------------
main
-------------------------------------------------------------------------*/
int
main(int /* argc ATS_UNUSED */, char *argv[])
{
enum
{
NO_ERROR = 0,
CMD_LINE_OPTION_ERROR = 1,
DATA_PROCESSING_ERROR = 2
};
// build the application information structure
//
appVersionInfo.setup(PACKAGE_NAME,PROGRAM_NAME, PACKAGE_VERSION, __DATE__,
__TIME__, BUILD_MACHINE, BUILD_PERSON, "");
// Before accessing file system initialize Layout engine
Layout::create();
// process command-line arguments
//
output_file[0] = 0;
process_args(argument_descriptions, countof(argument_descriptions), argv, USAGE_LINE);
// check for the version number request
//
if (version_flag) {
fprintf(stderr, "%s\n", appVersionInfo.FullVersionInfoStr);
_exit(NO_ERROR);
}
// check for help request
//
if (help) {
usage(argument_descriptions, countof(argument_descriptions), USAGE_LINE);
_exit(NO_ERROR);
}
// check that only one of the -o and -a options was specified
//
if (output_file[0] != 0 && auto_filenames) {
fprintf(stderr, "Error: specify only one of -o <file> and -a\n");
_exit(CMD_LINE_OPTION_ERROR);
}
// initialize this application for standalone logging operation
//
init_log_standalone_basic(PROGRAM_NAME);
Log::init(Log::NO_REMOTE_MANAGEMENT | Log::LOGCAT);
// setup output file
//
int out_fd = STDOUT_FILENO;
if (output_file[0] != 0) {
out_fd = open_output_file(output_file);
if (out_fd < 0) {
_exit(DATA_PROCESSING_ERROR);
}
} else if (!auto_filenames) {
out_fd = STDOUT_FILENO;
}
// process file arguments
//
int error = NO_ERROR;
if (n_file_arguments) {
int bin_ext_len = strlen(LOG_FILE_BINARY_OBJECT_FILENAME_EXTENSION);
int ascii_ext_len = strlen(LOG_FILE_ASCII_OBJECT_FILENAME_EXTENSION);
for (unsigned i = 0; i < n_file_arguments; ++i) {
int in_fd = open(file_arguments[i], O_RDONLY);
if (in_fd < 0) {
fprintf(stderr, "Error opening input file %s: ", file_arguments[i]);
perror(0);
error = DATA_PROCESSING_ERROR;
} else {
#if HAVE_POSIX_FADVISE
posix_fadvise(in_fd, 0, 0, POSIX_FADV_DONTNEED);
#endif
if (auto_filenames) {
// change .blog to .log
//
int n = strlen(file_arguments[i]);
int copy_len = (n >= bin_ext_len ? (strcmp(&file_arguments[i][n - bin_ext_len],
LOG_FILE_BINARY_OBJECT_FILENAME_EXTENSION) ==
0 ? n - bin_ext_len : n) : n);
char *out_filename = (char *)ats_malloc(copy_len + ascii_ext_len + 1);
memcpy(out_filename, file_arguments[i], copy_len);
memcpy(&out_filename[copy_len], LOG_FILE_ASCII_OBJECT_FILENAME_EXTENSION, ascii_ext_len);
out_filename[copy_len + ascii_ext_len] = 0;
out_fd = open_output_file(out_filename);
ats_free(out_filename);
if (out_fd < 0) {
error = DATA_PROCESSING_ERROR;
continue;
}
}
if (follow_flag)
lseek(in_fd, 0, SEEK_END);
while (true) {
if (process_file(in_fd, out_fd) != 0) {
error = DATA_PROCESSING_ERROR;
break;
}
if (!follow_flag)
break;
else
usleep(10000); // This avoids burning CPU, using poll() would have been nice, but doesn't work I think.
}
}
}
} else {
// read from stdin, allow STDIN to go EOF a few times until we get synced
//
int tries = 3;
while (--tries >= 0) {
if (process_file(STDIN_FILENO, out_fd) != 0)
tries = -1;
}
}
_exit(error);
}