ospf_prototypes.h

vxworks下ospf协议栈

/* ospf_prototypes.h - OSPF prototypes */

/* Copyright 2000-2003 Wind River Systems, Inc. */
#include "copyright_wrs.h"

/*
modification history
-------------------- 
02p,18aug03,agi     Removed ospf_MD_string(), OSPF now used common mdString()
02o,30jul03,agi     Renamed MD_string() to ospf_MD_string() to avoid name 
                    collision
02n,17jul03,agi     Added ospf_delete_entry_from_list()
02m,30jun03,agi     Fixed SPR#88879, OSPF does not clean up external LSDB when 
                    an interface is brought down
02l,11jun03,ram     SPR#88965 Separate route table and LSDB hash parameters
02k,11jun03,agi     SPR#8858, added bool ospfPartMemInitialize() prototype
02j,02jun03,ram     Removed obsolete memory allocation function prototypes
03w,02jun03,asr     Renamed route_proto to route_protocol
03v,09may03,kc      Fixed SPR#88389 - Added route_proto and is_default_route
                    arguments to ospf_dynamic_flush_external_routes() and
                    ospf_flush_the_link_state_database_of_self_originated_external_lsa().
03u,12may03,asr	    Changes to make OSPF virtual stack compatible
                    ospf_originate_default_summary_link_into_the_area().
02t,26may03,agi     Added ospf_get_system_elapsed_time_second(), OSPF memory
                    and OSPF utilities prototypes
02g,24apr03,kc      Fixed SPR#86625 - added
                    ospf_dynamic_send_default_summary_lsa() prototype. Also
                    added  prematurely_age_advertisement argument to
03t,27may03,mwv     Fixed SPR#87784 - added
                    ospf_process_export_route_queue_all () prototype.
03s,22may03,kkz     SPR#88613 - Added new functions for area address range
                    feature
03r,22may03,dsk     SPR#88619 Fix early LSA retransmission
03q,22apr03,ram     SPR#76812 Modifications for OSPF performance enhancements
03p,17feb02,ram     SPR#81808 Added OSPF memory partition support
02o,17feb03,ram     SPR#85893 Removed ospf_find_all_lsa proto
02n,29jan03,mwv     SPR#85893 add proto for ospf_find_all_lsa ()
03m,28jan03,ram     SPR#85050 Added support for external route redistribution
                    based on OSPF external metric values
03l,06jan03,ram     SPR#85432 Added new hello timer function prototype
03k,09dec02,ram     SPR#83418 Added support for OSPF metric type and value
                    configuration
03j,22nov02,htm     Added ospf_find_router_or_network_routing_table_node()
                    prototype
03i,19nov02,kc      Added prototypes for ospf_notify_areas_for_abr_change() and
                    ospf_flush_network_link_advertisement().  SPR#84478,84485,
                    84486
03h,19nov02,mwv     Merge TMS code SPR 84284
03g,08oct02,agi     Added ospf_is_if_unnumbered_up() prototype
03f,24jun02,kc      Changed check_if_status() prototype to return boolean.
03e,13may02,ark     Added new function ospf_find_network_LSA for SPR 75793
03d,30may02,kc      Added ospf_sysctl_rtableWalk() prototype.
03c,24may02,kc      Added ospf_sysctl_input() prototype.
03b,18apr02,kc      Fixed SPR #74432 - Added prototypes for
                    ospf_dynamic_export_external_routes() and
                    ospf_dynamic_flush_external_routes().
03a,25apr02,jkw     Additional ospfShowRoutingTable routine.
02z,18apr02,jkw     External 1583compatibility flooding.
02y,16apr02,jkw     One copy of external and type 11 lsa
02x,24mar02,kc      Changed ospf_startup() return type from void to STATUS.
02w,09apr02,jkw     Sequence number wrap.
02v,15feb02,kc      Added ospf_dynamic_init_unnumbered_interface() prototype.
02u,09jan02,jkw     Add new function for processing external route queue.
02t,20dec01,jkw     Removed sptr_area->sptr_interfaces structure.
02s,13dec01,kc      Added prototype for ospf_dynamic_calculate_spf().
02r,07dec01,kc      Added ospf_dynamic_reset_interface() and
                    ospf_dynamic_reinit_interface() prototypes.
02q,23oct01,kc      Added the prototypes ospf_dynamic_create_area_range(),
                    ospf_dynamic_destroy_area_range(), ospf_dynamic_config_overflow()
                    and ospf_dynamic_flush_opaque_lsa()
02p,13oct01,kc      Dynamic configuration changes.
02o,12oct01,kc      Added dynamic BOOL argument to ospf_add_entry_to_hosts_list()
                    and ospf_add_entry_to_virtual_link_list().
02n,06oct01,kc      Added ospf_init_setup() prototype.
02m,28sep01,kc      Added ospf_add_entry_to_hosts_list() and
                    ospf_add_entry_to_virtual_link_list() prototypes.
02l,26sep01,kc      Added ospf_put_an_interface_on_areas_interface_list(),
                    ospf_clear_advertisements_from_lists() prototypes.
02k,22sep01,kc      Added prototypes for ospf_multicast_group_request() and
                    ospf_validate_interface(). Obsolete ospf_router_rx_packet(),
                    and ospf_get_port_number() prototypes. Modified function
                    arguments for ospf_router_rx_packet().
02j,17sep01,kc      Added prototypes for ospf_show_xxx() routines.
02i,13aug01,kc      Added ospf_register_with_ip() and ospf_deregister_with_ip()
                    prototypes.
02h,26jul01,jkw     Added opaque lsa APIs
02g,24jul01,jkw     Removed WINROUTER preproc
02f,23jul01,jkw     Added routine to delete all items in the container and the container.
02e,26jun01,jkw     Added updates for multiple path destination.
02d,26sep00,reshma  Added WindRiver CopyRight
02c,25sep00,reshma  RFC-1587 implementation for OSPF NSSA Option, also tested against
                    ANVL.
02b,20jul00,reshma  Unix compatibility related changes.
02a,06jul00,reshma  Removed unnecessary header files and defines.
01z,04apr00,reshma  Added some MIB support (Read only). Passed all important ANVL OSPF
                    tests.
01y,23dec99,reshma  Compatibility with VxWorks-IP and VxWorks RTM-interface
01x,16aug99,jack    Folded the fix in RTM patricia - always return most specific route -
                    Sue case into ospf patricia tree.
01w,19may99,jack    redefined OSPF_PATRICIA_32_BITS_KEY_MAX_BIT_POSITION as per fixes in
                    patricia
01v,19may99,jack    Fixes in patricia on insertion
01u,12may99,jack    Changes related to equal cost multi path and
                    ospf_set_patricia_route_change_status_on_ospf_rt_node
01t,12may99,jack    changed the name of ospf_get_new_next_hop_blocks to
                    ospf_get_new_next_hop_blocks_and_mark_ospf_rt_node_new
01s,12may99,jack    Change in proto type of ospf_get_new_next_hop_blocks
01r,10may99,jack    Changes in prototypes and call and declaration of
                    ospf_get_new_next_hop_blocks
01q,10may99,jack    syntax error fix
01p,10may99,jack    Changes related to ospf_get_new_next_hop_blocks
01o,28dec98,jack    Compiled and added some comments
01n,01dec98,jack    Changes to get rid of vxworks warnings
01m,13nov98,jack    Changes related to introducing queuing in OSPF to RTM interface and
                 bug fix on the external route additions path (to RTM)
01l,11nov98,jack    Config changes, linted and big endian changes
01k,30oct98,jack    Incorporate changes for compilation on Vxworks
01j,23aug98,jack    ANVL tested OSPF with PATRICIA tree route table and no recursion
01i,10aug98,jack    PATRICIA Route Table Based OSPF Code Base
01h,08jul98,jack    Patricia RT table related changes - need to be tested
01g,19jun98,jack    listroutine changes. OSPF add and delete list routines, eventually
                 call the rwutils list routines.
01f,16jun98,jack    Changes related to external_routes queuing and the queue processing
01e,04jun98,jack    Integration with RTM and BGP
01d,10jul97,cindy   Pre-release v1.52b
01c,10feb97,cindy   Release Version 1.52
01b,22oct97,cindy   Release Version 1.50
01a,05jun96,cindy   First Beta Release
*/

