NewMadeleine

Documentation

« back to PM2 home.
nm_pkt_wrap_s Struct Reference

Internal packet wrapper. More...

#include <nm_pkt_wrap.h>

Collaboration diagram for nm_pkt_wrap_s:

Public Member Functions

 PUK_LIST_LINK (nm_pkt_wrap)
 link to insert the pw into a nm_pkt_wrap_list.
 
 PUK_LIST_LINK (nm_pw_poll)
 link to insert the pw into a nm_pw_poll
 
 __attribute__ ((aligned(16))) struct iovec prealloc_v[NM_PREALLOC_IOV_LEN]
 pre-allcoated iovec
 

Data Fields

struct nm_core_task_s core_task
 link to insert the pw as a core task
 
nm_drv_t p_drv
 assignated driver.
 
nm_trk_id_t trk_id
 assignated track ID.
 
nm_gate_t p_gate
 assignated gate, if relevant.
 
struct nm_trk_sp_trk
 assignated track, if relevant.
 
nm_pw_flag_t flags
 packet flags.
 
nm_len_t length
 cumulated amount of data (everything included) referenced by this wrap.
 
nm_len_t max_len
 maximum usable length
 
struct nm_data_sp_data
 data represented as datatype (if non-NULL, v must be empty)
 
struct iovec * v
 IO vector.
 
int v_size
 number of allocated entries in the iovec.
 
int v_nb
 number of used entries in the iovec
 
nm_prio_t prio
 priority, used for sending (all trks) and recv (large only)
 
struct nm_pkt_s pkt
 pkt to give to the driver
 
struct nm_refcount_s refcount
 number of references pointing to the header
 
void(* destructor )(struct nm_pkt_wrap_s *p_pw)
 destructor called uppon packet destroy
 
void * destructor_key
 key for destructor to store private data
 
struct nm_req_chunk_list_s req_chunks
 list of req chunks contained in this pw (sending)
 
struct nm_pw_pending_rtr_list_s pending_rtrs
 pending RTRs attached to this pw
 
struct nm_req_sp_unpack
 user-level unpack request (large message only)
 
nm_len_t chunk_offset
 offset of this chunk in the message (for large message)
 
struct nm_data_properties_s data_props
 pre-computed properties for the chunk of data
 
NM_ALIGN_TYPE buf [1]
 

Detailed Description

Internal packet wrapper.

Definition at line 136 of file nm_pkt_wrap.h.

Member Function Documentation

◆ __attribute__()

nm_pkt_wrap_s::__attribute__ ( (aligned(16))  )

pre-allcoated iovec

◆ PUK_LIST_LINK() [1/2]

nm_pkt_wrap_s::PUK_LIST_LINK ( nm_pkt_wrap  )

link to insert the pw into a nm_pkt_wrap_list.

◆ PUK_LIST_LINK() [2/2]

nm_pkt_wrap_s::PUK_LIST_LINK ( nm_pw_poll  )

link to insert the pw into a nm_pw_poll

Field Documentation

◆ buf

NM_ALIGN_TYPE nm_pkt_wrap_s::buf[1]

Definition at line 196 of file nm_pkt_wrap.h.

◆ chunk_offset

nm_len_t nm_pkt_wrap_s::chunk_offset

offset of this chunk in the message (for large message)

Definition at line 184 of file nm_pkt_wrap.h.

◆ core_task

struct nm_core_task_s nm_pkt_wrap_s::core_task

link to insert the pw as a core task

Definition at line 144 of file nm_pkt_wrap.h.

Referenced by nm_pw_completed_enqueue().

◆ data_props

struct nm_data_properties_s nm_pkt_wrap_s::data_props

pre-computed properties for the chunk of data

Definition at line 185 of file nm_pkt_wrap.h.

◆ destructor

void(* nm_pkt_wrap_s::destructor) (struct nm_pkt_wrap_s *p_pw)

destructor called uppon packet destroy

Definition at line 171 of file nm_pkt_wrap.h.

◆ destructor_key

void* nm_pkt_wrap_s::destructor_key

key for destructor to store private data

Definition at line 172 of file nm_pkt_wrap.h.

◆ flags

nm_pw_flag_t nm_pkt_wrap_s::flags

packet flags.

Definition at line 158 of file nm_pkt_wrap.h.

Referenced by nm_header_global_v0len(), nm_pw_completed_enqueue(), and nm_pw_gpu_fill().

◆ length

nm_len_t nm_pkt_wrap_s::length

cumulated amount of data (everything included) referenced by this wrap.

Definition at line 159 of file nm_pkt_wrap.h.

Referenced by nm_pw_remaining_buf().

◆ max_len

nm_len_t nm_pkt_wrap_s::max_len

maximum usable length

Definition at line 160 of file nm_pkt_wrap.h.

Referenced by nm_pw_remaining_buf().

◆ p_data

struct nm_data_s* nm_pkt_wrap_s::p_data

data represented as datatype (if non-NULL, v must be empty)

Definition at line 161 of file nm_pkt_wrap.h.

◆ p_drv

nm_drv_t nm_pkt_wrap_s::p_drv

assignated driver.


Definition at line 151 of file nm_pkt_wrap.h.

Referenced by nm_pw_assign().

◆ p_gate

nm_gate_t nm_pkt_wrap_s::p_gate

assignated gate, if relevant.

Definition at line 153 of file nm_pkt_wrap.h.

Referenced by nm_pw_assign().

◆ p_trk

struct nm_trk_s* nm_pkt_wrap_s::p_trk

assignated track, if relevant.

Definition at line 154 of file nm_pkt_wrap.h.

Referenced by nm_pw_assign().

◆ p_unpack

struct nm_req_s* nm_pkt_wrap_s::p_unpack

user-level unpack request (large message only)

Definition at line 181 of file nm_pkt_wrap.h.

◆ pending_rtrs

struct nm_pw_pending_rtr_list_s nm_pkt_wrap_s::pending_rtrs

pending RTRs attached to this pw

Definition at line 177 of file nm_pkt_wrap.h.

◆ pkt

struct nm_pkt_s nm_pkt_wrap_s::pkt

pkt to give to the driver

Definition at line 167 of file nm_pkt_wrap.h.

◆ prio

nm_prio_t nm_pkt_wrap_s::prio

priority, used for sending (all trks) and recv (large only)

Definition at line 166 of file nm_pkt_wrap.h.

◆ refcount

struct nm_refcount_s nm_pkt_wrap_s::refcount

number of references pointing to the header

Definition at line 170 of file nm_pkt_wrap.h.

Referenced by nm_pw_ref_dec(), and nm_pw_ref_dec_free().

◆ req_chunks

struct nm_req_chunk_list_s nm_pkt_wrap_s::req_chunks

list of req chunks contained in this pw (sending)

Definition at line 176 of file nm_pkt_wrap.h.

◆ trk_id

nm_trk_id_t nm_pkt_wrap_s::trk_id

assignated track ID.


Definition at line 152 of file nm_pkt_wrap.h.

Referenced by nm_header_global_finalize(), and nm_pw_assign().

◆ v

struct iovec* nm_pkt_wrap_s::v

IO vector.

Definition at line 162 of file nm_pkt_wrap.h.

Referenced by nm_header_global_finalize(), and nm_header_global_v0len().

◆ v_nb

int nm_pkt_wrap_s::v_nb

number of used entries in the iovec

Definition at line 164 of file nm_pkt_wrap.h.

◆ v_size

int nm_pkt_wrap_s::v_size

number of allocated entries in the iovec.

Definition at line 163 of file nm_pkt_wrap.h.


The documentation for this struct was generated from the following file: