YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

// Licensed to the Apache Software Foundation (ASF) under one

// or more contributor license agreements.  See the NOTICE file

// distributed with this work for additional information

// regarding copyright ownership.  The ASF licenses this file

// to you under the Apache License, Version 2.0 (the

// "License"); you may not use this file except in compliance

// with the License.  You may obtain a copy of the License at

//

//   http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing,

// software distributed under the License is distributed on an

// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

// KIND, either express or implied.  See the License for the

// specific language governing permissions and limitations

// under the License.

//

// The following only applies to changes made to this file as part of YugaByte development.

//

// Portions Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

// Utility functions which are handy when doing async/callback-based programming.

#ifndef YB_UTIL_ASYNC_UTIL_H

#define YB_UTIL_ASYNC_UTIL_H

#include <pthread.h>

#include <future>

#include <boost/function.hpp>

#include "yb/gutil/macros.h"

#include "yb/util/monotime.h"

#include "yb/util/status.h"

#include "yb/util/status_callback.h"

namespace yb {

typedef boost::function<void(const Status&)> StatusFunctor;

// Simple class which can be used to make async methods synchronous.

// For example:

//   Synchronizer s;

//   SomeAsyncMethod(s.callback());

//   CHECK_OK(s.Wait());

class Synchronizer {

 public:

  Synchronizer(const Synchronizer&) = delete;

  void operator=(const Synchronizer&) = delete;

  Synchronizer() {}

  ~Synchronizer();

  void StatusCB(const Status& status);

  // Use this for synchronizers declared on the stack. The callback does not take a reference to

  // its synchronizer, so the returned callback _must_ go out of scope before its synchronizer.

  StatusCallback AsStatusCallback();

  // Same semantics as AsStatusCallback.

  StdStatusCallback AsStdStatusCallback();

  // This version of AsStatusCallback is for cases when the callback can outlive the synchronizer.

  // The callback holds a weak pointer to the synchronizer.

  static StatusCallback AsStatusCallback(const std::shared_ptr<Synchronizer>& synchronizer);

  StatusFunctor AsStatusFunctor() {

    return std::bind(&Synchronizer::StatusCB, this, std::placeholders::_1);

  }

  CHECKED_STATUS Wait() {

    return WaitUntil(std::chrono::steady_clock::time_point::max());

  }

  CHECKED_STATUS WaitFor(const MonoDelta& delta) {

    return WaitUntil(std::chrono::steady_clock::now() + delta.ToSteadyDuration());

  }

  CHECKED_STATUS WaitUntil(const std::chrono::steady_clock::time_point& time);

  void Reset();

 private:

  // Invoked in the destructor and in Reset() to make sure Wait() was invoked if it had to be.

  void EnsureWaitDone();

  std::mutex mutex_;

  std::condition_variable cond_;

  bool assigned_ = false;

  // If we've created a callback and given it out to an asynchronous operation, we must call Wait()

  // on the synchronizer before destroying it. Not doing any locking around this variable because

  // Wait() is supposed to be called on the same thread as AsStatusCallback(), or with adequate

  // synchronization after that. Most frequently Wait() is called right after creating the

  // synchronizer.

  bool must_wait_ = false;

