libcilkrts/runtime/cilk_fiber-unix.h

   1 /* cilk_fiber-unix.h                  -*-C++-*-
   2  *
   3  *************************************************************************
   4  *
   5  *  Copyright (C) 2012-2016, Intel Corporation
   6  *  All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *    * Redistributions of source code must retain the above copyright
  13  *      notice, this list of conditions and the following disclaimer.
  14  *    * Redistributions in binary form must reproduce the above copyright
  15  *      notice, this list of conditions and the following disclaimer in
  16  *      the documentation and/or other materials provided with the
  17  *      distribution.
  18  *    * Neither the name of Intel Corporation nor the names of its
  19  *      contributors may be used to endorse or promote products derived
  20  *      from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *  HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  30  *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
  32  *  WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  *  POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  *  *********************************************************************
  36  *
  37  *  PLEASE NOTE: This file is a downstream copy of a file mainitained in
  38  *  a repository at cilkplus.org. Changes made to this file that are not
  39  *  submitted through the contribution process detailed at
  40  *  http://www.cilkplus.org/submit-cilk-contribution will be lost the next
  41  *  time that a new version is released. Changes only submitted to the
  42  *  GNU compiler collection or posted to the git repository at
  43  *  https://bitbucket.org/intelcilkruntime/intel-cilk-runtime.git are
  44  *  not tracked.
  45  *
  46  *  We welcome your contributions to this open source project. Thank you
  47  *  for your assistance in helping us improve Cilk Plus.
  48  **************************************************************************/
  49
  50 #ifndef INCLUDED_CILK_FIBER_UNIX_DOT_H
  51 #define INCLUDED_CILK_FIBER_UNIX_DOT_H
  52
  53 #ifndef __cplusplus
  54 #   error cilk_fiber-unix.h is a C++-only header
  55 #endif
  56
  57 #include "cilk_fiber.h"
  58 #include "jmpbuf.h"
  59
  60 /**
  61  * @file cilk_fiber-unix.h
  62  *
  63  * @brief Unix-specific implementation for cilk_fiber.
  64  */
  65
  66 /**
  67  * @brief Unix-specific fiber class derived from portable fiber class
  68  */
  69 struct cilk_fiber_sysdep : public cilk_fiber
  70 {
  71   public:
  72
  73 #if SUPPORT_GET_CURRENT_FIBER
  74     /**
  75      * @brief Gets the current fiber from TLS.
  76      */
  77     static cilk_fiber_sysdep* get_current_fiber_sysdep();
  78 #endif
  79
  80     /**
  81      * @brief Construct the system-dependent portion of a fiber.
  82      *
  83      * @param stack_size  The size of the stack for this fiber.
  84      */
  85     cilk_fiber_sysdep(std::size_t stack_size);
  86
  87     /**
  88      * @brief Construct the system-dependent of a fiber created from a
  89      * thread.
  90      */
  91     cilk_fiber_sysdep(from_thread_t);
  92
  93     /**
  94      * @brief Destructor
  95      */
  96     ~cilk_fiber_sysdep();
  97
  98     /**
  99      * @brief OS-specific calls to convert this fiber back to thread.
 100      *
 101      * Nothing to do for Linux.
 102      */
 103     void convert_fiber_back_to_thread();
 104
 105     /**
 106      * @brief System-dependent function to suspend self and resume execution of "other".
 107      *
 108      * This fiber is suspended.
 109      *
 110      * @pre @c is_resumable() should be true.
 111      *
 112      * @param other              Fiber to resume.
 113      */
 114     void suspend_self_and_resume_other_sysdep(cilk_fiber_sysdep* other);
 115
 116     /**
 117      * @brief System-dependent function called to jump to @p other
 118      * fiber.
 119      *
 120      * @pre @c is_resumable() should be false.
 121      *
 122      * @param other  Fiber to resume.
 123      */
 124     NORETURN jump_to_resume_other_sysdep(cilk_fiber_sysdep* other);
 125
 126     /**
 127      * @brief Runs the start_proc.
 128      * @pre is_resumable() should be false.
 129      * @pre is_allocated_from_thread() should be false.
 130      * @pre m_start_proc must be valid.
 131      */
 132     NORETURN run();
 133
 134     /**
 135      * @brief Returns the base of this fiber's stack.
 136      */
 137     inline char* get_stack_base_sysdep() { return m_stack_base; }
 138
 139   private:
 140     char*                       m_stack_base;    ///< The base of this fiber's stack.
 141     char*                       m_stack;         ///< Stack memory (low address)
 142     __CILK_JUMP_BUFFER          m_resume_jmpbuf; ///< Place to resume fiber
 143     unsigned                    m_magic;         ///< Magic number for checking
 144
 145     static long                 s_page_size;     ///< Page size for stacks.
 146
 147     // Allocate memory for a stack.  This method
 148     // initializes m_stack and m_stack_base.
 149     void make_stack(size_t stack_size);
 150
 151     // Deallocates memory for the stack.
 152     void free_stack();
 153
 154     // Common helper method for implementation of resume_other_sysdep
 155     // variants.
 156     inline void resume_other_sysdep(cilk_fiber_sysdep* other);
 157 };
 158
 159 #endif // ! defined(INCLUDED_CILK_FIBER_UNIX_DOT_H)