2011-09-15 Petr Benes <benesp16@fel.cvut.cz>

	PR 1906/cpukit
	* sapi/Makefile.am, sapi/preinstall.am, sapi/include/confdefs.h,
	score/Makefile.am, score/preinstall.am: Add the CBS (Constant
	Bandwidth Server) scheduler. This is a complex scheduling policy
	built atop of the EDF scheduler. Unlike other schedulers, this one
	provides a user API and handles not only deadlines of tasks but also
	claimed budget per period. The main aim of the scheduler is isolation
	of tasks so that each task is guaranteed to meet all deadlines
	regardless of how other tasks behave.
	* sapi/include/rtems/cbs.h, sapi/inline/rtems/cbs.inl,
	score/include/rtems/score/schedulercbs.h, score/src/schedulercbs.c,
	score/src/schedulercbsattachthread.c,
	score/src/schedulercbscleanup.c,
	score/src/schedulercbscreateserver.c,
	score/src/schedulercbsdestroyserver.c,
	score/src/schedulercbsdetachthread.c,
	score/src/schedulercbsgetapprovedbudget.c,
	score/src/schedulercbsgetexecutiontime.c,
	score/src/schedulercbsgetparameters.c,
	score/src/schedulercbsgetremainingbudget.c,
	score/src/schedulercbsgetserverid.c,
	score/src/schedulercbsreleasejob.c,
	score/src/schedulercbssetparameters.c,
	score/src/schedulercbsunblock.c: New files.

5 files changed, 308 insertions, 1 deletions

diff --git a/cpukit/sapi/Makefile.am b/cpukit/sapi/Makefile.am
index aadccf4b76..9b7ad53201 100644
--- a/cpukit/sapi/Makefile.am
+++ b/cpukit/sapi/Makefile.am
@@ -15,6 +15,7 @@ include_rtems_HEADERS += include/rtems/fatal.h
 include_rtems_HEADERS += include/rtems/init.h
 include_rtems_HEADERS += include/rtems/io.h
 include_rtems_HEADERS += include/rtems/mptables.h
+include_rtems_HEADERS += include/rtems/cbs.h
 include_rtems_HEADERS += include/rtems/rbtree.h
 include_rtems_HEADERS += include/rtems/sptables.h
 
@@ -22,6 +23,7 @@ EXTRA_DIST = include/rtems/README
 
 include_rtems_HEADERS += inline/rtems/chain.inl
 include_rtems_HEADERS += inline/rtems/extension.inl
+include_rtems_HEADERS += inline/rtems/cbs.inl
 include_rtems_HEADERS += inline/rtems/rbtree.inl
 
 ## src
diff --git a/cpukit/sapi/include/confdefs.h b/cpukit/sapi/include/confdefs.h
index 2a9d75ac2c..a82dd00a87 100644
--- a/cpukit/sapi/include/confdefs.h
+++ b/cpukit/sapi/include/confdefs.h
@@ -574,6 +574,7 @@ rtems_fs_init_functions_t    rtems_fs_init_helper =
  *  CONFIGURE_SCHEDULER_SIMPLE     - Light-weight Priority Scheduler
  *  CONFIGURE_SCHEDULER_SIMPLE_SMP - Simple SMP Priority Scheduler
  *  CONFIGURE_SCHEDULER_EDF        - EDF Scheduler
+ *  CONFIGURE_SCHEDULER_CBS        - CBS Scheduler
  * 
  * If no configuration is specified by the application, then 
  * CONFIGURE_SCHEDULER_PRIORITY is assumed to be the default.
@@ -600,7 +601,8 @@ rtems_fs_init_functions_t    rtems_fs_init_helper =
     !defined(CONFIGURE_SCHEDULER_PRIORITY) && \
     !defined(CONFIGURE_SCHEDULER_SIMPLE) && \
     !defined(CONFIGURE_SCHEDULER_SIMPLE_SMP) && \
