task_context.h

/*
 * Copyright (c) 2014-2016, Siemens AG. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EMBB_MTAPI_TASK_CONTEXT_H_
#define EMBB_MTAPI_TASK_CONTEXT_H_

#include <embb/mtapi/c/mtapi.h>
#include <embb/mtapi/internal/check_status.h>

namespace embb {
namespace mtapi {

/**
 * Provides information about the status of the currently running Task.
 *
 * \ingroup CPP_MTAPI
 */
class TaskContext {
 public:
  /**
   * Constructs a TaskContext from the given C representation.
   */
  explicit TaskContext(
    mtapi_task_context_t * task_context
                                       /**< The C task context to wrap. */
    )
    : context_(task_context) {
    // empty
  }

  /**
   * Queries whether the Task running in the TaskContext should finish.
   * \return \c true if the Task should finish, otherwise \c false
   * \notthreadsafe
   */
  bool ShouldCancel() {
    return MTAPI_TASK_CANCELLED == GetTaskState();
  }

  /**
   * Queries the current Task state.
   * \return The current Task state.
   * \notthreadsafe
   */
  mtapi_task_state_t GetTaskState() {
    mtapi_status_t status;
    mtapi_task_state_t result =
      mtapi_context_taskstate_get(context_, &status);
    internal::CheckStatus(status);
    return result;
  }

  /**
   * Queries the index of the worker thread the Task is running on.
   * \return The worker thread index the Task is running on
   * \notthreadsafe
   */
  mtapi_uint_t GetCurrentWorkerNumber() {
    mtapi_status_t status;
    mtapi_uint_t result = mtapi_context_corenum_get(context_, &status);
    internal::CheckStatus(status);
    return result;
  }

  /**
   * Queries the current instance of the currently executing Task.
   * \return The current instance number
   * \notthreadsafe
   */
  mtapi_uint_t GetInstanceNumber() {
    mtapi_status_t status;
    mtapi_uint_t result = mtapi_context_instnum_get(context_, &status);
    internal::CheckStatus(status);
    return result;
  }

  /**
   * Queries the number of instances of the currently executing Task.
   * \return The number of instances
   * \notthreadsafe
   */
  mtapi_uint_t GetNumberOfInstances() {
    mtapi_status_t status;
    mtapi_uint_t result = mtapi_context_numinst_get(context_, &status);
    internal::CheckStatus(status);
    return result;
  }

  /**
   * Sets the return status of the running Task. This will be returned by
   * Task::Wait() and is set to \c MTAPI_SUCCESS by default.
   * \notthreadsafe
   */
  void SetStatus(
    mtapi_status_t error_code          /**< [in] The status to return by
                                            Task::Wait(), Group::WaitAny(),
                                            Group::WaitAll() */
    ) {
    mtapi_status_t status;
    mtapi_context_status_set(context_, error_code, &status);
    internal::CheckStatus(status);
  }

  /**
   * Returns the internal representation of this object.
   * Allows for interoperability with the C interface.
   *
   * \returns A pointer to a mtapi_task_context_t.
   * \notthreadsafe
   */
  mtapi_task_context_t * GetInternal() const {
    return context_;
  }

 private:
  // no default constructor
  TaskContext();

  mtapi_task_context_t * context_;
};

} // namespace mtapi
} // namespace embb

#endif // EMBB_MTAPI_TASK_CONTEXT_H_