src/gpu-compute/scheduling_policy.hh

   1 /*
   2  * Copyright (c) 2014-2017 Advanced Micro Devices, Inc.
   3  * All rights reserved.
   4  *
   5  * For use for simulation and test purposes only
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright notice,
  11  * this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  * this list of conditions and the following disclaimer in the documentation
  15  * and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the copyright holder nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  * Authors: Sooraj Puthoor,
  34  *          Anthony Gutierrez
  35  */
  36
  37 #ifndef __GPU_COMPUTE_SCHEDULING_POLICY_HH__
  38 #define __GPU_COMPUTE_SCHEDULING_POLICY_HH__
  39
  40 #include <vector>
  41
  42 class Wavefront;
  43
  44 /**
  45  * Interface class for the wave scheduling policy.
  46  */
  47 class SchedulingPolicy
  48 {
  49   public:
  50     SchedulingPolicy() { }
  51     virtual Wavefront *chooseWave(std::vector<Wavefront*> *sched_list) = 0;
  52 };
  53
  54 /**
  55  * Intermediate class that derives from the i-face class, and implements
  56  * its API. It uses the CRTP to take in the actual scheduling policy
  57  * implementation as a template parameter. This allows us to use a pointer
  58  * to SchedulingPolicy and instantiate whichever policy we want. The
  59  * derived policies implement the scheduler arbitration logic using
  60  * the static member method called __chooseWave();
  61  */
  62 template<typename Policy>
  63 class __SchedulingPolicy : public SchedulingPolicy
  64 {
  65   public:
  66     __SchedulingPolicy() { }
  67
  68     Wavefront*
  69     chooseWave(std::vector<Wavefront*> *sched_list) override
  70     {
  71         return Policy::__chooseWave(sched_list);
  72     }
  73 };
  74
  75 #endif // __GPU_COMPUTE_SCHEDULING_POLICY_HH__