summaryrefslogtreecommitdiffstats
path: root/c-user/object_services.rst
blob: e748de7015c9b2ca9b33ae736e718d90f3793961 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: COPYRIGHT (c) 1988-2008.
.. COMMENT: On-Line Applications Research Corporation (OAR).
.. COMMENT: All rights reserved.

Object Services
###############

.. index:: object manipulation

Introduction
============

RTEMS provides a collection of services to assist in the management and usage
of the objects created and utilized via other managers.  These services assist
in the manipulation of RTEMS objects independent of the API used to create
them.  The object related services provided by RTEMS are:

- build_id

- rtems_build_name_ - build object name from characters

- rtems_object_get_classic_name_ - lookup name from Id

- rtems_object_get_name_ - obtain object name as string

- rtems_object_set_name_ - set object name

- rtems_object_id_get_api_ - obtain API from Id

- rtems_object_id_get_class_ - obtain class from Id

- rtems_object_id_get_node_ - obtain node from Id

- rtems_object_id_get_index_ - obtain index from Id

- rtems_build_id_ - build object id from components

- rtems_object_id_api_minimum_ - obtain minimum API value

- rtems_object_id_api_maximum_ - obtain maximum API value

- rtems_object_id_api_minimum_class_ - obtain minimum class value

- rtems_object_id_api_maximum_class_ - obtain maximum class value

- rtems_object_get_api_name_ - obtain API name

- rtems_object_get_api_class_name_ - obtain class name

- rtems_object_get_class_information_ - obtain class information

Background
==========

APIs
----

RTEMS implements multiple APIs including an Internal API, the Classic API, and
the POSIX API.  These APIs share the common foundation of SuperCore objects and
thus share object management code. This includes a common scheme for object Ids
and for managing object names whether those names be in the thirty-two bit form
used by the Classic API or C strings.

The object Id contains a field indicating the API that an object instance is
associated with.  This field holds a numerically small non-zero integer.

Object Classes
--------------

Each API consists of a collection of managers.  Each manager is responsible for
instances of a particular object class.  Classic API Tasks and POSIX Mutexes
example classes.

The object Id contains a field indicating the class that an object instance is
associated with.  This field holds a numerically small non-zero integer.  In
all APIs, a class value of one is reserved for tasks or threads.

Object Names
------------

Every RTEMS object which has an Id may also have a name associated with it.
Depending on the API, names may be either thirty-two bit integers as in the
Classic API or strings as in the POSIX API.

Some objects have Ids but do not have a defined way to associate a name with
them.  For example, POSIX threads have Ids but per POSIX do not have names. In
RTEMS, objects not defined to have thirty-two bit names may have string names
assigned to them via the ``rtems_object_set_name`` service.  The original
impetus in providing this service was so the normally anonymous POSIX threads
could have a user defined name in CPU Usage Reports.

Operations
==========

Decomposing and Recomposing an Object Id
----------------------------------------

Services are provided to decompose an object Id into its subordinate
components. The following services are used to do this:

- ``rtems_object_id_get_api``

- ``rtems_object_id_get_class``

- ``rtems_object_id_get_node``

- ``rtems_object_id_get_index``

The following C language example illustrates the decomposition of an Id and
printing the values.

.. code-block:: c

    void printObjectId(rtems_id id)
    {
        printf(
            "API=%d Class=%d Node=%d Index=%d\n",
            rtems_object_id_get_api(id),
            rtems_object_id_get_class(id),
            rtems_object_id_get_node(id),
            rtems_object_id_get_index(id)
        );
    }

This prints the components of the Ids as integers.

It is also possible to construct an arbitrary Id using the ``rtems_build_id``
service.  The following C language example illustrates how to construct the
"next Id."

.. code-block:: c

    rtems_id nextObjectId(rtems_id id)
    {
        return rtems_build_id(
                    rtems_object_id_get_api(id),
                    rtems_object_id_get_class(id),
                    rtems_object_id_get_node(id),
                    rtems_object_id_get_index(id) + 1
               );
    }

Note that this Id may not be valid in this
system or associated with an allocated object.

