chrome/common/logging_chrome.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_COMMON_LOGGING_CHROME_H__
   6 #define CHROME_COMMON_LOGGING_CHROME_H__
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/logging.h"
  12 #include "base/time.h"
  13
  14 class CommandLine;
  15 class FilePath;
  16
  17 namespace logging {
  18
  19 // Call to initialize logging for Chrome. This sets up the chrome-specific
  20 // logfile naming scheme and might do other things like log modules and
  21 // setting levels in the future.
  22 //
  23 // The main process might want to delete any old log files on startup by
  24 // setting delete_old_log_file, but the renderer processes should not, or
  25 // they will delete each others' logs.
  26 //
  27 // XXX
  28 // Setting suppress_error_dialogs to true disables any dialogs that would
  29 // normally appear for assertions and crashes, and makes any catchable
  30 // errors (namely assertions) available via GetSilencedErrorCount()
  31 // and GetSilencedError().
  32 void InitChromeLogging(const CommandLine& command_line,
  33                        OldFileDeletionState delete_old_log_file);
  34
  35 #if defined(OS_CHROMEOS)
  36 // Get the log file location.
  37 FilePath GetSessionLogFile(const CommandLine& command_line);
  38
  39 // Redirects chrome logging to the appropriate session log dir.
  40 void RedirectChromeLogging(const CommandLine& command_line);
  41 #endif
  42
  43 // Call when done using logging for Chrome.
  44 void CleanupChromeLogging();
  45
  46 // Returns the fully-qualified name of the log file.
  47 FilePath GetLogFileName();
  48
  49 // Returns true when error/assertion dialogs are to be shown,
  50 // false otherwise.
  51 bool DialogsAreSuppressed();
  52
  53 typedef std::vector<std::wstring> AssertionList;
  54
  55 // Gets the list of fatal assertions in the current log file, and
  56 // returns the number of fatal assertions.  (If you don't care
  57 // about the actual list of assertions, you can pass in NULL.)
  58 // NOTE: Since this reads the log file to determine the assertions,
  59 // this operation is O(n) over the length of the log.
  60 // NOTE: This can fail if the file is locked for writing.  However,
  61 // this is unlikely as this function is most useful after
  62 // the program writing the log has terminated.
  63 size_t GetFatalAssertions(AssertionList* assertions);
  64
  65 // Handler to silently dump the current process without crashing.
  66 void DumpWithoutCrashing();
  67
  68 #if defined(USE_LINUX_BREAKPAD) || defined(OS_MACOSX)
  69 // Sets a function that'll be invoked to dump the current process when
  70 // DumpWithoutCrashing() is called.
  71 void SetDumpWithoutCrashingFunction(void (*function)());
  72 #endif
  73
  74 // Inserts timestamp before file extension in the format
  75 // "_yymmdd-hhmmss".
  76 FilePath GenerateTimestampedName(const FilePath& base_path,
  77                                  base::Time timestamp);
  78 }  // namespace logging
  79
  80 #endif  // CHROME_COMMON_LOGGING_CHROME_H_