summaryrefslogblamecommitdiffstats
path: root/cpukit/include/rtems/record.h
blob: 2f5ad5415cc1529c31aee3b9e2a8f77f45b67812 (plain) (tree)
1
2
3
4
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869

                                           
  
                                                                                





























                                                                              
                               
                               
                                 





                          
                               




                                

                                                       
                 
 

                             

                           

                



                          

                       
                                                        































                                                                 











                                             



                                   















































                                                                               
                             

                       








                                                                        
 











































































































                                                                        





































































































































































































                                     






                          



























                                                                             











                                                                               
                               



                                  

                                  



































                                                                            

                                                                             
  

                                                    
   
                                                                                       





                            









                                                                              

                                    



































                                                                              





























































































































































































































































                                                                              






































































































































































                                                                               





           





























                                                                             






           































                                                                             







           

































                                                                             








           



































                                                                             









           















                             



















































































































































































































































































































































































































































































































































































































































                                                                                    














                                                                              





                                             






                                        









                                                                         






                            
/* SPDX-License-Identifier: BSD-2-Clause */

/*
 * Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTEMS_RECORD_H
#define _RTEMS_RECORD_H

#include "recorddata.h"

#include <rtems/score/atomic.h>
#include <rtems/score/cpu.h>
#include <rtems/score/interr.h>
#include <rtems/score/percpu.h>
#include <rtems/score/watchdog.h>
#include <rtems/counter.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct Record_Control {
  Atomic_Uint       head;
  unsigned int      tail;
  unsigned int      mask;
  Watchdog_Control  Watchdog;
  rtems_record_item Header[ 3 ];
  RTEMS_ALIGNED( CPU_CACHE_LINE_BYTES )
    rtems_record_item Items[ RTEMS_ZERO_LENGTH_ARRAY ];
} Record_Control;

typedef struct {
  unsigned int    item_count;
  Record_Control *controls;
} Record_Configuration;

typedef struct {
  Record_Control *control;
  unsigned int    head;
  uint32_t        now;
  uint32_t        level;
} rtems_record_context;

extern const Record_Configuration _Record_Configuration;

void _Record_Initialize( void );

bool _Record_Thread_create(
  struct _Thread_Control *executing,
  struct _Thread_Control *created
);

void _Record_Thread_start(
  struct _Thread_Control *executing,
  struct _Thread_Control *started
);

void _Record_Thread_restart(
  struct _Thread_Control *executing,
  struct _Thread_Control *restarted
);

void _Record_Thread_delete(
  struct _Thread_Control *executing,
  struct _Thread_Control *deleted
);

void _Record_Thread_switch(
  struct _Thread_Control *executing,
  struct _Thread_Control *heir
);

void _Record_Thread_begin( struct _Thread_Control *executing );

void _Record_Thread_exitted( struct _Thread_Control *executing );

void _Record_Fatal_dump_base64(
  Internal_errors_Source source,
  bool                   always_set_to_false,
  Internal_errors_t      code
);

void _Record_Fatal_dump_base64_zlib(
  Internal_errors_Source source,
  bool                   always_set_to_false,
  Internal_errors_t      code
);

void _Record_Thread_terminate(
  struct _Thread_Control *executing
);

RTEMS_INLINE_ROUTINE unsigned int _Record_Index(
  const Record_Control *control,
  unsigned int          index
)
{
  return index & control->mask;
}

RTEMS_INLINE_ROUTINE unsigned int _Record_Head( const Record_Control *control )
{
  return _Atomic_Load_uint( &control->head, ATOMIC_ORDER_RELAXED );
}

RTEMS_INLINE_ROUTINE unsigned int _Record_Tail( const Record_Control *control )
{
  return control->tail;
}

RTEMS_INLINE_ROUTINE bool _Record_Is_overflow(
  const Record_Control *control,
  unsigned int          tail,
  unsigned int          head
)
{
  return head - tail >= control->mask + 1U;
}

RTEMS_INLINE_ROUTINE unsigned int _Record_Capacity(
  const Record_Control *control,
  unsigned int          tail,
  unsigned int          head
)
{
  return ( tail - head - 1U ) & control->mask;
}

RTEMS_INLINE_ROUTINE rtems_counter_ticks _Record_Now( void )
{
  return rtems_counter_read();
}

typedef struct RTEMS_PACKED {
  uint32_t format;
  uint32_t magic;
  rtems_record_item Version;
  rtems_record_item Processor_maximum;
  rtems_record_item Count;
  rtems_record_item Frequency;
  rtems_record_item Info[64];
} Record_Stream_header;

size_t _Record_Stream_header_initialize( Record_Stream_header *header );

size_t _Record_String_to_items(
  rtems_record_event  event,
  const char         *str,
  size_t              len,
  rtems_record_item  *items,
  size_t              item_count
);

void _Record_Caller( void *return_address );

void _Record_Caller_3(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data
);

void _Record_Caller_4(
  void               *return_address,
  rtems_record_event  event_0,
  rtems_record_data   data_0,
  rtems_record_event  event_1,
  rtems_record_data   data_1
);

void _Record_Caller_arg( void *return_address, rtems_record_data data );

void _Record_Caller_arg_2(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1
);

void _Record_Caller_arg_3(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2
);

void _Record_Caller_arg_4(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3
);

void _Record_Caller_arg_5(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4
);

void _Record_Caller_arg_6(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4,
  rtems_record_data  data_5
);

void _Record_Caller_arg_7(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4,
  rtems_record_data  data_5,
  rtems_record_data  data_6
);

void _Record_Caller_arg_8(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4,
  rtems_record_data  data_5,
  rtems_record_data  data_6,
  rtems_record_data  data_7
);

void _Record_Caller_arg_9(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4,
  rtems_record_data  data_5,
  rtems_record_data  data_6,
  rtems_record_data  data_7,
  rtems_record_data  data_8
);

void _Record_Caller_arg_10(
  void              *return_address,
  rtems_record_data  data_0,
  rtems_record_data  data_1,
  rtems_record_data  data_2,
  rtems_record_data  data_3,
  rtems_record_data  data_4,
  rtems_record_data  data_5,
  rtems_record_data  data_6,
  rtems_record_data  data_7,
  rtems_record_data  data_8,
  rtems_record_data  data_9
);

void _Record_Entry_2(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1
);

void _Record_Entry_3(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2
);

void _Record_Entry_4(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3
);

void _Record_Entry_5(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4
);

void _Record_Entry_6(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5
);

void _Record_Entry_7(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6
);

void _Record_Entry_8(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7
);

void _Record_Entry_9(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7,
  rtems_record_data   data_8
);

void _Record_Entry_10(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7,
  rtems_record_data   data_8,
  rtems_record_data   data_9
);

void _Record_Exit_2(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1
);

void _Record_Exit_3(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2
);

void _Record_Exit_4(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3
);

void _Record_Exit_5(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4
);

void _Record_Exit_6(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5
);

void _Record_Exit_7(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6
);

void _Record_Exit_8(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7
);

void _Record_Exit_9(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7,
  rtems_record_data   data_8
);

void _Record_Exit_10(
  void               *return_address,
  rtems_record_event  event,
  rtems_record_data   data_0,
  rtems_record_data   data_1,
  rtems_record_data   data_2,
  rtems_record_data   data_3,
  rtems_record_data   data_4,
  rtems_record_data   data_5,
  rtems_record_data   data_6,
  rtems_record_data   data_7,
  rtems_record_data   data_8,
  rtems_record_data   data_9
);

/**
 * @addtogroup RTEMSRecord
 *
 * @{
 */