#include        <in.h>
#include        <net/if.h>
/************************************************************************/

#if !defined (_OSPF_PROTOTYPES_H_)
#define _OSPF_PROTOTYPES_H_

/*******************/
/* ospf_checksum.c */
/*******************/
USHORT ospf_generate_LS_checksum (void *vptr_data,USHORT length_of_data,BYTE *bptr_checksum);
enum TEST ospf_verify_LS_checksum (void *vptr_data, USHORT length_of_data /* in network order */, USHORT checksum);

/************************/
/* ospf_configuration.c */
/************************/

void ospf_configuration (enum PROTOCOL_CONTROL_OPERATION command,ULONG parameter_0,ULONG parameter_1);
ULONG ospf_get_configuration_table_address (void);
enum TEST ospf_set_default_values (char *cptr_value_string);
ULONG ospf_special_configuration_function_processing (ULONG parameter[]);
enum TEST ospf_set_bgp_subnets_to_redistribute (char *cptr_value_string);
enum TEST ospf_set_rip_subnets_to_redistribute (char *cptr_value_string);
enum TEST ospf_set_static_subnets_to_redistribute (char *cptr_value_string);
enum TEST ospf_set_neighbor_as_not_allowed (char *cptr_value_string);
enum TEST ospf_set_origin_as_not_allowed (char *cptr_value_string);
ULONG ospf_get_router_id();
ULONG ospf_get_number_of_areas();
ULONG ospf_get_number_of_virtual_links();
enum TEST ospf_set_port_passive (char *cptr_value_string);


