scottbyer@chromium.org | 189aa71 | 2012-07-26 05:36:33 +0900 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 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 BASE_AT_EXIT_H_ |
| 6 | #define BASE_AT_EXIT_H_ |
| 7 | |
| 8 | #include <stack> |
| 9 | |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 10 | #include "base/base_export.h" |
apatrick@chromium.org | 035f4af | 2011-09-07 08:14:47 +0900 | [diff] [blame] | 11 | #include "base/callback.h" |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 12 | #include "base/macros.h" |
brettw@chromium.org | abe477a | 2011-01-21 13:55:52 +0900 | [diff] [blame] | 13 | #include "base/synchronization/lock.h" |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 14 | |
| 15 | namespace base { |
| 16 | |
| 17 | // This class provides a facility similar to the CRT atexit(), except that |
| 18 | // we control when the callbacks are executed. Under Windows for a DLL they |
| 19 | // happen at a really bad time and under the loader lock. This facility is |
| 20 | // mostly used by base::Singleton. |
| 21 | // |
| 22 | // The usage is simple. Early in the main() or WinMain() scope create an |
| 23 | // AtExitManager object on the stack: |
| 24 | // int main(...) { |
| 25 | // base::AtExitManager exit_manager; |
maruel@chromium.org | 8fe7adc | 2009-03-04 00:01:12 +0900 | [diff] [blame] | 26 | // |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 27 | // } |
| 28 | // When the exit_manager object goes out of scope, all the registered |
| 29 | // callbacks and singleton destructors will be called. |
| 30 | |
darin@chromium.org | e585bed | 2011-08-06 00:34:00 +0900 | [diff] [blame] | 31 | class BASE_EXPORT AtExitManager { |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 32 | public: |
deanm@google.com | f6299e7 | 2008-09-08 18:06:51 +0900 | [diff] [blame] | 33 | typedef void (*AtExitCallbackType)(void*); |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 34 | |
| 35 | AtExitManager(); |
| 36 | |
| 37 | // The dtor calls all the registered callbacks. Do not try to register more |
| 38 | // callbacks after this point. |
| 39 | ~AtExitManager(); |
| 40 | |
| 41 | // Registers the specified function to be called at exit. The prototype of |
apatrick@chromium.org | 035f4af | 2011-09-07 08:14:47 +0900 | [diff] [blame] | 42 | // the callback function is void func(void*). |
deanm@google.com | f6299e7 | 2008-09-08 18:06:51 +0900 | [diff] [blame] | 43 | static void RegisterCallback(AtExitCallbackType func, void* param); |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 44 | |
apatrick@chromium.org | 035f4af | 2011-09-07 08:14:47 +0900 | [diff] [blame] | 45 | // Registers the specified task to be called at exit. |
| 46 | static void RegisterTask(base::Closure task); |
| 47 | |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 48 | // Calls the functions registered with RegisterCallback in LIFO order. It |
| 49 | // is possible to register new callbacks after calling this function. |
| 50 | static void ProcessCallbacksNow(); |
| 51 | |
haraken | df522bd | 2017-01-12 16:14:04 +0900 | [diff] [blame] | 52 | // Disable all registered at-exit callbacks. This is used only in a single- |
| 53 | // process mode. |
| 54 | static void DisableAllAtExitManagers(); |
| 55 | |
erg@google.com | d5fffd4 | 2011-01-08 03:06:45 +0900 | [diff] [blame] | 56 | protected: |
| 57 | // This constructor will allow this instance of AtExitManager to be created |
| 58 | // even if one already exists. This should only be used for testing! |
| 59 | // AtExitManagers are kept on a global stack, and it will be removed during |
| 60 | // destruction. This allows you to shadow another AtExitManager. |
| 61 | explicit AtExitManager(bool shadow); |
| 62 | |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 63 | private: |
brettw@chromium.org | abe477a | 2011-01-21 13:55:52 +0900 | [diff] [blame] | 64 | base::Lock lock_; |
apatrick@chromium.org | 035f4af | 2011-09-07 08:14:47 +0900 | [diff] [blame] | 65 | std::stack<base::Closure> stack_; |
amistry | 11fd640 | 2016-02-10 11:18:33 +0900 | [diff] [blame] | 66 | bool processing_callbacks_; |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 67 | AtExitManager* next_manager_; // Stack of managers to allow shadowing. |
| 68 | |
| 69 | DISALLOW_COPY_AND_ASSIGN(AtExitManager); |
| 70 | }; |
| 71 | |
phajdan.jr@chromium.org | e7f133a | 2009-11-19 18:11:39 +0900 | [diff] [blame] | 72 | #if defined(UNIT_TEST) |
| 73 | class ShadowingAtExitManager : public AtExitManager { |
| 74 | public: |
| 75 | ShadowingAtExitManager() : AtExitManager(true) {} |
| 76 | }; |
| 77 | #endif // defined(UNIT_TEST) |
| 78 | |
mmentovai@google.com | aa13be6 | 2008-09-03 03:20:34 +0900 | [diff] [blame] | 79 | } // namespace base |
| 80 | |
| 81 | #endif // BASE_AT_EXIT_H_ |