summaryrefslogtreecommitdiffstats
path: root/c-user/chains.rst
blob: 382bc4657a452d5f90d364ada05df47fc9037da8 (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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
.. comment SPDX-License-Identifier: CC-BY-SA-4.0

.. COMMENT: Copyright 2014 Gedare Bloom.
.. COMMENT: All rights reserved.

Chains
******

.. index:: chains

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

The Chains API is an interface to the Super Core (score) chain
implementation. The Super Core uses chains for all list type functions. This
includes wait queues and task queues. The Chains API provided by RTEMS is:

- rtems_chain_initialize_ - initialize the chain with nodes

- rtems_chain_initialize_empty_ - initialize the chain as empty

- rtems_chain_is_null_node_ - Is the node NULL ?

- rtems_chain_head_ - Return the chain's head

- rtems_chain_tail_ - Return the chain's tail

- rtems_chain_are_nodes_equal_ - Are the node's equal ?

- rtems_chain_is_empty_ - Is the chain empty ?

- rtems_chain_is_first_ - Is the Node the first in the chain ?

- rtems_chain_is_last_ - Is the Node the last in the chain ?

- rtems_chain_has_only_one_node_ - Does the node have one node ?

- rtems_chain_node_count_unprotected_ - Returns the node count of the chain (unprotected)

- rtems_chain_is_head_ - Is the node the head ?

- rtems_chain_is_tail_ - Is the node the tail ?

- rtems_chain_extract_ - Extract the node from the chain

- rtems_chain_extract_unprotected_ - Extract the node from the chain (unprotected)

- rtems_chain_get_ - Return the first node on the chain

- rtems_chain_get_unprotected_ - Return the first node on the chain (unprotected)

- rtems_chain_insert_ - Insert the node into the chain

- rtems_chain_insert_unprotected_ - Insert the node into the chain (unprotected)

- rtems_chain_append_ - Append the node to chain

- rtems_chain_append_unprotected_ - Append the node to chain (unprotected)

- rtems_chain_prepend_ - Prepend the node to the end of the chain

- rtems_chain_prepend_unprotected_ - Prepend the node to chain (unprotected)

Background
==========

The Chains API maps to the Super Core Chains API. Chains are implemented as a
double linked list of nodes anchored to a control node. The list starts at the
control node and is terminated at the control node. A node has previous and
next pointers. Being a double linked list nodes can be inserted and removed
without the need to travse the chain.

Chains have a small memory footprint and can be used in interrupt service
routines and are thread safe in a multi-threaded environment. The directives
list which operations disable interrupts.

Chains are very useful in Board Support packages and applications.

Nodes
-----

A chain is made up from nodes that orginate from a chain control object. A node
is of type ``rtems_chain_node``. The node is designed to be part of a user data
structure and a cast is used to move from the node address to the user data
structure address. For example:

.. code-block:: c

    typedef struct foo
    {
        rtems_chain_node node;
        int              bar;
    } foo;

creates a type ``foo`` that can be placed on a chain. To get the foo structure
from the list you perform the following:

.. code-block:: c

    foo* get_foo(rtems_chain_control* control)
    {
        return (foo*) rtems_chain_get(control);
    }

The node is placed at the start of the user's structure to allow the node
address on the chain to be easly cast to the user's structure address.

Controls
--------

A chain is anchored with a control object. Chain control provide the user with
access to the nodes on the chain. The control is head of the node.

.. code-block:: c

    [Control]
    first ------------------------>
    permanent_null <--------------- [NODE]
    last ------------------------->

The implementation does not require special checks for manipulating the first
and last nodes on the chain. To accomplish this the ``rtems_chain_control``
structure is treated as two overlapping ``rtems_chain_node`` structures.  The
permanent head of the chain overlays a node structure on the first and
``permanent_null`` fields.  The ``permanent_tail`` of the chain overlays a node
structure on the ``permanent_null`` and ``last`` elements of the structure.

Operations
==========

Multi-threading
---------------

Chains are designed to be used in a multi-threading environment. The directives
list which operations mask interrupts. Chains supports tasks and interrupt
service routines appending and extracting nodes with out the need for extra
locks. Chains how-ever cannot insure the integrity of a chain for all
operations. This is the responsibility of the user. For example an interrupt
service routine extracting nodes while a task is iterating over the chain can
have unpredictable results.

Creating a Chain
----------------

To create a chain you need to declare a chain control then add nodes
to the control. Consider a user structure and chain control:

.. code-block:: c

    typedef struct foo
    {
        rtems_chain_node node;
        uint8_t char*    data;
    } foo;
    rtems_chain_control chain;

Add nodes with the following code:

.. code-block:: c

    rtems_chain_initialize_empty (&chain);

    for (i = 0; i < count; i++)
    {
        foo* bar = malloc (sizeof (foo));
        if (!bar)
            return -1;
        bar->data = malloc (size);
        rtems_chain_append (&chain, &bar->node);
    }

The chain is initialized and the nodes allocated and appended to the
chain. This is an example of a pool of buffers.

Iterating a Chain
-----------------
.. index:: chain iterate

Iterating a chain is a common function. The example shows how to iterate the
buffer pool chain created in the last section to find buffers starting with a
specific string. If the buffer is located it is extracted from the chain and
placed on another chain:

.. code-block:: c

    void foobar (const char*          match,
                 rtems_chain_control* chain,
                 rtems_chain_control* out)
    {
        rtems_chain_node* node;
        foo*              bar;

        rtems_chain_initialize_empty (out);

        node = chain->first;
        while (!rtems_chain_is_tail (chain, node))
        {
            bar = (foo*) node;
            rtems_chain_node* next_node = node->next;
            if (strcmp (match, bar->data) == 0)
            {
                rtems_chain_extract (node);
                rtems_chain_append (out, node);
            }
            node = next_node;
        }
    }

Directives
==========

The section details the Chains directives.

.. COMMENT: Initialize this Chain With Nodes

.. raw:: latex

   \clearpage

.. _rtems_chain_initialize:

Initialize Chain With Nodes
---------------------------
.. index:: chain initialize
.. index:: rtems_chain_initialize

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_initialize(
            rtems_chain_control *the_chain,
            void                *starting_address,
            size_t               number_nodes,
            size_t               node_size
        )

RETURNS:
    Returns nothing.

DESCRIPTION:
    This function take in a pointer to a chain control and initializes it to
    contain a set of chain nodes.  The chain will contain ``number_nodes``
    chain nodes from the memory pointed to by ``start_address``.  Each node is
    assumed to be ``node_size`` bytes.

NOTES:
    This call will discard any nodes on the chain.

    This call does NOT inititialize any user data on each node.

.. COMMENT: Initialize this Chain as Empty

.. raw:: latex

   \clearpage

.. _rtems_chain_initialize_empty:

Initialize Empty
----------------
.. index:: chain initialize empty
.. index:: rtems_chain_initialize_empty

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_initialize_empty(
            rtems_chain_control *the_chain
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This function take in a pointer to a chain control and initializes it to
    empty.

NOTES:
    This call will discard any nodes on the chain.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_null_node:

Is Null Node ?
--------------
.. index:: chain is node null
.. index:: rtems_chain_is_null_node

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_null_node(
            const rtems_chain_node *the_node
        );

RETURNS:
    Returns ``true`` is the node point is NULL and ``false`` if the node is not
    NULL.

DESCRIPTION:
    Tests the node to see if it is a NULL returning ``true`` if a null.

.. raw:: latex

   \clearpage

.. _rtems_chain_head:

Head
----
.. index:: chain get head
.. index:: rtems_chain_head

CALLING SEQUENCE:
    .. code-block:: c

        rtems_chain_node *rtems_chain_head(
            rtems_chain_control *the_chain
        )

RETURNS:
    Returns the permanent head node of the chain.

DESCRIPTION:
    This function returns a pointer to the first node on the chain.

.. raw:: latex

   \clearpage

.. _rtems_chain_tail:

Tail
----
.. index:: chain get tail
.. index:: rtems_chain_tail

CALLING SEQUENCE:
    .. code-block:: c

        rtems_chain_node *rtems_chain_tail(
            rtems_chain_control *the_chain
        );

RETURNS:
    Returns the permanent tail node of the chain.

DESCRIPTION:
    This function returns a pointer to the last node on the chain.

.. raw:: latex

   \clearpage

.. _rtems_chain_are_nodes_equal:

Are Two Nodes Equal ?
---------------------
.. index:: chare are nodes equal
.. index:: rtems_chain_are_nodes_equal

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_are_nodes_equal(
            const rtems_chain_node *left,
            const rtems_chain_node *right
        );

RETURNS:
    This function returns ``true`` if the left node and the right node are
    equal, and ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if the left node and the right node are
    equal, and ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_empty:

Is the Chain Empty
------------------
.. index:: chain is chain empty
.. index:: rtems_chain_is_empty

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_empty(
            rtems_chain_control *the_chain
        );

RETURNS:
    This function returns ``true`` if there a no nodes on the chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if there a no nodes on the chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_first:

Is this the First Node on the Chain ?
-------------------------------------
.. index:: chain is node the first
.. index:: rtems_chain_is_first

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_first(
            const rtems_chain_node *the_node
        );

RETURNS:
    This function returns ``true`` if the node is the first node on a chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if the node is the first node on a chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_last:

Is this the Last Node on the Chain ?
------------------------------------
.. index:: chain is node the last
.. index:: rtems_chain_is_last

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_last(
            const rtems_chain_node *the_node
        );

RETURNS:
    This function returns ``true`` if the node is the last node on a chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if the node is the last node on a chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_has_only_one_node:

Does this Chain have only One Node ?
------------------------------------
.. index:: chain only one node
.. index:: rtems_chain_has_only_one_node

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_has_only_one_node(
            const rtems_chain_control *the_chain
        );

RETURNS:
    This function returns ``true`` if there is only one node on the chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if there is only one node on the chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_node_count_unprotected:

Returns the node count of the chain (unprotected)
-------------------------------------------------
.. index:: chain only one node
.. index:: rtems_chain_node_count_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        size_t rtems_chain_node_count_unprotected(
            const rtems_chain_control *the_chain
        );

RETURNS:
    This function returns the node count of the chain.

DESCRIPTION:
    This function returns the node count of the chain.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_head:

Is this Node the Chain Head ?
-----------------------------
.. index:: chain is node the head
.. index:: rtems_chain_is_head

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_head(
            rtems_chain_control    *the_chain,
            rtems_const chain_node *the_node
        );

RETURNS:
    This function returns ``true`` if the node is the head of the chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if the node is the head of the chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_is_tail:

Is this Node the Chain Tail ?
-----------------------------
.. index:: chain is node the tail
.. index:: rtems_chain_is_tail

CALLING SEQUENCE:
    .. code-block:: c

        bool rtems_chain_is_tail(
            rtems_chain_control    *the_chain,
            const rtems_chain_node *the_node
        )

RETURNS:
    This function returns ``true`` if the node is the tail of the chain and
    ``false`` otherwise.

DESCRIPTION:
    This function returns ``true`` if the node is the tail of the chain and
    ``false`` otherwise.

.. raw:: latex

   \clearpage

.. _rtems_chain_extract:

Extract a Node
--------------
.. index:: chain extract a node
.. index:: rtems_chain_extract

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_extract(
            rtems_chain_node *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine extracts the node from the chain on which it resides.

NOTES:
    Interrupts are disabled while extracting the node to ensure the atomicity
    of the operation.

    Use ``rtems_chain_extract_unprotected`` to avoid disabling of interrupts.

.. raw:: latex

   \clearpage

.. _rtems_chain_extract_unprotected:

Extract a Node (unprotected)
----------------------------
.. index:: chain extract a node unprotected
.. index:: rtems_chain_extract_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_extract_unprotected(
            rtems_chain_node *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine extracts the node from the chain on which it resides.

NOTES:
    The function does nothing to ensure the atomicity of the operation.

.. raw:: latex

   \clearpage

.. _rtems_chain_get:

Get the First Node
------------------
.. index:: chain get first node
.. index:: rtems_chain_get

CALLING SEQUENCE:
    .. code-block:: c

        rtems_chain_node *rtems_chain_get(
            rtems_chain_control *the_chain
        );

RETURNS:
    Returns a pointer a node. If a node was removed, then a pointer to that
    node is returned. If the chain was empty, then ``NULL`` is returned.

DESCRIPTION:
    This function removes the first node from the chain and returns a pointer
    to that node.  If the chain is empty, then ``NULL`` is returned.

NOTES:
    Interrupts are disabled while obtaining the node to ensure the atomicity of
    the operation.

    Use ``rtems_chain_get_unprotected()`` to avoid disabling of interrupts.

.. raw:: latex

   \clearpage

.. _rtems_chain_get_unprotected:

Get the First Node (unprotected)
--------------------------------
.. index:: chain get first node
.. index:: rtems_chain_get_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        rtems_chain_node *rtems_chain_get_unprotected(
            rtems_chain_control *the_chain
        );

RETURNS:
    A pointer to the former first node is returned.

DESCRIPTION:
    Removes the first node from the chain and returns a pointer to it.  In case
    the chain was empty, then the results are unpredictable.

NOTES:
    The function does nothing to ensure the atomicity of the operation.

.. raw:: latex

   \clearpage

.. _rtems_chain_insert:

Insert a Node
-------------
.. index:: chain insert a node
.. index:: rtems_chain_insert

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_insert(
            rtems_chain_node *after_node,
            rtems_chain_node *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine inserts a node on a chain immediately following the specified
    node.

NOTES:
    Interrupts are disabled during the insert to ensure the atomicity of the
    operation.

    Use ``rtems_chain_insert_unprotected()`` to avoid disabling of interrupts.

.. raw:: latex

   \clearpage

.. _rtems_chain_insert_unprotected:

Insert a Node (unprotected)
---------------------------
.. index:: chain insert a node unprotected
.. index:: rtems_chain_insert_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_insert_unprotected(
            rtems_chain_node *after_node,
            rtems_chain_node *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine inserts a node on a chain immediately following the specified
    node.

NOTES:
    The function does nothing to ensure the atomicity of the operation.

.. raw:: latex

   \clearpage

.. _rtems_chain_append:

Append a Node
-------------
.. index:: chain append a node
.. index:: rtems_chain_append

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_append(
            rtems_chain_control *the_chain,
            rtems_chain_node    *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine appends a node to the end of a chain.

NOTES:
    Interrupts are disabled during the append to ensure the atomicity of the
    operation.

    Use ``rtems_chain_append_unprotected`` to avoid disabling of interrupts.

.. raw:: latex

   \clearpage

.. _rtems_chain_append_unprotected:

Append a Node (unprotected)
---------------------------
.. index:: chain append a node unprotected
.. index:: rtems_chain_append_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_append_unprotected(
            rtems_chain_control *the_chain,
            rtems_chain_node    *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine appends a node to the end of a chain.

NOTES:
    The function does nothing to ensure the atomicity of the operation.

.. raw:: latex

   \clearpage

.. _rtems_chain_prepend:

Prepend a Node
--------------
.. index:: prepend node
.. index:: rtems_chain_prepend

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_prepend(
            rtems_chain_control *the_chain,
            rtems_chain_node    *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine prepends a node to the front of the chain.

NOTES:
    Interrupts are disabled during the prepend to ensure the atomicity of the
    operation.

    Use ``rtems_chain_prepend_unprotected`` to avoid disabling of interrupts.

.. raw:: latex

   \clearpage

.. _rtems_chain_prepend_unprotected:

Prepend a Node (unprotected)
----------------------------
.. index:: prepend node unprotected
.. index:: rtems_chain_prepend_unprotected

CALLING SEQUENCE:
    .. code-block:: c

        void rtems_chain_prepend_unprotected(
            rtems_chain_control *the_chain,
            rtems_chain_node    *the_node
        );

RETURNS:
    Returns nothing.

DESCRIPTION:
    This routine prepends a node to the front of the chain.

NOTES:
    The function does nothing to ensure the atomicity of the operation.