  Status status_;

};

// Functor is any functor that accepts callback as only argument.

template <class Result, class Functor>

std::future<Result> MakeFuture(const Functor& functor) {

  auto promise = std::make_shared<std::promise<Result>>();

  auto future = promise->get_future();

  functor([promise](Result result) {

    promise->set_value(std::move(result));

  });

client.cc:_ZZN2yb10MakeFutureINS_6ResultINSt3__110shared_ptrIKNS_6client27VersionedTablePartitionListEEEEEZNS4_12_GLOBAL__N_121FetchPartitionsFutureEPNS4_8YBClientERKNS2_12basic_stringIcNS2_11char_traitsIcEENS2_9allocatorIcEEEEE3$_5EENS2_6futureIT_EERKT0_ENKUlS8_E_clES8_

Line

Count

Source

118

85.4k

  functor([promise](Result result) {

119

85.4k

    promise->set_value(std::move(result));

120

85.4k

  });

Unexecuted instantiation: client.cc:_ZZN2yb10MakeFutureINS_6ResultINSt3__16vectorI13scoped_refptrINS_6client8internal12RemoteTabletEENS2_9allocatorIS8_EEEEEEZNS5_8YBClient22LookupAllTabletsFutureERKNS2_10shared_ptrIKNS5_7YBTableEEENS2_6chrono10time_pointINS_15CoarseMonoClockENSK_8durationIxNS2_5ratioILl1ELl1000000000EEEEEEEE3$_4EENS2_6futureIT_EERKT0_ENKUlSC_E_clESC_

Unexecuted instantiation: meta_cache.cc:_ZZN2yb10MakeFutureINS_6ResultI13scoped_refptrINS_6client8internal12RemoteTabletEEEEZNS4_9MetaCache23LookupTabletByKeyFutureERKNSt3__110shared_ptrINS3_7YBTableEEERKNS9_12basic_stringIcNS9_11char_traitsIcEENS9_9allocatorIcEEEENS9_6chrono10time_pointINS_15CoarseMonoClockENSN_8durationIxNS9_5ratioILl1ELl1000000000EEEEEEEE3$_5EENS9_6futureIT_EERKT0_ENKUlS7_E_clES7_

transaction.cc:_ZZN2yb10MakeFutureINS_6StatusEZNS_6client13YBTransaction12CommitFutureENSt3__16chrono10time_pointINS_15CoarseMonoClockENS5_8durationIxNS4_5ratioILl1ELl1000000000EEEEEEENS_17StronglyTypedBoolINS2_12SealOnly_TagEEEE3$_0EENS4_6futureIT_EERKT0_ENKUlS1_E_clES1_

Line

Count

Source

118

78.6k

  functor([promise](Result result) {

119

78.6k

    promise->set_value(std::move(result));

120

78.6k

  });

transaction.cc:_ZZN2yb10MakeFutureINS_6ResultINS_22ChildTransactionDataPBEEEZNS_6client13YBTransaction18PrepareChildFutureENS_17StronglyTypedBoolINS4_23ForceConsistentRead_TagEEENSt3__16chrono10time_pointINS_15CoarseMonoClockENSA_8durationIxNS9_5ratioILl1ELl1000000000EEEEEEEE3$_1EENS9_6futureIT_EERKT0_ENKUlS3_E_clES3_

Line

Count

Source

118

82.4k

  functor([promise](Result result) {

119

82.4k

    promise->set_value(std::move(result));

120

82.4k

  });

  return future;

}

client.cc:_ZN2yb10MakeFutureINS_6ResultINSt3__110shared_ptrIKNS_6client27VersionedTablePartitionListEEEEEZNS4_12_GLOBAL__N_121FetchPartitionsFutureEPNS4_8YBClientERKNS2_12basic_stringIcNS2_11char_traitsIcEENS2_9allocatorIcEEEEE3$_5EENS2_6futureIT_EERKT0_

Line

Count

Source

115

85.4k

std::future<Result> MakeFuture(const Functor& functor) {

116

85.4k

  auto promise = std::make_shared<std::promise<Result>>();

117

85.4k

  auto future = promise->get_future();

118

85.4k

  functor([promise](Result result) {

119

85.4k

    promise->set_value(std::move(result));

120

85.4k

  });

121

85.4k

  return future;

122

85.4k

}

Unexecuted instantiation: client.cc:_ZN2yb10MakeFutureINS_6ResultINSt3__16vectorI13scoped_refptrINS_6client8internal12RemoteTabletEENS2_9allocatorIS8_EEEEEEZNS5_8YBClient22LookupAllTabletsFutureERKNS2_10shared_ptrIKNS5_7YBTableEEENS2_6chrono10time_pointINS_15CoarseMonoClockENSK_8durationIxNS2_5ratioILl1ELl1000000000EEEEEEEE3$_4EENS2_6futureIT_EERKT0_

Unexecuted instantiation: meta_cache.cc:_ZN2yb10MakeFutureINS_6ResultI13scoped_refptrINS_6client8internal12RemoteTabletEEEEZNS4_9MetaCache23LookupTabletByKeyFutureERKNSt3__110shared_ptrINS3_7YBTableEEERKNS9_12basic_stringIcNS9_11char_traitsIcEENS9_9allocatorIcEEEENS9_6chrono10time_pointINS_15CoarseMonoClockENSN_8durationIxNS9_5ratioILl1ELl1000000000EEEEEEEE3$_5EENS9_6futureIT_EERKT0_

transaction.cc:_ZN2yb10MakeFutureINS_6StatusEZNS_6client13YBTransaction12CommitFutureENSt3__16chrono10time_pointINS_15CoarseMonoClockENS5_8durationIxNS4_5ratioILl1ELl1000000000EEEEEEENS_17StronglyTypedBoolINS2_12SealOnly_TagEEEE3$_0EENS4_6futureIT_EERKT0_

Line

Count

Source

115

78.6k

std::future<Result> MakeFuture(const Functor& functor) {

116

78.6k

  auto promise = std::make_shared<std::promise<Result>>();

117

78.6k

  auto future = promise->get_future();

118

78.6k

  functor([promise](Result result) {

119

78.6k

    promise->set_value(std::move(result));

120

78.6k

  });

121

78.6k

  return future;

122

78.6k

}

transaction.cc:_ZN2yb10MakeFutureINS_6ResultINS_22ChildTransactionDataPBEEEZNS_6client13YBTransaction18PrepareChildFutureENS_17StronglyTypedBoolINS4_23ForceConsistentRead_TagEEENSt3__16chrono10time_pointINS_15CoarseMonoClockENSA_8durationIxNS9_5ratioILl1ELl1000000000EEEEEEEE3$_1EENS9_6futureIT_EERKT0_

Line

Count

Source

115

82.3k

std::future<Result> MakeFuture(const Functor& functor) {

116

82.3k

  auto promise = std::make_shared<std::promise<Result>>();

117

82.3k

  auto future = promise->get_future();

118

82.3k

  functor([promise](Result result) {

119

82.3k

    promise->set_value(std::move(result));

120

82.3k

  });

121

82.3k

  return future;

122

82.3k

}

template <class T>

bool IsReady(const std::shared_future<T>& f) {

  return f.wait_for(std::chrono::seconds(0)) == std::future_status::ready;

}

Unexecuted instantiation: _ZN2yb7IsReadyINS_6ResultINS_19TransactionMetadataEEEEEbRKNSt3__113shared_futureIT_EE

Unexecuted instantiation: _ZN2yb7IsReadyINS_6client11FlushStatusEEEbRKNSt3__113shared_futureIT_EE

Unexecuted instantiation: _ZN2yb7IsReadyINS_6StatusEEEbRKNSt3__113shared_futureIT_EE

template <class T>

bool IsReady(const std::future<T>& f) {

  return f.wait_for(std::chrono::seconds(0)) == std::future_status::ready;

}

Unexecuted instantiation: _ZN2yb7IsReadyINS_6client11FlushStatusEEEbRKNSt3__16futureIT_EE

Unexecuted instantiation: _ZN2yb7IsReadyINS_6StatusEEEbRKNSt3__16futureIT_EE

} // namespace yb

#endif /* YB_UTIL_ASYNC_UTIL_H */