code.grnet.gr Git - archipelago/blob - xseg/xtypes/xobj.h

   1 /*
   2  * Copyright 2012 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *   2. Redistributions in binary form must reproduce the above
  12  *      copyright notice, this list of conditions and the following
  13  *      disclaimer in the documentation and/or other materials
  14  *      provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  17  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27  * POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * The views and conclusions contained in the software and
  30  * documentation are those of the authors and should not be
  31  * interpreted as representing official policies, either expressed
  32  * or implied, of GRNET S.A.
  33  */
  34
  35 #ifndef __XOBJ_H__
  36 #define __XOBJ_H__
  37
  38 #include <sys/util.h>
  39 #include <xtypes/xlock.h>
  40 #include <xtypes/xheap.h>
  41 #include <xtypes/domain.h>
  42 #include <xtypes/xhash.h>
  43
  44 struct xobject_header {
  45         XPTR_TYPE(struct xseg_object_handler) obj_h;
  46 };
  47
  48 struct xobject {
  49         uint32_t magic;
  50         uint64_t size;
  51         xptr next;
  52 };
  53
  54 struct xobject_h {
  55         struct xlock lock;
  56         uint32_t magic;
  57         uint64_t obj_size;
  58         uint32_t flags;
  59         XPTR_TYPE(void) container;
  60         xptr heap;
  61         xptr allocated;
  62         uint64_t nr_allocated;
  63         uint64_t allocated_space;
  64         xptr list;
  65         uint64_t nr_free;
  66 };
  67
  68 struct xobject_iter {
  69         struct xobject_h *obj_h;
  70         xhash_iter_t xhash_it;
  71         void *chunk;
  72         xhashidx cnt;
  73 };
  74
  75 void *xobj_get_obj(struct xobject_h * obj_h, uint32_t flags);
  76 void xobj_put_obj(struct xobject_h * obj_h, void *ptr);
  77 int xobj_alloc_obj(struct xobject_h * obj_h, uint64_t nr);
  78 int xobj_handler_init(struct xobject_h *obj_h, void *container,
  79                 uint32_t magic, uint64_t size, struct xheap *heap);
  80
  81 void xobj_iter_init(struct xobject_h *obj_h, struct xobject_iter *it);
  82 int xobj_iterate(struct xobject_h *obj_h, struct xobject_iter *it, void **obj);
  83 int xobj_check(struct xobject_h *obj_h, void *obj);
  84 int xobj_isFree(struct xobject_h *obj_h, void *obj);
  85
  86 int __xobj_check(struct xobject_h *obj_h, void *obj);
  87 int __xobj_isFree(struct xobject_h *obj_h, void *obj);
  88
  89 //TODO
  90 //xobj_handler_destroy()
  91 //releases allocated pages
  92 //
  93 //maybe we need lock free versions of get/put obj
  94 //
  95 //also an
  96 //unsigned long xobj_get_objs(obj_h, flags, uint64_t nr, void **buf)
  97 //which will put nr objects in buf
  98 #endif