Home | History | Annotate | Download | only in platform
      1 /* Copyright 2015 The TensorFlow Authors. All Rights Reserved.
      2 
      3 Licensed under the Apache License, Version 2.0 (the "License");
      4 you may not use this file except in compliance with the License.
      5 You may obtain a copy of the License at
      6 
      7     http://www.apache.org/licenses/LICENSE-2.0
      8 
      9 Unless required by applicable law or agreed to in writing, software
     10 distributed under the License is distributed on an "AS IS" BASIS,
     11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 See the License for the specific language governing permissions and
     13 limitations under the License.
     14 ==============================================================================*/
     15 
     16 #ifndef TENSORFLOW_PLATFORM_MUTEX_H_
     17 #define TENSORFLOW_PLATFORM_MUTEX_H_
     18 
     19 #include "tensorflow/core/platform/platform.h"
     20 #include "tensorflow/core/platform/types.h"
     21 
     22 namespace tensorflow {
     23 enum ConditionResult { kCond_Timeout, kCond_MaybeNotified };
     24 }  // namespace tensorflow
     25 
     26 // Include appropriate platform-dependent implementations of mutex etc.
     27 #if defined(PLATFORM_GOOGLE)
     28 #include "tensorflow/core/platform/google/mutex.h"
     29 #elif defined(PLATFORM_POSIX) || defined(PLATFORM_POSIX_ANDROID) || \
     30     defined(PLATFORM_GOOGLE_ANDROID) || defined(PLATFORM_WINDOWS)
     31 #include "tensorflow/core/platform/default/mutex.h"
     32 #else
     33 #error Define the appropriate PLATFORM_<foo> macro for this platform
     34 #endif
     35 
     36 // The mutex library included above defines:
     37 //   class mutex;
     38 //   class mutex_lock;
     39 //   class condition_variable;
     40 // It also defines the following:
     41 
     42 namespace tensorflow {
     43 
     44 // Like "cv->wait(*mu)", except that it only waits for up to "ms" milliseconds.
     45 //
     46 // Returns kCond_Timeout if the timeout expired without this
     47 // thread noticing a signal on the condition variable.  Otherwise may
     48 // return either kCond_Timeout or kCond_MaybeNotified
     49 ConditionResult WaitForMilliseconds(mutex_lock* mu, condition_variable* cv,
     50                                     int64 ms);
     51 }  // namespace tensorflow
     52 
     53 #endif  // TENSORFLOW_PLATFORM_MUTEX_H_
     54