1 /*
2 * Copyright (c) 2016, 2020, 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/logMessageBuffer.hpp"
26 #include "memory/allocation.inline.hpp"
27 #include "runtime/thread.inline.hpp"
28
29
30 LogMessageBuffer::LogMessageBuffer(Arena* arena) : _arena(arena),
31 _message_buffer_size(0),
32 _message_buffer_capacity(0),
33 _message_buffer(NULL),
34 _line_count(0),
35 _line_capacity(0),
36 _lines(NULL),
37 _allocated(false),
38 _least_detailed_level(LogLevel::Off),
39 _prefix_fn(NULL) {
40 }
41
42 LogMessageBuffer::~LogMessageBuffer() {
43 if (_allocated) {
44 if (!_arena) {
45 FREE_C_HEAP_ARRAY(char, _message_buffer);
46 FREE_C_HEAP_ARRAY(LogLine, _lines);
47 } else {
48 FREE_ARENA_ARRAY(_arena, char, _message_buffer, _message_buffer_capacity);
49 FREE_ARENA_ARRAY(_arena, LogLine, _lines, _line_capacity);
50 }
51 }
52 }
53
54 void LogMessageBuffer::reset() {
55 _message_buffer_size = 0;
56 _line_count = 0;
57 }
58
59 void LogMessageBuffer::initialize_buffers() {
60 assert(!_allocated, "buffer already initialized/allocated");
61 if (!_arena) {
62 _message_buffer = NEW_C_HEAP_ARRAY(char, InitialMessageBufferCapacity, mtLogging);
63 _lines = NEW_C_HEAP_ARRAY(LogLine, InitialLineCapacity, mtLogging);
64 }
65 else {
66 _message_buffer = NEW_ARENA_ARRAY(_arena, char, InitialMessageBufferCapacity);
67 _lines = NEW_ARENA_ARRAY(_arena, LogLine, InitialLineCapacity);
68 }
69
70 _allocated = true;
71 _message_buffer_capacity = InitialMessageBufferCapacity;
72 _line_capacity = InitialLineCapacity;
73 }
74
75 size_t LogMessageBuffer::initial_buffer_size() {
76 return sizeof(char) * InitialMessageBufferCapacity
77 + sizeof(LogLine) * InitialLineCapacity;
78 }
79
80 template<typename T>
81 void LogMessageBuffer::grow(T*& buffer, size_t& capacity, size_t minimum_length) {
82 size_t new_size = capacity * 2;
83 if (new_size < minimum_length) {
84 new_size = minimum_length;
85 }
86 if (!_arena) {
87 buffer = REALLOC_C_HEAP_ARRAY(T, buffer, new_size, mtLogging);
88 }
89 else {
90 buffer = REALLOC_ARENA_ARRAY(_arena, T, buffer, capacity, new_size);
91 }
92 capacity = new_size;
93 }
94
95 void LogMessageBuffer::Iterator::skip_messages_with_finer_level() {
96 for (; _current_line_index < _message._line_count; _current_line_index++) {
97 if (_message._lines[_current_line_index].level >= _level) {
98 break;
99 }
100 }
101 }
102
103 void LogMessageBuffer::write_n(LogLevelType level, const char * s, size_t len) {
104 if (!_allocated) {
105 initialize_buffers();
106 }
107
108 if (level > _least_detailed_level) {
109 _least_detailed_level = level;
110 }
111
112 size_t written;
113 for (int attempts = 0; attempts < 2; attempts++) {
114 written = 0;
115 size_t remain = _message_buffer_capacity - _message_buffer_size;
116 char* curr = _message_buffer + _message_buffer_size;
117
118 if (_prefix_fn != NULL) {
119 written += _prefix_fn(curr, remain);
120 }
121 curr += written;
122
123 written += len + 1; // add tailing zero
124 if (written > remain) {
125 grow(_message_buffer, _message_buffer_capacity, _message_buffer_size + written);
126 continue;
127 }
128
129 strncpy(curr, s, len);
130 curr[len] = '\0';
131 break;
132 }
133
134 if (_line_count == _line_capacity) {
135 grow(_lines, _line_capacity);
136 }
137 _lines[_line_count].level = level;
138 _lines[_line_count].message_offset = _message_buffer_size;
139 _message_buffer_size += written;
140 _line_count++;
141 }
142
143 void LogMessageBuffer::write(LogLevelType level, const char* fmt, ...) {
144 va_list args;
145 va_start(args, fmt);
146 vwrite(level, fmt, args);
147 va_end(args);
148 };
149
150 void LogMessageBuffer::vwrite(LogLevelType level, const char* fmt, va_list args) {
151 if (!_allocated) {
152 initialize_buffers();
153 }
154
155 if (level > _least_detailed_level) {
156 _least_detailed_level = level;
157 }
158
159 size_t written;
160 for (int attempts = 0; attempts < 2; attempts++) {
161 written = 0;
162 size_t remaining_buffer_length = _message_buffer_capacity - _message_buffer_size;
163 char* current_buffer_position = _message_buffer + _message_buffer_size;
164
165 if (_prefix_fn != NULL) {
166 written += _prefix_fn(current_buffer_position, remaining_buffer_length);
167 current_buffer_position += written;
168 if (remaining_buffer_length < written) {
169 remaining_buffer_length = 0;
170 } else {
171 remaining_buffer_length -= written;
172 }
173 }
174
175 va_list copy;
176 va_copy(copy, args);
177 written += (size_t)os::vsnprintf(current_buffer_position, remaining_buffer_length, fmt, copy) + 1;
178 va_end(copy);
179 if (written > _message_buffer_capacity - _message_buffer_size) {
180 assert(attempts == 0, "Second attempt should always have a sufficiently large buffer (resized to fit).");
181 grow(_message_buffer, _message_buffer_capacity, _message_buffer_size + written);
182 continue;
183 }
184 break;
185 }
186
187 if (_line_count == _line_capacity) {
188 grow(_lines, _line_capacity);
189 }
190
191 _lines[_line_count].level = level;
192 _lines[_line_count].message_offset = _message_buffer_size;
193 _message_buffer_size += written;
194 _line_count++;
195 }
196
197 #define LOG_LEVEL(level, name) \
198 LogMessageBuffer& LogMessageBuffer::v##name(const char* fmt, va_list args) { \
199 vwrite(LogLevel::level, fmt, args); \
200 return *this; \
201 } \
202 LogMessageBuffer& LogMessageBuffer::name(const char* fmt, ...) { \
203 va_list args; \
204 va_start(args, fmt); \
205 vwrite(LogLevel::level, fmt, args); \
206 va_end(args); \
207 return *this; \
208 }
209 LOG_LEVEL_LIST
210 #undef LOG_LEVEL