agent.h File Reference

Declarations for Agent initialization. More...

#include "ctr.h"
#include "policy_registry.h"
#include <BPSecLib_Public.h>
#include <BPSecLib_Private.h>
#include <policy_provider/SamplePolicyProvider.h>
#include <m-atomic.h>
#include <m-buffer.h>
#include <m-string.h>
#include <arpa/inet.h>
#include <pthread.h>
#include <inttypes.h>

Include dependency graph for agent.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	MockBPA_Agent_BSL_Ctx_t
	Each BSL context and its associated control state. More...
struct	MockBPA_Agent_t
	Overall Mock BPA state above any particular bundle handling. More...

Macros
#define	MOCKBPA_DATA_QUEUE_SIZE   100
	Queue size for bundle queues.

Functions
int	MockBPA_GetBundleMetadata (const BSL_BundleRef_t *bundle_ref, BSL_PrimaryBlock_t *result_primary_block)
int	MockBPA_GetBlockNums (const BSL_BundleRef_t *bundle_ref, size_t block_id_array_capacity, uint64_t *block_id_array_result, size_t *result_count)
int	MockBPA_GetBlockMetadata (const BSL_BundleRef_t *bundle_ref, uint64_t block_num, BSL_CanonicalBlock_t *result_canonical_block)
int	MockBPA_ReallocBTSD (BSL_BundleRef_t *bundle_ref, uint64_t block_num, size_t bytesize)
int	MockBPA_CreateBlock (BSL_BundleRef_t *bundle_ref, uint64_t block_type_code, uint64_t *result_block_num)
int	MockBPA_RemoveBlock (BSL_BundleRef_t *bundle_ref, uint64_t block_num)
int	MockBPA_DeleteBundle (BSL_BundleRef_t *bundle_ref, BSL_ReasonCode_t reason)
BSL_HostDescriptors_t	MockBPA_Agent_Descriptors (MockBPA_Agent_t *agent)
	Get host descriptors without a specific agent.
int	MockBPA_Agent_Init (MockBPA_Agent_t *agent)
	Initialize and register this mock BPA for the current process.
void	MockBPA_Agent_Deinit (MockBPA_Agent_t *agent)
	Clean up the mock BPA for the current process.
int	MockBPA_Agent_Start (MockBPA_Agent_t *agent)
	Start worker threads.
void	MockBPA_Agent_Stop (MockBPA_Agent_t *agent)
	Stop an agent from another thread or a signal handler.
int	MockBPA_Agent_Exec (MockBPA_Agent_t *agent)
	Execute the main thread activity while work threads are running.
int	MockBPA_Agent_Join (MockBPA_Agent_t *agent)
	Wait for and join worker threads.

Detailed Description

Declarations for Agent initialization.

Function Documentation

MockBPA_Agent_Deinit()

void MockBPA_Agent_Deinit

(

MockBPA_Agent_t *

agent

)

Clean up the mock BPA for the current process.

Parameters

[out]

agent

The agent to deinitialize.

References agent, MockBPA_Agent_t::appin, MockBPA_Agent_t::appout, MockBPA_Agent_BSL_Ctx_t::bsl, BSL_API_DeinitLib(), BSL_FREE, BSL_LOG_ERR, MockBPA_Agent_t::clin, MockBPA_Agent_t::clout, MockBPA_Agent_t::deliver, MockBPA_Agent_t::forward, MockBPA_Agent_BSL_Ctx_t::mutex, MockBPA_Agent_t::over_rx, MockBPA_Agent_t::over_tx, MockBPA_Agent_t::tx_notify_r, MockBPA_Agent_t::tx_notify_w, MockBPA_Agent_t::under_rx, and MockBPA_Agent_t::under_tx.

Referenced by main().

MockBPA_Agent_Descriptors()

BSL_HostDescriptors_t MockBPA_Agent_Descriptors

(

MockBPA_Agent_t *

agent

)

Get host descriptors without a specific agent.

Parameters

[in]

agent

The agent to associate as user data.

