arm41.h File Reference

ARM 4.1 standard header file. More...

#include "arm4.h"

Go to the source code of this file.

Data Structures
struct	arm_subbuffer_block_cause
	used to specify a block cause for a blocking transaction. More...
struct	arm_message_rcvd_event
	describes a received event. More...
struct	arm_subbuffer_message_rcvd_event
	used to pass an received event to the ARM implementation. More...
struct	arm_message_sent_event
	describes a sent event. More...
struct	arm_subbuffer_message_sent_event
	used to pass a sent event to the ARM implementation. More...
struct	arm_subbuffer_formatted_arrival_time_usecJan1970
	used to pass a arrival time since jan 1970. More...
struct	arm_subbuffer_formatted_arrival_time_strings
	used to pass a arrival time in a string representation More...
struct	arm_subbuffer_prep_time
	used to pass a arrival time as a pre-calculated preparation time More...
struct	arm_subbuffer_prep_stats
	used to pass a arrival time as a pre-calculated preparation statistics More...
struct	arm_subbuffer_diag_properties
	used to pass diagnostic detail properties to the ARM implementation More...
struct	arm_subbuffer_app_control
	The sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers. More...
struct	arm_subbuffer_tran_id_control
	The sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers for all instances using a registered transaction ID. More...
struct	arm_subbuffer_tran_instance_control
	The Transaction Instance Control sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers for a transaction instance. More...
Defines
#define	ARM_SUBBUFFER_BLOCK_CAUSE   8
	Block cause sub-buffer format see arm_subbuffer_block_cause_t.
#define	ARM_SUBBUFFER_MESSAGE_RCVD_EVENT   9
	Message received event sub-buffer format see arm_subbuffer_message_rcvd_event_t.
#define	ARM_SUBBUFFER_MESSAGE_SENT_EVENT   10
	Message sent event sub-buffer format see arm_subbuffer_message_sent_event_t.
#define	ARM_SUBBUFFER_FORMATTED_ARRIVAL_TIME_USECJAN1970   11
	Formatted arrival time UsecJan1970 sub-buffer format see arm_subbuffer_formatted_arrival_time_usecjan1970_t.
#define	ARM_SUBBUFFER_FORMATTED_ARRIVAL_TIME_STRINGS   12
	Formatted arrival time strings sub-buffer format see arm_subbuffer_formatted_arrival_time_strings_t.
#define	ARM_SUBBUFFER_PREP_TIME   13
	Preparation time sub-buffer format see arm_subbuffer_prep_time_t.
#define	ARM_SUBBUFFER_PREP_STATS   14
	Preparation statistics sub-buffer format see arm_subbuffer_prep_stats_t.
#define	ARM_SUBBUFFER_DIAG_PROPERTIES   15
	Diagnostic properties sub-buffer format see arm_subbuffer_diag_properties_t.
#define	ARM_SUBBUFFER_APP_CONTROL   108
	Application control sub-buffer format see arm_subbuffer_app_control_t.
#define	ARM_SUBBUFFER_TRAN_ID_CONTROL   109
	Transction ID control sub-buffer format see arm_subbuffer_tran_id_control_t.
#define	ARM_SUBBUFFER_TRAN_INSTANCE_CONTROL   110
	Transaction instance control sub-buffer format see arm_subbuffer_tran_instance_control_t.
#define	ARM_CORR_FLAGNUM_ASYNCH   3
	Asynchronous flow flag number.
#define	ARM_CORR_FLAGNUM_INDEPENDENT   4
	Independent Flow flag number.
#define	ARM_SET_CORRELATOR_FLAG(corr, flag_num, boolean_value)
	Macro for modifying correlator flags.
#define	ARM_MESSAGE_SENT_EVENT_MAX_COUNT   32
	max. number of sent events.
#define	ARM_MESSAGE_RCVD_EVENT_MAX_COUNT   32
	max. number of received events.
#define	ARM_DIAG_PROPERTY_MAX_CHARS   2048
	max. length of name+value of a diagnostic property
