git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/general/gr_circular_file.cc

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2002 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with GNU Radio; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <gr_circular_file.h>
  28
  29 #include <unistd.h>
  30 #ifdef HAVE_SYS_MMAN_H
  31 #include <sys/mman.h>
  32 #endif
  33 #include <sys/types.h>
  34 #include <sys/stat.h>
  35 #include <unistd.h>
  36 #include <fcntl.h>
  37 #include <stdio.h>
  38 #include <assert.h>
  39 #include <stdlib.h>
  40
  41 #include <algorithm>
  42 #include <stdio.h>
  43 #include <string.h>
  44
  45 static const int HEADER_SIZE = 4096;
  46 static const int HEADER_MAGIC = 0xEB021026;
  47
  48 static const int HD_MAGIC = 0;
  49 static const int HD_HEADER_SIZE = 1;    // integer offsets into header
  50 static const int HD_BUFFER_SIZE = 2;
  51 static const int HD_BUFFER_BASE = 3;
  52 static const int HD_BUFFER_CURRENT = 4;
  53
  54 gr_circular_file::gr_circular_file (const char *filename,
  55                                     bool writable, int size)
  56   : d_fd (-1), d_header (0), d_buffer (0), d_mapped_size (0), d_bytes_read (0)
  57 {
  58   int   mm_prot;
  59   if (writable){
  60 #ifdef HAVE_MMAP
  61     mm_prot = PROT_READ | PROT_WRITE;
  62 #endif
  63     d_fd = open (filename, O_CREAT | O_RDWR | O_TRUNC, 0664);
  64     if (d_fd < 0){
  65       perror (filename);
  66       exit (1);
  67     }
  68 #ifdef HAVE_MMAP        /* FIXME */
  69     ftruncate (d_fd, size + HEADER_SIZE);
  70 #endif
  71   }
  72   else {
  73 #ifdef HAVE_MMAP
  74     mm_prot = PROT_READ;
  75 #endif
  76     d_fd = open (filename, O_RDONLY);
  77     if (d_fd < 0){
  78       perror (filename);
  79       exit (1);
  80     }
  81   }
  82
  83   struct stat statbuf;
  84   if (fstat (d_fd, &statbuf) < 0){
  85     perror (filename);
  86     exit (1);
  87   }
  88
  89   if (statbuf.st_size < HEADER_SIZE){
  90     fprintf (stderr, "%s: file too small to be circular buffer\n", filename);
  91     exit (1);
  92   }
  93
  94   d_mapped_size = statbuf.st_size;
  95 #ifdef HAVE_MMAP
  96   void *p = mmap (0, d_mapped_size, mm_prot, MAP_SHARED, d_fd, 0);
  97   if (p == MAP_FAILED){
  98     perror ("gr_circular_file: mmap failed");
  99     exit (1);
 100   }
 101
 102   d_header = (int *) p;
 103 #else
 104     perror ("gr_circular_file: mmap unsupported by this system");
 105     exit (1);
 106 #endif
 107
 108   if (writable){        // init header
 109
 110     if (size < 0){
 111       fprintf (stderr, "gr_circular_buffer: size must be > 0 when writable\n");
 112       exit (1);
 113     }
 114
 115     d_header[HD_MAGIC] = HEADER_MAGIC;
 116     d_header[HD_HEADER_SIZE] = HEADER_SIZE;
 117     d_header[HD_BUFFER_SIZE] = size;
 118     d_header[HD_BUFFER_BASE] = HEADER_SIZE;     // right after header
 119     d_header[HD_BUFFER_CURRENT] = 0;
 120   }
 121
 122   // sanity check (the asserts are a bit unforgiving...)
 123
 124   assert (d_header[HD_MAGIC] == HEADER_MAGIC);
 125   assert (d_header[HD_HEADER_SIZE] == HEADER_SIZE);
 126   assert (d_header[HD_BUFFER_SIZE] > 0);
 127   assert (d_header[HD_BUFFER_BASE] >= d_header[HD_HEADER_SIZE]);
 128   assert (d_header[HD_BUFFER_BASE] + d_header[HD_BUFFER_SIZE] <= d_mapped_size);
 129   assert (d_header[HD_BUFFER_CURRENT] >= 0 &&
 130           d_header[HD_BUFFER_CURRENT] < d_header[HD_BUFFER_SIZE]);
 131
 132   d_bytes_read = 0;
 133   d_buffer = (unsigned char *) d_header + d_header[HD_BUFFER_BASE];
 134 }
 135
 136 gr_circular_file::~gr_circular_file ()
 137 {
 138 #ifdef HAVE_MMAP
 139   if (munmap ((char *) d_header, d_mapped_size) < 0){
 140     perror ("gr_circular_file: munmap");
 141     exit (1);
 142   }
 143 #endif
 144   close (d_fd);
 145 }
 146
 147 bool
 148 gr_circular_file::write (void *vdata, int nbytes)
 149 {
 150   unsigned char *data = (unsigned char *) vdata;
 151   int   buffer_size = d_header[HD_BUFFER_SIZE];
 152   int   buffer_current = d_header[HD_BUFFER_CURRENT];
 153
 154   while (nbytes > 0){
 155     int n = std::min (nbytes, buffer_size - buffer_current);
 156     memcpy (d_buffer + buffer_current, data, n);
 157
 158     buffer_current += n;
 159     if (buffer_current >= buffer_size)
 160       buffer_current = 0;
 161
 162     data += n;
 163     nbytes -= n;
 164   }
 165
 166   d_header[HD_BUFFER_CURRENT] = buffer_current;
 167   return true;
 168 }
 169
 170 int
 171 gr_circular_file::read (void *vdata, int nbytes)
 172 {
 173   unsigned char *data = (unsigned char *) vdata;
 174   int   buffer_current = d_header[HD_BUFFER_CURRENT];
 175   int   buffer_size = d_header[HD_BUFFER_SIZE];
 176   int   total = 0;
 177
 178   nbytes = std::min (nbytes, buffer_size - d_bytes_read);
 179
 180   while (nbytes > 0){
 181     int offset = (buffer_current + d_bytes_read) % buffer_size;
 182     int n = std::min (nbytes, buffer_size - offset);
 183     memcpy (data, d_buffer + offset, n);
 184     data += n;
 185     d_bytes_read += n;
 186     total += n;
 187     nbytes -= n;
 188   }
 189   return total;
 190 }
 191
 192 void
 193 gr_circular_file::reset_read_pointer ()
 194 {
 195   d_bytes_read = 0;
 196 }