bslmt_semaphoreimpl_darwin.h

Go to the documentation of this file.

/// @file bslmt_semaphoreimpl_darwin.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bslmt_semaphoreimpl_darwin.h                                       -*-C++-*-
#ifndef INCLUDED_BSLMT_SEMAPHOREIMPL_DARWIN
#define INCLUDED_BSLMT_SEMAPHOREIMPL_DARWIN
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bslmt_semaphoreimpl_darwin bslmt_semaphoreimpl_darwin
/// @brief  Provide a Darwin implementation of `bslmt::Semaphore`.
/// @addtogroup bsl
/// @{
/// @addtogroup bslmt
/// @{
/// @addtogroup bslmt_semaphoreimpl_darwin
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bslmt_semaphoreimpl_darwin-purpose"> Purpose</a>
/// * <a href="#bslmt_semaphoreimpl_darwin-classes"> Classes </a>
/// * <a href="#bslmt_semaphoreimpl_darwin-description"> Description </a>
///   * <a href="#bslmt_semaphoreimpl_darwin-usage"> Usage </a>
///
/// # Purpose {#bslmt_semaphoreimpl_darwin-purpose}
/// Provide a Darwin implementation of `bslmt::Semaphore`.
///
/// # Classes {#bslmt_semaphoreimpl_darwin-classes}
///
/// -  bslmt::SemaphoreImpl<DarwinSemaphore>: semaphore specialization for Darwin
///
/// @see  bslmt_semaphore
///
/// # Description {#bslmt_semaphoreimpl_darwin-description}
/// This component provides an implementation of `bslmt::Semaphore`
/// for POSIX threads ("pthreads") according to the POSIX support on Darwin
/// platform, `bslmt::SemaphoreImpl<DarwinSemaphore>`, via the template
/// specialization:
/// @code
/// bslmt::SemaphoreImpl<Platform::DarwinSemaphore>
/// @endcode
/// This template class should not be used (directly) by client code.  Clients
/// should instead use `bslmt::Semaphore`.
///
/// ## Usage {#bslmt_semaphoreimpl_darwin-usage}
///
///
/// This component is an implementation detail of `bslmt` and is *not* intended
/// for direct client use.  It is subject to change without notice.  As such, a
/// usage example is not provided.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bsl
 * @{
 */
/** @addtogroup bslmt
 * @{
 */
/** @addtogroup bslmt_semaphoreimpl_darwin
 * @{
 */
 
#include <bslscm_version.h>
 
#include <bsls_assert.h>
#include <bsls_platform.h>
 
#include <bslmt_platform.h>
 
#ifdef BSLS_PLATFORM_OS_DARWIN
#include <semaphore.h>
 
 
namespace bslmt {
 
template <class SEMAPHORE_POLICY>
class SemaphoreImpl;
 
              // ==============================================
              // class SemaphoreImpl<Platform::DarwinSemaphore>
              // ==============================================
 
/// This class provides a full specialization of `SemaphoreImpl` for
/// pthreads on Darwin.  The implementation provided here defines an
/// efficient proxy for the `sem_t` pthread type, and related operations.
template <>
class SemaphoreImpl<Platform::DarwinSemaphore> {
 
    // DATA
    sem_t             *d_sem_p;           // pointer to native semaphore handle
    static const char *s_semaphorePrefix; // prefix for a unique semaphore name
 
  private:
    // NOT IMPLEMENTED
    SemaphoreImpl(const SemaphoreImpl&);
    SemaphoreImpl& operator=(const SemaphoreImpl&);
 
  public:
    // CREATORS
 
    /// Create a semaphore initialized to the specified `count`.  This
    /// method does not return normally unless there are sufficient system
    /// resources to construct the object.
    SemaphoreImpl(int count);
 
    /// Destroy a semaphore
    ~SemaphoreImpl();
 
    // MANIPULATORS
 
    /// Atomically increment the count of this semaphore.
    void post();
 
    /// Atomically increment the count of this semaphore by the specified `number`.  
    /// 
    /// \pre The behavior is undefined   unless `number > 0`.
    void post(int number);
 
    /// Decrement the count of this semaphore if it is positive and return
    /// 0.  Return a non-zero value otherwise.
    int tryWait();
 
    /// Block until the count of this semaphore is a positive value and
    /// atomically decrement it.
    void wait();
 
    // ACCESSORS
 
    /// Return the current value of this semaphore.
    int getValue() const;
};
 
// ============================================================================
//                             INLINE DEFINITIONS
// ============================================================================
 
              // ----------------------------------------------
              // class SemaphoreImpl<Platform::DarwinSemaphore>
              // ----------------------------------------------
 
// CREATORS
inline
SemaphoreImpl<bslmt::Platform::DarwinSemaphore>::~SemaphoreImpl()
{
    int result = ::sem_close(d_sem_p);
 
    (void) result;
    BSLS_ASSERT(result == 0);
}
 
// MANIPULATORS
inline
void SemaphoreImpl<bslmt::Platform::DarwinSemaphore>::post()
{
    int result = ::sem_post(d_sem_p);
 
    (void) result;
    BSLS_ASSERT(result == 0);
}
 
inline
int SemaphoreImpl<bslmt::Platform::DarwinSemaphore>::tryWait()
{
    return ::sem_trywait(d_sem_p);
 
}
 
// ACCESSORS
inline
int SemaphoreImpl<bslmt::Platform::DarwinSemaphore>::getValue() const
{
    // Not implemented on Darwin, but sem_getvalue still returns success.
    BSLS_ASSERT_UNREACHABLE(
          "`sem_getvalue` is optional in POSIX and not implemented on Darwin");
    return 0;
}
 
}  // close package namespace
 
 
#endif  // BSLS_PLATFORM_OS_DARWIN
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2023 Bloomberg Finance L.P.
//
// 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.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */