brettw@chromium.org | 6139182 | 2011-01-01 05:02:16 +0900 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium Authors. All rights reserved. |
license.bot | f003cfe | 2008-08-24 09:55:55 +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. |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 4 | |
| 5 | // This file provides a macro ONLY for use in testing. |
| 6 | // DO NOT USE IN PRODUCTION CODE. There are much better ways to wait. |
| 7 | |
| 8 | // This code is very helpful in testing multi-threaded code, without depending |
| 9 | // on almost any primitives. This is especially helpful if you are testing |
| 10 | // those primitive multi-threaded constructs. |
| 11 | |
| 12 | // We provide a simple one argument spin wait (for 1 second), and a generic |
| 13 | // spin wait (for longer periods of time). |
| 14 | |
brettw@chromium.org | 6139182 | 2011-01-01 05:02:16 +0900 | [diff] [blame] | 15 | #ifndef BASE_SPIN_WAIT_H_ |
| 16 | #define BASE_SPIN_WAIT_H_ |
thakis@chromium.org | 01d1452 | 2010-07-27 08:08:24 +0900 | [diff] [blame] | 17 | #pragma once |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 18 | |
brettw@chromium.org | 6139182 | 2011-01-01 05:02:16 +0900 | [diff] [blame] | 19 | #include "base/threading/platform_thread.h" |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 20 | #include "base/time.h" |
| 21 | |
| 22 | // Provide a macro that will wait no longer than 1 second for an asynchronous |
| 23 | // change is the value of an expression. |
| 24 | // A typical use would be: |
| 25 | // |
| 26 | // SPIN_FOR_1_SECOND_OR_UNTIL_TRUE(0 == f(x)); |
| 27 | // |
| 28 | // The expression will be evaluated repeatedly until it is true, or until |
| 29 | // the time (1 second) expires. |
| 30 | // Since tests generally have a 5 second watch dog timer, this spin loop is |
| 31 | // typically used to get the padding needed on a given test platform to assure |
| 32 | // that the test passes, even if load varies, and external events vary. |
| 33 | |
| 34 | #define SPIN_FOR_1_SECOND_OR_UNTIL_TRUE(expression) \ |
dsh@google.com | 0f8dd26 | 2008-10-28 05:43:33 +0900 | [diff] [blame] | 35 | SPIN_FOR_TIMEDELTA_OR_UNTIL_TRUE(base::TimeDelta::FromSeconds(1), \ |
| 36 | (expression)) |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 37 | |
| 38 | #define SPIN_FOR_TIMEDELTA_OR_UNTIL_TRUE(delta, expression) do { \ |
jar@chromium.org | 25f1e9a | 2010-05-11 01:35:47 +0900 | [diff] [blame] | 39 | base::TimeTicks start = base::TimeTicks::Now(); \ |
dsh@google.com | 0f8dd26 | 2008-10-28 05:43:33 +0900 | [diff] [blame] | 40 | const base::TimeDelta kTimeout = delta; \ |
erg@google.com | bf6ce9f | 2010-01-27 08:08:02 +0900 | [diff] [blame] | 41 | while (!(expression)) { \ |
jar@chromium.org | 25f1e9a | 2010-05-11 01:35:47 +0900 | [diff] [blame] | 42 | if (kTimeout < base::TimeTicks::Now() - start) { \ |
| 43 | EXPECT_LE((base::TimeTicks::Now() - start).InMilliseconds(), \ |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 44 | kTimeout.InMilliseconds()) << "Timed out"; \ |
| 45 | break; \ |
| 46 | } \ |
brettw@chromium.org | 6139182 | 2011-01-01 05:02:16 +0900 | [diff] [blame] | 47 | base::PlatformThread::Sleep(50); \ |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 48 | } \ |
erg@google.com | bf6ce9f | 2010-01-27 08:08:02 +0900 | [diff] [blame] | 49 | } while (0) |
initial.commit | 3f4a732 | 2008-07-27 06:49:38 +0900 | [diff] [blame] | 50 | |
brettw@chromium.org | 6139182 | 2011-01-01 05:02:16 +0900 | [diff] [blame] | 51 | #endif // BASE_SPIN_WAIT_H_ |