Sun Oracle Logo


Sun Netra Data Plane Software Suite 2.1 Update 1 Reference Manual

Reference Manual

820-5156-11



Contents

Figures

Tables

Preface

1. Configuration API

Hardware Architecture API

Hardware Architecture API Data Types

Hardware Architecture API Functions

teja_architecture_create

Description

Syntax

Parameters

Return Values

teja_architecture_set_property

Description

Syntax

Parameters

Return Values

teja_architecture_get_property

Description

Syntax

Parameters

Return Values

teja_architecture_set_read_only

Description

Syntax

Parameters

Return Values

teja_processor_create

Description

Syntax

Parameters

Return Values

teja_processor_set_property

Description

Syntax

Parameters

Return Values

teja_processor_get_property

Description

Syntax

Parameters

Return Values

teja_processor_add_preprocessor_symbol

Description

Syntax

Parameters

Return Values

teja_memory_create

Description

Syntax

Parameters

Return Values

teja_memory_set_property

Description

Syntax

Parameters

Return Values

teja_memory_get_property

Description

Syntax

Parameters

Return Values

teja_bus_create

Description

Syntax

Parameters

Return Values

teja_bus_set_property

Description

Syntax

Parameters

Return Values

teja_bus_get_property

Description

Syntax

Parameters

Return Values

teja_hardware_object_create

Description

Syntax

Parameters

Return Values

teja_hardware_object_set_property

Description

Syntax

Parameters

Return Values

teja_hardware_object_get_property

Description

Syntax

Parameters

Return Values

teja_architecture_connect

Description

Syntax

Parameters

Return Values

teja_processor_connect

Description

Syntax

Parameters

Return Values

teja_memory_connect

Description

Syntax

Parameters

Return Values

teja_hardware_object_connect

Description

Syntax

Parameters

Return Values

teja_lookup_architecture

Description

Syntax

Parameters

Return Values

teja_lookup_processor

Description

Syntax

Parameters

Return Values

teja_lookup_memory

Description

Syntax

Parameters

Return Values

teja_lookup_bus

Description

Syntax

Parameters

Return Values

teja_lookup_hardware_object

Description

Syntax

Parameters

Return Values

teja_port_create

Description

Syntax

Parameters

Return Values

teja_architecture_set_port

Description

Syntax

Parameters

Return Values

teja_architecture_set_port_internal

Description

Syntax

Parameters

Return Values

teja_processor_set_port

Description

Syntax

Parameters

Return Values

teja_memory_set_port

Description

Syntax

Parameters

Return Values

teja_hardware_object_set_port

Description

Syntax

Parameters

Return Values

teja_bus_set_port

Description

Syntax

Parameters

Return Values

teja_port_add_property

Description

Syntax

Parameters

Return Values

teja_architecture_get_parent

Description

Syntax

Parameters

Return Values

teja_processor_get_parent

Description

Syntax

Parameters

Return Values

teja_bus_get_parent

Description

Syntax

Parameters

Return Values

teja_memory_get_parent

Description

Syntax

Parameters

Return Values

teja_hardware_object_get_parent

Description

Syntax

Parameters

Return Values

teja_architecture_get_processors

Description

Syntax

Parameters

Return Values

teja_architecture_get_memories

Description

Syntax

Parameters

Return Values

teja_architecture_get_hardware_objects

Description

Syntax

Parameters

Return Values

teja_architecture_get_busses

Description

Syntax

Parameters

Return Values

teja_architecture_get_architectures

Description

Syntax

Parameters

Return Values

teja_processor_get_connected_bus

Description

Syntax

Parameters

Return Values

teja_memory_get_connected_bus

Description

Syntax

Parameters

Return Values

teja_hardware_object_get_connected_bus

Description

Syntax

Parameters

Return Values

teja_architecture_get_connected_bus

Description

Syntax

Parameters

Return Values

teja_bus_get_connected_processors

Description

Syntax

Parameters

Return Values

teja_bus_get_connected_memories

Description

Syntax

Parameters

Return Values

teja_bus_get_connected_hardware_objects

Description

Syntax

Parameters

Return Values

teja_bus_get_connected_architectures

Description

Syntax

Parameters

Return Values

teja_processor_get_busses

Description

Syntax

Parameters

Return Values

teja_memory_get_busses

Description

Syntax

Parameters

Return Values

teja_hardware_object_get_busses

Description

Syntax

Parameters

Return Values

teja_address_space_create

Description

Syntax

Parameters

Return Values

teja_address_space_join

Description

Syntax

Parameters

Return Values

teja_address_range_create_absolute

Description

Syntax

Parameters

Return Values

teja_address_range_create_aligned

Description

Syntax

Parameters

Return Values

teja_address_range_create_generic

Description

Syntax

Parameters

Return Values

teja_address_range_get_lower_bound

Description

Syntax

Parameters

Return Values

teja_address_range_get_upper_bound

Description

Syntax

Parameters

Return Values

Software Architecture API

Software Architecture API Data Types

Software Architecture API Functions

teja_os_create

Description

Syntax

Parameters

Return Values

teja_os_set_property

Description

Syntax

Parameters

Return Values

teja_os_get_property

Description

Syntax

Parameters

Return Values

teja_process_create

Description

Syntax

Parameters

Return Values

teja_process_set_property

Description

Syntax

Parameters

Return Values

teja_process_get_property

Description

Syntax

Parameters

Return Values

teja_processor_add_preprocessor_symbol

teja_thread_create

Description

Syntax

Parameters

Return Values

teja_thread_set_property

Description

Syntax

Parameters

Return Values

teja_thread_get_property

Description

Syntax

Parameters

Return Values

teja_lookup_os

Description

Syntax

Parameters

Return Values

teja_lookup_process

Description

Syntax

Parameters

Return Values

teja_lookup_thread

Description

Syntax

Parameters

Return Values

teja_channel_declare

Description

Syntax

Parameters

Return Values

teja_channel_set_property

Description

Syntax

Parameters

Return Values

teja_channel_get_property

Description

Syntax

Parameters

Return Values

teja_memory_pool_declare

Description

Syntax

Parameters

Return Values

teja_memory_pool_set_property

Description

Syntax

Parameters

Return Values

teja_memory_pool_get_property

Description

Syntax

Parameters

Return Values

teja_queue_declare

Description

Syntax

Parameters

Return Values

teja_queue_set_property

Description

Syntax

Parameters

Return Values

teja_queue_get_property

Description

Syntax

Parameters

Return Values

teja_mutex_declare

Description

Syntax

Parameters

Return Values

teja_mutex_set_property

Description

Syntax

Parameters

Return Values

teja_mutex_get_property

Description

Syntax

Parameters

Return Values

teja_lookup_channel

Description

Syntax

Parameters

Return Values

teja_lookup_memory_pool

Description

Syntax

Parameters

Return Values

teja_lookup_queue

Description

Syntax

Parameters

Return Values

teja_lookup_mutex

Description

Syntax

Parameters

Return Values

teja_process_add_symbol*

Description

Syntax

Parameters

Return Values

Map API

Map API Data Types

Map API Functions

teja_map_function_to_thread

Description

Syntax

Parameters

Return Values

teja_map_variable_to_memory

Description

Syntax

Parameters

Return Values

teja_alias_variable

Description

Syntax

Parameters

Return Values

teja_map_variables_to_memory

Description

Syntax

Parameters

Return Values

teja_map_initialization_function_to_process

Description

Syntax

Parameters

Return Values

teja_mapping_set_property

Description

Syntax

Parameters

Return Values

Error-Handling API

Error-Handling API Data Types

Error-Handling API Functions

teja_abort

Description

Syntax

Parameters

Return Values

teja_register_error_handler

Description

Syntax

Parameters

Return Values

Error-Handler Function Prototype

CMT-Specific Hardware Architecture Constants

CMT-Specific Hardware Architecture Types

CMT-Specific Hardware Architecture Properties

CMT-Specific Software Architecture Constants

CMT-Specific Software Architecture Types

CMT-Specific Software Architecture Properties

2. User API

Late-Binding API

Late-Binding API Data Types

Late-Binding API Macros

Late-Binding API Mutex Functions

