log-utils.h 3.94 KB
Newer Older
1
// Copyright 2006-2009 the V8 project authors. All rights reserved.
2 3
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
4 5 6 7

#ifndef V8_LOG_UTILS_H_
#define V8_LOG_UTILS_H_

8 9
#include <stdio.h>

10 11
#include <cstdarg>

12
#include "src/allocation.h"
13 14
#include "src/base/platform/mutex.h"
#include "src/flags.h"
15

16 17 18
namespace v8 {
namespace internal {

19 20
class Logger;

21
// Functions and data for performing output of log messages.
22
class Log {
23
 public:
24
  // Performs process-wide initialization.
25
  void Initialize(const char* log_file_name);
26

27
  // Disables logging, but preserves acquired resources.
28
  void stop() { is_stopped_ = true; }
29

30
  static bool InitLogAtStart() {
jkummerow's avatar
jkummerow committed
31 32
    return FLAG_log || FLAG_log_api || FLAG_log_code || FLAG_log_gc ||
           FLAG_log_handles || FLAG_log_suspect || FLAG_log_regexp ||
33
           FLAG_ll_prof || FLAG_perf_basic_prof ||
jkummerow's avatar
jkummerow committed
34
           FLAG_log_internal_timer_events || FLAG_prof_cpp;
35 36
  }

37
  // Frees all resources acquired in Initialize and Open... functions.
38 39 40
  // When a temporary file is used for the log, returns its stream descriptor,
  // leaving the file open.
  FILE* Close();
41 42

  // Returns whether logging is enabled.
43
  bool IsEnabled() {
44
    return !is_stopped_ && output_handle_ != NULL;
45 46
  }

47
  // Size of buffer used for formatting log messages.
48 49 50 51
  static const int kMessageBufferSize = 2048;

  // This mode is only used in tests, as temporary files are automatically
  // deleted on close and thus can't be accessed afterwards.
52
  static const char* const kLogToTemporaryFile;
53
  static const char* const kLogToConsole;
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
  // Utility class for formatting log messages. It fills the message into the
  // static buffer in Log.
  class MessageBuilder BASE_EMBEDDED {
   public:
    // Create a message builder starting from position 0.
    // This acquires the mutex in the log as well.
    explicit MessageBuilder(Log* log);
    ~MessageBuilder() { }

    // Append string data to the log message.
    void Append(const char* format, ...);

    // Append string data to the log message.
    void AppendVA(const char* format, va_list args);

    // Append a character to the log message.
    void Append(const char c);

    // Append double quoted string to the log message.
    void AppendDoubleQuotedString(const char* string);

    // Append a heap string.
    void Append(String* str);

    // Appends an address.
    void AppendAddress(Address addr);

    void AppendSymbolName(Symbol* symbol);

    void AppendDetailed(String* str, bool show_impl_info);

    // Append a portion of a string.
    void AppendStringPart(const char* str, int len);

    // Write the log message to the log file currently opened.
    void WriteToLogFile();

   private:
    Log* log_;
94
    base::LockGuard<base::Mutex> lock_guard_;
95 96 97
    int pos_;
  };

98
 private:
99 100 101 102
  explicit Log(Logger* logger);

  // Opens stdout for logging.
  void OpenStdout();
103

104 105
  // Opens file for logging.
  void OpenFile(const char* name);
106

107 108
  // Opens a temporary file for logging.
  void OpenTemporaryFile();
109 110

  // Implementation of writing to a log file.
111
  int WriteToFile(const char* msg, int length) {
112
    DCHECK(output_handle_ != NULL);
113
    size_t rv = fwrite(msg, 1, length, output_handle_);
114
    DCHECK(static_cast<size_t>(length) == rv);
115
    USE(rv);
116
    fflush(output_handle_);
117
    return length;
118 119
  }

120
  // Whether logging is stopped (e.g. due to insufficient resources).
121
  bool is_stopped_;
122

123 124
  // When logging is active output_handle_ is used to store a pointer to log
  // destination.  mutex_ should be acquired before using output_handle_.
125
  FILE* output_handle_;
126 127 128

  // mutex_ is a Mutex used for enforcing exclusive
  // access to the formatting buffer and the log file or log memory buffer.
129
  base::Mutex mutex_;
130 131 132

  // Buffer used for formatting log messages. This is a singleton buffer and
  // mutex_ should be acquired before using it.
133 134 135
  char* message_buffer_;

  Logger* logger_;
136

137
  friend class Logger;
138 139 140
};


141 142
}  // namespace internal
}  // namespace v8
143 144

#endif  // V8_LOG_UTILS_H_