geekos/src/geekos/ring_buffer.c

   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 #include <geekos/ring_buffer.h>
  21 #include <geekos/malloc.h>
  22 #include <geekos/ktypes.h>
  23 #include <geekos/debug.h>
  24
  25
  26 void init_ring_buffer(struct ring_buffer * ring, uint_t size) {
  27   ring->buf = Malloc(size);
  28   ring->size = size;
  29
  30   ring->start = 0;
  31   ring->end = 0;
  32   ring->current_len = 0;
  33 }
  34
  35
  36 struct ring_buffer * create_ring_buffer(uint_t size) {
  37   struct ring_buffer * ring = (struct ring_buffer *)Malloc(sizeof(struct ring_buffer));
  38
  39   init_ring_buffer(ring, size);
  40
  41   return ring;
  42 }
  43
  44 void free_ring_buffer(struct ring_buffer * ring) {
  45   Free(ring->buf);
  46   Free(ring);
  47 }
  48
  49
  50
  51
  52
  53 static inline uchar_t * get_read_ptr(struct ring_buffer * ring) {
  54   return (uchar_t *)(ring->buf + ring->start);
  55 }
  56
  57 static inline uchar_t * get_write_ptr(struct ring_buffer * ring) {
  58   return (uchar_t *)(ring->buf + ring->end);
  59 }
  60
  61
  62 static inline int get_read_section_size(struct ring_buffer * ring) {
  63   return ring->size - ring->start;
  64 }
  65
  66 static inline int get_write_section_size(struct ring_buffer * ring) {
  67   return ring->size - ring->end;
  68 }
  69
  70 static inline int is_read_loop(struct ring_buffer * ring, uint_t len) {
  71   if ((ring->start >= ring->end) && (ring->current_len > 0)) {
  72     // end is past the end of the buffer
  73     if (get_read_section_size(ring) < len) {
  74       return 1;
  75     }
  76   }
  77   return 0;
  78 }
  79
  80
  81 static inline int is_write_loop(struct ring_buffer * ring, uint_t len) {
  82   if ((ring->end >= ring->start) && (ring->current_len < ring->size)) {
  83     // end is past the end of the buffer
  84     if (get_write_section_size(ring) < len) {
  85       return 1;
  86     }
  87   }
  88   return 0;
  89 }
  90
  91
  92 int rb_data_len(struct ring_buffer * ring) {
  93   return ring->current_len;
  94 }
  95
  96 int rb_capacity(struct ring_buffer * ring) {
  97   return ring->size;
  98 }
  99
 100 int rb_read(struct ring_buffer * ring, char * dst, uint_t len) {
 101   int read_len = 0;
 102   int ring_data_len = ring->current_len;
 103
 104   read_len = (len > ring_data_len) ? ring_data_len : len;
 105
 106   if (is_read_loop(ring, read_len)) {
 107     int section_len = get_read_section_size(ring);
 108
 109     memcpy(dst, get_read_ptr(ring), section_len);
 110     memcpy(dst + section_len, ring->buf, read_len - section_len);
 111
 112     ring->start = read_len - section_len;
 113   } else {
 114     memcpy(dst, get_read_ptr(ring), read_len);
 115
 116     ring->start += read_len;
 117   }
 118
 119   ring->current_len -= read_len;
 120
 121   return read_len;
 122 }
 123
 124
 125
 126
 127 int rb_peek(struct ring_buffer * ring, char * dst, uint_t len) {
 128   int read_len = 0;
 129   int ring_data_len = ring->current_len;
 130
 131   read_len = (len > ring_data_len) ? ring_data_len : len;
 132
 133   if (is_read_loop(ring, read_len)) {
 134     int section_len = get_read_section_size(ring);
 135
 136     memcpy(dst, get_read_ptr(ring), section_len);
 137     memcpy(dst + section_len, ring->buf, read_len - section_len);
 138   } else {
 139     memcpy(dst, get_read_ptr(ring), read_len);
 140   }
 141
 142   return read_len;
 143 }
 144
 145
 146 int rb_delete(struct ring_buffer * ring, uint_t len) {
 147   int del_len = 0;
 148   int ring_data_len = ring->current_len;
 149
 150   del_len = (len > ring_data_len) ? ring_data_len : len;
 151
 152   if (is_read_loop(ring, del_len)) {
 153     int section_len = get_read_section_size(ring);
 154     ring->start = del_len - section_len;
 155   } else {
 156     ring->start += del_len;
 157   }
 158
 159   ring->current_len -= del_len;
 160   return del_len;
 161 }
 162
 163
 164 int rb_write(struct ring_buffer * ring, char * src, uint_t len) {
 165   int write_len = 0;
 166   int ring_avail_space = ring->size - ring->current_len;
 167
 168   write_len = (len > ring_avail_space) ? ring_avail_space : len;
 169
 170
 171   if (is_write_loop(ring, write_len)) {
 172     int section_len = get_write_section_size(ring);
 173
 174     memcpy(get_write_ptr(ring), src, section_len);
 175     ring->end = 0;
 176
 177     memcpy(get_write_ptr(ring), src + section_len, write_len - section_len);
 178
 179     ring->end += write_len - section_len;
 180   } else {
 181     memcpy(get_write_ptr(ring), src, write_len);
 182
 183     ring->end += write_len;
 184   }
 185
 186   ring->current_len += write_len;
 187
 188   return write_len;
 189 }
 190
 191
 192 void print_ring_buffer(struct ring_buffer * ring) {
 193   int ctr = 0;
 194
 195   for (ctr = 0; ctr < ring->current_len; ctr++) {
 196     int index = (ctr + ring->start) % ring->size;
 197
 198     PrintBoth("Entry %d (index=%d): %c\n", ctr, index, ring->buf[index]);
 199   }
 200 }