Main Page | Modules | Data Structures | File List | Data Fields | Globals

Obtaining information from the scheduler.
[Core module]


Functions

bool fsf_is_admission_test_enabled ()
int fsf_get_cpu_time (fsf_server_id_t server, struct timespec *cpu_time)
int fsf_get_remaining_budget (fsf_server_id_t server, struct timespec *budget)
int fsf_get_budget_and_period (fsf_server_id_t server, struct timespec *budget, struct timespec *period)

Detailed Description

This group of function is used to get informations from the scheduler, like execution time of a task, remaining budget of a server, etc.

Function Documentation

int fsf_get_budget_and_period fsf_server_id_t  server,
struct timespec *  budget,
struct timespec *  period
 

This function stores in the variables pointed to by budget and period, the execution-time budget and the period respectively associated with the specified server. If any of these pointers is NULL, the corresponding information is not stored.

Parameters:
[in] server server id
[out] budget budget available for the current server instance
[out] period period available for the current server instance
Return values:
0 if succesful completion
FSF_ERR_BAD_ARGUMENT if the value of the server argument is not in range, budget is NULL or period is NULL
FSF_ERR_NOT_SCHEDULED_CALLING_THREAD if the calling thread is not scheduled under the FSF
FSF_ERR_INVALID_SCHEDULER_REPLY the scheduler is wrong or not running
FSF_ERR_NOT_CONTRACTED_SERVER if the server of the calling thread has been cancelled or it is not valid

int fsf_get_cpu_time fsf_server_id_t  server,
struct timespec *  cpu_time
 

This function stores the current execution time spent by the threads bound to the specified server in the variable pointed to by cpu_time.

Parameters:
[in] server server id
[out] cpu_time pointer to a timespec structure that will contain the cpu time consumed by the threads that are bound to the specific server, since its creation.
Return values:
0 if succesful completion
FSF_ERR_BAD_ARGUMENT if the value of the server argument is not in range or cpu_time is NULL
FSF_ERR_NOT_SCHEDULED_CALLING_THREAD if the calling thread is not scheduled under the FSF
FSF_ERR_INVALID_SCHEDULER_REPLY the scheduler is wrong or not running
FSF_ERR_NOT_CONTRACTED_SERVER if the server of the calling thread has been cancelled or it is not valid

int fsf_get_remaining_budget fsf_server_id_t  server,
struct timespec *  budget
 

This function stores in the variable pointed to by budget the remaining execution-time budget associated with the specified server.

Parameters:
[in] server server id
[out] budget pointer to a timespec structure that will contain the remaining budget
Return values:
0 if succesful completion
FSF_ERR_BAD_ARGUMENT if the value of the server argument is not in range or budget is NULL
FSF_ERR_NOT_SCHEDULED_CALLING_THREAD if the calling thread is not scheduled under the FSF
FSF_ERR_INVALID_SCHEDULER_REPLY the scheduler is wrong or not running
FSF_ERR_NOT_CONTRACTED_SERVER if the server of the calling thread has been cancelled or it is not valid

bool fsf_is_admission_test_enabled  ) 
 

Returns true if the system is configured with the on-line admission test enabled, or false otherwise.


Generated on Tue Apr 5 17:01:27 2005 for FSF by doxygen 1.3.4