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