eformat::write Namespace Reference

Classes
class	FullEventFragment
struct	node_t
class	ROBFragment
	forward More...
class	ROSFragment
	forward More...
class	SubDetectorFragment
	forward More...

Typedefs
typedef struct eformat::write::node_t	node_t

Functions
void	set (node_t &i, const uint32_t *b, size_t l, node_t *n=0)
void	set (node_t &i, const struct iovec &v, node_t *n=0)
void	cat (node_t *n, const struct iovec *v, uint32_t count)
void	cat (node_t *n, uint32_t count)
uint32_t	count (const node_t &list)
uint32_t	count_words (const node_t &list)
uint32_t	copy (const node_t &list, uint32_t *dest, size_t max)
uint32_t	shallow_copy (const node_t &list, struct iovec *dest, uint32_t max)

Typedef Documentation

node_t

typedef struct eformat::write::node_t eformat::write::node_t

Defines what is a valid "I/O vector" (a.k.a. iov) node list for eformat

Function Documentation

cat() [1/2]

void eformat::write::cat	(	node_t *	n,
		const struct iovec *	v,
		uint32_t	count
	)

Concatenates a set of IOV's to make up a list as required by some eformat::write functionality.

Parameters

n	the first node_t of a vector of node_t's. The C array pointed by n should have at least "count" available positions
v	the first IOV node of a vector
count	the number of IOV nodes pointed by "v"

Definition at line 30 of file node.cxx.

{
  for (size_t i=0; i<(count-1); ++i) set(n[i], v[i], &n[i+1]);
  set(n[count-1], v[count-1], 0);
}

cat() [2/2]

void eformat::write::cat	(	node_t *	n,
		uint32_t	count
	)

Concatenates an already set vector of eformat::write::node_t to make up a valid list.

Parameters

n	the first node_t of a vector of node_t's. The C array pointed by n should have, exactly, "count" available positions
count	the number of IOV nodes pointed by "v"

Definition at line 36 of file node.cxx.

{
  for (size_t i=0; i<(count-1); ++i) n[i].next = &n[i+1];
  n[count-1].next = 0;
}

copy()

uint32_t eformat::write::copy	(	const node_t &	list,
		uint32_t *	dest,
		size_t	max
	)

Performs a memcpy like operation, concatenating the list given as parameter to a block of memory, as fast as possible.

Parameters

list	The top of the list
dest	The destination block of memory
max	The number of 32-bit words allocated in "dest"

Returns

The number of words copied, in total. If the return value was zero, a problem with the total destination size length was detected and the copy operation may have undergone in an incomplete way

Definition at line 64 of file node.cxx.

{
  const eformat::write::node_t* current = &list;
  uint32_t cpos = 0;
  while (current) {
    if (cpos + current->size_word > max) return 0;
    if (current->size_word > 0 && current->base) {
      memcpy(&dest[cpos], current->base, sizeof(uint32_t)*current->size_word);
      cpos += current->size_word;
    }
    current = current->next;
  }
  return cpos;
}

Referenced by eformat::old::convert(), convert_ros(), and RawDataOutputSvc::putEvent().

count()

uint32_t eformat::write::count

(

const node_t &

list

)

Counts how many pages I'm made of

Parameters

list	The top of the list

Definition at line 42 of file node.cxx.

{
  const eformat::write::node_t* current = &list;
  uint32_t retval = 0;
  while (current) {
    ++retval;
    current = current->next;
  }
  return retval;
}

Referenced by eformat::write::FullEventFragment::FullEventFragment(), eformat::write::ROSFragment::ROSFragment(), and eformat::write::SubDetectorFragment::SubDetectorFragment().

count_words()

uint32_t eformat::write::count_words

(

const node_t &

list

)

Count how many words I'm made of

Parameters

list	The top of the list

Definition at line 53 of file node.cxx.

{
  const eformat::write::node_t* current = &list;
  uint32_t retval = 0;
  while (current) {
    retval += current->size_word;
    current = current->next;
  }
  return retval;
}

set() [1/2]

void eformat::write::set	(	node_t &	i,
		const struct iovec &	v,
		node_t *	n = 0
	)

Sets an IOV base values

Parameters

i	the node to be set
v	the I/O vector node to use as basis
n	the next node this node should point to

Definition at line 23 of file node.cxx.

{ 
  i.base = reinterpret_cast<uint32_t*>(v.iov_base);
  i.size_word = v.iov_len/4; 
  i.next = n;
}

set() [2/2]

void eformat::write::set	(	node_t &	i,
		const uint32_t *	b,
		size_t	l,
		node_t *	n = 0
	)

Sets an IOV base values

Parameters

i	the node to be set
b	the base address to be used by this IOV
l	the size of the page, in words
n	the next node this node should point to

Definition at line 16 of file node.cxx.

{ 
  i.base = const_cast<uint32_t*>(b); 
  i.size_word = l; 
  i.next = n;
}

Referenced by cat(), eformat::write::FullEventFragment::FullEventFragment(), eformat::write::FullEventFragment::operator=(), eformat::write::ROBFragment::operator=(), eformat::write::ROSFragment::operator=(), eformat::write::SubDetectorFragment::operator=(), eformat::write::ROBFragment::ROBFragment(), eformat::write::ROSFragment::ROSFragment(), and eformat::write::SubDetectorFragment::SubDetectorFragment().

shallow_copy()

uint32_t eformat::write::shallow_copy	(	const node_t &	list,
		struct iovec *	dest,
		uint32_t	max
	)

Performs a shallow copy like operation, concatenating the list given as parameter to a vector of iovec nodes. This will only copy pointers and sizes, but not real data.

Parameters

list	The top of the list
dest	The destination vector of iovec nodes
max	The number of iovec nodes I can use there

Returns

The number of pages used, in total. If the return value was zero, a problem with the total destination size length was detected and the copy operation may have undergone in an incomplete way

Definition at line 80 of file node.cxx.

{
  const eformat::write::node_t* current = &list;
  uint32_t cpos = 0;
  while (current) {
    if (cpos > max) return 0;
    if (current->size_word > 0 && current->base) {
      dest[cpos].iov_base = 
    reinterpret_cast<void*>(const_cast<uint32_t*>(current->base));
      dest[cpos].iov_len = sizeof(uint32_t)*current->size_word;
      ++cpos;
    }
    current = current->next;
  }
  return cpos;
}