#define	ARM_DIAG_PROPERTIES_MAX_CHARS   4096
	max. total length of diagnostic properties
#define	ARM_EVENT_DESCRIPTION_MAX_CHARS   128
	max. length of the description fields of block cause and message events
#define	ARM_BLOCK_CAUSE_SYNCHRONOUS_EVENT   1
	A synchronous call, such as an RPC (Remote Procedure Call) has been made and the application is awaiting a response before proceeding.
#define	ARM_BLOCK_CAUSE_ASYNCHRONOUS_EVENT   2
	The application has invoked an asynchronous transaction and/or is involved in a conversation that consists of exchanging messages.
#define	ARM41_APP_CONTROL_COUNT   12
	number of control fields starting with app_control_used
#define	ARM41_TRAN_ID_CONTROL_COUNT   9
	number of control fields starting with control_used
#define	ARM41_TRAN_INSTANCE_CONTROL_COUNT   10
	number of control fields starting with control_used
#define	ARM_COLLECTION_DEPTH_NONE   0
	The implementation prefers that the application does not instrument any transactions.
#define	ARM_COLLECTION_DEPTH_PROCESS   1
	The implementation prefers that the application instrument these transactions at a process granularity; i.e., that it use a single arm_start_transaction()/arm_stop_transaction() pair per process.
#define	ARM_COLLECTION_DEPTH_CONTAINER   2
	The implementation prefers that the application instruments these transactions at a container granularity; i.e., that it use a single start/stop pair per container.
#define	ARM_COLLECTION_DEPTH_MAX   3
	The implementation prefers that the application instruments transactions at the maximum possible granularity. This may be the same as the process or container granularity, depending on the application.
Typedefs
typedef arm_int32_t	arm_block_cause_t
typedef struct arm_subbuffer_block_cause	arm_subbuffer_block_cause_t
	used to specify a block cause for a blocking transaction.
typedef struct arm_message_rcvd_event	arm_message_rcvd_event_t
	describes a received event.
typedef struct arm_subbuffer_message_rcvd_event	arm_subbuffer_message_rcvd_event_t
	used to pass an received event to the ARM implementation.
typedef struct arm_message_sent_event	arm_message_sent_event_t
	describes a sent event.
typedef struct arm_subbuffer_message_sent_event	arm_subbuffer_message_sent_event_t
	used to pass a sent event to the ARM implementation.
typedef struct arm_subbuffer_formatted_arrival_time_usecJan1970	arm_subbuffer_formatted_arrival_time_usecJan1970_t
	used to pass a arrival time since jan 1970.
typedef struct arm_subbuffer_formatted_arrival_time_strings	arm_subbuffer_formatted_arrival_time_strings_t
	used to pass a arrival time in a string representation
typedef struct arm_subbuffer_prep_time	arm_subbuffer_prep_time_t
	used to pass a arrival time as a pre-calculated preparation time
typedef struct arm_subbuffer_prep_stats	arm_subbuffer_prep_stats_t
	used to pass a arrival time as a pre-calculated preparation statistics
typedef struct arm_subbuffer_diag_properties	arm_subbuffer_diag_properties_t
	used to pass diagnostic detail properties to the ARM implementation
typedef struct arm_subbuffer_app_control	arm_subbuffer_app_control_t
	The sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers.
typedef struct arm_subbuffer_tran_id_control	arm_subbuffer_tran_id_control_t
	The sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers for all instances using a registered transaction ID.
typedef struct arm_subbuffer_tran_instance_control	arm_subbuffer_tran_instance_control_t
	The Transaction Instance Control sub-buffer is used by applications to request the type and scope of instrumentation the ARM implementation prefers for a transaction instance.

---

Detailed Description

ARM 4.1 standard header file.

This header file defines all defines, typedefs, structures, and API functions visible for an application which uses an ARM agent. All compiler/platform specifics are handled in a separate header file named <arm4os.h>.

Note:

: The ARM4.1 C language binding extends the ARM 4.0 C binding.

---

Typedef Documentation

typedef arm_int32_t arm_block_cause_t

transaction block cause type.