/*
  MMapings  -  manage ranges of mmaped areas on a file descriptor

  Copyright (C)         Lumiera.org
    2008,               Christian Thaeter <ct@pipapo.org>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

* *****************************************************/


/** @file mmapings.c
 ** Implementation of organisational data of memory mapped file regions
 ** @todo development in this area is stalled since 2010
 */


#include "include/logging.h"
#include "lib/mutex.h"
#include "lib/safeclib.h"


#include "vault/mmapings.h"
#include "vault/mmapcache.h"



LumieraMMapings
lumiera_mmapings_init (LumieraMMapings self, LumieraFile file, size_t chunksize, size_t bias)
{
  TRACE (mmapings_dbg);
  REQUIRE (!file->descriptor->mmapings);

  llist_init (&self->mmaps);
  self->descriptor = file->descriptor;
  TODO("align chunksize on 2's exponent or error out?");
  self->chunksize = chunksize;
  self->bias = bias;

  lumiera_mutex_init (&self->lock, "mmapings", &NOBUG_FLAG(mutex_dbg), NOBUG_CONTEXT);

  return self;
}


LumieraMMapings
lumiera_mmapings_destroy (LumieraMMapings self)
{
  TRACE (mmapings_dbg);
  if (!self)
    return NULL;

  LLIST_WHILE_TAIL (&self->mmaps, node)
    {
      LumieraMMap map = LLIST_TO_STRUCTP (node, lumiera_mmap, searchnode);
      REQUIRE (map->refcnt == 0, "map still in use: %p", map);
      lumiera_mmap_delete (map);
    }

  lumiera_mutex_destroy (&self->lock, &NOBUG_FLAG(mutex_dbg), NOBUG_CONTEXT);

  return self;
}


LumieraMMapings
lumiera_mmapings_new (LumieraFile file, size_t chunksize, size_t bias)
{
  TRACE (mmapings_dbg);
  LumieraMMapings self = lumiera_malloc (sizeof (*self));
  return lumiera_mmapings_init (self, file, chunksize, bias);
}


void
lumiera_mmapings_delete (LumieraMMapings self)
{
  TRACE (mmapings_dbg);
  free (lumiera_mmapings_destroy (self));
}


LumieraMMap
lumiera_mmapings_mmap_acquire (LumieraMMapings self, LumieraFile file, off_t start, size_t size)
{
  TRACE (mmapings_dbg);

  LumieraMMap ret = NULL;

  if (self)
    LUMIERA_MUTEX_SECTION (mutex_sync, &self->lock)
      {
        /* find first matching mmap, crude way */
        LLIST_FOREACH (&self->mmaps, node)
          {
            ////////////TODO improve the algorithm used here: choose mmaps by size, move mfu to head etc...

            LumieraMMap mmap = LLIST_TO_STRUCTP (node, lumiera_mmap, searchnode);

            if (mmap->size >= size && mmap->start <= start && mmap->start+mmap->size >= start+size)
              {
                ret = mmap;
                break;
              }
          }

        /* found? */
        if (ret)
          {
            if (!ret->refcnt)
              /* in cache, needs to be checked out */
              lumiera_mmapcache_checkout (ret);
            ++ret->refcnt;
          }
        else
          {
            /* create new mmap */
            TRACE (mmapings_dbg, "mmap not found, creating");
            ret = lumiera_mmap_new (file, start, size);

            llist_insert_head (&self->mmaps, &ret->searchnode);

            TODO ("sort search list?");
          }

        PLANNED ("use refmap for finer grained refcounting");

        ENSURE (llist_is_empty(&ret->cachenode));
     }

  return ret;
}

void
lumiera_mmapings_release_mmap (LumieraMMapings self, LumieraMMap map)
{
  TRACE (mmapings_dbg);

  if (self)
    LUMIERA_MUTEX_SECTION (mutex_sync, &self->lock)
      {
        if (!--map->refcnt)
          {
            TRACE (mmapcache_dbg, "checkin");
            lumiera_mmapcache_checkin (map);
          }
      }
}

/*
// Local Variables:
// mode: C
// c-file-style: "gnu"
// indent-tabs-mode: nil
// End:
*/