SysTutorials Posts

NAME arm_unblock_transaction – unblock transaction SYNOPSIS #include <arm4.h> arm_error_t arm_unblock_transaction(  const arm_tran_start_handle_t tran_handle,   const arm_tran_block_handle_t block_handle,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_unblock_transaction() indicates that the suspension indicated by the block_handle for the transaction identified by the start handle is no longer waiting for a downstream transaction to complete. Call arm_unblock_transaction() when a transaction is no longer blocked…

NAME arm_unbind_thread – unbind a thread SYNOPSIS #include <arm4.h> arm_error_t arm_unbind_thread(  const arm_tran_start_handle_t tran_handle,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_unbind_thread() indicates that the thread from which it is called is no longer performing on behalf of the transaction identified by the start handle.   Call arm_unbind_thread() when a thread is no longer executing a transaction. The…

NAME arm_stop_transaction – stop transaction SYNOPSIS #include <arm4.h> arm_error_t arm_stop_transaction(  const arm_tran_start_handle_t tran_handle,   const arm_tran_status_t tran_status,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_stop_transaction() signals the end of a transaction.   Call arm_stop_transaction() just after a transaction completes. arm_start_transaction() signals the ARM library to start timing the transaction response time. arm_stop_transaction() signals the ARM library to stop timing the…

NAME arm_stop_application – stop application SYNOPSIS #include <arm4.h> arm_error_t arm_stop_application(  const arm_app_start_handle_t app_handle,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_stop_application() indicates that the application instance has finished making ARM calls. It typically means that the instance is ending, such as just prior to the process exiting or a thread that represents an application instance terminating.   For…

NAME arm_start_transaction – start transaction SYNOPSIS #include <arm4.h> arm_error_t arm_start_transaction(  const arm_app_start_handle_t app_handle,   const arm_id_t *tran_id,   const arm_correlator_t *parent_correlator,   const arm_int32_t flags,   const arm_buffer4_t *buffer4,   arm_tran_start_handle_t *tran_handle,  arm_correlator_t *current_correlator); DESCRIPTION arm_start_transaction() is used to indicate that a transaction is beginning execution. Call arm_start_transaction() just prior to a transaction beginning execution. arm_start_transaction() signals the ARM library to start timing the transaction response time….

NAME arm_start_application – check application is running SYNOPSIS #include <arm4.h> arm_error_t arm_start_application(  const arm_id_t *app_id,   const arm_char_t *app_group,   const arm_char_t *app_instance,   const arm_int32_t flags,  const arm_buffer4_t *buffer4,   arm_app_start_handle_t *app_handle); DESCRIPTION arm_start_application() indicates that an instance of an application has started running and is prepared to make ARM calls. In many cases, there will be only one application instance in a process,…

NAME arm_report_transaction – report transaction statistics SYNOPSIS #include <arm4.h> arm_error_t arm_report_transaction(  const arm_app_start_handle_t app_handle,   const arm_id_t *tran_id,   const arm_tran_status_t tran_status,   const arm_response_time_t response_time,   const arm_stop_time_t stop_time,   const arm_correlator_t *parent_correlator,   const arm_correlator_t *current_correlator,   const arm_int32_t flags,   const arm_buffer4_t *buffer4); DESCRIPTION arm_report_transaction() is used to report statistics about a transaction that has already completed.   arm_report_transaction() may be used instead of a paired arm_start_transaction() and arm_stop_transaction()…

NAME arm_register_transaction – describe transaction SYNOPSIS #include <arm4.h> arm_error_t arm_register_transaction(  const arm_id_t *app_id,   const arm_char_t *tran_name,   const arm_id_t *input_tran_id,   const arm_int32_t flags,  const arm_buffer4_t *buffer4,  arm_id_t *output_tran_id);  DESCRIPTION arm_register_transaction() describes metadata about a transaction.   The application uses arm_register_transaction() to inform the ARM library of metadata about the transaction measured by the application. This metadata does not change from one application…

NAME arm_register_metric – describe metrics SYNOPSIS #include <arm4.h> arm_error_t arm_register_metric(  const arm_id_t *app_id,   const arm_char_t *name,   const arm_metric_format_t format,   const arm_metric_usage_t usage,   const arm_char_t *unit,   const arm_id_t *input_metric_id,   const arm_int32_t flags,  const arm_buffer4_t *buffer4,  arm_id_t *output_metric_id); DESCRIPTION arm_register_metric() describes metadata about a metric. The application uses arm_register_metric() to inform the ARM library of metadata about each metric the application provides. ARM generates an ID…

