ringbuffer.c

   1 /* ringbuffer.c
   2  * Routines for packet capture windows
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 /*
  26  * <laurent.deniel@free.fr>
  27  *
  28  * Almost completely rewritten in order to:
  29  *
  30  * - be able to use a unlimited number of ringbuffer files
  31  * - close the current file and open (truncating) the next file at switch
  32  * - set the final file name once open (or reopen)
  33  * - avoid the deletion of files that could not be truncated (can't arise now)
  34  *   and do not erase empty files
  35  *
  36  * The idea behind that is to remove the limitation of the maximum # of
  37  * ringbuffer files being less than the maximum # of open fd per process
  38  * and to be able to reduce the amount of virtual memory usage (having only
  39  * one file open at most) or the amount of file system usage (by truncating
  40  * the files at switch and not the capture stop, and by closing them which
  41  * makes possible their move or deletion after a switch).
  42  *
  43  */
  44
  45 #include "config.h"
  46
  47 #ifdef HAVE_LIBPCAP
  48
  49 #ifdef HAVE_FCNTL_H
  50 #include <fcntl.h>
  51 #endif
  52
  53 #ifdef HAVE_UNISTD_H
  54 #include <unistd.h>
  55 #endif
  56
  57 #include <stdio.h>
  58 #include <string.h>
  59 #include <time.h>
  60 #include <errno.h>
  61
  62 #include <pcap.h>
  63
  64 #include <glib.h>
  65
  66 #include "pcapio.h"
  67 #include "ringbuffer.h"
  68 #include <wsutil/file_util.h>
  69
  70
  71 /* Ringbuffer file structure */
  72 typedef struct _rb_file {
  73   gchar         *name;
  74 } rb_file;
  75
  76 /* Ringbuffer data structure */
  77 typedef struct _ringbuf_data {
  78   rb_file      *files;
  79   guint         num_files;           /* Number of ringbuffer files (1 to ...) */
  80   guint         curr_file_num;       /* Number of the current file (ever increasing) */
  81   gchar        *fprefix;             /* Filename prefix */
  82   gchar        *fsuffix;             /* Filename suffix */
  83   gboolean      unlimited;           /* TRUE if unlimited number of files */
  84
  85   int           fd;                  /* Current ringbuffer file descriptor */
  86   FILE         *pdh;
  87   gboolean      group_read_access;   /* TRUE if files need to be opened with group read access */
  88 } ringbuf_data;
  89
  90 static ringbuf_data rb_data;
  91
  92
  93 /*
  94  * create the next filename and open a new binary file with that name
  95  */
  96 static int ringbuf_open_file(rb_file *rfile, int *err)
  97 {
  98   char    filenum[5+1];
  99   char    timestr[14+1];
 100   time_t  current_time;
 101
 102   if (rfile->name != NULL) {
 103     if (rb_data.unlimited == FALSE) {
 104       /* remove old file (if any, so ignore error) */
 105       ws_unlink(rfile->name);
 106     }
 107     g_free(rfile->name);
 108   }
 109
 110 #ifdef _WIN32
 111   _tzset();
 112 #endif
 113   current_time = time(NULL);
 114
 115   g_snprintf(filenum, sizeof(filenum), "%05u", (rb_data.curr_file_num + 1) % RINGBUFFER_MAX_NUM_FILES);
 116   strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
 117   rfile->name = g_strconcat(rb_data.fprefix, "_", filenum, "_", timestr,
 118                             rb_data.fsuffix, NULL);
 119
 120   if (rfile->name == NULL) {
 121     *err = ENOMEM;
 122     return -1;
 123   }
 124
 125   rb_data.fd = ws_open(rfile->name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
 126                             rb_data.group_read_access ? 0640 : 0600);
 127
 128   if (rb_data.fd == -1 && err != NULL) {
 129     *err = errno;
 130   }
 131
 132   return rb_data.fd;
 133 }
 134
 135 /*
 136  * Initialize the ringbuffer data structures
 137  */
 138 int
 139 ringbuf_init(const char *capfile_name, guint num_files, gboolean group_read_access)
 140 {
 141   unsigned int i;
 142   char        *pfx, *last_pathsep;
 143   gchar       *save_file;
 144
 145   rb_data.files = NULL;
 146   rb_data.curr_file_num = 0;
 147   rb_data.fprefix = NULL;
 148   rb_data.fsuffix = NULL;
 149   rb_data.unlimited = FALSE;
 150   rb_data.fd = -1;
 151   rb_data.pdh = NULL;
 152   rb_data.group_read_access = group_read_access;
 153
 154   /* just to be sure ... */
 155   if (num_files <= RINGBUFFER_MAX_NUM_FILES) {
 156     rb_data.num_files = num_files;
 157   } else {
 158     rb_data.num_files = RINGBUFFER_MAX_NUM_FILES;
 159   }
 160
 161   /* Check file name */
 162   if (capfile_name == NULL) {
 163     /* ringbuffer does not work with temporary files! */
 164     return -1;
 165   }
 166
 167   /* set file name prefix/suffix */
 168
 169   save_file = g_strdup(capfile_name);
 170   last_pathsep = strrchr(save_file, G_DIR_SEPARATOR);
 171   pfx = strrchr(save_file,'.');
 172   if (pfx != NULL && (last_pathsep == NULL || pfx > last_pathsep)) {
 173     /* The pathname has a "." in it, and it's in the last component
 174        of the pathname (because there is either only one component,
 175        i.e. last_pathsep is null as there are no path separators,
 176        or the "." is after the path separator before the last
 177        component.
 178
 179        Treat it as a separator between the rest of the file name and
 180        the file name suffix, and arrange that the names given to the
 181        ring buffer files have the specified suffix, i.e. put the
 182        changing part of the name *before* the suffix. */
 183     pfx[0] = '\0';
 184     rb_data.fprefix = g_strdup(save_file);
 185     pfx[0] = '.'; /* restore capfile_name */
 186     rb_data.fsuffix = g_strdup(pfx);
 187   } else {
 188     /* Either there's no "." in the pathname, or it's in a directory
 189        component, so the last component has no suffix. */
 190     rb_data.fprefix = g_strdup(save_file);
 191     rb_data.fsuffix = NULL;
 192   }
 193   g_free(save_file);
 194   save_file = NULL;
 195
 196   /* allocate rb_file structures (only one if unlimited since there is no
 197      need to save all file names in that case) */
 198
 199   if (num_files == RINGBUFFER_UNLIMITED_FILES) {
 200     rb_data.unlimited = TRUE;
 201     rb_data.num_files = 1;
 202   }
 203
 204   rb_data.files = (rb_file *)g_malloc(rb_data.num_files * sizeof(rb_file));
 205   if (rb_data.files == NULL) {
 206     return -1;
 207   }
 208
 209   for (i=0; i < rb_data.num_files; i++) {
 210     rb_data.files[i].name = NULL;
 211   }
 212
 213   /* create the first file */
 214   if (ringbuf_open_file(&rb_data.files[0], NULL) == -1) {
 215     ringbuf_error_cleanup();
 216     return -1;
 217   }
 218
 219   return rb_data.fd;
 220 }
 221
 222
 223 const gchar *ringbuf_current_filename(void)
 224 {
 225   return rb_data.files[rb_data.curr_file_num % rb_data.num_files].name;
 226 }
 227
 228 /*
 229  * Calls libpcap_fdopen() for the current ringbuffer file
 230  */
 231 FILE *
 232 ringbuf_init_libpcap_fdopen(int *err)
 233 {
 234   rb_data.pdh = libpcap_fdopen(rb_data.fd, err);
 235   return rb_data.pdh;
 236 }
 237
 238 /*
 239  * Switches to the next ringbuffer file
 240  */
 241 gboolean
 242 ringbuf_switch_file(FILE **pdh, gchar **save_file, int *save_file_fd, int *err)
 243 {
 244   int     next_file_index;
 245   rb_file *next_rfile = NULL;
 246
 247   /* close current file */
 248
 249   if (!libpcap_dump_close(rb_data.pdh, err)) {
 250     ws_close(rb_data.fd);       /* XXX - the above should have closed this already */
 251     rb_data.pdh = NULL; /* it's still closed, we just got an error while closing */
 252     rb_data.fd = -1;
 253     return FALSE;
 254   }
 255
 256   rb_data.pdh = NULL;
 257   rb_data.fd  = -1;
 258
 259   /* get the next file number and open it */
 260
 261   rb_data.curr_file_num++ /* = next_file_num*/;
 262   next_file_index = (rb_data.curr_file_num) % rb_data.num_files;
 263   next_rfile = &rb_data.files[next_file_index];
 264
 265   if (ringbuf_open_file(next_rfile, err) == -1) {
 266     return FALSE;
 267   }
 268
 269   if (ringbuf_init_libpcap_fdopen(err) == NULL) {
 270     return FALSE;
 271   }
 272
 273   /* switch to the new file */
 274   *save_file = next_rfile->name;
 275   *save_file_fd = rb_data.fd;
 276   (*pdh) = rb_data.pdh;
 277
 278   return TRUE;
 279 }
 280
 281 /*
 282  * Calls libpcap_dump_close() for the current ringbuffer file
 283  */
 284 gboolean
 285 ringbuf_libpcap_dump_close(gchar **save_file, int *err)
 286 {
 287   gboolean  ret_val = TRUE;
 288
 289   /* close current file, if it's open */
 290   if (rb_data.pdh != NULL) {
 291     if (!libpcap_dump_close(rb_data.pdh, err)) {
 292       ws_close(rb_data.fd);
 293       ret_val = FALSE;
 294     }
 295
 296     rb_data.pdh = NULL;
 297     rb_data.fd  = -1;
 298   }
 299
 300   /* set the save file name to the current file */
 301   *save_file = rb_data.files[rb_data.curr_file_num % rb_data.num_files].name;
 302   return ret_val;
 303 }
 304
 305 /*
 306  * Frees all memory allocated by the ringbuffer
 307  */
 308 void
 309 ringbuf_free(void)
 310 {
 311   unsigned int i;
 312
 313   if (rb_data.files != NULL) {
 314     for (i=0; i < rb_data.num_files; i++) {
 315       if (rb_data.files[i].name != NULL) {
 316         g_free(rb_data.files[i].name);
 317         rb_data.files[i].name = NULL;
 318       }
 319     }
 320     g_free(rb_data.files);
 321     rb_data.files = NULL;
 322   }
 323   if (rb_data.fprefix != NULL) {
 324     g_free(rb_data.fprefix);
 325     rb_data.fprefix = NULL;
 326   }
 327   if (rb_data.fsuffix != NULL) {
 328     g_free(rb_data.fsuffix);
 329     rb_data.fsuffix = NULL;
 330   }
 331 }
 332
 333 /*
 334  * Frees all memory allocated by the ringbuffer
 335  */
 336 void
 337 ringbuf_error_cleanup(void)
 338 {
 339   unsigned int i;
 340
 341   /* try to close via wtap */
 342   if (rb_data.pdh != NULL) {
 343     if (libpcap_dump_close(rb_data.pdh, NULL)) {
 344       rb_data.fd = -1;
 345     }
 346     rb_data.pdh = NULL;
 347   }
 348
 349   /* close directly if still open */
 350   /* XXX - it shouldn't still be open; "libpcap_dump_close()" should leave the
 351      file closed even if it fails */
 352   if (rb_data.fd != -1) {
 353     ws_close(rb_data.fd);
 354     rb_data.fd = -1;
 355   }
 356
 357   if (rb_data.files != NULL) {
 358     for (i=0; i < rb_data.num_files; i++) {
 359       if (rb_data.files[i].name != NULL) {
 360         ws_unlink(rb_data.files[i].name);
 361       }
 362     }
 363   }
 364   /* free the memory */
 365   ringbuf_free();
 366 }
 367
 368 #endif /* HAVE_LIBPCAP */