/**
 * @brief Prepares to add and commit record items in a critical section with
 * interrupts disabled.
 *
 * This function does not disable interrupts.  It must be called with
 * interrupts disabled.  Interrupts must be disabled until the corresponding
 * rtems_record_commit_critical() was called.
 *
 * @param context The record context which must be used for the following
 *   rtems_record_add() and rtems_record_commit_critical() calls.  The record
 *   context may have an arbitrary content at function entry.
 * @param cpu_self The control of the current processor.
 */
RTEMS_INLINE_ROUTINE void rtems_record_prepare_critical(
  rtems_record_context  *context,
  const Per_CPU_Control *cpu_self
)
{
  Record_Control *control;
  unsigned int    head;

  context->now = RTEMS_RECORD_TIME_EVENT( _Record_Now(), 0 );
  control = cpu_self->record;
  context->control = control;
  head = _Record_Head( control );
  context->head = head;
}

/**
 * @brief Prepares to add and commit record items.
 *
 * This function disables interrupts.
 *
 * @param context The record context which must be used for the following
 *   rtems_record_add() and rtems_record_commit() calls.  The record context
 *   may have an arbitrary content at function entry.
 *
 * @see rtems_record_produce().
 */
RTEMS_INLINE_ROUTINE void rtems_record_prepare( rtems_record_context *context )
{
  uint32_t               level;
  const Per_CPU_Control *cpu_self;
  Record_Control        *control;
  unsigned int           head;

  _CPU_ISR_Disable( level );
  RTEMS_COMPILER_MEMORY_BARRIER();
  context->now = RTEMS_RECORD_TIME_EVENT( _Record_Now(), 0 );
  context->level = level;
  cpu_self = _Per_CPU_Get();
  control = cpu_self->record;
  context->control = control;
  head = _Record_Head( control );
  context->head = head;
}

