vipl_structs.h

Go to the documentation of this file.

/********************************************************
 * Myricom VI-GM networking software and documentation  *
 * Copyright (c) 2001 by Myricom, Inc.                  *
 * All rights reserved.                                 *
 * See the file `COPYING' for copyright notice.         *
 ********************************************************/

#ifndef __VIPL_STRUCTS
#define __VIPL_STRUCTS

typedef gm_up_t VIP_UINTPTR;


typedef struct VIP_SEND_REQ
{
  VIP_UCHAR type;
  VIP_UCHAR dest_port_id;
  VIP_UINT16 dest_gm_id;
  VIP_UINT32 length;
  VIP_PVOID64 target_ptr;
  VIP_PVOID ptr;
  struct VIP_GM *vip_gm_ptr;
  struct VIP_NIC *vip_nic_ptr;
  struct VIP_VI *vip_vi_ptr;
  VIP_DESCRIPTOR *vip_desc_ptr;
  struct VIP_SEND_REQ *next;
}
VIP_SEND_REQ;


typedef struct VIP_HANDLE
{
  VIP_UINT16 magic;
  VIP_UINT16 seq_num;
  VIP_UINT32 ref_count;
  struct VIP_HANDLE *prev;
  struct VIP_HANDLE *next;
  struct VIP_NIC *vip_nic_ptr;
}
VIP_HANDLE;


typedef struct VIP_HANDLE_SET
{
  struct gm_lookaside *lookaside;
  VIP_UINT16 set_magic;
  VIP_UINT16 cur_seq_num;
  VIP_UINT32 count;
  VIP_UINT32 max_count;
  VIP_HANDLE *head;
  VIP_HANDLE *tail;
  struct VIP_NIC *vip_nic_ptr;
}
VIP_HANDLE_SET;


typedef struct VIP_GM
{
  struct gm_port *gm_port;
  VIP_PVOID **recv_buffers;
  VIP_PVOID **send_buffers;
  VIP_PVOID *send_buffers_free;
  struct gm_lookaside *vip_send_req_lookaside;
  VIP_SEND_REQ *send_fifo_head;
  VIP_SEND_REQ *send_fifo_tail;
  VIP_UINTPTR memory_registered;
  VIP_UINT32 send_buf_free_cnt;
  VIP_UINT32 send_fifo_queued;
  VIP_UINT32 ref_count;
  VIP_UINT32 gm_id;
  VIP_UINT32 conn_mgr_gm_id;
  VIP_UINT32 magic;
  gm_alarm_t alive_alarm;
  VIP_PACKET_ALIVE *alive_buffer;
  struct VIP_CONN *head_waiting_conn_ptr;
  struct VIP_CONN *tail_waiting_conn_ptr;
  struct VIP_NIC *vip_nic_ptrs[VI_GM_MAX_NIC_HANDLES + 1];
  struct gm_lookaside *notify_lookaside;
  struct gm_lookaside *regmem_avl_lookaside;
  VIP_AVL_TREE_T regmem_avl_tree;
  VIP_UINT16 gm_board_id;
  VIP_UINT16 gm_port_id;
  VIP_UINT16 recv_tokens;
  VIP_UINT16 max_recv_tokens;
  VIP_UINT16 send_tokens;
  VIP_UINT16 max_send_tokens;
  VIP_THREAD_T plumber_periodic;
  VIP_THREAD_T plumber_blocking;
  VIP_MUTEX_T lock;
  VIP_MUTEX_T recv_lock;
  VIP_SEMAPHORE_T blocking_plumber_tokens;
  VIP_BOOLEAN periodic_plumber_cancelled;
  VIP_BOOLEAN blocking_plumber_cancelled;
  VIP_UCHAR mac_address[VI_GM_MAC_ADDRESS_LEN];
}
VIP_GM;


typedef struct VIP_NIC
{
  VIP_UINT16 magic;
  VIP_UINT16 index;
  VIP_UINT32 ptag_last_id;
  VIP_GM *vip_gm_ptr;
  VIP_HANDLE_SET vip_vi_set;
  VIP_HANDLE_SET vip_ptag_set;
  VIP_HANDLE_SET vip_mem_set;
  VIP_HANDLE_SET vip_cq_set;
  VIP_HANDLE_SET vip_conn_set;
  VIP_MEM_HANDLE vip_mem_handle_free;
  struct VIP_MEM *vip_mem_handle_ptrs[VI_GM_MAX_REGISTER_REGIONS + 1];
  VIP_UINT16 vip_vi_index_free;
  struct VIP_VI *vip_vi_ptrs[VI_GM_MAX_VI + 1];
  void (*error_callback) (VIP_PVOID, VIP_ERROR_DESCRIPTOR *);
  VIP_PVOID error_callback_context;
  VIP_MUTEX_T lock;
  VIP_BOOLEAN ns_initialized;
}
VIP_NIC;