teja_mutex_lock

Description

Syntax

Parameters

Return Values

Example

teja_mutex_trylock

Description

Syntax

Parameters

Return Values

Example

teja_mutex_unlock

Description

Syntax

Parameters

Return Values

Example

Late-Binding API Queue Functions

teja_queue_enqueue

Description

Syntax

Parameters

Return Values

Example

teja_queue_dequeue

Description

Syntax

Parameters

Return Values

Example

teja_queue_is_empty

Description

Syntax

Parameters

Return Values

Example

teja_queue_get_size

Description

Syntax

Parameters

Return Values

Example

Late-Binding API Memory Pool Functions

teja_memory_pool_get_node

Description

Syntax

Parameters

Return Values

Example

teja_memory_pool_put_node

Description

Syntax

Parameters

Return Values

Example

teja_memory_pool_get_node_from_index

Description

Syntax

Parameters

Return Values

Example

teja_memory_pool_get_index_from_node

Description

Syntax

Parameters

Return Values

Example

Late-Binding API Channel Functions

teja_channel_is_connection_open

Description

Syntax

Parameters

Return Values

Example

teja_channel_make_connection

Description

Syntax

Parameters

Return Values

Example

teja_channel_break_connection

Description

Syntax

Parameters

Return Values

Example

teja_channel_send

Description

Syntax

Parameters

Return Values

Example

Late-Binding API Interruptible Wait

teja_wait

Description

Syntax

Parameters

Return Values

Example

Sun Netra DPS Runtime API

Sun Netra DPS Runtime API Data Types

Sun Netra DPS Runtime API Memory Management Functions

teja_free

Description

Syntax

Parameters

Return Values

teja_malloc

Description

Syntax

Parameters

Return Values

teja_realloc

Description

Syntax

Parameters

Return Values

Sun Netra DPS Runtime API Thread Functions

teja_get_thread_id

Description

Syntax

Return Values

teja_get_thread_name_for_id

Description

Syntax

Parameters

Return Values

teja_get_id_for_thread_name

Description

Syntax

Parameters

Return Values

teja_thread_handle_start

Description

Syntax

Parameters

Return Values

teja_thread_handle_end

Description

Syntax

Return Values

teja_thread_handle_get_for_thread_id

Description

Syntax

Parameters

Return Values

Sun Netra DPS Runtime API Miscellaneous Functions

teja_thread_shutdown

Description

Syntax

Return Values

Sun Netra DPS Runtime API Time Functions

teja_get_time

Description

Syntax

Parameters

Return Values

teja_wait_time

Description

Syntax

Parameters

Return Values

teja_os_wait

Description

Syntax

Parameters

Return Values

Miscellaneous Functions

teja_get_argc

Description

Syntax

Return Values

teja_get_argv

Description

Syntax

Return Values

Finite State Automata API

Finite State Automata API Defines

Finite State Automata API Macros

teja_fsm_declare

Description

Syntax

Parameters

teja_fsm_begin

Description

Syntax

Parameters

teja_fsm_end

Description

Syntax

teja_fsm_start

Description

Syntax

Parameters

teja_fsm_state_declare

Description

Syntax

Parameters

teja_fsm_state_begin

Description

Syntax

Parameters

teja_fsm_state_end

Description

Syntax

teja_fsm_goto_state

Description

Syntax

Parameters

FSM Example

Hardware Specific Miscellaneous Functions

teja_os_get_timer

Description

Syntax

Return Values

C Library Support on Bare Hardware

3. Profiler API

Profiler API Configuration

Profiler API Data Types

Profiler API Functions

teja_profiler_start

Description

Syntax

Parameters

Return Values

teja_profiler_stop

Description

Syntax

Parameters

Return Values

teja_profiler_update

Description

Syntax

Parameters

Return Values

teja_profiler_get_values

Description

Syntax

Parameters

Return Values

teja_profiler_get_value

Description

Syntax

Parameters

Return Values

teja_profiler_dump

Description

Syntax

Parameters

Return Values

Processor Specific Profiler Constants

UltraSPARC T1 Processor-Specific Profiler Groups

UltraSPARC T2 Processor-Specific Profiler Groups