NAME arm_register_application – describe application SYNOPSIS #include <arm4.h> arm_error_t arm_register_application(  const arm_char_t *app_name,   const arm_id_t *input_app_id,   const arm_int32_t flags,  const arm_buffer4_t *buffer4,  arm_id_t *output_app_id); DESCRIPTION arm_register_application() describes metadata about an application. The application uses arm_register_application() to inform the ARM library of metadata about the application. This metadata does not change from one application instance to another. It contains part of…

NAME arm_is_charset_supported – check character encoding SYNOPSIS #include <arm4.h> arm_error_t arm_is_charset_supported(  const arm_charset_t charset,  arm_boolean_t *supported); DESCRIPTION arm_is_charset_supported() indicates whether an ARM library supports a specified character encoding. The default encoding for all strings provided by the application on all operating systems is UTF-8. An application may specify an alternate encoding when executing arm_register_application(), and then use…

NAME arm_get_error_message – get error message SYNOPSIS #include <arm4.h> arm_error_t arm_get_error_message(  const arm_charset_t charset,  const arm_error_t code,   arm_message_buffer_t msg); DESCRIPTION arm_get_error_message() stores a string containing an error message for the specified error code. ARM implementations return values that are specific to the implementation. The only enforced convention is that a return code of zero indicates that no errors…

NAME arm_get_correlator_length – get length of correlator SYNOPSIS #include <arm4.h> arm_error_t arm_get_correlator_length(  const arm_correlator_t *correlator,   arm_correlator_length_t *length); DESCRIPTION arm_get_correlator_length() returns the length of a correlator, based on the length field within the correlator header. Note that this length is not necessarily the length of the buffer containing the correlator. A correlator header contains a length field. arm_get_correlator_length()…

NAME arm_get_correlator_flags – get value of flag SYNOPSIS #include <arm4.h> arm_error_t arm_get_correlator_flags(  const arm_correlator_t *correlator,   const arm_int32_t corr_flag_num,   arm_boolean_t *flag); DESCRIPTION arm_get_correlator_flags() returns the value of a specified flag in the correlator header. A correlator header contains bit flags. arm_get_correlator_flags() is used to test the value of those flags. See arm_generate_correlator() for a description of a correlator. corr_flag_num…

NAME arm_get_arrival_time – store current time SYNOPSIS #include <arm4.h> arm_error_t arm_get_arrival_time(  arm_arrival_time_t *opaque_time); DESCRIPTION arm_get_arrival_time() stores a 64-bit integer representing the current time. There are situations in which there is a significant delay between the time when processing of a transaction begins and when all the context property values that are needed before arm_start_transaction() can be…

NAME arm_generate_correlator – generate a correlator SYNOPSIS #include <arm4.h> arm_error_t arm_generate_correlator(  const arm_app_start_handle_t app_handle,   const arm_id_t *tran_id,   const arm_correlator_t *parent_correlator,   const arm_int32_t flags,   const arm_buffer4_t *buffer4,   arm_correlator_t *current_correlator); DESCRIPTION arm_generate_correlator() is used to generate a correlator for use with arm_report_transaction().   A correlator is a correlation token passed from a calling transaction to a called transaction. The correlation token may be…

NAME arm_discard_transaction – discard transaction SYNOPSIS #include <arm4.h> arm_error_t arm_discard_transaction(  const arm_tran_start_handle_t tran_handle,  const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_discard_transaction() signals that the referenced arm_start_transaction() should be ignored and treated as if it never happened. Measurements associated with a transaction that is processing should be discarded. Either arm_discard_transaction() or arm_stop_transaction() is used – never both. An example…

NAME arm_destroy_application – destroy application data SYNOPSIS #include <arm4.h> arm_error_t arm_destroy_application(  const arm_id_t *app_id,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_destroy_application() indicates that the registration data about an application previously registered with arm_register_application() is no longer needed.   The purpose of this call is to signal the ARM implementation so it can release any storage it is…

NAME arm_block_transaction – mark a transaction as blocked SYNOPSIS #include <arm4.h> arm_error_t arm_block_transaction(  const arm_tran_start_handle_t tran_handle,   const arm_int32_t flags,  const arm_buffer4_t *buffer4,  arm_tran_block_handle_t *block_handle); DESCRIPTION arm_block_transaction() is used to indicate that the transaction instance is blocked waiting on an external transaction (which may or may not be instrumented with ARM) or some other event to complete. It has been…

NAME arm_bind_thread – bind thread SYNOPSIS #include <arm4.h> arm_error_t arm_bind_thread(  const arm_tran_start_handle_t tran_handle,   const arm_int32_t flags,  const arm_buffer4_t *buffer4); DESCRIPTION arm_bind_thread() indicates that the thread from which it is called is performing on behalf of the transaction identified by the start handle. The thread binding could be useful for managing computing resources at a finer level of granularity…