geekos/include/geekos/ring_buffer.h

   1 /*
   2  * This file is part of the Palacios Virtual Machine Monitor developed
   3  * by the V3VEE Project with funding from the United States National
   4  * Science Foundation and the Department of Energy.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  10  * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
  11  * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
  12  * All rights reserved.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20 #ifndef __RING_BUFFER_H__
  21 #define __RING_BUFFER_H__
  22
  23
  24 #include <geekos/ktypes.h>
  25
  26
  27 struct ring_buffer {
  28   uchar_t * buf;
  29   uint_t size;
  30
  31   uint_t start;
  32   uint_t end;
  33   uint_t current_len;
  34
  35 };
  36
  37
  38 void init_ring_buffer(struct ring_buffer * ring, uint_t size);
  39 struct ring_buffer * create_ring_buffer(uint_t size);
  40
  41 void free_ring_buffer(struct ring_buffer * ring);
  42
  43
  44 int rb_read(struct ring_buffer * ring, char * dst, uint_t len);
  45 int rb_peek(struct ring_buffer * ring, char * dst, uint_t len);
  46 int rb_delete(struct ring_buffer * ring, uint_t len);
  47 int rb_write(struct ring_buffer * ring, char * src, uint_t len);
  48 int rb_data_len(struct ring_buffer * ring);
  49 int rb_capacity(struct ring_buffer * ring);
  50
  51
  52 void print_ring_buffer(struct ring_buffer * ring);
  53
  54
  55 #endif // ! __RING_BUFFER_H__