4. Driver API

Sun Netra DPS Crypto and Hashing API

Sun Netra DPS Crypto and Hash API Function Descriptions

Crypto and Hash Context Setup Part

NDPSCreateCryptoContext

Description

Syntax

Parameters

Return Values

NDPSDestroyCryptoContext

Description

Syntax

Parameters

Return Values

Crypto API

NDPSCryptKeyLength

Description

Syntax

Parameters

Return Values

NDPSCryptKeyLoad

Description

Syntax

Parameters

Return Values

NDPSCryptIVLoad

Description

Syntax

Parameters

Return Values

NDPSCrypt

Description

Syntax

Parameters

Return Values

NDPSCryptMultiple

Description

Syntax

Parameters

Return Values

NDPSCryptAndHashMultiple

Description

Syntax

Parameters

Return Values

Hash API

NDPSHashLength

Description

Syntax

Parameters

Return Values

NDPSHashIVLoad

Description

Syntax

Parameters

Return Values

NDPSHashIVGet

Description

Syntax

Parameters

Return Values

NDPSHashDirect

Description

Syntax

Parameters

Return Values

NDPSHashDirectMultiple

Description

Syntax

Parameters

Return Values

Crypto and Hash Combined API

NDPSCryptAndHash

Description

Syntax

Parameters

Return Values

Miscellaneous APIs

NDPSAESXCBCMAC96init

Description

Syntax

Parameters

Return Values

NDPSAESXCBCMAC96fini

Description

Syntax

Parameters

Return Values

NDPSAESXCBCMAC96KeyLoad

Description

Syntax

Parameters

Return Values

NDPSAESXCBCMAC96AuthGenerate

Description

Syntax

Parameters

Return Values

Ethernet API

Network Applications

Ethernet Device Driver

Ethernet API Functions

Description of Ethernet API Functions

eth_pbuf_alloc

Description

Syntax

Parameters

Return Values

eth_pbuf_free

Description

Syntax

Parameters

eth_buf_alloc

Description

Syntax

Parameters

Return Values

eth_buf_free

Description

Syntax

Parameters

eth_open

Description

Syntax

Parameters

Return Values

eth_close

Description

Syntax

Parameters

Return Values

eth_read

Description

Syntax

Parameters

Return Values

eth_write

Description

Syntax

Parameters

Return Values

eth_ioc

Description

Syntax

Parameters

Return Values

eth_ioc Command and Arguments

ETH_IOC_GET_MAC_ADDR

Description

Arguments

ETH_IOC_SET_MAC_ADDR

Description

Arguments

ETH_IOC_CHK_LINK

Description

Arguments

ETH_IOC_GET_LINK

Description

Arguments

ETH_IOC_SET_PROMISC

Description

Arguments

ETH_IOC_SET_MAX_FRAME_SIZE

Description

Arguments

ETH_IOC_ADD_MCAST_ADDR

Description

Arguments

ETH_IOC_DEL_MCAST_ADDR

Description

Arguments

ETH_IOC_SHOW_MCAST_ADDR

Description

Arguments

ETH_IOC_SET_ADDR_FILTER

Description

Arguments

ETH_IOC_GET_STATS

Description

Arguments

ETH_IOC_SHOW_STATS

Description

Arguments

ETH_IOC_SET_MAC_TBL

Description

Arguments

ETH_IOC_SHOW_MAC_TBL

Description

Arguments

ETH_IOC_SET_VLAN_TBL

Description

Arguments

ETH_IOC_SET_RDC_GRP

Description

Arguments

ETH_IOC_SHOW_RDC_GRPS

Description

Arguments

ETH_IOC_BIND_RDC_GRP

Description

Arguments

ETH_IOC_GET_PORTINFO

Description

Arguments

ETH_IOC_SHOW_PORTINFO

Description

Arguments

ETH_IOC_SET_CLASSIFY

Description

Arguments

ETH_IOC_CHK_ERRS

Description

Arguments

Ethernet API Function Summary

Notes

Note 1

Note 2

Note 3

Note 4

Note 5

Note 6

Note 7

Note 8

Note 9

Note 10

