The list of policies associated with a protocol. More...

#include <policy_list.hh>

Inheritance diagram for PolicyList:

Public Types
enum	PolicyType { IMPORT, EXPORT }
typedef set< uint32_t >	TagSet
typedef map< string, TagSet * >	TagMap
Public Member Functions
	PolicyList (const string &p, PolicyType pt, PolicyMap &pmap, SetMap &smap, VarMap &vmap, string mod)
void	push_back (const string &policyname)
	Append a policy to the list.
void	compile_policy (PolicyStatement &ps, Code::TargetSet &mod, uint32_t &tagstart, map< string, set< uint32_t > > &ptags)
	Compiles a specific policy.
void	compile (Code::TargetSet &mod, uint32_t &tagstart, map< string, set< uint32_t > > &ptags)
	Compile all policies which were not previously compiled.
string	str ()
void	link_code (Code &ret)
	Link the all the code avialable in this policy list with code supplied.
void	get_targets (Code::TargetSet &targets)
	Return all targets in this policy list.
void	get_redist_tags (const string &protocol, Code::TagSet &ts)
	Return the policy tags used by a specific protocol for route redistribution.
Private Types
typedef pair< string, CodeList * >	PolicyCode
typedef list< PolicyCode >	PolicyCodeList
typedef set< string >	POLICIES
Private Member Functions
void	semantic_check (PolicyStatement &ps, VisitorSemantic::PolicyType type)
	Semantically check the policy for this instantiation.
void	compile_import (PolicyCodeList::iterator &iter, PolicyStatement &ps, Code::TargetSet &modified_targets)
	Compile an import policy.
void	compile_export (PolicyCodeList::iterator &iter, PolicyStatement &ps, Code::TargetSet &modified_targets, uint32_t &tagstart, map< string, set< uint32_t > > &ptags)
	Compile an export policy.
Term *	create_mod (Term::BLOCKS block)
void	add_policy_expression (const string &exp)
Private Attributes
string	_protocol
PolicyType	_type
PolicyCodeList	_policies
PolicyMap &	_pmap
SetMap &	_smap
VarMap &	_varmap
string	_mod
Term *	_mod_term
Term *	_mod_term_import
Term *	_mod_term_export
POLICIES	_pe_policies
Static Private Attributes
static uint32_t	_pe = 0

Detailed Description

The list of policies associated with a protocol.

This relates to the import/export directives of protocols.

Depending on what protocols support, they will normally have a single import/export policy list associated with them.

Each policy list is an instantiation of a policy, and thus it hold the specific code for this instantiation.

Constructor & Destructor Documentation

PolicyList::PolicyList	(	const string &	p,
		PolicyType	pt,
		PolicyMap &	pmap,
		SetMap &	smap,
		VarMap &	vmap,
		string	mod
	)

Parameters:

p	protocol for which this list applies.
pt	the type of policy list [import/export].
pmap	the container of all policies.
smap	the container of all sets.
vmap	the VarMap.

Member Function Documentation

void PolicyList::compile	(	Code::TargetSet &	mod,
		uint32_t &	tagstart,
		map< string, set< uint32_t > > &	ptags
	)

Compile all policies which were not previously compiled.

Throws an exception on semantic / compile errors.

Parameters:

mod	set filled with targets which are modified by compilation.
tagstart	first policy tag available.

void PolicyList::compile_export	(	PolicyCodeList::iterator &	iter,
		PolicyStatement &	ps,
		Code::TargetSet &	modified_targets,
		uint32_t &	tagstart,
		map< string, set< uint32_t > > &	ptags
	)		`[private]`

Compile an export policy.

Parameters:

iter	position in code list which needs to be replaced with code.
ps	policy to compile.
modified_targets	set filled with targets modified by compilation.
tagstart	first policy tag available.

void PolicyList::compile_import	(	PolicyCodeList::iterator &	iter,
		PolicyStatement &	ps,
		Code::TargetSet &	modified_targets
	)		`[private]`

Compile an import policy.

Parameters:

iter	position in code list which needs to be replaced with code.
ps	policy to compile.
modified_targets	set filled with targets modified by compilation.

void PolicyList::compile_policy	(	PolicyStatement &	ps,
		Code::TargetSet &	mod,
		uint32_t &	tagstart,
		map< string, set< uint32_t > > &	ptags
	)

Compiles a specific policy.

Throws an exception on semantic / compile errors.

Parameters:

ps	policy to compile.
mod	set filled with targets which are modified by compilation.
tagstart	first policy tag available.

void PolicyList::get_redist_tags	(	const string &	protocol,
		Code::TagSet &	ts
	)

Return the policy tags used by a specific protocol for route redistribution.

Parameters:

protocol	protocol for which tags are requested.
ts	set filled with policy-tags used by the protocol.

void PolicyList::get_targets ( Code::TargetSet & targets )

Return all targets in this policy list.

Parameters:

targets set filled with all targets in this policy instantiation.

void PolicyList::link_code ( Code & ret )

Link the all the code avialable in this policy list with code supplied.

The code supplied will normally contain a target, so only relevant code is linked.

Parameters:

ret	code to link with.

void PolicyList::push_back ( const string & policyname )

Append a policy to the list.

Parameters:

policyname the name of the policy

void PolicyList::semantic_check	(	PolicyStatement &	ps,
		VisitorSemantic::PolicyType	type
	)		`[private]`

Semantically check the policy for this instantiation.

Throws an exception on error.

Parameters:

ps	policy to check.
type	type of policy [import/export].

string PolicyList::str ( )

Returns:: string representation of list

The documentation for this class was generated from the following files:

/home/greearb/git/xorp.ct.github/xorp/policy/policy_list.hh
/home/greearb/git/xorp.ct.github/xorp/policy/policy_list.cc

PolicyList Class Reference

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation