vat.h

   1 #ifndef _vat__h__included__
   2 #define _vat__h__included__
   3
   4 #include <stdlib.h>
   5 #include "lock.h"
   6
   7 struct message;
   8 struct object;
   9
  10 /* Vat. */
  11 struct vat;
  12
  13 /******************************************************************************
  14  *
  15  * DESCRIPTION:
  16  *      Grab queue lock.
  17  *
  18  * PARAMETERS:
  19  *      vat                     The vat to manipulate.
  20  *
  21  *****************************************************************************/
  22 void vat_grab_queue_lock();
  23
  24 /******************************************************************************
  25  *
  26  * DESCRIPTION:
  27  *      Ungrab queue lock.
  28  *
  29  * PARAMETERS:
  30  *      vat                     The vat to manipulate.
  31  *
  32  *****************************************************************************/
  33 void vat_ungrab_queue_lock();
  34
  35 /******************************************************************************
  36  *
  37  * DESCRIPTION:
  38  *      Queue message into vat message queue.
  39  *
  40  * PARAMETERS:
  41  *      vat                     The vat to use.
  42  *      message                 The message to queue.
  43  *
  44  *****************************************************************************/
  45 void vat_queue_message(struct vat* vat, struct message* message);
  46
  47 /******************************************************************************
  48  *
  49  * DESCRIPTION:
  50  *      Perform full mark and sweep GC on vat.
  51  *
  52  * PARAMETERS:
  53  *      vat                     The vat to use.
  54  *
  55  * RETURN VALUE:
  56  *      1 if objects still remain, 0 if vat is now empty.
  57  *
  58  *****************************************************************************/
  59 unsigned vat_perform_gc(struct vat* vat);
  60
  61 /******************************************************************************
  62  *
  63  * DESCRIPTION:
  64  *      Get maximum number of locals.
  65  *
  66  * PARAMETERS:
  67  *      vat                     The vat to use.
  68  *
  69  * RETURN VALUE:
  70  *      Maximum locals count.
  71  *
  72  *****************************************************************************/
  73 size_t vat_maxlocals(struct vat* vat);
  74
  75 /******************************************************************************
  76  *
  77  * DESCRIPTION:
  78  *      Create vat.
  79  *
  80  * PARAMETERS:
  81  *      maxlocals               Maximum locals count.
  82  *
  83  * RETURN VALUE:
  84  *      The vat.
  85  *
  86  *****************************************************************************/
  87 struct vat* vat_create(size_t maxlocals);
  88
  89 /******************************************************************************
  90  *
  91  * DESCRIPTION:
  92  *      Destroy vat, and all objects in it.
  93  *
  94  * PARAMETERS:
  95  *      vat                     The vat to destroy.
  96  *
  97  *****************************************************************************/
  98 void vat_destroy(struct vat* vat);
  99
 100 /******************************************************************************
 101  *
 102  * DESCRIPTION:
 103  *      Add object to vat.
 104  *
 105  * PARAMETERS:
 106  *      vat                     The vat to manipulate.
 107  *      object                  The object to add.
 108  *
 109  *****************************************************************************/
 110 void vat_add_object(struct vat* vat, struct object* object);
 111
 112 /******************************************************************************
 113  *
 114  * DESCRIPTION:
 115  *      Deque message from vat message queue.
 116  *
 117  * PARAMETERS:
 118  *      vat                     The vat to manipulate.
 119  *
 120  * RETURN VALUE:
 121  *      Message dequed.
 122  *
 123  *****************************************************************************/
 124 struct message* vat_deque_message(struct vat* vat);
 125
 126 #endif