c-user: rtems_scheduler_get_processor_maximum()

Close #3732.
This commit is contained in:
Sebastian Huber 2019-04-05 09:14:03 +02:00
parent 3495a91aa9
commit 53300c8e16
2 changed files with 36 additions and 43 deletions

View File

@ -39,6 +39,8 @@ The directives provided by the scheduler manager are:
- rtems_scheduler_get_processor_ - Get current processor index
- rtems_scheduler_get_processor_maximum_ - Get processor maximum
- rtems_scheduler_get_processor_set_ - Get processor set of a scheduler
- rtems_scheduler_add_processor_ - Add processor to a scheduler
@ -728,6 +730,40 @@ DESCRIPTION:
NOTES:
None.
.. raw:: latex
\clearpage
.. _rtems_scheduler_get_processor_maximum:
SCHEDULER_GET_PROCESSOR_MAXIMUM - Get processor maximum
-------------------------------------------------------
CALLING SEQUENCE:
.. code-block:: c
uint32_t rtems_scheduler_get_processor_maximum( void );
DIRECTIVE STATUS CODES:
This directive returns the processor maximum supported by the system.
DESCRIPTION:
In uniprocessor configurations, a value of one will be returned.
In SMP configurations, this directive returns the minimum of the processors
(physically or virtually) available by the platform and the configured
processor maximum. Not all processors in the range from processor index
zero to the last processor index (which is the processor maximum minus one)
may be configured to be used by a scheduler or online (online processors
have a scheduler assigned).
NOTES:
None.
.. raw:: latex
\clearpage
.. _rtems_scheduler_get_processor_set:
SCHEDULER_GET_PROCESSOR_SET - Get processor set of a scheduler

View File

@ -35,10 +35,6 @@ adequate locking protocols. One aim is to enable a schedulability analysis
under the sporadic task model :cite:`Brandenburg:2011:SL`
:cite:`Burns:2013:MrsP`.
The directives provided by the SMP support are:
- rtems_get_processor_count_ - Get processor count
Background
==========
@ -499,45 +495,6 @@ on a suitable platform, e.g. QorIQ T4240. High-performance SMP applications
need full control of the object storage :cite:`Drepper:2007:Memory`.
Therefore, self-contained synchronization objects are now available for RTEMS.
Directives
==========
This section details the symmetric multiprocessing services. A subsection is
dedicated to each of these services and describes the calling sequence, related
constants, usage, and status codes.
.. raw:: latex
\clearpage
.. _rtems_get_processor_count:
GET_PROCESSOR_COUNT - Get processor count
-----------------------------------------
CALLING SEQUENCE:
.. code-block:: c
uint32_t rtems_get_processor_count(void);
DIRECTIVE STATUS CODES:
The count of processors in the system that can be run. The value returned
is the highest numbered processor index of all processors available to the
application (if a scheduler is assigned) plus one.
DESCRIPTION:
In uniprocessor configurations, a value of one will be returned.
In SMP configurations, this returns the value of a global variable set
during system initialization to indicate the count of utilized processors.
The processor count depends on the physically or virtually available
processors and application configuration. The value will always be less
than or equal to the maximum count of application configured processors.
NOTES:
None.
Implementation Details
======================