Printing an Object Id
---------------------

RTEMS also provides services to associate the API and Class portions of an
Object Id with strings.  This allows the application developer to provide more
information about an object in diagnostic messages.

In the following C language example, an Id is decomposed into its constituent
parts and "pretty-printed."

.. code-block:: c

    void prettyPrintObjectId(rtems_id id)
    {
        int tmpAPI, tmpClass;

        tmpAPI   = rtems_object_id_get_api(id),
        tmpClass = rtems_object_id_get_class(id),

        printf(
            "API=%s Class=%s Node=%d Index=%d\n",
            rtems_object_get_api_name(tmpAPI),
            rtems_object_get_api_class_name(tmpAPI, tmpClass),
            rtems_object_id_get_node(id),
            rtems_object_id_get_index(id)
        );
    }

Directives
==========

.. raw:: latex

   \clearpage

.. _rtems_build_name:

BUILD_NAME - Build object name from characters
----------------------------------------------
.. index:: build object name
.. index:: rtems_build_name

CALLING SEQUENCE:
    .. code-block:: c

        rtems_name rtems_build_name(
            uint8_t c1,
            uint8_t c2,
            uint8_t c3,
            uint8_t c4
        );

DIRECTIVE STATUS CODES:
    Returns a name constructed from the four characters.

DESCRIPTION:
    This service takes the four characters provided as arguments and constructs
    a thirty-two bit object name with ``c1`` in the most significant byte and
    ``c4`` in the least significant byte.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_get_classic_name:

