1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker * Copyright (C) 2012 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker *
4*4d7e907cSAndroid Build Coastguard Worker * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker *
8*4d7e907cSAndroid Build Coastguard Worker * http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker *
10*4d7e907cSAndroid Build Coastguard Worker * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker */
16*4d7e907cSAndroid Build Coastguard Worker
17*4d7e907cSAndroid Build Coastguard Worker /*
18*4d7e907cSAndroid Build Coastguard Worker * Encapsulate a condition variable for thread synchronization.
19*4d7e907cSAndroid Build Coastguard Worker */
20*4d7e907cSAndroid Build Coastguard Worker
21*4d7e907cSAndroid Build Coastguard Worker #include "CondVar.h"
22*4d7e907cSAndroid Build Coastguard Worker
23*4d7e907cSAndroid Build Coastguard Worker #include <android-base/logging.h>
24*4d7e907cSAndroid Build Coastguard Worker #include <android-base/stringprintf.h>
25*4d7e907cSAndroid Build Coastguard Worker #include <errno.h>
26*4d7e907cSAndroid Build Coastguard Worker #include <string.h>
27*4d7e907cSAndroid Build Coastguard Worker
28*4d7e907cSAndroid Build Coastguard Worker using android::base::StringPrintf;
29*4d7e907cSAndroid Build Coastguard Worker
30*4d7e907cSAndroid Build Coastguard Worker /*******************************************************************************
31*4d7e907cSAndroid Build Coastguard Worker **
32*4d7e907cSAndroid Build Coastguard Worker ** Function: CondVar
33*4d7e907cSAndroid Build Coastguard Worker **
34*4d7e907cSAndroid Build Coastguard Worker ** Description: Initialize member variables.
35*4d7e907cSAndroid Build Coastguard Worker **
36*4d7e907cSAndroid Build Coastguard Worker ** Returns: None.
37*4d7e907cSAndroid Build Coastguard Worker **
38*4d7e907cSAndroid Build Coastguard Worker *******************************************************************************/
CondVar()39*4d7e907cSAndroid Build Coastguard Worker CondVar::CondVar() {
40*4d7e907cSAndroid Build Coastguard Worker pthread_condattr_t attr;
41*4d7e907cSAndroid Build Coastguard Worker pthread_condattr_init(&attr);
42*4d7e907cSAndroid Build Coastguard Worker pthread_condattr_setclock(&attr, CLOCK_MONOTONIC);
43*4d7e907cSAndroid Build Coastguard Worker memset(&mCondition, 0, sizeof(mCondition));
44*4d7e907cSAndroid Build Coastguard Worker int const res = pthread_cond_init(&mCondition, &attr);
45*4d7e907cSAndroid Build Coastguard Worker if (res) {
46*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::CondVar: fail init; error=0x%X", res);
47*4d7e907cSAndroid Build Coastguard Worker }
48*4d7e907cSAndroid Build Coastguard Worker }
49*4d7e907cSAndroid Build Coastguard Worker
50*4d7e907cSAndroid Build Coastguard Worker /*******************************************************************************
51*4d7e907cSAndroid Build Coastguard Worker **
52*4d7e907cSAndroid Build Coastguard Worker ** Function: ~CondVar
53*4d7e907cSAndroid Build Coastguard Worker **
54*4d7e907cSAndroid Build Coastguard Worker ** Description: Cleanup all resources.
55*4d7e907cSAndroid Build Coastguard Worker **
56*4d7e907cSAndroid Build Coastguard Worker ** Returns: None.
57*4d7e907cSAndroid Build Coastguard Worker **
58*4d7e907cSAndroid Build Coastguard Worker *******************************************************************************/
~CondVar()59*4d7e907cSAndroid Build Coastguard Worker CondVar::~CondVar() {
60*4d7e907cSAndroid Build Coastguard Worker int const res = pthread_cond_destroy(&mCondition);
61*4d7e907cSAndroid Build Coastguard Worker if (res) {
62*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::~CondVar: fail destroy; error=0x%X", res);
63*4d7e907cSAndroid Build Coastguard Worker }
64*4d7e907cSAndroid Build Coastguard Worker }
65*4d7e907cSAndroid Build Coastguard Worker
66*4d7e907cSAndroid Build Coastguard Worker /*******************************************************************************
67*4d7e907cSAndroid Build Coastguard Worker **
68*4d7e907cSAndroid Build Coastguard Worker ** Function: wait
69*4d7e907cSAndroid Build Coastguard Worker **
70*4d7e907cSAndroid Build Coastguard Worker ** Description: Block the caller and wait for a condition.
71*4d7e907cSAndroid Build Coastguard Worker **
72*4d7e907cSAndroid Build Coastguard Worker ** Returns: None.
73*4d7e907cSAndroid Build Coastguard Worker **
74*4d7e907cSAndroid Build Coastguard Worker *******************************************************************************/
wait(std::mutex & mutex)75*4d7e907cSAndroid Build Coastguard Worker void CondVar::wait(std::mutex& mutex) {
76*4d7e907cSAndroid Build Coastguard Worker int const res = pthread_cond_wait(&mCondition, mutex.native_handle());
77*4d7e907cSAndroid Build Coastguard Worker if (res) {
78*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::wait: fail wait; error=0x%X", res);
79*4d7e907cSAndroid Build Coastguard Worker }
80*4d7e907cSAndroid Build Coastguard Worker }
81*4d7e907cSAndroid Build Coastguard Worker
82*4d7e907cSAndroid Build Coastguard Worker /*******************************************************************************
83*4d7e907cSAndroid Build Coastguard Worker **
84*4d7e907cSAndroid Build Coastguard Worker ** Function: wait
85*4d7e907cSAndroid Build Coastguard Worker **
86*4d7e907cSAndroid Build Coastguard Worker ** Description: Block the caller and wait for a condition.
87*4d7e907cSAndroid Build Coastguard Worker ** millisec: Timeout in milliseconds.
88*4d7e907cSAndroid Build Coastguard Worker **
89*4d7e907cSAndroid Build Coastguard Worker ** Returns: True if wait is successful; false if timeout occurs.
90*4d7e907cSAndroid Build Coastguard Worker **
91*4d7e907cSAndroid Build Coastguard Worker *******************************************************************************/
wait(std::mutex & mutex,long millisec)92*4d7e907cSAndroid Build Coastguard Worker bool CondVar::wait(std::mutex& mutex, long millisec) {
93*4d7e907cSAndroid Build Coastguard Worker bool retVal = false;
94*4d7e907cSAndroid Build Coastguard Worker struct timespec absoluteTime;
95*4d7e907cSAndroid Build Coastguard Worker
96*4d7e907cSAndroid Build Coastguard Worker if (clock_gettime(CLOCK_MONOTONIC, &absoluteTime) == -1) {
97*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::wait: fail get time; errno=0x%X", errno);
98*4d7e907cSAndroid Build Coastguard Worker } else {
99*4d7e907cSAndroid Build Coastguard Worker absoluteTime.tv_sec += millisec / 1000;
100*4d7e907cSAndroid Build Coastguard Worker long ns = absoluteTime.tv_nsec + ((millisec % 1000) * 1000000);
101*4d7e907cSAndroid Build Coastguard Worker if (ns > 1000000000) {
102*4d7e907cSAndroid Build Coastguard Worker absoluteTime.tv_sec++;
103*4d7e907cSAndroid Build Coastguard Worker absoluteTime.tv_nsec = ns - 1000000000;
104*4d7e907cSAndroid Build Coastguard Worker } else
105*4d7e907cSAndroid Build Coastguard Worker absoluteTime.tv_nsec = ns;
106*4d7e907cSAndroid Build Coastguard Worker }
107*4d7e907cSAndroid Build Coastguard Worker
108*4d7e907cSAndroid Build Coastguard Worker int waitResult = pthread_cond_timedwait(&mCondition, mutex.native_handle(), &absoluteTime);
109*4d7e907cSAndroid Build Coastguard Worker if ((waitResult != 0) && (waitResult != ETIMEDOUT))
110*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::wait: fail timed wait; error=0x%X", waitResult);
111*4d7e907cSAndroid Build Coastguard Worker retVal = (waitResult == 0); // waited successfully
112*4d7e907cSAndroid Build Coastguard Worker return retVal;
113*4d7e907cSAndroid Build Coastguard Worker }
114*4d7e907cSAndroid Build Coastguard Worker
115*4d7e907cSAndroid Build Coastguard Worker /*******************************************************************************
116*4d7e907cSAndroid Build Coastguard Worker **
117*4d7e907cSAndroid Build Coastguard Worker ** Function: notifyOne
118*4d7e907cSAndroid Build Coastguard Worker **
119*4d7e907cSAndroid Build Coastguard Worker ** Description: Unblock the waiting thread.
120*4d7e907cSAndroid Build Coastguard Worker **
121*4d7e907cSAndroid Build Coastguard Worker ** Returns: None.
122*4d7e907cSAndroid Build Coastguard Worker **
123*4d7e907cSAndroid Build Coastguard Worker *******************************************************************************/
notifyOne()124*4d7e907cSAndroid Build Coastguard Worker void CondVar::notifyOne() {
125*4d7e907cSAndroid Build Coastguard Worker int const res = pthread_cond_signal(&mCondition);
126*4d7e907cSAndroid Build Coastguard Worker if (res) {
127*4d7e907cSAndroid Build Coastguard Worker LOG(ERROR) << StringPrintf("CondVar::notifyOne: fail signal; error=0x%X", res);
128*4d7e907cSAndroid Build Coastguard Worker }
129*4d7e907cSAndroid Build Coastguard Worker }
130