typedef struct VIP_CQ_ENTRY
{
  struct VIP_VI *vip_vi_ptr;
  VIP_BOOLEAN recv_queue;
  VIP_BOOLEAN completed;
}
VIP_CQ_ENTRY;


typedef struct VIP_CQ
{
  VIP_HANDLE handle;
  VIP_CQ_ENTRY *queue;
  VIP_UINT32 count;
  VIP_UINT32 next_poll;
  VIP_UINT32 next_completion;
  VIP_UINT32 event_count;
  VIP_EVENT_T event;
  VIP_SEMAPHORE_T notify_tokens;
  VIP_BOOLEAN notify_initialized;
  VIP_BOOLEAN notify_cancelled;
  VIP_THREAD_T notify_thread;
  struct VIP_NOTIFY *first_notify_handler;
  struct VIP_NOTIFY *last_notify_handler;
}
VIP_CQ;


typedef struct VIP_PTAG
{
  VIP_HANDLE handle;
  VIP_UINT32 id;
}
VIP_PTAG;


typedef struct VIP_MEM
{
  VIP_HANDLE handle;
  VIP_BOOLEAN rdma_write;
  VIP_ULONG length;
  VIP_PVOID address;
  VIP_PTAG *vip_ptag_ptr;
}
VIP_MEM;



typedef struct VIP_VI_QUEUE
{
  VIP_DESCRIPTOR *first;
  VIP_DESCRIPTOR *last;
  VIP_DESCRIPTOR *current_desc;
  VIP_MEM_HANDLE current_mem;
  VIP_UINT32 total_count;
  VIP_CQ *vip_cq_ptr;
  VIP_ULONG count_to_process;
  VIP_UINT32 event_count;
  VIP_EVENT_T event;
  VIP_SEMAPHORE_T notify_tokens;
  VIP_BOOLEAN notify_initialized;
  VIP_BOOLEAN notify_cancelled;
  VIP_THREAD_T notify_thread;
  struct VIP_NOTIFY *first_notify_handler;
  struct VIP_NOTIFY *last_notify_handler;
}
VIP_VI_QUEUE;


typedef struct VIP_VI
{
  VIP_HANDLE handle;
  VIP_VI_QUEUE send_queue;
  VIP_VI_QUEUE recv_queue;
  VIP_PTAG *vip_ptag_ptr;
  struct VIP_CONN *conn_ptr;
  VIP_NET_UINT16 net_remote_nic_index;
  VIP_NET_UINT16 net_remote_vi_index;
  VIP_UINT32 mtu;
  VIP_QOS qos;
  VIP_UINT16 index;
  VIP_UINT16 gm_dest_id;
  VIP_UCHAR gm_dest_port;
  VIP_BOOLEAN rdma_write;
  VIP_RELIABILITY_LEVEL reliability;
  VIP_UCHAR pending_callbacks;
  VIP_VI_STATE state;
}
VIP_VI;


typedef struct VIP_CONN
{
  VIP_HANDLE handle;
  VIP_NET_UINT16 net_remote_seq_num;
  VIP_NET_UINT64 net_remote_conn_ptr;
  VIP_VI *vip_vi_ptr;
  struct VIP_CONN *prev_waiting_conn_ptr;
  struct VIP_CONN *next_waiting_conn_ptr;
  gm_alarm_t peer_timeout_alarm;
  VIP_BOOLEAN waiting_list;
  VIP_NET_UINT32 net_srv_magic[VI_GM_MAX_PORTS];
  VIP_VI_ATTRIBUTES remote_vi_attribs;
  VIP_UINT16 locale_disc_len;
  VIP_UCHAR locale_net_addr[VI_GM_MAC_ADDRESS_LEN
                            + VI_GM_MAX_DISCRIMINATOR_LEN];
  VIP_UINT16 remote_disc_len;
  VIP_UCHAR remote_net_addr[VI_GM_MAC_ADDRESS_LEN
                            + VI_GM_MAX_DISCRIMINATOR_LEN];
  VIP_UINT16 remote_gm_id;
  VIP_UCHAR remote_port_id;
  VIP_UCHAR type;
  VIP_RETURN status;
  VIP_EVENT_T event;
}
VIP_CONN;


typedef struct VIP_CHKSUM
{
  VIP_UINT64 sum;
  VIP_UINT64 len;
}
VIP_CHKSUM;


typedef struct VIP_AVL_RANGE
{
  VIP_UINTPTR addr;
  VIP_UINT32 length;
  VIP_UINT32 count;
}
VIP_AVL_RANGE;


typedef struct VIP_NOTIFY
{
  VIP_PVOID handler;
  VIP_PVOID context;
  struct VIP_NOTIFY *next;
}
VIP_NOTIFY;

#endif