----------------------------------------------
----------------------------------
------------------------------------------------------------------------------
-- Cheddar is a GNU GPL real time scheduling analysis tool.
-- This program provides services to automatically check performances
-- of real time architectures.
--
-- Copyright (C) 2002-2010,  by Frank Singhoff, Alain Plantec, Jerome Legrand
--
-- The Cheddar project was started in 2002 by
-- the LISyC Team, University of Western Britanny.
--
-- Since 2008, Ellidiss technologies also contributes to the development of
-- Cheddar and provides industrial support.
--
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation; either version 2 of the License, or
-- (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with this program; if not, write to the Free Software
-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
--
--
-- Contact : cheddar@listes.univ-brest.fr
--
-----------------------------------------------------------------------------
-- Last update :
--    $Rev: 523 $
--    $Date: 2012-09-26 15:09:39 +0200 (Wed, 26 Sep 2012) $
--    $Author: fotsing $
------------------------------------------------------------------------------
------------------------------------------------------------------------------

with fifos;

package Scheduler.Fixed_Priority.Hpf is

   type Hpf_Scheduler is new Fixed_Priority_Scheduler with private;
   type Hpf_Scheduler_Ptr is access all Hpf_Scheduler'Class;

   type Hpf_Tcb is new Fixed_Priority_Tcb with record
      Task_Quantum : Natural := 0;
   end record;

   type Hpf_Tcb_Ptr is access all Hpf_Tcb'Class;

   procedure Initialize (A_Tcb : in out Hpf_Tcb);

   procedure Initialize (A_Scheduler : in out Hpf_Scheduler);

   function Copy
     (A_Scheduler : in Hpf_Scheduler)
      return        Generic_Scheduler_Ptr;

   procedure Check_Before_Scheduling
     (My_Scheduler   : in Hpf_Scheduler;
      My_Tasks       : in Tasks_Set;
      Processor_Name : in Unbounded_String);

   procedure Compute_Response_Time
     (My_Scheduler   : in Hpf_Scheduler;
      My_Tasks       : in out Tasks_Set;
      Processor_Name : in Unbounded_String;
      Msg            : in out Unbounded_String;
      Response_Time  : out Response_Time_Table);

   function Build_Tcb
     (My_Scheduler : in Hpf_Scheduler;
      A_Task       : Generic_Task_Ptr)
      return         Tcb_Ptr;

   procedure Do_Election
     (My_Scheduler       : in out Hpf_Scheduler;
      Si                 : in out Scheduling_Information;
      Result             : in out Scheduling_Sequence_Ptr;
      Msg                : in out Unbounded_String;
      Current_Time       : in Natural;
      Processor_Name     : in Unbounded_String;
      Address_Space_Name : in Unbounded_String;
      My_Dependencies    : in Tasks_Dependencies_Ptr;
      With_Offsets       : in Boolean;
      With_Precedencies  : in Boolean;
      With_Resources     : in Boolean;
      Event_To_Generate  : in Time_Unit_Event_Type_Boolean_Table;
      Elected            : in out Tasks_Range;
      No_Task            : in out Boolean);

   procedure Specific_Scheduler_Initialization
     (My_Scheduler       : in out Hpf_Scheduler;
      Si                 : in out Scheduling_Information;
      Processor_Name     : in Unbounded_String;
      address_space_name : in Unbounded_String;
      My_Tasks           : in out Tasks_Set;
      my_schedulers      : in Scheduler_table;
      My_Resources       : in out Resources_Set;
      My_Buffers         : in out Buffers_Set;
      My_Messages        : in Messages_Set;
      Msg                : in out Unbounded_String);

   procedure Utilization_Factor_Feasibility_Test
     (My_Scheduler   : in Hpf_Scheduler;
      My_Tasks       : in Tasks_Set;
      Processor_Name : in Unbounded_String;
      Result         : in out Unbounded_String;
      Output         : in Output_Format := String_Output);

   procedure Dispatched_Change_Current_Priority
     (My_Scheduler : in out Hpf_Scheduler;
      A_Tcb        : in Fixed_Priority_Tcb_Ptr;
      New_Priority : Priority_Range);

private

   procedure Put_Tcb (E : Hpf_Tcb_Ptr);

   package Tcb_Fifos is new fifos (
      Framework_Config.Max_Tasks,
      Hpf_Tcb_Ptr,
      Put_Tcb);
   use Tcb_Fifos;

   type Fifo_Table is array (Priority_Range) of fifo;

   type Hpf_Scheduler is new Fixed_Priority_Scheduler with record
      Priority_Fifos : Fifo_Table;
   end record;

end Scheduler.Fixed_Priority.Hpf;