-    !defined(CONFIGURE_SCHEDULER_EDF)
+    !defined(CONFIGURE_SCHEDULER_EDF) && \
+    !defined(CONFIGURE_SCHEDULER_CBS)
   #if defined(RTEMS_SMP) && defined(CONFIGURE_SMP_APPLICATION)
     #define CONFIGURE_SCHEDULER_SIMPLE_SMP
   #else
@@ -676,6 +678,31 @@ rtems_fs_init_functions_t    rtems_fs_init_helper =
     _Configure_From_workspace(sizeof(Scheduler_EDF_Per_thread)))
 #endif
 
+/*
+ * If the CBS Scheduler is selected, then configure for it.
+ */
+#if defined(CONFIGURE_SCHEDULER_CBS)
+  #include <rtems/score/schedulercbs.h>
+  #define CONFIGURE_SCHEDULER_ENTRY_POINTS SCHEDULER_CBS_ENTRY_POINTS
+
+  #ifndef CONFIGURE_CBS_MAXIMUM_SERVERS
+    #define CONFIGURE_CBS_MAXIMUM_SERVERS CONFIGURE_MAXIMUM_TASKS
+  #endif
+
+  #ifdef CONFIGURE_INIT
+    uint32_t _Scheduler_CBS_Maximum_servers = CONFIGURE_CBS_MAXIMUM_SERVERS;
+  #endif
+
+  /**
+   * define the memory used by the CBS scheduler
+   */
+  #define CONFIGURE_MEMORY_FOR_SCHEDULER ( \
+    _Configure_From_workspace((sizeof(Scheduler_CBS_Server) + \
+        sizeof(Scheduler_CBS_Server*)) * CONFIGURE_CBS_MAXIMUM_SERVERS))
+  #define CONFIGURE_MEMORY_PER_TASK_FOR_SCHEDULER ( \
+    _Configure_From_workspace(sizeof(Scheduler_CBS_Per_thread)))
+#endif
+
 #if defined(CONFIGURE_SCHEDULER_USER)
   #define CONFIGURE_SCHEDULER_ENTRY_POINTS \
           CONFIGURE_SCHEDULER_USER_ENTRY_POINTS