/******************/
/* ospf_control.c */
/******************/
void ospf_halt_ospf_router (void);
enum TEST ospf_control (enum PROTOCOL_CONTROL_OPERATION command,ULONG parameter_0,ULONG parameter_1);

void ospf_shut_down_ospf_router (void);
/***************************/
/* ospf_database_summary.c */
/***************************/

enum OSPF_RETURN_FLAGS ospf_build_ls_database_summary (OSPF_INTERFACE *sptr_interface,OSPF_NEIGHBOR *sptr_neighbor);
OSPF_LS_DATABASE_SUMMARY *ospf_allocate_ls_database_summary (OSPF_INTERFACE *sptr_interface);
void ospf_free_ls_database_summary (OSPF_LS_DATABASE_SUMMARY *sptr_database_summary);


/******************/
/* ospf_vx_main.c */
/******************/
/*Added change as per TMS PR # 1569.
  Changed the return type from void to STATUS*/
/* void ospf_task_initialize (const char *p_configuration_file);*/

STATUS ospf_task_initialize (const char *p_configuration_file);


/*************************************/
/* ospf_designated_router_election.c */
/*************************************/

void ospf_run_designated_router_election (OSPF_INTERFACE *sptr_interface);

/*******************/
/* ospf_dijkstra.c */
/*******************/

void ospf_run_dijkstra (OSPF_AREA_ENTRY *sptr_area);
void ospf_bring_up_virtual_links_if_necessary (OSPF_AREA_ENTRY *sptr_area);
void ospf_set_intervening_router (OSPF_SHORTEST_PATH_NODE *sptr_vertex_V, OSPF_SHORTEST_PATH_NODE *sptr_vertex_W,
                             OSPF_AREA_ENTRY* sptr_area, OSPF_ROUTER_LINK_PIECE *sptr_link );

/*************************************/
/* ospf_external_routes.c            */
/*************************************/
void ospf_process_external_route_to_ospf ();
OSPF_EXTERNAL_ROUTE* ospf_find_originated_external_route (OSPF_EXTERNAL_ROUTE *sptr_originated_external_routes,
    OSPF_EXTERNAL_ROUTE *sptr_external_route);
/* SPR 85050 -- Begin */
void ospf_queue_export_route_to_ospf (ULONG destination_network,ULONG network_mask,ULONG metric,ULONG forwarding_address,ULONG tag,ULONG proto);
void delete_exported_route_from_ospf (ULONG destination_network,ULONG network_mask,ULONG metric,ULONG forwarding_address,ULONG tag,ULONG proto);
/* SPR 85050 -- End */

/*************************************/
/* ospf_external_route_calculation.c */
/*************************************/

void ospf_calculate_routes_to_external_destinations (void);
#if defined (__NSSA__)
void ospf_calculate_type_7_as_external_routes (void);
#endif /*__NSSA__*/

void ospf_calculate_routes_to_a_single_external_destination (UNION_OSPF_LINK_STATE_ADVERTISEMENT *advertisement,
    enum BOOLEAN on_new_external_lsa_received_path);

#if defined (__NSSA__)
void ospf_calculate_type_7_routes_to_a_single_external_destination (UNION_OSPF_LINK_STATE_ADVERTISEMENT *advertisement,