1
// Copyright 2006-2009 the V8 project authors. All rights reserved.
2
// Redistribution and use in source and binary forms, with or without
3
// modification, are permitted provided that the following conditions are
6
// * Redistributions of source code must retain the above copyright
7
// notice, this list of conditions and the following disclaimer.
8
// * Redistributions in binary form must reproduce the above
9
// copyright notice, this list of conditions and the following
10
// disclaimer in the documentation and/or other materials provided
11
// with the distribution.
12
// * Neither the name of Google Inc. nor the names of its
13
// contributors may be used to endorse or promote products derived
14
// from this software without specific prior written permission.
16
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
#ifndef V8_LOG_UTILS_H_
29
#define V8_LOG_UTILS_H_
31
#include "allocation.h"
38
// Functions and data for performing output of log messages.
41
// Performs process-wide initialization.
44
// Disables logging, but preserves acquired resources.
45
void stop() { is_stopped_ = true; }
47
// Frees all resources acquired in Initialize and Open... functions.
48
// When a temporary file is used for the log, returns its stream descriptor,
49
// leaving the file open.
52
// Returns whether logging is enabled.
54
return !is_stopped_ && output_handle_ != NULL;
57
// Size of buffer used for formatting log messages.
58
static const int kMessageBufferSize = 2048;
60
// This mode is only used in tests, as temporary files are automatically
61
// deleted on close and thus can't be accessed afterwards.
62
static const char* const kLogToTemporaryFile;
65
explicit Log(Logger* logger);
67
// Opens stdout for logging.
70
// Opens file for logging.
71
void OpenFile(const char* name);
73
// Opens a temporary file for logging.
74
void OpenTemporaryFile();
76
// Implementation of writing to a log file.
77
int WriteToFile(const char* msg, int length) {
78
ASSERT(output_handle_ != NULL);
79
size_t rv = fwrite(msg, 1, length, output_handle_);
80
ASSERT(static_cast<size_t>(length) == rv);
82
fflush(output_handle_);
86
// Whether logging is stopped (e.g. due to insufficient resources).
89
// When logging is active output_handle_ is used to store a pointer to log
90
// destination. mutex_ should be acquired before using output_handle_.
93
// Used when low-level profiling is active.
94
FILE* ll_output_handle_;
96
// mutex_ is a Mutex used for enforcing exclusive
97
// access to the formatting buffer and the log file or log memory buffer.
100
// Buffer used for formatting log messages. This is a singleton buffer and
101
// mutex_ should be acquired before using it.
102
char* message_buffer_;
107
friend class LogMessageBuilder;
111
// Utility class for formatting log messages. It fills the message into the
112
// static buffer in Log.
113
class LogMessageBuilder BASE_EMBEDDED {
115
// Create a message builder starting from position 0. This acquires the mutex
116
// in the log as well.
117
explicit LogMessageBuilder(Logger* logger);
118
~LogMessageBuilder() { }
120
// Append string data to the log message.
121
void Append(const char* format, ...);
123
// Append string data to the log message.
124
void AppendVA(const char* format, va_list args);
126
// Append a character to the log message.
127
void Append(const char c);
129
// Append a heap string.
130
void Append(String* str);
132
// Appends an address.
133
void AppendAddress(Address addr);
135
void AppendDetailed(String* str, bool show_impl_info);
137
// Append a portion of a string.
138
void AppendStringPart(const char* str, int len);
140
// Write the log message to the log file currently opened.
141
void WriteToLogFile();
149
} } // namespace v8::internal
151
#endif // V8_LOG_UTILS_H_