/**
 * @brief Adds a record item.
 *
 * @param context The record context initialized via rtems_record_prepare().
 * @param event The record event without a time stamp for the item.
 * @param data The record data for the item.
 */
RTEMS_INLINE_ROUTINE void rtems_record_add(
  rtems_record_context *context,
  rtems_record_event    event,
  rtems_record_data     data
)
{
  Record_Control    *control;
  rtems_record_item *item;
  unsigned int       head;

  control = context->control;
  head = context->head;
  item = &control->Items[ _Record_Index( control, head ) ];
  context->head = head + 1;

  item->event = context->now | event;
  item->data = data;
}

/**
 * @brief Commits a set of record items in a critical section with interrupts
 * disabled.
 *
 * @param context The record context initialized via
 *   rtems_record_prepare_critical().
 */
RTEMS_INLINE_ROUTINE void rtems_record_commit_critical( rtems_record_context *context )
{
  _Atomic_Store_uint(
    &context->control->head,
    context->head,
    ATOMIC_ORDER_RELEASE
  );
}

/**
 * @brief Commits a set of record items.
 *
 * @param context The record context initialized via rtems_record_prepare().
 */
RTEMS_INLINE_ROUTINE void rtems_record_commit( rtems_record_context *context )
{
  rtems_record_commit_critical( context );
  RTEMS_COMPILER_MEMORY_BARRIER();
  _CPU_ISR_Enable( context->level );
}

/**
 * @brief Produces a record item.
 *
 * @param event The record event without a time stamp for the item.
 * @param data The record data for the item.
 */
void rtems_record_produce( rtems_record_event event, rtems_record_data data );

/**
 * @brief Produces two record items.
 *
 * @param event_0 The record event without a time stamp for the first item.
 * @param data_0 The record data for the first item.
 * @param event_1 The record event without a time stamp for the second item.
 * @param data_1 The record data for the second item.
 */
void rtems_record_produce_2(
  rtems_record_event event_0,
  rtems_record_data  data_0,
  rtems_record_event event_1,
  rtems_record_data  data_1
);

/**
 * @brief Produces n record items.
 *
 * @param item The record items without a time stamps.
 * @param n The count of record items.
 */