diff --git a/cpukit/sapi/include/rtems/cbs.h b/cpukit/sapi/include/rtems/cbs.h
new file mode 100644
index 0000000000..d016e5cdec
--- /dev/null
+++ b/cpukit/sapi/include/rtems/cbs.h
@@ -0,0 +1,65 @@
+/**
+ * @file rtems/cbs.h
+ *
+ *  This include file contains all the constants and structures associated
+ *  with the CBS library in RTEMS.
+ */
+
+/*
+ *  Copyright (C) 2011 Petr Benes.
+ *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ *
+ *  $Id$
+ */
+
+#ifndef CONFIGURE_SCHEDULER_CBS
+  #error "cbs.h available only with CONFIGURE_SCHEDULER_CBS"
+#endif
+
+#ifndef _RTEMS_CBS_H
+#define _RTEMS_CBS_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdint.h>
+#include <rtems/score/schedulercbs.h>
+
+/* Return codes. */
+#define RTEMS_CBS_OK                       SCHEDULER_CBS_OK
+#define RTEMS_CBS_ERROR_GENERIC            SCHEDULER_CBS_ERROR_GENERIC
+#define RTEMS_CBS_ERROR_NO_MEMORY          SCHEDULER_CBS_ERROR_NO_MEMORY
+#define RTEMS_CBS_ERROR_INVALID_PARAMETER  SCHEDULER_CBS_ERROR_INVALID_PARAM
+#define RTEMS_CBS_ERROR_UNAUTHORIZED       SCHEDULER_CBS_ERROR_UNAUTHORIZED
+#define RTEMS_CBS_ERROR_UNIMPLEMENTED      SCHEDULER_CBS_ERROR_UNIMPLEMENTED
+#define RTEMS_CBS_ERROR_MISSING_COMPONENT  SCHEDULER_CBS_ERROR_MISSING_COMPONENT
+#define RTEMS_CBS_ERROR_INCONSISTENT_STATE SCHEDULER_CBS_ERROR_INCONSISTENT_STATE
+#define RTEMS_CBS_ERROR_SYSTEM_OVERLOAD    SCHEDULER_CBS_ERROR_SYSTEM_OVERLOAD
+#define RTEMS_CBS_ERROR_INTERNAL_ERROR     SCHEDULER_CBS_ERROR_INTERNAL_ERROR
+#define RTEMS_CBS_ERROR_NOT_FOUND          SCHEDULER_CBS_ERROR_NOT_FOUND
+#define RTEMS_CBS_ERROR_FULL               SCHEDULER_CBS_ERROR_FULL
+#define RTEMS_CBS_ERROR_EMPTY              SCHEDULER_CBS_ERROR_EMPTY
+#define RTEMS_CBS_ERROR_NOSERVER           SCHEDULER_CBS_ERROR_NOSERVER
+
+/** Callback function invoked when a budget overrun of a task occurs. */
+typedef Scheduler_CBS_Budget_overrun rtems_cbs_budget_overrun;
+
+/** Server id. */
+typedef Scheduler_CBS_Server_id rtems_cbs_server_id;
+
+/** Server parameters. */
+typedef Scheduler_CBS_Parameters rtems_cbs_parameters;
+
+#include <rtems/cbs.inl>
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+/* end of include file */
diff --git a/cpukit/sapi/inline/rtems/cbs.inl b/cpukit/sapi/inline/rtems/cbs.inl
new file mode 100644
index 0000000000..451d8cbc04
--- /dev/null
+++ b/cpukit/sapi/inline/rtems/cbs.inl
@@ -0,0 +1,205 @@
+/**
+ * @file cbs.inl
+ *
+ *  This include file contains all the constants and structures associated
+ *  with the CBS library.
+ *
+ */
+
+/*
+ *  Copyright (C) 2011 Petr Benes.
+ *  Copyright (C) 2011 On-Line Applications Research Corporation (OAR).
+ *
+ *  The license and distribution terms for this file may be
+ *  found in the file LICENSE in this distribution or at
+ *  http://www.rtems.com/license/LICENSE.
+ *
+ *  $Id$
+ */
+
+#ifndef _RTEMS_CBS_H
+# error "Never use <rtems/cbs.inl> directly; include <rtems/cbs.h> instead."
+#endif
+
+#include <rtems/score/schedulercbs.h>
+
+/**
+ *  @brief rtems cbs init
+ *
+ *  Initializes the CBS library.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_initialize ( void )
+{
+  return _Scheduler_CBS_Initialize();
+}
+
+/**
+ *  @brief rtems cbs cleanup
+ *
+ *  Cleanup resources associated to the CBS Library.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_cleanup ( void )
+{
+  return _Scheduler_CBS_Cleanup();
+}
+
+/**
+ *  @brief rtems cbs create server
+ *
+ *  Create a new server with specified parameters.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_create_server (
+  rtems_cbs_parameters     *params,
+  rtems_cbs_budget_overrun  budget_overrun_callback,
+  rtems_cbs_server_id      *server_id
+)
+{
+  return _Scheduler_CBS_Create_server(
+             params,
+             budget_overrun_callback,
+             server_id
+         );
+}
+
+/**
+ *  @brief rtems cbs attach thread
+ *
+ *  Attach a task to an already existing server.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_attach_thread (
+  rtems_cbs_server_id server_id,
+  rtems_id            task_id
+)
+{
+  return _Scheduler_CBS_Attach_thread( server_id, task_id );
+}
+
+/**
+ *  @brief rtems cbs detach thread
+ *
+ *  Detach from the CBS Server.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_detach_thread (
+  rtems_cbs_server_id server_id,
+  rtems_id            task_id
+)
+{
+  return _Scheduler_CBS_Detach_thread( server_id, task_id );
+}
+
+/**
+ *  @brief rtems cbs destroy server
+ *
+ *  Detach all tasks from a server and destroy it.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_destroy_server (
+  rtems_cbs_server_id server_id
+)
+{
+  return _Scheduler_CBS_Destroy_server( server_id );
+}
+
+/**
+ *  @brief rtems cbs get server id
+ *
+ *  Get a thread server id, or RTEMS_CBS_E_NOT_FOUND if it is not
+ *  attached to any server.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_get_server_id (
+  rtems_id             task_id,
+  rtems_cbs_server_id *server_id
+)
+{
+  return _Scheduler_CBS_Get_server_id( task_id, server_id );
+}
+
+/**
+ *  @brief rtems cbs get parameters
+ *
+ *  Retrieve CBS scheduling parameters.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_get_parameters (
+  rtems_cbs_server_id   server_id,
+  rtems_cbs_parameters *params
+)
+{
+  return _Scheduler_CBS_Get_parameters( server_id, params );
+}
+
+/**
+ *  @brief rtems cbs set parameters
+ *
+ *  Change CBS scheduling parameters.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_set_parameters (
+  rtems_cbs_server_id   server_id,
+  rtems_cbs_parameters *params
+)
+{
+  return _Scheduler_CBS_Set_parameters( server_id, params );
+}
+
+/**
+ *  @brief rtems cbs get execution time
+ *
+ *  Retrieve time info relative to the current server.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_get_execution_time (
+  rtems_cbs_server_id    server_id,
+  time_t                *exec_time,
+  time_t                *abs_time
+)
+{
+  return _Scheduler_CBS_Get_execution_time( server_id, exec_time, abs_time );
+}
+
+/**
+ *  @brief rtems cbs get remaining budget
+ *
+ *  Retrieve remaining budget for the current server instance.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_get_remaining_budget (
+  rtems_cbs_server_id  server_id,
+  time_t              *remaining_budget
+)
+{
+  return _Scheduler_CBS_Get_remaining_budget( server_id, remaining_budget );
+}
+
+/**
+ *  @brief rtems cbs get approved budget
+ *
+ *  Retrieve the budget that has been approved for the subsequent
+ *  server instances.
+ *
+ *  @return status code.
+ */
+RTEMS_INLINE_ROUTINE int rtems_cbs_get_approved_budget (
+  rtems_cbs_server_id  server_id,
+  time_t              *appr_budget
+)
+{
+  return _Scheduler_CBS_Get_approved_budget( server_id, appr_budget );
+}
diff --git a/cpukit/sapi/preinstall.am b/cpukit/sapi/preinstall.am
index f49f81427c..5ce9966786 100644
--- a/cpukit/sapi/preinstall.am
+++ b/cpukit/sapi/preinstall.am
@@ -60,6 +60,10 @@ $(PROJECT_INCLUDE)/rtems/mptables.h: include/rtems/mptables.h $(PROJECT_INCLUDE)
 	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/mptables.h
 PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/mptables.h
 
+$(PROJECT_INCLUDE)/rtems/cbs.h: include/rtems/cbs.h $(PROJECT_INCLUDE)/rtems/$(dirstamp)
+	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/cbs.h
+PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/cbs.h
+
 $(PROJECT_INCLUDE)/rtems/rbtree.h: include/rtems/rbtree.h $(PROJECT_INCLUDE)/rtems/$(dirstamp)
 	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/rbtree.h
 PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/rbtree.h
@@ -76,6 +80,10 @@ $(PROJECT_INCLUDE)/rtems/extension.inl: inline/rtems/extension.inl $(PROJECT_INC
 	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/extension.inl
 PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/extension.inl
 
+$(PROJECT_INCLUDE)/rtems/cbs.inl: inline/rtems/cbs.inl $(PROJECT_INCLUDE)/rtems/$(dirstamp)
+	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/cbs.inl
+PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/cbs.inl
+
 $(PROJECT_INCLUDE)/rtems/rbtree.inl: inline/rtems/rbtree.inl $(PROJECT_INCLUDE)/rtems/$(dirstamp)
 	$(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/rbtree.inl
 PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/rbtree.inl