References agent, bsl_mock_decode_eid(), bsl_mock_encode_eid(), mock_bpa_eid_from_text(), MockBPA_EID_Deinit(), MockBPA_EID_Init(), and BSL_HostDescriptors_t::user_data.

Referenced by main().

MockBPA_Agent_Exec()

int MockBPA_Agent_Exec

(

MockBPA_Agent_t *

agent

)

Execute the main thread activity while work threads are running.

This will block until MockBPA_Agent_Stop() is called.

Parameters

[out]

agent

The agent to work for.

Returns

Zero if successful.

References agent, MockBPA_Agent_t::app_addr, BSL_Data_AppendFrom(), BSL_LOG_DEBUG, BSL_LOG_ERR, BSL_LOG_INFO, mock_bpa_ctr_t::encoded, BSL_Data_t::len, MockBPA_Agent_t::over_addr, MockBPA_Agent_t::over_rx, MockBPA_Agent_t::over_tx, BSL_Data_t::ptr, MockBPA_Agent_t::router_addr, MockBPA_Agent_t::stop_state, MockBPA_Agent_t::tx_notify_r, MockBPA_Agent_t::under_addr, MockBPA_Agent_t::under_rx, and MockBPA_Agent_t::under_tx.

Referenced by main().

MockBPA_Agent_Init()

int MockBPA_Agent_Init

(

MockBPA_Agent_t *

agent

)

Initialize and register this mock BPA for the current process.

Parameters

[out]

agent

The agent to initialize.

Returns

Zero if successful.

References agent, MockBPA_Agent_t::app_addr, MockBPA_Agent_t::appin, MockBPA_Agent_t::appout, MockBPA_Agent_BSL_Ctx_t::bsl, BSL_API_InitLib(), BSL_API_RegisterPolicyProvider(), BSL_API_RegisterSecurityContext(), BSL_CALLOC, BSL_LibCtx_Sizeof(), BSL_LOG_ERR, BSL_SUCCESS, BSLP_QueryPolicy(), MockBPA_Agent_t::clin, MockBPA_Agent_t::clout, MockBPA_Agent_t::deliver, MockBPA_Agent_t::forward, MOCKBPA_DATA_QUEUE_SIZE, MockBPA_Agent_BSL_Ctx_t::mutex, MockBPA_Agent_t::over_addr, MockBPA_Agent_t::over_rx, MockBPA_Agent_t::over_tx, MockBPA_Agent_BSL_Ctx_t::policy, MockBPA_Agent_t::router_addr, MockBPA_Agent_t::stop_state, MockBPA_Agent_t::tx_notify_r, MockBPA_Agent_t::tx_notify_w, MockBPA_Agent_t::under_addr, MockBPA_Agent_t::under_rx, and MockBPA_Agent_t::under_tx.

Referenced by main().

MockBPA_Agent_Join()

int MockBPA_Agent_Join

(

MockBPA_Agent_t *

agent

)

Wait for and join worker threads.

Parameters

[out]

agent

The agent to start threads for.

Returns

Zero if successful.

See also

MockBPA_Agent_Start()

References agent, BSL_LOG_ERR, BSL_LOG_INFO, MockBPA_Agent_t::deliver, MockBPA_Agent_t::forward, MockBPA_Agent_t::over_rx, MockBPA_Agent_t::thr_over_rx, and MockBPA_Agent_t::under_rx.

Referenced by main().

MockBPA_Agent_Start()

int MockBPA_Agent_Start

(

MockBPA_Agent_t *

agent

)

Start worker threads.

Parameters

[out]

agent

The agent to start threads for.

Returns

Zero if successful.

See also

MockBPA_Agent_Join()

References agent, and MockBPA_Agent_t::thr_over_rx.

Referenced by main().

MockBPA_Agent_Stop()

void MockBPA_Agent_Stop

(

MockBPA_Agent_t *

agent

)

Stop an agent from another thread or a signal handler.

Parameters

[in,out]

agent

The agent to set the stopping state on.

References agent, BSL_LOG_ERR, MockBPA_Agent_t::stop_state, and MockBPA_Agent_t::tx_notify_w.