Note 11

Note 12

vnet Driver API

vnet API Functions

Description of vnet API functions

vnet_pbuf_alloc

Description

Syntax

Parameters

Return Values

vnet_buf_alloc

Description

Syntax

Parameters

Return Values

vnet_pbuf_free

Description

Syntax

Parameters

vnet_buf_free

Description

Syntax

Parameters

Return Values

vnet_eth_open

Description

Syntax

Parameters

Return Values

vnet_eth_read

Description

Syntax

Parameters

Return Values

vnet_eth_write

Description

Syntax

Parameters

Return Values

vnet_eth_ioc

Description

Syntax

Parameters

Return Values

vnet_eth_ioc Commands and Arguments

ETH_IOC_GET_MAC_ADDR

Description

Arguments

ETH_IOC_CHK_LINK

Description

Arguments

ETH_IOC_GET_LINK

Description

Arguments

ETH_IOC_ADD_MCAST_ADDR

Description

Arguments

ETH_IOC_DEL_MCAST_ADDR

Description

Arguments

ETH_IOC_SHOW_MCAST_ADDRS

Description

Arguments

ETH_IOC_GET_STATS

Description

Arguments

ETH_IOC_SHOW_STATS

Description

Arguments

ETH_IOC_SET_MAC_ADDR

ETH_IOC_SET_PROMISC

ETH_IOC_SET_MAX_FRAME_SIZE

ETH_IOC_SET_ADDR_FILTER

ETH_IOC_SET_MAC_TBL

ETH_IOC_SET_VLAN_TBL

ETH_IOC_SET_RDC_GRP

ETH_IOC_SHOW_RDC_GRPS

ETH_IOC_BIND_RDC_GRP

ETH_IOC_GET_PORTINFO

ETH_IOC_SHOW_PORTINFO

ETH_IOC_SET_CLASSIFY

ETH_IOC_CHK_ERRS

Description

vnet_eth_get_mac_addr

Description

Syntax

Parameters

Return Values

vnet_eth_flush

Description

Syntax

Parameters

Return Values

vnet_set_rxburst

Description

Syntax

Parameters

Return Values

vnet_get_rxburst

Description

Syntax

Parameters

Return Values

vnet Device Driver Tunables

Description

Notes

Note 1

Note 2

Note 3

Note 4

Note 5

Note 6

5. Fast Queue API

Fast Queue API Introduction

Fast Queue API Function Descriptions

fastq_create

Description

Syntax

Parameters

Return Values

fastq_enqueue

Description

Syntax

Parameters

Return Values

fastq_dequeue

Description

Syntax

Parameters

Return Values

fastq_enqueue_noyield

Description

Syntax

Parameters

Return Values

fastq_dequeue_noyield

Description

Syntax

Parameters

Return Values

fastq_get_size

Description

Syntax

Parameters

Return Values

fastq_is_empty

Description

Syntax

Parameters

Return Values

fastq_is_full

Description

Syntax

Parameters

Return Values

6. Interprocess Communication API

Interprocess Communication API Introduction

Common Programming Interfaces

ipc_connect

Description

Syntax

Parameters

Return Values

ipc_register_callbacks

Description

Syntax

Parameters

Return Values

ipc_tx

Description

Syntax

Parameters

Return Values

ipc_rx

Description

Syntax

Parameters

ipc_free

Description

Syntax

Parameters

IPC Framework Programming Interfaces

tnipc_init

Description

Syntax

Return Values

tnipc_poll

Description

Syntax

Return Values

tnipc_register_local_poll

Description

Syntax

Parameter

Return Values

tnipc_local_poll

Description

Syntax

Parameter

Return Values

tnipc_unregister_local_poll

Description

Syntax

Parameter

Return Values

IPC Programming Interfaces for Solaris Domains

User Space

Kernel

7. Fastpath Manager API

Fastpath Manager API Introduction

Fastpath Manager API Function Descriptions

fastpath_mgr_init

Description

Syntax

Parameters

Return Values

fastpath_mgr_process

Description

Syntax

Parameters

Return Values

fastpath_mgr_register_event_handler

Description

Syntax

Parameters