OBJECT_GET_CLASSIC_NAME - Lookup name from id
---------------------------------------------
.. index:: get name from id
.. index:: obtain name from id
.. index:: rtems_object_get_classic_name

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_object_get_classic_name(
            rtems_id      id,
            rtems_name   *name
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - name looked up successfully
     * - ``RTEMS_INVALID_ADDRESS``
       - invalid name pointer
     * - ``RTEMS_INVALID_ID``
       - invalid object id

DESCRIPTION:
    This service looks up the name for the object ``id`` specified and, if
    found, places the result in ``*name``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_get_name:

OBJECT_GET_NAME - Obtain object name as string
----------------------------------------------
.. index:: get object name as string
.. index:: obtain object name as string
.. index:: rtems_object_get_name

CALLING SEQUENCE:
    .. code-block:: c

        char* rtems_object_get_name(
            rtems_id       id,
            size_t         length,
            char          *name
        );

DIRECTIVE STATUS CODES:
    Returns a pointer to the name if successful or ``NULL`` otherwise.

DESCRIPTION:
    This service looks up the name of the object specified by ``id`` and places
    it in the memory pointed to by ``name``.  Every attempt is made to return
    name as a printable string even if the object has the Classic API
    thirty-two bit style name.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_set_name:

OBJECT_SET_NAME - Set object name
---------------------------------
.. index:: set object name
.. index:: rtems_object_set_name

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_object_set_name(
            rtems_id       id,
            const char    *name
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - name looked up successfully
     * - ``RTEMS_INVALID_ADDRESS``
       - invalid name pointer
     * - ``RTEMS_INVALID_ID``
       - invalid object id

DESCRIPTION:
    This service sets the name of ``id`` to that specified by the string
    located at ``name``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    If the object specified by ``id`` is of a class that has a string name,
    this method will free the existing name to the RTEMS Workspace and allocate
    enough memory from the RTEMS Workspace to make a copy of the string located
    at ``name``.

    If the object specified by ``id`` is of a class that has a thirty-two bit
    integer style name, then the first four characters in ``*name`` will be
    used to construct the name.  name to the RTEMS Workspace and allocate
    enough memory from the RTEMS Workspace to make a copy of the string

.. raw:: latex

   \clearpage

.. _rtems_object_id_get_api:

OBJECT_ID_GET_API - Obtain API from Id
--------------------------------------
.. index:: obtain API from id
.. index:: rtems_object_id_get_api

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_get_api(
            rtems_id id
        );

DIRECTIVE STATUS CODES:
    Returns the API portion of the object Id.

DESCRIPTION:
    This directive returns the API portion of the provided object ``id``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    This directive does NOT validate the ``id`` provided.

.. raw:: latex

   \clearpage

.. _rtems_object_id_get_class:

OBJECT_ID_GET_CLASS - Obtain Class from Id
------------------------------------------
.. index:: obtain class from object id
.. index:: rtems_object_id_get_class

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_get_class(
            rtems_id id
        );

DIRECTIVE STATUS CODES:
    Returns the class portion of the object Id.

DESCRIPTION:
    This directive returns the class portion of the provided object ``id``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    This directive does NOT validate the ``id`` provided.

.. raw:: latex

   \clearpage

.. _rtems_object_id_get_node:

OBJECT_ID_GET_NODE - Obtain Node from Id
----------------------------------------
.. index:: obtain node from object id
.. index:: rtems_object_id_get_node

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_get_node(
            rtems_id id
        );

DIRECTIVE STATUS CODES:
    Returns the node portion of the object Id.

DESCRIPTION:
    This directive returns the node portion of the provided object ``id``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    This directive does NOT validate the ``id`` provided.

.. raw:: latex

   \clearpage

.. _rtems_object_id_get_index:

OBJECT_ID_GET_INDEX - Obtain Index from Id
------------------------------------------
.. index:: obtain index from object id
.. index:: rtems_object_id_get_index

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_get_index(
            rtems_id id
        );

DIRECTIVE STATUS CODES:
    Returns the index portion of the object Id.

DESCRIPTION:
    This directive returns the index portion of the provided object ``id``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    This directive does NOT validate the ``id`` provided.

.. raw:: latex

   \clearpage

.. _rtems_build_id:

BUILD_ID - Build Object Id From Components
------------------------------------------
.. index:: build object id from components
.. index:: rtems_build_id

CALLING SEQUENCE:
    .. code-block:: c

        rtems_id rtems_build_id(
            int the_api,
            int the_class,
            int the_node,
            int the_index
        );

DIRECTIVE STATUS CODES:
    Returns an object Id constructed from the provided arguments.

DESCRIPTION:
    This service constructs an object Id from the provided ``the_api``,
    ``the_class``, ``the_node``, and ``the_index``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    This directive does NOT validate the arguments provided or the Object id
    returned.

.. raw:: latex

   \clearpage

.. _rtems_object_id_api_minimum:

OBJECT_ID_API_MINIMUM - Obtain Minimum API Value
------------------------------------------------
.. index:: obtain minimum API value
.. index:: rtems_object_id_api_minimum

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_api_minimum(void);

DIRECTIVE STATUS CODES:
    Returns the minimum valid for the API portion of an object Id.

DESCRIPTION:
    This service returns the minimum valid for the API portion of an object Id.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_id_api_maximum:

OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value
------------------------------------------------
.. index:: obtain maximum API value
.. index:: rtems_object_id_api_maximum

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_id_api_maximum(void);

DIRECTIVE STATUS CODES:
    Returns the maximum valid for the API portion of an object Id.

DESCRIPTION:
    This service returns the maximum valid for the API portion of an object Id.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_api_minimum_class:

OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value
-----------------------------------------------------
.. index:: obtain minimum class value
.. index:: rtems_object_api_minimum_class

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_api_minimum_class(
            int api
        );

DIRECTIVE STATUS CODES:
    If ``api`` is not valid, -1 is returned.

    If successful, this service returns the minimum valid for the class portion
    of an object Id for the specified ``api``.

DESCRIPTION:
    This service returns the minimum valid for the class portion of an object
    Id for the specified ``api``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_api_maximum_class:

OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value
-----------------------------------------------------
.. index:: obtain maximum class value
.. index:: rtems_object_api_maximum_class

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_api_maximum_class(
            int api
        );

DIRECTIVE STATUS CODES:
    If ``api`` is not valid, -1 is returned.

    If successful, this service returns the maximum valid for the class portion
    of an object Id for the specified ``api``.

DESCRIPTION:
    This service returns the maximum valid for the class portion of an object
    Id for the specified ``api``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_id_api_minimum_class:

OBJECT_ID_API_MINIMUM_CLASS - Obtain Minimum Class Value for an API
-------------------------------------------------------------------
.. index:: obtain minimum class value for an API
.. index:: rtems_object_id_api_minimum_class

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_get_id_api_minimum_class(
            int api
        );

DIRECTIVE STATUS CODES:
    If ``api`` is not valid, -1 is returned.

    If successful, this service returns the index corresponding to the first
    object class of the specified ``api``.

DESCRIPTION:
    This service returns the index for the first object class associated with
    the specified ``api``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_id_api_maximum_class:

OBJECT_ID_API_MAXIMUM_CLASS - Obtain Maximum Class Value for an API
-------------------------------------------------------------------
.. index:: obtain maximum class value for an API
.. index:: rtems_object_id_api_maximum_class

CALLING SEQUENCE:
    .. code-block:: c

        int rtems_object_get_api_maximum_class(
            int api
        );

DIRECTIVE STATUS CODES:
    If ``api`` is not valid, -1 is returned.

    If successful, this service returns the index corresponding to the last
    object class of the specified ``api``.

DESCRIPTION:
    This service returns the index for the last object class associated with
    the specified ``api``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

.. raw:: latex

   \clearpage

.. _rtems_object_get_api_name:

OBJECT_GET_API_NAME - Obtain API Name
-------------------------------------
.. index:: obtain API name
.. index:: rtems_object_get_api_name

CALLING SEQUENCE:
    .. code-block:: c

        const char* rtems_object_get_api_name(
            int api
        );

DIRECTIVE STATUS CODES:
    If ``api`` is not valid, the string ``"BAD API"`` is returned.

    If successful, this service returns a pointer to a string containing the
    name of the specified ``api``.

DESCRIPTION:
    This service returns the name of the specified ``api``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    The string returned is from constant space.  Do not modify or free it.

.. raw:: latex

   \clearpage

.. _rtems_object_get_api_class_name:

OBJECT_GET_API_CLASS_NAME - Obtain Class Name
---------------------------------------------
.. index:: obtain class name
.. index:: rtems_object_get_api_class_name

CALLING SEQUENCE:
    .. code-block:: c

        const char *rtems_object_get_api_class_name(
            int the_api,
            int the_class
        );

DIRECTIVE STATUS CODES:
    If ``the_api`` is not valid, the string ``"BAD API"`` is returned.

    If ``the_class`` is not valid, the string ``"BAD CLASS"`` is returned.

    If successful, this service returns a pointer to a string containing the
    name of the specified ``the_api`` / ``the_class`` pair.

DESCRIPTION:
    This service returns the name of the object class indicated by the
    specified ``the_api`` and ``the_class``.

NOTES:
    This directive is strictly local and does not impact task scheduling.

    The string returned is from constant space.  Do not modify or free it.

.. raw:: latex

   \clearpage

.. _rtems_object_get_class_information:

OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
-------------------------------------------------------
.. index:: obtain class information
.. index:: rtems_object_get_class_information

CALLING SEQUENCE:
    .. code-block:: c

        rtems_status_code rtems_object_get_class_information(
            int                                 the_api,
            int                                 the_class,
            rtems_object_api_class_information *info
        );

DIRECTIVE STATUS CODES:
    .. list-table::
     :class: rtems-table

     * - ``RTEMS_SUCCESSFUL``
       - information obtained successfully
     * - ``RTEMS_INVALID_ADDRESS``
       - ``info`` is NULL
     * - ``RTEMS_INVALID_NUMBER``
       - invalid ``api`` or ``the_class``

    If successful, the structure located at ``info`` will be filled in with
    information about the specified ``api`` / ``the_class`` pairing.

DESCRIPTION:
    This service returns information about the object class indicated by the
    specified ``api`` and ``the_class``. This structure is defined as follows:

    .. code-block:: c

        typedef struct {
            rtems_id  minimum_id;
            rtems_id  maximum_id;
            int       maximum;
            bool      auto_extend;
            int       unallocated;
        } rtems_object_api_class_information;

NOTES:
    This directive is strictly local and does not impact task scheduling.