src/svm/svm_fifo_segment.c - fdio/vpp - Gitiles

 /*
  * Copyright (c) 2016 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #include <svm/svm_fifo_segment.h>

 svm_fifo_segment_main_t svm_fifo_segment_main;

 static void
 preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
 			svm_fifo_segment_create_args_t * a)
 {
   u32 rx_fifo_size, tx_fifo_size;
   svm_fifo_t *f;
   u8 *rx_fifo_space, *tx_fifo_space;
   int i;

   /* Parameter check */
   if (a->rx_fifo_size == 0 || a->tx_fifo_size == 0
       || a->preallocated_fifo_pairs == 0)
     return;

   /* Calculate space requirements */
   rx_fifo_size = (sizeof (*f) + a->rx_fifo_size) * a->preallocated_fifo_pairs;
   tx_fifo_size = (sizeof (*f) + a->tx_fifo_size) * a->preallocated_fifo_pairs;

   /* Allocate rx fifo space. May fail. */
   rx_fifo_space = clib_mem_alloc_aligned_at_offset
     (rx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
      0 /* os_out_of_memory */ );

   /* Same for TX */
   tx_fifo_space = clib_mem_alloc_aligned_at_offset
     (tx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
      0 /* os_out_of_memory */ );

   /* Make sure it worked. Clean up if it didn't... */
   if (rx_fifo_space == 0 || tx_fifo_space == 0)
     {
       if (rx_fifo_space)
 	clib_mem_free (rx_fifo_space);
       else
 	clib_warning ("rx fifo preallocation failure: size %d npairs %d",
 		      a->rx_fifo_size, a->preallocated_fifo_pairs);

       if (tx_fifo_space)
 	clib_mem_free (tx_fifo_space);
       else
 	clib_warning ("tx fifo preallocation failure: size %d nfifos %d",
 		      a->tx_fifo_size, a->preallocated_fifo_pairs);
       return;
     }

   /* Carve rx fifo space */
   f = (svm_fifo_t *) rx_fifo_space;
   for (i = 0; i < a->preallocated_fifo_pairs; i++)
     {
       f->next = fsh->free_fifos[FIFO_SEGMENT_RX_FREELIST];
       fsh->free_fifos[FIFO_SEGMENT_RX_FREELIST] = f;
       rx_fifo_space += sizeof (*f) + a->rx_fifo_size;
       f = (svm_fifo_t *) rx_fifo_space;
     }
   /* Carve tx fifo space */
   f = (svm_fifo_t *) tx_fifo_space;
   for (i = 0; i < a->preallocated_fifo_pairs; i++)
     {
       f->next = fsh->free_fifos[FIFO_SEGMENT_TX_FREELIST];
       fsh->free_fifos[FIFO_SEGMENT_TX_FREELIST] = f;
       tx_fifo_space += sizeof (*f) + a->tx_fifo_size;
       f = (svm_fifo_t *) tx_fifo_space;
     }
 }

 /** (master) create an svm fifo segment */
 int
 svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
 {
   int rv;
   svm_fifo_segment_private_t *s;
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;
   void *oldheap;

   /* Allocate a fresh segment */
   pool_get (sm->segments, s);
   memset (s, 0, sizeof (*s));

   s->ssvm.ssvm_size = a->segment_size;
   s->ssvm.i_am_master = 1;
   s->ssvm.my_pid = getpid ();
   s->ssvm.name = (u8 *) a->segment_name;
   s->ssvm.requested_va = sm->next_baseva;

   rv = ssvm_master_init (&s->ssvm, s - sm->segments);

   if (rv)
     {
       _vec_len (s) = vec_len (s) - 1;
       return (rv);
     }

   /* Note; requested_va updated due to seg base addr randomization */
   sm->next_baseva = s->ssvm.requested_va + a->segment_size;

   sh = s->ssvm.sh;
   oldheap = ssvm_push_heap (sh);

   /* Set up svm_fifo_segment shared header */
   fsh = clib_mem_alloc (sizeof (*fsh));
   memset (fsh, 0, sizeof (*fsh));
   sh->opaque[0] = fsh;
   s->h = fsh;
   fsh->segment_name = format (0, "%s%c", a->segment_name, 0);

   preallocate_fifo_pairs (fsh, a);

   ssvm_pop_heap (oldheap);

   sh->ready = 1;
   a->new_segment_index = s - sm->segments;
   return (0);
 }

 /** Create an svm fifo segment in process-private memory */
 int
 svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
 {
   svm_fifo_segment_private_t *s;
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;

   /* Allocate a fresh segment */
   pool_get (sm->segments, s);
   memset (s, 0, sizeof (*s));

   s->ssvm.ssvm_size = ~0;
   s->ssvm.i_am_master = 1;
   s->ssvm.my_pid = getpid ();
   s->ssvm.name = (u8 *) a->segment_name;
   s->ssvm.requested_va = ~0;

   /* Allocate a [sic] shared memory header, in process memory... */
   sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
   s->ssvm.sh = sh;

   memset (sh, 0, sizeof (*sh));
   sh->heap = clib_mem_get_heap ();

   /* Set up svm_fifo_segment shared header */
   fsh = clib_mem_alloc (sizeof (*fsh));
   memset (fsh, 0, sizeof (*fsh));
   sh->opaque[0] = fsh;
   s->h = fsh;
   fsh->segment_name = format (0, "%s%c", a->segment_name, 0);

   preallocate_fifo_pairs (fsh, a);

   sh->ready = 1;
   a->new_segment_index = s - sm->segments;
   return (0);
 }

 /** (slave) attach to an svm fifo segment */
 int
 svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
 {
   int rv;
   svm_fifo_segment_private_t *s;
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;

   /* Allocate a fresh segment */
   pool_get (sm->segments, s);
   memset (s, 0, sizeof (*s));

   s->ssvm.ssvm_size = a->segment_size;
   s->ssvm.my_pid = getpid ();
   s->ssvm.name = (u8 *) a->segment_name;
   s->ssvm.requested_va = sm->next_baseva;

   rv = ssvm_slave_init (&s->ssvm, sm->timeout_in_seconds);

   if (rv)
     {
       _vec_len (s) = vec_len (s) - 1;
       return (rv);
     }

   /* Fish the segment header */
   sh = s->ssvm.sh;
   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
   s->h = fsh;

   a->new_segment_index = s - sm->segments;
   return (0);
 }

 void
 svm_fifo_segment_delete (svm_fifo_segment_private_t * s)
 {
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
   ssvm_delete (&s->ssvm);
   pool_put (sm->segments, s);
 }

 svm_fifo_t *
 svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
 			     u32 data_size_in_bytes,
 			     svm_fifo_segment_freelist_t list_index)
 {
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;
   svm_fifo_t *f;
   void *oldheap;

   sh = s->ssvm.sh;
   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];

   ssvm_lock (sh, 1, 0);
   oldheap = ssvm_push_heap (sh);

   switch (list_index)
     {
     case FIFO_SEGMENT_RX_FREELIST:
     case FIFO_SEGMENT_TX_FREELIST:
       f = fsh->free_fifos[list_index];
       if (f)
 	{
 	  fsh->free_fifos[list_index] = f->next;
 	  /* (re)initialize the fifo, as in svm_fifo_create */
 	  memset (f, 0, sizeof (*f));
 	  f->nitems = data_size_in_bytes;
 	  f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
 	  goto found;
 	}
       /* FALLTHROUGH */
     case FIFO_SEGMENT_FREELIST_NONE:
       break;

     default:
       clib_warning ("ignore bogus freelist %d", list_index);
       break;
     }

   /* Note: this can fail, in which case: create another segment */
   f = svm_fifo_create (data_size_in_bytes);
   if (PREDICT_FALSE (f == 0))
     {
       ssvm_pop_heap (oldheap);
       ssvm_unlock (sh);
       return (0);
     }

 found:
   /* If rx_freelist add to active fifos list. When cleaning up segment,
    * we need a list of active sessions that should be disconnected. Since
    * both rx and tx fifos keep pointers to the session, it's enough to track
    * only one. */
   if (list_index == FIFO_SEGMENT_RX_FREELIST)
     {
       if (fsh->fifos)
 	{
 	  fsh->fifos->prev = f;
 	  f->next = fsh->fifos;
 	}
       fsh->fifos = f;
     }

   ssvm_pop_heap (oldheap);
   ssvm_unlock (sh);
   return (f);
 }

 void
 svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
 			    svm_fifo_segment_freelist_t list_index)
 {
   ssvm_shared_header_t *sh;
   svm_fifo_segment_header_t *fsh;
   void *oldheap;

   sh = s->ssvm.sh;
   fsh = (svm_fifo_segment_header_t *) sh->opaque[0];

   ssvm_lock (sh, 1, 0);
   oldheap = ssvm_push_heap (sh);

   switch (list_index)
     {
     case FIFO_SEGMENT_RX_FREELIST:
       /* Remove from active list */
       if (f->prev)
 	f->prev->next = f->next;
       if (f->next)
 	f->next->prev = f->prev;
       /* FALLTHROUGH */
     case FIFO_SEGMENT_TX_FREELIST:
       /* Add to free list */
       f->next = fsh->free_fifos[list_index];
       fsh->free_fifos[list_index] = f;
       /* FALLTHROUGH */
     case FIFO_SEGMENT_FREELIST_NONE:
       break;

     default:
       clib_warning ("ignore bogus freelist %d", list_index);
       break;
     }

   ssvm_pop_heap (oldheap);
   ssvm_unlock (sh);
 }

 void
 svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds)
 {
   svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;

   sm->next_baseva = baseva;
   sm->timeout_in_seconds = timeout_in_seconds;
 }

 u32
 svm_fifo_segment_index (svm_fifo_segment_private_t * s)
 {
   return s - svm_fifo_segment_main.segments;
 }

 /*
  * fd.io coding-style-patch-verification: ON
  *
  * Local Variables:
  * eval: (c-set-style "gnu")
  * End:
  */
	/*
	* Copyright (c) 2016 Cisco and/or its affiliates.
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at:
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#include <svm/svm_fifo_segment.h>

	svm_fifo_segment_main_t svm_fifo_segment_main;

	static void
	preallocate_fifo_pairs (svm_fifo_segment_header_t * fsh,
	svm_fifo_segment_create_args_t * a)
	{
	u32 rx_fifo_size, tx_fifo_size;
	svm_fifo_t *f;
	u8 rx_fifo_space, tx_fifo_space;
	int i;

	/* Parameter check */
	if (a->rx_fifo_size == 0 \|\| a->tx_fifo_size == 0
	\|\| a->preallocated_fifo_pairs == 0)
	return;

	/* Calculate space requirements */
	rx_fifo_size = (sizeof (f) + a->rx_fifo_size) a->preallocated_fifo_pairs;
	tx_fifo_size = (sizeof (f) + a->tx_fifo_size) a->preallocated_fifo_pairs;

	/* Allocate rx fifo space. May fail. */
	rx_fifo_space = clib_mem_alloc_aligned_at_offset
	(rx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
	0 /* os_out_of_memory */ );

	/* Same for TX */
	tx_fifo_space = clib_mem_alloc_aligned_at_offset
	(tx_fifo_size, CLIB_CACHE_LINE_BYTES, 0 /* align_offset */ ,
	0 /* os_out_of_memory */ );

	/* Make sure it worked. Clean up if it didn't... */
	if (rx_fifo_space == 0 \|\| tx_fifo_space == 0)
	{
	if (rx_fifo_space)
	clib_mem_free (rx_fifo_space);
	else
	clib_warning ("rx fifo preallocation failure: size %d npairs %d",
	a->rx_fifo_size, a->preallocated_fifo_pairs);

	if (tx_fifo_space)
	clib_mem_free (tx_fifo_space);
	else
	clib_warning ("tx fifo preallocation failure: size %d nfifos %d",
	a->tx_fifo_size, a->preallocated_fifo_pairs);
	return;
	}

	/* Carve rx fifo space */
	f = (svm_fifo_t *) rx_fifo_space;
	for (i = 0; i < a->preallocated_fifo_pairs; i++)
	{
	f->next = fsh->free_fifos[FIFO_SEGMENT_RX_FREELIST];
	fsh->free_fifos[FIFO_SEGMENT_RX_FREELIST] = f;
	rx_fifo_space += sizeof (*f) + a->rx_fifo_size;
	f = (svm_fifo_t *) rx_fifo_space;
	}
	/* Carve tx fifo space */
	f = (svm_fifo_t *) tx_fifo_space;
	for (i = 0; i < a->preallocated_fifo_pairs; i++)
	{
	f->next = fsh->free_fifos[FIFO_SEGMENT_TX_FREELIST];
	fsh->free_fifos[FIFO_SEGMENT_TX_FREELIST] = f;
	tx_fifo_space += sizeof (*f) + a->tx_fifo_size;
	f = (svm_fifo_t *) tx_fifo_space;
	}
	}

	/** (master) create an svm fifo segment */
	int
	svm_fifo_segment_create (svm_fifo_segment_create_args_t * a)
	{
	int rv;
	svm_fifo_segment_private_t *s;
	svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
	ssvm_shared_header_t *sh;
	svm_fifo_segment_header_t *fsh;
	void *oldheap;

	/* Allocate a fresh segment */
	pool_get (sm->segments, s);
	memset (s, 0, sizeof (*s));

	s->ssvm.ssvm_size = a->segment_size;
	s->ssvm.i_am_master = 1;
	s->ssvm.my_pid = getpid ();
	s->ssvm.name = (u8 *) a->segment_name;
	s->ssvm.requested_va = sm->next_baseva;

	rv = ssvm_master_init (&s->ssvm, s - sm->segments);

	if (rv)
	{
	_vec_len (s) = vec_len (s) - 1;
	return (rv);
	}

	/* Note; requested_va updated due to seg base addr randomization */
	sm->next_baseva = s->ssvm.requested_va + a->segment_size;

	sh = s->ssvm.sh;
	oldheap = ssvm_push_heap (sh);

	/* Set up svm_fifo_segment shared header */
	fsh = clib_mem_alloc (sizeof (*fsh));
	memset (fsh, 0, sizeof (*fsh));
	sh->opaque[0] = fsh;
	s->h = fsh;
	fsh->segment_name = format (0, "%s%c", a->segment_name, 0);

	preallocate_fifo_pairs (fsh, a);

	ssvm_pop_heap (oldheap);

	sh->ready = 1;
	a->new_segment_index = s - sm->segments;
	return (0);
	}

	/** Create an svm fifo segment in process-private memory */
	int
	svm_fifo_segment_create_process_private (svm_fifo_segment_create_args_t * a)
	{
	svm_fifo_segment_private_t *s;
	svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
	ssvm_shared_header_t *sh;
	svm_fifo_segment_header_t *fsh;

	/* Allocate a fresh segment */
	pool_get (sm->segments, s);
	memset (s, 0, sizeof (*s));

	s->ssvm.ssvm_size = ~0;
	s->ssvm.i_am_master = 1;
	s->ssvm.my_pid = getpid ();
	s->ssvm.name = (u8 *) a->segment_name;
	s->ssvm.requested_va = ~0;

	/* Allocate a [sic] shared memory header, in process memory... */
	sh = clib_mem_alloc_aligned (sizeof (*sh), CLIB_CACHE_LINE_BYTES);
	s->ssvm.sh = sh;

	memset (sh, 0, sizeof (*sh));
	sh->heap = clib_mem_get_heap ();

	/* Set up svm_fifo_segment shared header */
	fsh = clib_mem_alloc (sizeof (*fsh));
	memset (fsh, 0, sizeof (*fsh));
	sh->opaque[0] = fsh;
	s->h = fsh;
	fsh->segment_name = format (0, "%s%c", a->segment_name, 0);

	preallocate_fifo_pairs (fsh, a);

	sh->ready = 1;
	a->new_segment_index = s - sm->segments;
	return (0);
	}

	/** (slave) attach to an svm fifo segment */
	int
	svm_fifo_segment_attach (svm_fifo_segment_create_args_t * a)
	{
	int rv;
	svm_fifo_segment_private_t *s;
	svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
	ssvm_shared_header_t *sh;
	svm_fifo_segment_header_t *fsh;

	/* Allocate a fresh segment */
	pool_get (sm->segments, s);
	memset (s, 0, sizeof (*s));

	s->ssvm.ssvm_size = a->segment_size;
	s->ssvm.my_pid = getpid ();
	s->ssvm.name = (u8 *) a->segment_name;
	s->ssvm.requested_va = sm->next_baseva;

	rv = ssvm_slave_init (&s->ssvm, sm->timeout_in_seconds);

	if (rv)
	{
	_vec_len (s) = vec_len (s) - 1;
	return (rv);
	}

	/* Fish the segment header */
	sh = s->ssvm.sh;
	fsh = (svm_fifo_segment_header_t *) sh->opaque[0];
	s->h = fsh;

	a->new_segment_index = s - sm->segments;
	return (0);
	}

	void
	svm_fifo_segment_delete (svm_fifo_segment_private_t * s)
	{
	svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;
	ssvm_delete (&s->ssvm);
	pool_put (sm->segments, s);
	}

	svm_fifo_t *
	svm_fifo_segment_alloc_fifo (svm_fifo_segment_private_t * s,
	u32 data_size_in_bytes,
	svm_fifo_segment_freelist_t list_index)
	{
	ssvm_shared_header_t *sh;
	svm_fifo_segment_header_t *fsh;
	svm_fifo_t *f;
	void *oldheap;

	sh = s->ssvm.sh;
	fsh = (svm_fifo_segment_header_t *) sh->opaque[0];

	ssvm_lock (sh, 1, 0);
	oldheap = ssvm_push_heap (sh);

	switch (list_index)
	{
	case FIFO_SEGMENT_RX_FREELIST:
	case FIFO_SEGMENT_TX_FREELIST:
	f = fsh->free_fifos[list_index];
	if (f)
	{
	fsh->free_fifos[list_index] = f->next;
	/* (re)initialize the fifo, as in svm_fifo_create */
	memset (f, 0, sizeof (*f));
	f->nitems = data_size_in_bytes;
	f->ooos_list_head = OOO_SEGMENT_INVALID_INDEX;
	goto found;
	}
	/* FALLTHROUGH */
	case FIFO_SEGMENT_FREELIST_NONE:
	break;

	default:
	clib_warning ("ignore bogus freelist %d", list_index);
	break;
	}

	/* Note: this can fail, in which case: create another segment */
	f = svm_fifo_create (data_size_in_bytes);
	if (PREDICT_FALSE (f == 0))
	{
	ssvm_pop_heap (oldheap);
	ssvm_unlock (sh);
	return (0);
	}

	found:
	/* If rx_freelist add to active fifos list. When cleaning up segment,
	* we need a list of active sessions that should be disconnected. Since
	* both rx and tx fifos keep pointers to the session, it's enough to track
	* only one. */
	if (list_index == FIFO_SEGMENT_RX_FREELIST)
	{
	if (fsh->fifos)
	{
	fsh->fifos->prev = f;
	f->next = fsh->fifos;
	}
	fsh->fifos = f;
	}

	ssvm_pop_heap (oldheap);
	ssvm_unlock (sh);
	return (f);
	}

	void
	svm_fifo_segment_free_fifo (svm_fifo_segment_private_t * s, svm_fifo_t * f,
	svm_fifo_segment_freelist_t list_index)
	{
	ssvm_shared_header_t *sh;
	svm_fifo_segment_header_t *fsh;
	void *oldheap;

	sh = s->ssvm.sh;
	fsh = (svm_fifo_segment_header_t *) sh->opaque[0];

	ssvm_lock (sh, 1, 0);
	oldheap = ssvm_push_heap (sh);

	switch (list_index)
	{
	case FIFO_SEGMENT_RX_FREELIST:
	/* Remove from active list */
	if (f->prev)
	f->prev->next = f->next;
	if (f->next)
	f->next->prev = f->prev;
	/* FALLTHROUGH */
	case FIFO_SEGMENT_TX_FREELIST:
	/* Add to free list */
	f->next = fsh->free_fifos[list_index];
	fsh->free_fifos[list_index] = f;
	/* FALLTHROUGH */
	case FIFO_SEGMENT_FREELIST_NONE:
	break;

	default:
	clib_warning ("ignore bogus freelist %d", list_index);
	break;
	}

	ssvm_pop_heap (oldheap);
	ssvm_unlock (sh);
	}

	void
	svm_fifo_segment_init (u64 baseva, u32 timeout_in_seconds)
	{
	svm_fifo_segment_main_t *sm = &svm_fifo_segment_main;

	sm->next_baseva = baseva;
	sm->timeout_in_seconds = timeout_in_seconds;
	}

	u32
	svm_fifo_segment_index (svm_fifo_segment_private_t * s)
	{
	return s - svm_fifo_segment_main.segments;
	}

	/*
	* fd.io coding-style-patch-verification: ON
	*
	* Local Variables:
	* eval: (c-set-style "gnu")
	* End:
	*/