/* ringbuffer.c
* Routines for packet capture windows
*
- * $Id: ringbuffer.c,v 1.8 2004/02/25 05:21:08 guy Exp $
+ * $Id$
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* <laurent.deniel@free.fr>
*
* Almost completely rewritten in order to:
- *
+ *
* - be able to use a unlimited number of ringbuffer files
* - close the current file and open (truncating) the next file at switch
* - set the final file name once open (or reopen)
* - avoid the deletion of files that could not be truncated (can't arise now)
* and do not erase empty files
*
- * The idea behind that is to remove the limitation of the maximum # of
+ * The idea behind that is to remove the limitation of the maximum # of
* ringbuffer files being less than the maximum # of open fd per process
* and to be able to reduce the amount of virtual memory usage (having only
* one file open at most) or the amount of file system usage (by truncating
- * the files at switch and not the capture stop, and by closing them which
+ * the files at switch and not the capture stop, and by closing them which
* makes possible their move or deletion after a switch).
*
*/
#ifdef HAVE_LIBPCAP
-#ifdef HAVE_IO_H
-#include <io.h>
-#endif
-
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif
-#ifdef HAVE_SYS_STAT_H
-#include <sys/stat.h>
-#endif
-
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <time.h>
#include <errno.h>
-#ifdef NEED_SNPRINTF_H
-#include "snprintf.h"
-#endif
+#include <pcap.h>
+
+#include <glib.h>
-#include "wiretap/wtap.h"
+#include "pcapio.h"
#include "ringbuffer.h"
+#include <wsutil/file_util.h>
-/* Win32 needs the O_BINARY flag for open() */
-#ifndef O_BINARY
-#define O_BINARY 0
-#endif
/* Ringbuffer file structure */
typedef struct _rb_file {
/* Ringbuffer data structure */
typedef struct _ringbuf_data {
rb_file *files;
- guint num_files; /* Number of ringbuffer files */
- guint curr_file_num; /* Number of the current file */
+ guint num_files; /* Number of ringbuffer files (1 to ...) */
+ guint curr_file_num; /* Number of the current file (ever increasing) */
gchar *fprefix; /* Filename prefix */
gchar *fsuffix; /* Filename suffix */
gboolean unlimited; /* TRUE if unlimited number of files */
- int filetype;
- int linktype;
- int snaplen;
- guint16 number;
+
int fd; /* Current ringbuffer file descriptor */
- wtap_dumper *pdh;
+ FILE *pdh;
+ gboolean group_read_access; /* TRUE if files need to be opened with group read access */
} ringbuf_data;
static ringbuf_data rb_data;
+
+/*
+ * create the next filename and open a new binary file with that name
+ */
static int ringbuf_open_file(rb_file *rfile, int *err)
{
char filenum[5+1];
if (rfile->name != NULL) {
if (rb_data.unlimited == FALSE) {
/* remove old file (if any, so ignore error) */
- unlink(rfile->name);
+ ws_unlink(rfile->name);
}
g_free(rfile->name);
}
#endif
current_time = time(NULL);
- rb_data.number++;
-
- snprintf(filenum, sizeof(filenum), "%05d", rb_data.number);
+ g_snprintf(filenum, sizeof(filenum), "%05u", (rb_data.curr_file_num + 1) % RINGBUFFER_MAX_NUM_FILES);
strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(¤t_time));
rfile->name = g_strconcat(rb_data.fprefix, "_", filenum, "_", timestr,
rb_data.fsuffix, NULL);
return -1;
}
- rb_data.fd = open(rfile->name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT, 0600);
+ rb_data.fd = ws_open(rfile->name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
+ rb_data.group_read_access ? 0640 : 0600);
if (rb_data.fd == -1 && err != NULL) {
*err = errno;
* Initialize the ringbuffer data structures
*/
int
-ringbuf_init(const char *capfile_name, guint num_files)
+ringbuf_init(const char *capfile_name, guint num_files, gboolean group_read_access)
{
unsigned int i;
- char *pfx;
+ char *pfx, *last_pathsep;
gchar *save_file;
rb_data.files = NULL;
rb_data.unlimited = FALSE;
rb_data.fd = -1;
rb_data.pdh = NULL;
- rb_data.number = 0;
+ rb_data.group_read_access = group_read_access;
/* just to be sure ... */
if (num_files <= RINGBUFFER_MAX_NUM_FILES) {
/* set file name prefix/suffix */
save_file = g_strdup(capfile_name);
+ last_pathsep = strrchr(save_file, G_DIR_SEPARATOR);
pfx = strrchr(save_file,'.');
- if (pfx != NULL) {
+ if (pfx != NULL && (last_pathsep == NULL || pfx > last_pathsep)) {
+ /* The pathname has a "." in it, and it's in the last component
+ of the pathname (because there is either only one component,
+ i.e. last_pathsep is null as there are no path separators,
+ or the "." is after the path separator before the last
+ component.
+
+ Treat it as a separator between the rest of the file name and
+ the file name suffix, and arrange that the names given to the
+ ring buffer files have the specified suffix, i.e. put the
+ changing part of the name *before* the suffix. */
pfx[0] = '\0';
rb_data.fprefix = g_strdup(save_file);
pfx[0] = '.'; /* restore capfile_name */
rb_data.fsuffix = g_strdup(pfx);
} else {
+ /* Either there's no "." in the pathname, or it's in a directory
+ component, so the last component has no suffix. */
rb_data.fprefix = g_strdup(save_file);
rb_data.fsuffix = NULL;
}
rb_data.num_files = 1;
}
- rb_data.files = g_malloc(rb_data.num_files * sizeof(rb_file));
+ rb_data.files = (rb_file *)g_malloc(rb_data.num_files * sizeof(rb_file));
if (rb_data.files == NULL) {
return -1;
}
return rb_data.fd;
}
+
+const gchar *ringbuf_current_filename(void)
+{
+ return rb_data.files[rb_data.curr_file_num % rb_data.num_files].name;
+}
+
/*
- * Calls wtap_dump_fdopen() for the current ringbuffer file
+ * Calls libpcap_fdopen() for the current ringbuffer file
*/
-wtap_dumper*
-ringbuf_init_wtap_dump_fdopen(int filetype, int linktype, int snaplen, int *err)
+FILE *
+ringbuf_init_libpcap_fdopen(int *err)
{
-
- rb_data.filetype = filetype;
- rb_data.linktype = linktype;
- rb_data.snaplen = snaplen;
-
- rb_data.pdh = wtap_dump_fdopen(rb_data.fd, filetype, linktype, snaplen, err);
-
+ rb_data.pdh = libpcap_fdopen(rb_data.fd, err);
return rb_data.pdh;
}
* Switches to the next ringbuffer file
*/
gboolean
-ringbuf_switch_file(capture_file *cf, wtap_dumper **pdh, int *err)
+ringbuf_switch_file(FILE **pdh, gchar **save_file, int *save_file_fd, int *err)
{
- int next_file_num;
+ int next_file_index;
rb_file *next_rfile = NULL;
/* close current file */
- if (!wtap_dump_close(rb_data.pdh, err)) {
- close(rb_data.fd);
+ if (!libpcap_dump_close(rb_data.pdh, err)) {
+ ws_close(rb_data.fd); /* XXX - the above should have closed this already */
+ rb_data.pdh = NULL; /* it's still closed, we just got an error while closing */
rb_data.fd = -1;
return FALSE;
}
/* get the next file number and open it */
- next_file_num = (rb_data.curr_file_num + 1) % rb_data.num_files;
- next_rfile = &rb_data.files[next_file_num];
+ rb_data.curr_file_num++ /* = next_file_num*/;
+ next_file_index = (rb_data.curr_file_num) % rb_data.num_files;
+ next_rfile = &rb_data.files[next_file_index];
if (ringbuf_open_file(next_rfile, err) == -1) {
return FALSE;
}
- if (ringbuf_init_wtap_dump_fdopen(rb_data.filetype, rb_data.linktype,
- rb_data.snaplen, err) == NULL) {
+ if (ringbuf_init_libpcap_fdopen(err) == NULL) {
return FALSE;
}
/* switch to the new file */
- rb_data.curr_file_num = next_file_num;
- cf->save_file = next_rfile->name;
- cf->save_file_fd = rb_data.fd;
+ *save_file = next_rfile->name;
+ *save_file_fd = rb_data.fd;
(*pdh) = rb_data.pdh;
return TRUE;
}
/*
- * Calls wtap_dump_close() for the current ringbuffer file
+ * Calls libpcap_dump_close() for the current ringbuffer file
*/
gboolean
-ringbuf_wtap_dump_close(capture_file *cf, int *err)
+ringbuf_libpcap_dump_close(gchar **save_file, int *err)
{
gboolean ret_val = TRUE;
- /* close current file */
+ /* close current file, if it's open */
+ if (rb_data.pdh != NULL) {
+ if (!libpcap_dump_close(rb_data.pdh, err)) {
+ ws_close(rb_data.fd);
+ ret_val = FALSE;
+ }
- if (!wtap_dump_close(rb_data.pdh, err)) {
- close(rb_data.fd);
- ret_val = FALSE;
+ rb_data.pdh = NULL;
+ rb_data.fd = -1;
}
- rb_data.pdh = NULL;
- rb_data.fd = -1;
-
- cf->save_file = rb_data.files[rb_data.curr_file_num].name;
+ /* set the save file name to the current file */
+ *save_file = rb_data.files[rb_data.curr_file_num % rb_data.num_files].name;
return ret_val;
}
/* try to close via wtap */
if (rb_data.pdh != NULL) {
- if (wtap_dump_close(rb_data.pdh, NULL)) {
+ if (libpcap_dump_close(rb_data.pdh, NULL)) {
rb_data.fd = -1;
}
rb_data.pdh = NULL;
}
/* close directly if still open */
+ /* XXX - it shouldn't still be open; "libpcap_dump_close()" should leave the
+ file closed even if it fails */
if (rb_data.fd != -1) {
- close(rb_data.fd);
+ ws_close(rb_data.fd);
rb_data.fd = -1;
}
if (rb_data.files != NULL) {
for (i=0; i < rb_data.num_files; i++) {
if (rb_data.files[i].name != NULL) {
- unlink(rb_data.files[i].name);
+ ws_unlink(rb_data.files[i].name);
}
}
}