/***** includes *****/
#include "lfds710_ringbuffer_internal.h"





/****************************************************************************/
void lfds710_ringbuffer_write( struct lfds710_ringbuffer_state *rs,
                               void *key,
                               void *value,
                               enum lfds710_misc_flag *overwrite_occurred_flag,
                               void **overwritten_key,
                               void **overwritten_value )
{
  int
    rv = 0;

  struct lfds710_freelist_element
    *fe;

  struct lfds710_queue_umm_element
    *qumme;

  struct lfds710_ringbuffer_element
    *re = NULL;

  LFDS710_PAL_ASSERT( rs != NULL );
  // TRD : key can be NULL
  // TRD : value can be NULL
  // TRD : overwrite_occurred_flag can be NULL
  // TRD : overwritten_key can be NULL
  // TRD : overwritten_value can be NULL
  // TRD : psts can be NULL

  if( overwrite_occurred_flag != NULL )
    *overwrite_occurred_flag = LFDS710_MISC_FLAG_LOWERED;

  do
  {
    rv = lfds710_freelist_pop( &rs->fs, &fe, NULL );

    if( rv == 1 )
      re = LFDS710_FREELIST_GET_VALUE_FROM_ELEMENT( *fe );

    if( rv == 0 )
    {
      // TRD : the queue can return empty as well - remember, we're lock-free; anything could have happened since the previous instruction
      rv = lfds710_queue_umm_dequeue( &rs->qumms, &qumme );

      if( rv == 1 )
      {
        re = LFDS710_QUEUE_UMM_GET_VALUE_FROM_ELEMENT( *qumme );
        re->qumme_use = (struct lfds710_queue_umm_element *) qumme;

        if( overwrite_occurred_flag != NULL )
          *overwrite_occurred_flag = LFDS710_MISC_FLAG_RAISED;

        if( overwritten_key != NULL )
          *overwritten_key = re->key;

        if( overwritten_value != NULL )
          *overwritten_value = re->value;
      }
    }
  }
  while( rv == 0 );

  re->key = key;
  re->value = value;

  LFDS710_QUEUE_UMM_SET_VALUE_IN_ELEMENT( *re->qumme_use, re );
  lfds710_queue_umm_enqueue( &rs->qumms, re->qumme_use );

  return;
}