/* ringbuffer.c
* Routines for packet capture windows
*
- * $Id: ringbuffer.c,v 1.2 2002/05/04 10:10:42 guy Exp $
- *
- * 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
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
+/*
+ * <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
+ * 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
+ * makes possible their move or deletion after a switch).
+ *
+ */
-#ifdef HAVE_LIBPCAP
+#include <config.h>
-#ifdef HAVE_IO_H
-#include <io.h>
-#endif
+#ifdef HAVE_LIBPCAP
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif
-#ifdef HAVE_SYS_TYPES_H
-#include <sys/types.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 "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 {
- gchar* name;
- int fd;
- time_t creation_time;
- gboolean is_new;
- guint16 number;
- wtap_dumper* pdh;
- long start_pos;
+ gchar *name;
} 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 */
- gchar* fprefix; /* Filename prefix */
- gchar* fsuffix; /* Filename suffix */
-} ringbuf_data;
-
-/* Create the ringbuffer data structure */
+ rb_file *files;
+ 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 fd; /* Current ringbuffer file descriptor */
+ FILE *pdh;
+ gboolean group_read_access; /* TRUE if files need to be opened with group read access */
+} ringbuf_data;
+
static ringbuf_data rb_data;
-/*
- * Initialize the ringbuffer data structure
+
+/*
+ * create the next filename and open a new binary file with that name
*/
-int
-ringbuf_init(const char *capfile_name, guint num_files)
+static int ringbuf_open_file(rb_file *rfile, int *err)
+{
+ char filenum[5+1];
+ char timestr[14+1];
+ time_t current_time;
+
+ if (rfile->name != NULL) {
+ if (rb_data.unlimited == FALSE) {
+ /* remove old file (if any, so ignore error) */
+ ws_unlink(rfile->name);
+ }
+ g_free(rfile->name);
+ }
+
+#ifdef _WIN32
+ _tzset();
+#endif
+ current_time = time(NULL);
+
+ 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);
+
+ if (rfile->name == NULL) {
+ if (err != NULL)
+ *err = ENOMEM;
+ return -1;
+ }
+
+ 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;
+ }
+
+ return rb_data.fd;
+}
+
+/*
+ * Initialize the ringbuffer data structures
+ */
+int
+ringbuf_init(const char *capfile_name, guint num_files, gboolean group_read_access)
{
- int save_file_fd;
unsigned int i;
- char *pfx;
+ char *pfx, *last_pathsep;
gchar *save_file;
- char save_file_num[3+1];
+
+ rb_data.files = NULL;
+ rb_data.curr_file_num = 0;
+ rb_data.fprefix = NULL;
+ rb_data.fsuffix = NULL;
+ rb_data.unlimited = FALSE;
+ rb_data.fd = -1;
+ rb_data.pdh = NULL;
+ rb_data.group_read_access = group_read_access;
/* just to be sure ... */
if (num_files <= RINGBUFFER_MAX_NUM_FILES) {
return -1;
}
- /* Open the initial file */
- save_file_fd = open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT, 0600);
- if (save_file_fd == -1) {
- /* open failed */
- return -1;
- }
-
- /* allocate memory */
- rb_data.files = (rb_file *)calloc(num_files, sizeof(rb_file));
- if (rb_data.files == NULL) {
- /* could not allocate memory */
- return -1;
- }
-
- /* initialize */
- rb_data.fprefix = NULL;
- rb_data.fsuffix = NULL;
- for (i=0; i<rb_data.num_files; i++) {
- rb_data.files[i].name = NULL;
- rb_data.files[i].fd = -1;
- }
+ /* set file name prefix/suffix */
- /* get 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;
}
g_free(save_file);
save_file = NULL;
-#ifdef _WIN32
- _tzset();
-#endif
- /* save the initial file parameters */
- rb_data.files[0].name = g_strdup(capfile_name);
- rb_data.files[0].fd = save_file_fd;
- rb_data.files[0].creation_time = time(NULL);
- rb_data.files[0].number = 0;
- rb_data.files[0].is_new = TRUE;
-
- /* create the other files */
- for (i=1; i<rb_data.num_files; i++) {
- /* create a file name */
- snprintf(save_file_num,3+1,"%03d",i);
- save_file = g_strconcat(capfile_name, ".", save_file_num, NULL);
- /* open the file */
- save_file_fd = open(save_file, O_RDWR|O_BINARY|O_TRUNC|O_CREAT, 0600);
- if (save_file_fd != -1) {
- rb_data.files[i].name = save_file;
- rb_data.files[i].fd = save_file_fd;
- rb_data.files[i].creation_time = time(NULL);
- rb_data.files[i].number = i;
- rb_data.files[i].is_new = TRUE;
- } else {
- /* could not open a file */
- ringbuf_error_cleanup();
- return -1;
- }
+ /* allocate rb_file structures (only one if unlimited since there is no
+ need to save all file names in that case) */
+
+ if (num_files == RINGBUFFER_UNLIMITED_FILES) {
+ rb_data.unlimited = TRUE;
+ rb_data.num_files = 1;
}
-
- /* done */
- rb_data.curr_file_num = 0;
- return rb_data.files[0].fd;
+
+ rb_data.files = (rb_file *)g_malloc(rb_data.num_files * sizeof(rb_file));
+ if (rb_data.files == NULL) {
+ return -1;
+ }
+
+ for (i=0; i < rb_data.num_files; i++) {
+ rb_data.files[i].name = NULL;
+ }
+
+ /* create the first file */
+ if (ringbuf_open_file(&rb_data.files[0], NULL) == -1) {
+ ringbuf_error_cleanup();
+ return -1;
+ }
+
+ return rb_data.fd;
}
-/*
- * Calls wtap_dump_fdopen() for all ringbuffer files
+
+const gchar *ringbuf_current_filename(void)
+{
+ return rb_data.files[rb_data.curr_file_num % rb_data.num_files].name;
+}
+
+/*
+ * Calls ws_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)
{
- unsigned int i;
- FILE *fh;
-
- for (i=0; i<rb_data.num_files; i++) {
- rb_data.files[i].pdh = wtap_dump_fdopen(rb_data.files[i].fd, filetype,
- linktype, snaplen, err);
- if (rb_data.files[i].pdh == NULL) {
- /* could not open file */
- return NULL;
- } else {
- /*
- * Flush out the capture file header, as written by "wtap_dump_fdopen()".
- *
- * XXX - this relies on Wiretap writing out data sequentially,
- * and writing the entire capture file header when the file
- * is created. That happens to be true for libpcap files,
- * which are Ethereal's native capture files, and which are
- * therefore the capture file types we're writing, but is not
- * true for all the capture file types Wiretap can write.
- */
- fh = wtap_dump_file(rb_data.files[i].pdh);
- if (fflush(fh) == EOF) {
- if (err != NULL) {
- *err = errno;
- }
- return NULL;
- }
- rb_data.files[i].start_pos = ftell(fh);
- clearerr(fh);
+ rb_data.pdh = ws_fdopen(rb_data.fd, "wb");
+ if (rb_data.pdh == NULL) {
+ if (err != NULL) {
+ *err = errno;
}
}
- /* done */
- rb_data.files[0].is_new = FALSE;
- return rb_data.files[0].pdh;
+ 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;
- FILE *fh;
-
- /* flush the current file */
- fh = wtap_dump_file(rb_data.files[rb_data.curr_file_num].pdh);
- clearerr(fh);
- errno = WTAP_ERR_CANT_CLOSE;
- if (fflush(fh) == EOF) {
+ int next_file_index;
+ rb_file *next_rfile = NULL;
+
+ /* close current file */
+
+ if (fclose(rb_data.pdh) == EOF) {
if (err != NULL) {
*err = errno;
}
+ 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 */
- next_file_num = (rb_data.curr_file_num + 1) % rb_data.num_files;
- /* prepare the file if it was already used */
- if (!rb_data.files[next_file_num].is_new) {
- /* rewind to the position after the file header */
- fh = wtap_dump_file(rb_data.files[next_file_num].pdh);
- fseek(fh, rb_data.files[next_file_num].start_pos, SEEK_SET);
- wtap_set_bytes_dumped(rb_data.files[next_file_num].pdh,
- rb_data.files[next_file_num].start_pos);
- /* set the absolute file number */
- rb_data.files[next_file_num].number += rb_data.num_files;
+
+ rb_data.pdh = NULL;
+ rb_data.fd = -1;
+
+ /* get the next file number and open it */
+
+ 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;
}
-#ifdef _WIN32
- _tzset();
-#endif
- rb_data.files[next_file_num].creation_time = time(NULL);
+
+ if (ringbuf_init_libpcap_fdopen(err) == NULL) {
+ return FALSE;
+ }
+
/* switch to the new file */
- cf->save_file = rb_data.files[next_file_num].name;
- cf->save_file_fd = rb_data.files[next_file_num].fd;
- (*pdh) = rb_data.files[next_file_num].pdh;
- /* mark the file as used */
- rb_data.files[next_file_num].is_new = FALSE;
- /* finally set the current file number */
- rb_data.curr_file_num = next_file_num;
+ *save_file = next_rfile->name;
+ *save_file_fd = rb_data.fd;
+ (*pdh) = rb_data.pdh;
return TRUE;
}
-/*
- * Calls wtap_dump_close() for all ringbuffer files
+/*
+ * Calls fclose() 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;
- unsigned int i;
- gchar *new_name;
- char filenum[5+1];
- char timestr[14+1];
- FILE *fh;
-
- /* assume success */
- ret_val = TRUE;
- /* close all files */
- for (i=0; i<rb_data.num_files; i++) {
- fh = wtap_dump_file(rb_data.files[i].pdh);
- clearerr(fh);
- /* Flush the file */
- errno = WTAP_ERR_CANT_CLOSE;
- if (fflush(fh) == EOF) {
+ gboolean ret_val = TRUE;
+
+ /* close current file, if it's open */
+ if (rb_data.pdh != NULL) {
+ if (fclose(rb_data.pdh) == EOF) {
if (err != NULL) {
*err = errno;
}
+ ws_close(rb_data.fd);
ret_val = FALSE;
- /* If the file's not a new one, remove it as it hasn't been truncated
- and thus contains garbage at the end.
-
- We don't remove it if it's new - it's incomplete, but at least
- the stuff before the incomplete record is usable. */
- close(rb_data.files[i].fd);
- if (!rb_data.files[i].is_new) {
- unlink(rb_data.files[i].name);
- }
- continue;
- }
-
- /* Truncate the file to the current size. This must be done in order
- to get rid of the 'garbage' packets at the end of the file from
- previous usage */
- if (!rb_data.files[i].is_new) {
- if (ftruncate(rb_data.files[i].fd,ftell(fh)) != 0) {
- /* could not truncate the file */
- if (err != NULL) {
- *err = errno;
- }
- ret_val = FALSE;
- /* remove the file since it contains garbage at the end */
- close(rb_data.files[i].fd);
- unlink(rb_data.files[i].name);
- continue;
- }
- }
- /* close the file */
- if (!wtap_dump_close(rb_data.files[i].pdh, err)) {
- /* error only if it is a used file */
- if (!rb_data.files[i].is_new) {
- ret_val = FALSE;
- }
- }
- if (!rb_data.files[i].is_new) {
- /* rename the file */
- snprintf(filenum,5+1,"%05d",rb_data.files[i].number);
- strftime(timestr,14+1,"%Y%m%d%H%M%S",
- localtime(&(rb_data.files[i].creation_time)));
- new_name = g_strconcat(rb_data.fprefix,"_", filenum, "_", timestr,
- rb_data.fsuffix, NULL);
- if (rename(rb_data.files[i].name, new_name) != 0) {
- /* save the latest error */
- if (err != NULL) {
- *err = errno;
- }
- ret_val = FALSE;
- g_free(new_name);
- } else {
- g_free(rb_data.files[i].name);
- rb_data.files[i].name = new_name;
- }
- } else {
- /* this file has never been used - remove it */
- unlink(rb_data.files[i].name);
}
+ rb_data.pdh = NULL;
+ rb_data.fd = -1;
}
- /* make the current file the save file */
- 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;
}
-/*
+/*
* Frees all memory allocated by the ringbuffer
*/
void
-ringbuf_free()
-{
+ringbuf_free(void)
+{
unsigned int i;
-
+
if (rb_data.files != NULL) {
for (i=0; i < rb_data.num_files; i++) {
- g_free(rb_data.files[i].name);
- rb_data.files[i].name = NULL;
+ if (rb_data.files[i].name != NULL) {
+ g_free(rb_data.files[i].name);
+ rb_data.files[i].name = NULL;
+ }
}
- free(rb_data.files);
+ g_free(rb_data.files);
rb_data.files = NULL;
}
- g_free(rb_data.fprefix);
- g_free(rb_data.fsuffix);
+ if (rb_data.fprefix != NULL) {
+ g_free(rb_data.fprefix);
+ rb_data.fprefix = NULL;
+ }
+ if (rb_data.fsuffix != NULL) {
+ g_free(rb_data.fsuffix);
+ rb_data.fsuffix = NULL;
+ }
}
-/*
+/*
* Frees all memory allocated by the ringbuffer
*/
-void
+void
ringbuf_error_cleanup(void)
{
unsigned int i;
-
- if (rb_data.files == NULL) {
- ringbuf_free();
- return;
+
+ /* try to close via wtap */
+ if (rb_data.pdh != NULL) {
+ if (fclose(rb_data.pdh) == 0) {
+ rb_data.fd = -1;
+ }
+ rb_data.pdh = NULL;
+ }
+
+ /* close directly if still open */
+ if (rb_data.fd != -1) {
+ ws_close(rb_data.fd);
+ rb_data.fd = -1;
}
- for (i=0; i<rb_data.num_files; i++) {
- /* try to close via wtap */
- if (rb_data.files[i].pdh != NULL) {
- if (wtap_dump_close(rb_data.files[i].pdh, NULL)) {
- /* done */
- rb_data.files[i].fd = -1;
+ if (rb_data.files != NULL) {
+ for (i=0; i < rb_data.num_files; i++) {
+ if (rb_data.files[i].name != NULL) {
+ ws_unlink(rb_data.files[i].name);
}
}
- /* close directly if still open */
- if (rb_data.files[i].fd != -1) {
- close(rb_data.files[i].fd);
- }
- /* remove the other files, the initial file will be handled
- by the calling funtion */
- if (rb_data.files[i].name != NULL) {
- unlink(rb_data.files[i].name);
- }
}
- /* free the memory */
+ /* free the memory */
ringbuf_free();
}
#endif /* HAVE_LIBPCAP */
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local Variables:
+ * c-basic-offset: 2
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * ex: set shiftwidth=2 tabstop=8 expandtab:
+ * :indentSize=2:tabSize=8:noTabs=true:
+ */
git.samba.org / metze / wireshark / wip.git / blobdiff