void rtems_record_produce_n(
  const rtems_record_item *items,
  size_t                   n
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event.
 *
 * The event data is the address of the call to this function.
 */
void rtems_record_line( void );

/**
 * @brief Generates an RTEMS_RECORD_LINE event and an extra event.
 *
 * The event data is the address of the call to this function.
 *
 * @param event The record event without a time stamp for the second item.
 * @param data The record data for the second item.
 */
void rtems_record_line_2(
  rtems_record_event event,
  rtems_record_data  data
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and two extra events.
 *
 * The event data is the address of the call to this function.
 *
 * @param event_0 The record event without a time stamp for the second item.
 * @param data_0 The record data for the second item.
 * @param event_1 The record event without a time stamp for the third item.
 * @param data_1 The record data for the third item.
 */
void rtems_record_line_3(
  rtems_record_event event_0,
  rtems_record_data  data_0,
  rtems_record_event event_1,
  rtems_record_data  data_1
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and one argument event.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data The RTEMS_RECORD_ARG_0 event data.
 */
void rtems_record_line_arg( rtems_record_data data );

/**
 * @brief Generates an RTEMS_RECORD_LINE event and two argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 */
void rtems_record_line_arg_2(
  rtems_record_data data_0,
  rtems_record_data data_1
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and three argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 */
void rtems_record_line_arg_3(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and four argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 */
void rtems_record_line_arg_4(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and five argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 */
void rtems_record_line_arg_5(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and six argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 */
void rtems_record_line_arg_6(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4,
  rtems_record_data data_5
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and seven argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 */
void rtems_record_line_arg_7(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4,
  rtems_record_data data_5,
  rtems_record_data data_6
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and eight argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 */
void rtems_record_line_arg_8(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4,
  rtems_record_data data_5,
  rtems_record_data data_6,
  rtems_record_data data_7
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and nine argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 */
void rtems_record_line_arg_9(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4,
  rtems_record_data data_5,
  rtems_record_data data_6,
  rtems_record_data data_7,
  rtems_record_data data_8
);

/**
 * @brief Generates an RTEMS_RECORD_LINE event and ten argument events.
 *
 * The event data of the RTEMS_RECORD_LINE event is the address of the call to
 * this function.
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 * @param data_9 The RTEMS_RECORD_ARG_9 event data.
 */
void rtems_record_line_arg_10(
  rtems_record_data data_0,
  rtems_record_data data_1,
  rtems_record_data data_2,
  rtems_record_data data_3,
  rtems_record_data data_4,
  rtems_record_data data_5,
  rtems_record_data data_6,
  rtems_record_data data_7,
  rtems_record_data data_8,
  rtems_record_data data_9
);

/**
 * @brief Generates an RTEMS_RECORD_CALLER and an RTEMS_RECORD_LINE event.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller().
 */
#define rtems_record_caller() _Record_Caller( RTEMS_RETURN_ADDRESS() )

/**
 * @brief Generates an RTEMS_RECORD_CALLER, an RTEMS_RECORD_LINE event, and an
 * extra event.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_3().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_3().
 *
 * @param event The record event without a time stamp for the third item.
 * @param data The record data for the third item.
 */
#define rtems_record_caller_3( event, data ) \
  _Record_Caller_3( RTEMS_RETURN_ADDRESS(), event, data )

/**
 * @brief Generates an RTEMS_RECORD_CALLER, an RTEMS_RECORD_LINE event, and two
 * extra events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_4().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_4().
 *
 * @param event_0 The record event without a time stamp for the third item.
 * @param data_0 The record data for the third item.
 * @param event_1 The record event without a time stamp for the fourth item.
 * @param data_1 The record data for the fourth item.
 */
#define rtems_record_caller_4( event_0, data_0, event_1, data_1 ) \
  _Record_Caller_4( \
    RTEMS_RETURN_ADDRESS(), \
    event_0, \
    data_0, \
    event_1, \
    data_1 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and one argument event.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg().
 *
 * @param data The RTEMS_RECORD_ARG_0 event data.
 */
#define rtems_record_caller_arg( data ) \
  _Record_Caller_arg( RTEMS_RETURN_ADDRESS(), data )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and two argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_2().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_2().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 */
#define rtems_record_caller_arg_2( data_0, data_1 ) \
  _Record_Caller_arg_2( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and three argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_3().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_3().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 */
#define rtems_record_caller_arg_3( data_0, data_1, data_2 ) \
  _Record_Caller_arg_3( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and four argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_4().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_4().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 */
#define rtems_record_caller_arg_4( data_0, data_1, data_2, data_3 ) \
  _Record_Caller_arg_4( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and five argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_5().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_5().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 */
#define rtems_record_caller_arg_5( data_0, data_1, data_2, data_3, data_4 ) \
  _Record_Caller_arg_5( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and six argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_6().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_6().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 */
#define rtems_record_caller_arg_6( \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5 \
) \
  _Record_Caller_arg_6( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and seven argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_7().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_7().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 */
#define rtems_record_caller_arg_7( \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6 \
) \
  _Record_Caller_arg_7( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and eight argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_8().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_8().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 */
#define rtems_record_caller_arg_8( \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7 \
) \
  _Record_Caller_arg_8( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and nine argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_9().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_9().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 */
#define rtems_record_caller_arg_9( \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8 \
) \
  _Record_Caller_arg_9( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8 \
  )

/**
 * @brief Generates an RTEMS_RECORD_CALLER event, an RTEMS_RECORD_LINE event,
 * and ten argument events.
 *
 * The RTEMS_RECORD_CALLER event data is the return address of the function
 * calling rtems_record_caller_arg_10().
 *
 * The RTEMS_RECORD_LINE event data is the address of the call to
 * rtems_record_caller_arg_10().
 *
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 * @param data_10 The RTEMS_RECORD_ARG_10 event data.
 */
#define rtems_record_caller_arg_10( \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8, \
  data_9 \
) \
  _Record_Caller_arg_10( \
    RTEMS_RETURN_ADDRESS(), \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8, \
    data_9 \
  )

/**
 * @brief Generates the specified entry event.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry().
 *
 * @param event The entry event.
 */
#define rtems_record_entry( event ) \
  rtems_record_produce( event, (rtems_record_data) RTEMS_RETURN_ADDRESS() )

/**
 * @brief Generates the specified entry event and an argument event.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_1().
 *
 * @param event The entry event.
 * @param data The RTEMS_RECORD_ARG_0 event data.
 */
#define rtems_record_entry_1( event, data ) \
  rtems_record_produce_2( \
    event, \
    (rtems_record_data) RTEMS_RETURN_ADDRESS(), \
    RTEMS_RECORD_ARG_0, \
    data \
  )

/**
 * @brief Generates the specified entry event and two argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_2().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 */
#define rtems_record_entry_2( event, data_0, data_1 ) \
  _Record_Entry_2( RTEMS_RETURN_ADDRESS(), event, data_0, data_1 )

/**
 * @brief Generates the specified entry event and three argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_3().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 */
#define rtems_record_entry_3( event, data_0, data_1, data_2 ) \
  _Record_Entry_3( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2 \
  )

/**
 * @brief Generates the specified entry event and four argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_4().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 */
#define rtems_record_entry_4( event, data_0, data_1, data_2, data_3 ) \
  _Record_Entry_4( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3 \
  )

/**
 * @brief Generates the specified entry event and five argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_5().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 */
#define rtems_record_entry_5( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4 \
) \
  _Record_Entry_5( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4 \
  )

/**
 * @brief Generates the specified entry event and six argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_6().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 */
#define rtems_record_entry_6( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5 \
) \
  _Record_Entry_6( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5 \
  )

/**
 * @brief Generates the specified entry event and seven argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_7().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 */
#define rtems_record_entry_7( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6 \
) \
  _Record_Entry_7( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6 \
  )

/**
 * @brief Generates the specified entry event and eight argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_8().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 */
#define rtems_record_entry_8( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7 \
) \
  _Record_Entry_8( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7 \
  )

/**
 * @brief Generates the specified entry event and nine argument events.
 *
 * The event data of the specified entry event is the return address of the
 * function calling rtems_record_entry_9().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 */
#define rtems_record_entry_9( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8 \
) \
  _Record_Entry_9( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8 \
  )

/**
 * @brief Generates the specified entry event and ten argument events.
 *
 * The event data of the specified entry event is the return address of the function
 * calling rtems_record_entry_10().
 *
 * @param event The entry event.
 * @param data_0 The RTEMS_RECORD_ARG_0 event data.
 * @param data_1 The RTEMS_RECORD_ARG_1 event data.
 * @param data_2 The RTEMS_RECORD_ARG_2 event data.
 * @param data_3 The RTEMS_RECORD_ARG_3 event data.
 * @param data_4 The RTEMS_RECORD_ARG_4 event data.
 * @param data_5 The RTEMS_RECORD_ARG_5 event data.
 * @param data_6 The RTEMS_RECORD_ARG_6 event data.
 * @param data_7 The RTEMS_RECORD_ARG_7 event data.
 * @param data_8 The RTEMS_RECORD_ARG_8 event data.
 * @param data_10 The RTEMS_RECORD_ARG_10 event data.
 */
#define rtems_record_entry_10( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8, \
  data_9 \
) \
  _Record_Entry_10( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8, \
    data_9 \
  )

/**
 * @brief Generates the specified exit event.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit().
 *
 * @param event The exit event.
 */
#define rtems_record_exit( event ) \
  rtems_record_produce( event, (rtems_record_data) RTEMS_RETURN_ADDRESS() )

/**
 * @brief Generates the specified exit event and a return event.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_1().
 *
 * @param event The exit event.
 * @param data The RTEMS_RECORD_RETURN_0 event data.
 */
#define rtems_record_exit_1( event, data ) \
  rtems_record_produce_2( \
    event, \
    (rtems_record_data) RTEMS_RETURN_ADDRESS(), \
    RTEMS_RECORD_RETURN_0, \
    data \
  )

/**
 * @brief Generates the specified exit event and two argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_2().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 */
#define rtems_record_exit_2( event, data_0, data_1 ) \
  _Record_Entry_2( RTEMS_RETURN_ADDRESS(), event, data_0, data_1 )

/**
 * @brief Generates the specified exit event and three argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_3().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 */
#define rtems_record_exit_3( event, data_0, data_1, data_2 ) \
  _Record_Exit_3( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2 \
  )

/**
 * @brief Generates the specified exit event and four argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_4().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 */
#define rtems_record_exit_4( event, data_0, data_1, data_2, data_3 ) \
  _Record_Exit_4( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3 \
  )

/**
 * @brief Generates the specified exit event and five argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_5().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 */
#define rtems_record_exit_5( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4 \
) \
  _Record_Exit_5( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4 \
  )

/**
 * @brief Generates the specified exit event and six argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_6().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 * @param data_5 The RTEMS_RECORD_RETURN_5 event data.
 */
#define rtems_record_exit_6( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5 \
) \
  _Record_Exit_6( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5 \
  )

/**
 * @brief Generates the specified exit event and seven argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_7().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 * @param data_5 The RTEMS_RECORD_RETURN_5 event data.
 * @param data_6 The RTEMS_RECORD_RETURN_6 event data.
 */
#define rtems_record_exit_7( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6 \
) \
  _Record_Exit_7( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6 \
  )

/**
 * @brief Generates the specified exit event and eight argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_8().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 * @param data_5 The RTEMS_RECORD_RETURN_5 event data.
 * @param data_6 The RTEMS_RECORD_RETURN_6 event data.
 * @param data_7 The RTEMS_RECORD_RETURN_7 event data.
 */
#define rtems_record_exit_8( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7 \
) \
  _Record_Exit_8( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7 \
  )

/**
 * @brief Generates the specified exit event and nine argument events.
 *
 * The event data of the specified exit event is the return address of the
 * function calling rtems_record_exit_9().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 * @param data_5 The RTEMS_RECORD_RETURN_5 event data.
 * @param data_6 The RTEMS_RECORD_RETURN_6 event data.
 * @param data_7 The RTEMS_RECORD_RETURN_7 event data.
 * @param data_8 The RTEMS_RECORD_RETURN_8 event data.
 */
#define rtems_record_exit_9( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8 \
) \
  _Record_Exit_9( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8 \
  )

/**
 * @brief Generates the specified exit event and ten argument events.
 *
 * The event data of the specified exit event is the return address of the function
 * calling rtems_record_exit_10().
 *
 * @param event The exit event.
 * @param data_0 The RTEMS_RECORD_RETURN_0 event data.
 * @param data_1 The RTEMS_RECORD_RETURN_1 event data.
 * @param data_2 The RTEMS_RECORD_RETURN_2 event data.
 * @param data_3 The RTEMS_RECORD_RETURN_3 event data.
 * @param data_4 The RTEMS_RECORD_RETURN_4 event data.
 * @param data_5 The RTEMS_RECORD_RETURN_5 event data.
 * @param data_6 The RTEMS_RECORD_RETURN_6 event data.
 * @param data_7 The RTEMS_RECORD_RETURN_7 event data.
 * @param data_8 The RTEMS_RECORD_RETURN_8 event data.
 * @param data_10 The RTEMS_RECORD_RETURN_10 event data.
 */
#define rtems_record_exit_10( \
  event, \
  data_0, \
  data_1, \
  data_2, \
  data_3, \
  data_4, \
  data_5, \
  data_6, \
  data_7, \
  data_8, \
  data_9 \
) \
  _Record_Exit_10( \
    RTEMS_RETURN_ADDRESS(), \
    event, \
    data_0, \
    data_1, \
    data_2, \
    data_3, \
    data_4, \
    data_5, \
    data_6, \
    data_7, \
    data_8, \
    data_9 \
  )

/**
 * @brief Disables interrupts and generates an RTEMS_RECORD_ISR_DISABLE event.
 *
 * @return The previous interrupt level.
 */
uint32_t rtems_record_interrupt_disable( void );

/**
 * @brief Restores the previous interrupt level and generates an
 *   RTEMS_RECORD_ISR_ENABLE event.
 *
 * @param level The previous interrupt level.  Must be the return value of the
 *   corresponding rtems_record_interrupt_disable().
 */
void rtems_record_interrupt_enable( uint32_t level );

typedef void ( *rtems_record_drain_visitor )(
  const rtems_record_item *items,
  size_t                   count,
  void                    *arg
);

void _Record_Drain(
  Record_Control             *control,
  uint32_t                    cpu_index,
  rtems_record_drain_visitor  visitor,
  void                       *arg
);

/**
 * @brief Drains the record items on all processors.
 *
 * Calls the visitor function for each drained item set.
 *
 * @param visitor The visitor function.
 * @param arg The argument for the visitor function.
 */
void rtems_record_drain( rtems_record_drain_visitor visitor, void *arg );

/** @} */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _RTEMS_RECORD_H */