palacios/src/geekos/ring_buffer.c

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