File: breakpad_utils.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (90 lines) | stat: -rw-r--r-- 3,043 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef REMOTING_BASE_CRASH_BREAKPAD_UTILS_H_
#define REMOTING_BASE_CRASH_BREAKPAD_UTILS_H_

#include <atomic>
#include <memory>
#include <string>

#include "base/files/file_path.h"
#include "base/process/process_handle.h"
#include "base/threading/thread_restrictions.h"
#include "base/time/time.h"
#include "base/values.h"

#if BUILDFLAG(IS_WIN)
#include "base/win/scoped_handle.h"
#endif

namespace remoting {

// base::Value keys used in multiple crash components.
extern const char kBreakpadProductVersionKey[];
extern const char kBreakpadProcessStartTimeKey[];
extern const char kBreakpadProcessIdKey[];
extern const char kBreakpadProcessNameKey[];
extern const char kBreakpadProcessUptimeKey[];

// Returns the path to the directory to use when generating or processing
// minidumps. Does not attempt to create the directory or check R/W permissions.
extern base::FilePath GetMinidumpDirectoryPath();

extern bool CreateMinidumpDirectoryIfNeeded(
    const base::FilePath& minidump_directory);

extern bool WriteMetadataForMinidump(const base::FilePath& minidump_file_path,
                                     base::Value::Dict custom_client_info);

#if BUILDFLAG(IS_WIN)

// The name of the pipe to use for OOP crash reporting.
extern const wchar_t kCrashServerPipeName[];

base::win::ScopedHandle GetClientHandleForCrashServerPipe();
#endif  // BUILDFLAG(IS_WIN)

// Helper for generating and uploading minidumps.
class BreakpadHelper {
 public:
  BreakpadHelper();

  BreakpadHelper(const BreakpadHelper&) = delete;
  BreakpadHelper& operator=(const BreakpadHelper&) = delete;

  ~BreakpadHelper();

  // Configures the instance for handling minidumps, must be called before
  // |OnMinidumpGenerated|.
  bool Initialize(const base::FilePath& minidump_directory);

  // Called in the Breakpad client's filter callback, this function is used to
  // ensure multiple threads do not report an exception concurrently.
  void OnException();

  // Prepares a newly generated minidump for upload. Will block when writing
  // the upload metadata file.
  bool OnMinidumpGenerated(const base::FilePath& minidump_file_path);

 private:
  // Indicates whether an exception is already being handled.
  std::atomic<bool> handling_exception_{false};

  // Indicates whether the instance is ready to begin handling minidumps.
  bool initialized_ = false;

  // ID of the current process.
  base::ProcessId process_id_ = base::GetCurrentProcId();
  // Path and name of the executable for the current process.
  base::FilePath process_name_;
  // The BreakpadHelper singleton is created soon after the process has started,
  // this means the time the singleton was created can be used as a cheap
  // approximation for the time the process actually started.
  base::Time process_start_time_ = base::Time::NowFromSystemTime();
};

}  // namespace remoting

#endif  // REMOTING_BASE_CRASH_BREAKPAD_UTILS_H_