| // Copyright 2017 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROME_BROWSER_CONFLICTS_MODULE_INSPECTOR_WIN_H_ |
| #define CHROME_BROWSER_CONFLICTS_MODULE_INSPECTOR_WIN_H_ |
| |
| #include "base/callback.h" |
| #include "base/containers/queue.h" |
| #include "base/macros.h" |
| #include "base/memory/scoped_refptr.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/sequence_checker.h" |
| #include "base/task/task_traits.h" |
| #include "chrome/browser/conflicts/module_info_win.h" |
| #include "chrome/services/util_win/public/mojom/util_win.mojom.h" |
| |
| namespace base { |
| class SequencedTaskRunner; |
| } |
| |
| // This class takes care of inspecting several modules (identified by their |
| // ModuleInfoKey) and returning the result via the OnModuleInspectedCallback on |
| // the SequencedTaskRunner where it was created. |
| // |
| // The inspection of all modules is quite expensive in terms of resources, so it |
| // is done one by one, in a task with a background priority level. If needed, it |
| // is possible to increase the priority level of these tasks by calling |
| // IncreaseInspectionPriority(). |
| // |
| // This class is not thread safe and it enforces safety via a SEQUENCE_CHECKER. |
| class ModuleInspector { |
| public: |
| using OnModuleInspectedCallback = |
| base::Callback<void(const ModuleInfoKey& module_key, |
| ModuleInspectionResult inspection_result)>; |
| |
| explicit ModuleInspector( |
| const OnModuleInspectedCallback& on_module_inspected_callback); |
| ~ModuleInspector(); |
| |
| // Adds the module to the queue of modules to inspect. Starts the inspection |
| // process if the |queue_| is empty. |
| void AddModule(const ModuleInfoKey& module_key); |
| |
| // Removes the throttling. |
| void IncreaseInspectionPriority(); |
| |
| // Returns true if ModuleInspector is not doing anything right now. |
| bool IsIdle(); |
| |
| private: |
| // Invoked when Chrome has finished starting up to initiate the inspection of |
| // queued modules. |
| void OnStartupFinished(); |
| |
| // Handles a connection error to the UtilWin service. |
| void OnUtilWinServiceConnectionError(); |
| |
| // Starts inspecting the module at the front of the queue. |
| void StartInspectingModule(); |
| |
| // Called back on the execution context on which the ModuleInspector was |
| // created when a module has finished being inspected. The callback will be |
| // executed and, if the |queue_| is not empty, the next module will be sent |
| // for inspection. |
| void OnInspectionFinished(const ModuleInfoKey& module_key, |
| ModuleInspectionResult inspection_result); |
| |
| OnModuleInspectedCallback on_module_inspected_callback_; |
| |
| // The modules are put in queue until they are sent for inspection. |
| base::queue<ModuleInfoKey> queue_; |
| |
| // Indicates if Chrome has finished starting up. Used to delay the background |
| // inspection tasks in order to not negatively impact startup performance. |
| bool is_after_startup_; |
| |
| // A pointer to the UtilWin service. Only used if the WinOOPInspectModule |
| // feature is enabled. It is created when inspection is ongoing, and freed |
| // when no longer needed. |
| chrome::mojom::UtilWinPtr util_win_ptr_; |
| |
| // The task runner where module inspections takes place. It originally starts |
| // at BEST_EFFORT priority, but is changed to USER_VISIBLE when |
| // IncreaseInspectionPriority() is called. |
| scoped_refptr<base::SequencedTaskRunner> task_runner_; |
| |
| // The vector of paths to %env_var%, used to account for differences in |
| // localization and where people keep their files. |
| // e.g. c:\windows vs d:\windows |
| StringMapping path_mapping_; |
| |
| // The number of time this class will try to restart the UtilWin service if a |
| // connection error occurs. This is to prevent the degenerate case where the |
| // service always fails to start and the restart cycle happens infinitely. |
| int connection_error_retry_count_; |
| |
| SEQUENCE_CHECKER(sequence_checker_); |
| |
| // Weak pointers are used to safely post the inspection result back to the |
| // ModuleInspector from the task scheduler. |
| base::WeakPtrFactory<ModuleInspector> weak_ptr_factory_; |
| |
| DISALLOW_COPY_AND_ASSIGN(ModuleInspector); |
| }; |
| |
| #endif // CHROME_BROWSER_CONFLICTS_MODULE_INSPECTOR_WIN_H_ |