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::FileOpenMode = "a";
35 const char* LogFileOutput::PidFilenamePlaceholder = "%p";
36 const char* LogFileOutput::TimestampFilenamePlaceholder = "%t";
37 const char* LogFileOutput::TimestampFormat = "%Y-%m-%d_%H-%M-%S";
38 const char* LogFileOutput::FileSizeOptionKey = "filesize";
39 const char* LogFileOutput::FileCountOptionKey = "filecount";
40 char LogFileOutput::_pid_str[PidBufferSize];
41 char LogFileOutput::_vm_start_time_str[StartTimeBufferSize];
42
43 LogFileOutput::LogFileOutput(const char* name)
44 : LogFileStreamOutput(NULL), _name(os::strdup_check_oom(name, mtLogging)),
45 _file_name(NULL), _archive_name(NULL), _archive_name_len(0), _current_size(0),
46 _rotate_size(0), _current_file(1), _file_count(0), _rotation_semaphore(1) {
47 _file_name = make_file_name(name, _pid_str, _vm_start_time_str);
48 }
49
50 void LogFileOutput::set_file_name_parameters(jlong vm_start_time) {
51 int res = jio_snprintf(_pid_str, sizeof(_pid_str), "%d", os::current_process_id());
52 assert(res > 0, "PID buffer too small");
53
54 struct tm local_time;
55 time_t utc_time = vm_start_time / 1000;
56 os::localtime_pd(&utc_time, &local_time);
57 res = (int)strftime(_vm_start_time_str, sizeof(_vm_start_time_str), TimestampFormat, &local_time);
58 assert(res > 0, "VM start time buffer too small.");
59 }
60
61 LogFileOutput::~LogFileOutput() {
62 if (_stream != NULL) {
63 if (_archive_name != NULL) {
64 archive();
65 }
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 size_t LogFileOutput::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 bool LogFileOutput::configure_rotation(const char* options) {
86 if (options == NULL || strlen(options) == 0) {
87 return true;
88 }
89 bool success = true;
90 char* opts = os::strdup_check_oom(options, mtLogging);
91
92 char* comma_pos;
93 char* pos = opts;
94 do {
95 comma_pos = strchr(pos, ',');
96 if (comma_pos != NULL) {
97 *comma_pos = '\0';
98 }
99
100 char* equals_pos = strchr(pos, '=');
101 if (equals_pos == NULL) {
102 success = false;
103 break;
104 }
105 char* key = pos;
106 char* value_str = equals_pos + 1;
107 *equals_pos = '\0';
108
109 if (strcmp(FileCountOptionKey, key) == 0) {
110 size_t value = parse_value(value_str);
111 if (value == SIZE_MAX || value >= UINT_MAX) {
112 success = false;
113 break;
114 }
115 _file_count = static_cast<uint>(value);
116 _file_count_max_digits = static_cast<uint>(log10(static_cast<double>(_file_count)) + 1);
117 _archive_name_len = 2 + strlen(_file_name) + _file_count_max_digits;
118 _archive_name = NEW_C_HEAP_ARRAY(char, _archive_name_len, mtLogging);
119 } else if (strcmp(FileSizeOptionKey, key) == 0) {
120 success = Arguments::atomull(value_str, &_rotate_size);
121 } else {
122 success = false;
123 break;
124 }
125 pos = comma_pos + 1;
126 } while (comma_pos != NULL);
127
128 os::free(opts);
129 return success;
130 }
131
132 bool LogFileOutput::initialize(const char* options) {
133 if (!configure_rotation(options)) {
134 return false;
135 }
136 _stream = fopen(_file_name, FileOpenMode);
137 if (_stream == NULL) {
138 log_error(logging)("Could not open log file '%s' (%s).\n", _file_name, os::strerror(errno));
139 return false;
140 }
141 return true;
142 }
143
144 int LogFileOutput::write(const LogDecorations& decorations, const char* msg) {
145 if (_stream == NULL) {
146 // An error has occurred with this output, avoid writing to it.
147 return 0;
148 }
149
150 _rotation_semaphore.wait();
151 int written = LogFileStreamOutput::write(decorations, msg);
152 _current_size += written;
153
154 if (should_rotate()) {
155 rotate();
156 }
157 _rotation_semaphore.signal();
158
159 return written;
160 }
161
162 void LogFileOutput::archive() {
163 assert(_archive_name != NULL && _archive_name_len > 0, "Rotation must be configured before using this function.");
164 int ret = jio_snprintf(_archive_name, _archive_name_len, "%s.%0*u",
165 _file_name, _file_count_max_digits, _current_file);
166 assert(ret >= 0, "Buffer should always be large enough");
167
168 // Attempt to remove possibly existing archived log file before we rename.
169 // Don't care if it fails, we really only care about the rename that follows.
170 remove(_archive_name);
171
172 // Rename the file from ex hotspot.log to hotspot.log.2
173 if (rename(_file_name, _archive_name) == -1) {
174 jio_fprintf(defaultStream::error_stream(), "Could not rename log file '%s' to '%s' (%s).\n",
175 _file_name, _archive_name, os::strerror(errno));
176 }
177 }
178
179 void LogFileOutput::force_rotate() {
180 if (_file_count == 0) {
181 // Rotation not possible
182 return;
183 }
184 _rotation_semaphore.wait();
185 rotate();
186 _rotation_semaphore.signal();
187 }
188
189 void LogFileOutput::rotate() {
190
191 if (fclose(_stream)) {
192 jio_fprintf(defaultStream::error_stream(), "Error closing file '%s' during log rotation (%s).\n",
193 _file_name, os::strerror(errno));
194 }
195
196 // Archive the current log file
197 archive();
198
199 // Open the active log file using the same stream as before
200 _stream = fopen(_file_name, FileOpenMode);
201 if (_stream == NULL) {
202 jio_fprintf(defaultStream::error_stream(), "Could not reopen file '%s' during log rotation (%s).\n",
203 _file_name, os::strerror(errno));
204 return;
205 }
206
207 // Reset accumulated size, increase current file counter, and check for file count wrap-around.
208 _current_size = 0;
209 _current_file = (_current_file >= _file_count ? 1 : _current_file + 1);
210 }
211
212 char* LogFileOutput::make_file_name(const char* file_name,
213 const char* pid_string,
214 const char* timestamp_string) {
215 char* result = NULL;
216
217 // Lets start finding out if we have any %d and/or %t in the name.
218 // We will only replace the first occurrence of any placeholder
219 const char* pid = strstr(file_name, PidFilenamePlaceholder);
220 const char* timestamp = strstr(file_name, TimestampFilenamePlaceholder);
221
222 if (pid == NULL && timestamp == NULL) {
223 // We found no place-holders, return the simple filename
224 return os::strdup_check_oom(file_name, mtLogging);
225 }
226
227 // At least one of the place-holders were found in the file_name
228 const char* first = "";
229 size_t first_pos = SIZE_MAX;
230 size_t first_replace_len = 0;
231
232 const char* second = "";
233 size_t second_pos = SIZE_MAX;
234 size_t second_replace_len = 0;
235
236 // If we found a %p, then setup our variables accordingly
237 if (pid != NULL) {
238 if (timestamp == NULL || pid < timestamp) {
239 first = pid_string;
240 first_pos = pid - file_name;
241 first_replace_len = strlen(PidFilenamePlaceholder);
242 } else {
243 second = pid_string;
244 second_pos = pid - file_name;
245 second_replace_len = strlen(PidFilenamePlaceholder);
246 }
247 }
248
249 if (timestamp != NULL) {
250 if (pid == NULL || timestamp < pid) {
251 first = timestamp_string;
252 first_pos = timestamp - file_name;
253 first_replace_len = strlen(TimestampFilenamePlaceholder);
254 } else {
255 second = timestamp_string;
256 second_pos = timestamp - file_name;
257 second_replace_len = strlen(TimestampFilenamePlaceholder);
258 }
259 }
260
261 size_t first_len = strlen(first);
262 size_t second_len = strlen(second);
263
264 // Allocate the new buffer, size it to hold all we want to put in there +1.
265 size_t result_len = strlen(file_name) + first_len - first_replace_len + second_len - second_replace_len;
266 result = NEW_C_HEAP_ARRAY(char, result_len + 1, mtLogging);
267
268 // Assemble the strings
269 size_t file_name_pos = 0;
270 size_t i = 0;
271 while (i < result_len) {
272 if (file_name_pos == first_pos) {
273 // We are in the range of the first placeholder
274 strcpy(result + i, first);
275 // Bump output buffer position with length of replacing string
276 i += first_len;
277 // Bump source buffer position to skip placeholder
278 file_name_pos += first_replace_len;
279 } else if (file_name_pos == second_pos) {
280 // We are in the range of the second placeholder
281 strcpy(result + i, second);
282 i += second_len;
283 file_name_pos += second_replace_len;
284 } else {
285 // Else, copy char by char of the original file
286 result[i] = file_name[file_name_pos++];
287 i++;
288 }
289 }
290 // Add terminating char
291 result[result_len] = '\0';
292 return result;
293 }