Return Values

fastpath_mgr_unregister_event_handler

Description

Syntax

Parameters

Return Values

fastpath_mgr_check

Description

Syntax

Parameters

Return Values

8. Access Control List Library API

Access Control List Library API Introduction

Algorithms

Hybrid Algorithm

Binary Search on Prefix Lengths

TRIE Algorithm

Swapping

Remapping

Data Types

Packet Type

Rule Type

ACL Library API Function Descriptions

acl_init

Description

Syntax

Parameters

Return Values

acl_insert

Description

Syntax

Parameters

Return Values

acl_remove

Description

Syntax

Parameters

Return Values

acl_lookup

Description

Syntax

Parameters

Return Values

acl_list

Description

Syntax

Parameters

Return Values

Error Codes

LPM - Trie API Function Descriptions

trie_create

Description

Syntax

Parameters

Return Values

trie_get_buf

Description

Syntax

Parameters

Return Values

trie_add_prefix

Description

Syntax

Parameters

Return Values

trie_remove_prefix

Description

Syntax

Parameters

Return Values

trie_lookup

Description

Syntax

Parameters

Return Values

LPM - BSPL API Function Descriptions

bspl_create

Description

Syntax

Parameters

Return Values

bspl_destroy

Description

Syntax

Parameters

Return Values

bspl_add_prefix

Description

Syntax

Parameters

Return Values

bspl_add_markers

Description

Syntax

Parameters

Return Values

bspl_remove_prefix

Description

Syntax

Parameters

Return Values

bspl_lookup

Description

Syntax

Parameters

Return Values

bspl6_create

Description

Syntax

Parameters

Return Values

bspl6_destroy

Description

Syntax

Parameters

Return Values

bspl6_add_prefix

Description

Syntax

Parameters

Return Values

bspl6_add_markers

Description

Syntax

Parameters

Return Values

bspl6_remove_prefix

Description

Syntax

Parameters

Return Values

bspl6_lookup

Description

Syntax

Parameters

Return Values

9. malloc Library for Slow Path

malloc Library API Introduction

Compiling Sun Netra DPS Application with malloc Library

procedure iconsmall spaceDeclare Memory Pools

procedure iconsmall spaceInclude malloc Definition

malloc Configuration File

malloc Library APIs

create_malloc_mem_pools

Description

Syntax

Parameters

Return Values

netra_dps_malloc_init

Description

Syntax

malloc

Description

Syntax

Parameters

Return Values

free

Description

Syntax

Parameters

10. Transparent Interprocess Communication API

Transparent Interprocess Communication API Introduction

TIPC Ethernet Bearer API for Sun Sun Netra DPS

tipc_eth_get_mac

Description

Syntax

Parameters

Return Values

tipc_eth_get_fastq

Description

Syntax

Parameters

Return Values

tipc_eth_pbuf_alloc

Description

Syntax

Parameters

Return Values

tipc_eth_pbuf_free

Description

Syntax

Parameters

Return Values

TIPC Entry Point APIs for Sun Netra DPS

tipc_init

Description

Syntax

Parameters

Return Values

tipc_init_mempool

Description

Syntax

Parameters

Return Values

tipc_pbuf_alloc

Description

Syntax

Parameters

Return Values

tipc_pbuf_free

Description

Syntax

Parameters

Return Values

tipc_process

Description

Syntax

Parameters

Return Values

tipc_vnet_config_register

Description

Syntax

Parameters

Return Values

tipc_cfgsrv_pbuf_alloc

Description

Syntax

Parameters

Return Values

tipc_cfgsrv_pbuf_free

Description

Syntax

Parameters

Return Values

TIPC Socket APIs for Sun Netra DPS

socket

Description

Syntax

Parameters

Return Values

accept

Description

Syntax

Parameters

Return Values

recv

Description

Syntax

Parameters

Return Values

recvfrom

Description

Syntax

Parameters

Return Values

send

Description

Syntax

Parameters

Return Values

sendto

Description

Syntax

Parameters

Return Values

TIPC Tunables

procedure iconsmall spaceTo Configure the TIPC Stack With the Linux tn-tipc-config Tool

Index