1 /*
2 * Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24 #include "precompiled.hpp"
25 #include "logging/log.hpp"
26 #include "logging/logConfiguration.hpp"
27 #include "logging/logFileOutput.hpp"
28 #include "memory/allocation.inline.hpp"
29 #include "runtime/arguments.hpp"
30 #include "runtime/os.inline.hpp"
31 #include "utilities/globalDefinitions.hpp"
32 #include "utilities/defaultStream.hpp"
33
34 const char* LogFileOutput::Prefix = "file=";
35 const char* LogFileOutput::FileOpenMode = "a";
36 const char* LogFileOutput::PidFilenamePlaceholder = "%p";
37 const char* LogFileOutput::TimestampFilenamePlaceholder = "%t";
38 const char* LogFileOutput::TimestampFormat = "%Y-%m-%d_%H-%M-%S";
39 const char* LogFileOutput::FileSizeOptionKey = "filesize";
40 const char* LogFileOutput::FileCountOptionKey = "filecount";
41 char LogFileOutput::_pid_str[PidBufferSize];
42 char LogFileOutput::_vm_start_time_str[StartTimeBufferSize];
43
44 LogFileOutput::LogFileOutput(const char* name)
45 : LogFileStreamOutput(NULL), _name(os::strdup_check_oom(name, mtLogging)),
46 _file_name(NULL), _archive_name(NULL), _archive_name_len(0),
47 _rotate_size(DefaultFileSize), _file_count(DefaultFileCount),
48 _current_size(0), _current_file(0), _rotation_semaphore(1) {
49 assert(strstr(name, Prefix) == name, "invalid output name '%s': missing prefix: %s", name, Prefix);
50 _file_name = make_file_name(name + strlen(Prefix), _pid_str, _vm_start_time_str);
51 }
52
53 void LogFileOutput::set_file_name_parameters(jlong vm_start_time) {
54 int res = jio_snprintf(_pid_str, sizeof(_pid_str), "%d", os::current_process_id());
55 assert(res > 0, "PID buffer too small");
56
57 struct tm local_time;
58 time_t utc_time = vm_start_time / 1000;
59 os::localtime_pd(&utc_time, &local_time);
60 res = (int)strftime(_vm_start_time_str, sizeof(_vm_start_time_str), TimestampFormat, &local_time);
61 assert(res > 0, "VM start time buffer too small.");
62 }
63
64 LogFileOutput::~LogFileOutput() {
65 if (_stream != NULL) {
66 if (fclose(_stream) != 0) {
67 jio_fprintf(defaultStream::error_stream(), "Could not close log file '%s' (%s).\n",
68 _file_name, os::strerror(errno));
69 }
70 }
71 os::free(_archive_name);
72 os::free(_file_name);
73 os::free(const_cast<char*>(_name));
74 }
75
76 static size_t parse_value(const char* value_str) {
77 char* end;
78 unsigned long long value = strtoull(value_str, &end, 10);
79 if (!isdigit(*value_str) || end != value_str + strlen(value_str) || value >= SIZE_MAX) {
80 return SIZE_MAX;
81 }
82 return value;
83 }
84
85 static bool file_exists(const char* filename) {
86 struct stat dummy_stat;
87 return os::stat(filename, &dummy_stat) == 0;
88 }
89
90 static uint number_of_digits(uint number) {
91 return number < 10 ? 1 : (number < 100 ? 2 : 3);
92 }
93
94 static bool is_regular_file(const char* filename) {
95 struct stat st;
96 int ret = os::stat(filename, &st);
97 if (ret != 0) {
98 return false;
99 }
100 return (st.st_mode & S_IFMT) == S_IFREG;
101 }
102
103 // Try to find the next number that should be used for file rotation.
104 // Return UINT_MAX on error.
105 static uint next_file_number(const char* filename,
106 uint number_of_digits,
107 uint filecount,
108 outputStream* errstream) {
109 bool found = false;
110 uint next_num = 0;
111
112 // len is filename + dot + digits + null char
113 size_t len = strlen(filename) + number_of_digits + 2;
114 char* archive_name = NEW_C_HEAP_ARRAY(char, len, mtLogging);
115 char* oldest_name = NEW_C_HEAP_ARRAY(char, len, mtLogging);
116
117 for (uint i = 0; i < filecount; i++) {
118 int ret = jio_snprintf(archive_name, len, "%s.%0*u",
119 filename, number_of_digits, i);
120 assert(ret > 0 && static_cast<size_t>(ret) == len - 1,
121 "incorrect buffer length calculation");
122
123 if (file_exists(archive_name) && !is_regular_file(archive_name)) {
124 // We've encountered something that's not a regular file among the
125 // possible file rotation targets. Fail immediately to prevent
126 // problems later.
127 errstream->print_cr("Possible rotation target file '%s' already exists "
128 "but is not a regular file.", archive_name);
129 next_num = UINT_MAX;
130 break;
131 }
132
133 // Stop looking if we find an unused file name
134 if (!file_exists(archive_name)) {
135 next_num = i;
136 found = true;
137 break;
138 }
139
140 // Keep track of oldest existing log file
141 if (!found
142 || os::compare_file_modified_times(oldest_name, archive_name) > 0) {
143 strcpy(oldest_name, archive_name);
144 next_num = i;
145 found = true;
146 }
147 }
148
149 FREE_C_HEAP_ARRAY(char, oldest_name);
150 FREE_C_HEAP_ARRAY(char, archive_name);
151 return next_num;
152 }
153
154 bool LogFileOutput::parse_options(const char* options, outputStream* errstream) {
155 if (options == NULL || strlen(options) == 0) {
156 return true;
157 }
158 bool success = true;
159 char* opts = os::strdup_check_oom(options, mtLogging);
160
161 char* comma_pos;
162 char* pos = opts;
163 do {
164 comma_pos = strchr(pos, ',');
165 if (comma_pos != NULL) {
166 *comma_pos = '\0';
167 }
168
169 char* equals_pos = strchr(pos, '=');
170 if (equals_pos == NULL) {
171 success = false;
172 break;
173 }
174 char* key = pos;
175 char* value_str = equals_pos + 1;
176 *equals_pos = '\0';
177
178 if (strcmp(FileCountOptionKey, key) == 0) {
179 size_t value = parse_value(value_str);
180 if (value > MaxRotationFileCount) {
181 errstream->print_cr("Invalid option: %s must be in range [0, %u]",
182 FileCountOptionKey,
183 MaxRotationFileCount);
184 success = false;
185 break;
186 }
187 _file_count = static_cast<uint>(value);
188 } else if (strcmp(FileSizeOptionKey, key) == 0) {
189 julong value;
190 success = Arguments::atojulong(value_str, &value);
191 if (!success || (value > SIZE_MAX)) {
192 errstream->print_cr("Invalid option: %s must be in range [0, "
193 SIZE_FORMAT "]", FileSizeOptionKey, SIZE_MAX);
194 success = false;
195 break;
196 }
197 _rotate_size = static_cast<size_t>(value);
198 } else {
199 errstream->print_cr("Invalid option '%s' for log file output.", key);
200 success = false;
201 break;
202 }
203 pos = comma_pos + 1;
204 } while (comma_pos != NULL);
205
206 os::free(opts);
207 return success;
208 }
209
210 bool LogFileOutput::initialize(const char* options, outputStream* errstream) {
211 if (!parse_options(options, errstream)) {
212 return false;
213 }
214
215 if (_file_count > 0) {
216 // compute digits with filecount - 1 since numbers will start from 0
217 _file_count_max_digits = number_of_digits(_file_count - 1);
218 _archive_name_len = 2 + strlen(_file_name) + _file_count_max_digits;
219 _archive_name = NEW_C_HEAP_ARRAY(char, _archive_name_len, mtLogging);
220 }
221
222 log_trace(logging)("Initializing logging to file '%s' (filecount: %u"
223 ", filesize: " SIZE_FORMAT " KiB).",
224 _file_name, _file_count, _rotate_size / K);
225
226 if (_file_count > 0 && file_exists(_file_name)) {
227 if (!is_regular_file(_file_name)) {
228 errstream->print_cr("Unable to log to file %s with log file rotation: "
229 "%s is not a regular file",
230 _file_name, _file_name);
231 return false;
232 }
233 _current_file = next_file_number(_file_name,
234 _file_count_max_digits,
235 _file_count,
236 errstream);
237 if (_current_file == UINT_MAX) {
238 return false;
239 }
240 log_trace(logging)("Existing log file found, saving it as '%s.%0*u'",
241 _file_name, _file_count_max_digits, _current_file);
242 archive();
243 increment_file_count();
244 }
245
246 _stream = fopen(_file_name, FileOpenMode);
247 if (_stream == NULL) {
248 errstream->print_cr("Error opening log file '%s': %s",
249 _file_name, strerror(errno));
250 return false;
251 }
252
253 if (_file_count == 0 && is_regular_file(_file_name)) {
254 log_trace(logging)("Truncating log file");
255 os::ftruncate(os::get_fileno(_stream), 0);
256 }
257
258 return true;
259 }
260
261 int LogFileOutput::write(const LogDecorations& decorations, const char* msg) {
262 if (_stream == NULL) {
263 // An error has occurred with this output, avoid writing to it.
264 return 0;
265 }
266
267 _rotation_semaphore.wait();
268 int written = LogFileStreamOutput::write(decorations, msg);
269 _current_size += written;
270
271 if (should_rotate()) {
272 rotate();
273 }
274 _rotation_semaphore.signal();
275
276 return written;
277 }
278
279 int LogFileOutput::write(LogMessageBuffer::Iterator msg_iterator) {
280 if (_stream == NULL) {
281 // An error has occurred with this output, avoid writing to it.
282 return 0;
283 }
284
285 _rotation_semaphore.wait();
286 int written = LogFileStreamOutput::write(msg_iterator);
287 _current_size += written;
288
289 if (should_rotate()) {
290 rotate();
291 }
292 _rotation_semaphore.signal();
293
294 return written;
295 }
296
297 void LogFileOutput::archive() {
298 assert(_archive_name != NULL && _archive_name_len > 0, "Rotation must be configured before using this function.");
299 int ret = jio_snprintf(_archive_name, _archive_name_len, "%s.%0*u",
300 _file_name, _file_count_max_digits, _current_file);
301 assert(ret >= 0, "Buffer should always be large enough");
302
303 // Attempt to remove possibly existing archived log file before we rename.
304 // Don't care if it fails, we really only care about the rename that follows.
305 remove(_archive_name);
306
307 // Rename the file from ex hotspot.log to hotspot.log.2
308 if (rename(_file_name, _archive_name) == -1) {
309 jio_fprintf(defaultStream::error_stream(), "Could not rename log file '%s' to '%s' (%s).\n",
310 _file_name, _archive_name, os::strerror(errno));
311 }
312 }
313
314 void LogFileOutput::force_rotate() {
315 if (_file_count == 0) {
316 // Rotation not possible
317 return;
318 }
319 _rotation_semaphore.wait();
320 rotate();
321 _rotation_semaphore.signal();
322 }
323
324 void LogFileOutput::rotate() {
325
326 if (fclose(_stream)) {
327 jio_fprintf(defaultStream::error_stream(), "Error closing file '%s' during log rotation (%s).\n",
328 _file_name, os::strerror(errno));
329 }
330
331 // Archive the current log file
332 archive();
333
334 // Open the active log file using the same stream as before
335 _stream = fopen(_file_name, FileOpenMode);
336 if (_stream == NULL) {
337 jio_fprintf(defaultStream::error_stream(), "Could not reopen file '%s' during log rotation (%s).\n",
338 _file_name, os::strerror(errno));
339 return;
340 }
341
342 // Reset accumulated size, increase current file counter, and check for file count wrap-around.
343 _current_size = 0;
344 increment_file_count();
345 }
346
347 char* LogFileOutput::make_file_name(const char* file_name,
348 const char* pid_string,
349 const char* timestamp_string) {
350 char* result = NULL;
351
352 // Lets start finding out if we have any %d and/or %t in the name.
353 // We will only replace the first occurrence of any placeholder
354 const char* pid = strstr(file_name, PidFilenamePlaceholder);
355 const char* timestamp = strstr(file_name, TimestampFilenamePlaceholder);
356
357 if (pid == NULL && timestamp == NULL) {
358 // We found no place-holders, return the simple filename
359 return os::strdup_check_oom(file_name, mtLogging);
360 }
361
362 // At least one of the place-holders were found in the file_name
363 const char* first = "";
364 size_t first_pos = SIZE_MAX;
365 size_t first_replace_len = 0;
366
367 const char* second = "";
368 size_t second_pos = SIZE_MAX;
369 size_t second_replace_len = 0;
370
371 // If we found a %p, then setup our variables accordingly
372 if (pid != NULL) {
373 if (timestamp == NULL || pid < timestamp) {
374 first = pid_string;
375 first_pos = pid - file_name;
376 first_replace_len = strlen(PidFilenamePlaceholder);
377 } else {
378 second = pid_string;
379 second_pos = pid - file_name;
380 second_replace_len = strlen(PidFilenamePlaceholder);
381 }
382 }
383
384 if (timestamp != NULL) {
385 if (pid == NULL || timestamp < pid) {
386 first = timestamp_string;
387 first_pos = timestamp - file_name;
388 first_replace_len = strlen(TimestampFilenamePlaceholder);
389 } else {
390 second = timestamp_string;
391 second_pos = timestamp - file_name;
392 second_replace_len = strlen(TimestampFilenamePlaceholder);
393 }
394 }
395
396 size_t first_len = strlen(first);
397 size_t second_len = strlen(second);
398
399 // Allocate the new buffer, size it to hold all we want to put in there +1.
400 size_t result_len = strlen(file_name) + first_len - first_replace_len + second_len - second_replace_len;
401 result = NEW_C_HEAP_ARRAY(char, result_len + 1, mtLogging);
402
403 // Assemble the strings
404 size_t file_name_pos = 0;
405 size_t i = 0;
406 while (i < result_len) {
407 if (file_name_pos == first_pos) {
408 // We are in the range of the first placeholder
409 strcpy(result + i, first);
410 // Bump output buffer position with length of replacing string
411 i += first_len;
412 // Bump source buffer position to skip placeholder
413 file_name_pos += first_replace_len;
414 } else if (file_name_pos == second_pos) {
415 // We are in the range of the second placeholder
416 strcpy(result + i, second);
417 i += second_len;
418 file_name_pos += second_replace_len;
419 } else {
420 // Else, copy char by char of the original file
421 result[i] = file_name[file_name_pos++];
422 i++;
423 }
424 }
425 // Add terminating char
426 result[result_len] = '\0';
427 return result;
428 }
429
430 void LogFileOutput::describe(outputStream *out) {
431 LogOutput::describe(out);
432 out->print(" ");
433
434 out->print("filecount=%u,filesize=" SIZE_FORMAT "%s", _file_count,
435 byte_size_in_proper_unit(_rotate_size),
436 proper_unit_for_byte_size(_rotate_size));
437 }
438