summaryrefslogtreecommitdiff
path: root/src/TNetLib/Barrier.cc
blob: 0170e04ef4c8f55d4e5ee2e342f551ae3b439e7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * barrier.c
 *
 * This file implements the "barrier" synchronization construct.
 *
 * A barrier causes threads to wait until a set of threads has
 * all "reached" the barrier. The number of threads required is
 * set when the barrier is initialized, and cannot be changed
 * except by reinitializing.
 *
 * The barrier_init() and barrier_destroy() functions,
 * respectively, allow you to initialize and destroy the
 * barrier.
 *
 * The barrier_wait() function allows a thread to wait for a
 * barrier to be completed. One thread (the one that happens to
 * arrive last) will return from barrier_wait() with the status
 * -1 on success -- others will return with 0. The special
 * status makes it easy for the calling code to cause one thread
 * to do something in a serial region before entering another
 * parallel section of code.
 */
#include <pthread.h>
#include "Error.h"
#include "Barrier.h"

namespace TNet {

/*
 * Initialize a barrier for use.
 */
Barrier::Barrier(int count)
 : threshold_(count), counter_(count), cycle_(0) {

  if(0 != pthread_mutex_init(&mutex_, NULL))
    KALDI_ERR << "Cannot initialize mutex";
  
  if(0 != pthread_cond_init(&cv_, NULL)) {
    pthread_mutex_destroy(&mutex_);
    KALDI_ERR << "Cannot initilize condv";
  }
}

/*
 * Destroy a barrier when done using it.
 */
Barrier::~Barrier() {

  if(0 != pthread_mutex_lock(&mutex_))
    KALDI_ERR << "Cannot lock mutex";

  /*
   * Check whether any threads are known to be waiting; report
   * "BUSY" if so.
   */
  if(counter_ != threshold_) {
    pthread_mutex_unlock (&mutex_);
    KALDI_ERR << "Cannot destroy barrier with waiting thread";
  }

  if(0 != pthread_mutex_unlock(&mutex_))
    KALDI_ERR << "Cannot unlock barrier";

  /*
   * If unable to destroy either 1003.1c synchronization
   * object, halt
   */
  if(0 != pthread_mutex_destroy(&mutex_))
    KALDI_ERR << "Cannot destroy mutex";

  if(0 != pthread_cond_destroy(&cv_)) 
    KALDI_ERR << "Cannot destroy condv";
}


void Barrier::SetThreshold(int thr) {
  if(counter_ != threshold_) 
    KALDI_ERR << "Cannot set threshold, while a thread is waiting";

  threshold_ = thr; counter_ = thr;
}



/*
 * Wait for all members of a barrier to reach the barrier. When
 * the count (of remaining members) reaches 0, broadcast to wake
 * all threads waiting.
 */
int Barrier::Wait() {
  int status, cancel, tmp, cycle;

  if(threshold_ == 0)
    KALDI_ERR << "Cannot wait when Threshold value was not set";

  if(0 != pthread_mutex_lock(&mutex_)) 
    KALDI_ERR << "Cannot lock mutex";

  cycle = cycle_;   /* Remember which cycle we're on */

  if(--counter_ == 0) {
    cycle_ = !cycle_;
    counter_ = threshold_;
    status = pthread_cond_broadcast(&cv_);
    /*
     * The last thread into the barrier will return status
     * -1 rather than 0, so that it can be used to perform
     * some special serial code following the barrier.
     */
    if(status == 0) status = -1;
  } else {
    /*
     * Wait with cancellation disabled, because barrier_wait
     * should not be a cancellation point.
     */
    pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &cancel);

    /*
     * Wait until the barrier's cycle changes, which means
     * that it has been broadcast, and we don't want to wait
     * anymore.
     */
    while (cycle == cycle_) {
      status = pthread_cond_wait(&cv_, &mutex_);
      if (status != 0) break;
    }

    pthread_setcancelstate(cancel, &tmp);
  }
  /*
   * Ignore an error in unlocking. It shouldn't happen, and
   * reporting it here would be misleading -- the barrier wait
   * completed, after all, whereas returning, for example,
   * EINVAL would imply the wait had failed. The next attempt
   * to use the barrier *will* return an error, or hang, due
   * to whatever happened to the mutex.
   */
  pthread_mutex_unlock (&mutex_);
  return status;          /* error, -1 for waker, or 0 */
}


}//namespace TNet