1berry/wireshark
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
wireshark/ringbuffer.h

40 lines
1.2 KiB
C
Raw Permalink Normal View History

Add remaining header files to Doxygen Add @file markers for remaining header files so that Doxygen will generate documentation for them.
2021-11-29 23:27:19 -05:00
/** @file
*
some code cleanup (comments changed) svn path=/trunk/; revision=12848
2004-12-28 00:36:06 +00:00
* Definitions for capture ringbuffer files
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
*
name change svn path=/trunk/; revision=18197
2006-05-21 05:12:17 +00:00
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
* Copyright 1998 Gerald Combs
Removed trailing whitespaces from .h and .c files using the winapi_cleanup tool written by Patrik Stridvall for the wine project. svn path=/trunk/; revision=6117
2002-08-28 21:04:11 +00:00
*
replace SPDX identifier GPL-2.0+ with GPL-2.0-or-later. The first is deprecated, as per https://spdx.org/licenses/. Change-Id: I8e21e1d32d09b8b94b93a2dc9fbdde5ffeba6bed Reviewed-on: https://code.wireshark.org/review/25661 Petri-Dish: Anders Broman <a.broman58@gmail.com> Petri-Dish: Dario Lombardo <lomato@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2018-02-07 12:26:45 +01:00
* SPDX-License-Identifier: GPL-2.0-or-later
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
*/
#ifndef __RINGBUFFER_H__
#define __RINGBUFFER_H__
Remove some unnecessary includes from header files ringbuffer.h hasn't needed to include wiretap/wtap.h for the last 18 years (since e6886d90ce0ff33ee80acf3c2ea570333d8d5a23 when pcapio was introduced), at least not for its own purposes. Replace that include with wireshark.h (so that we have stdbool), which is already included by wiretap/wtap.h capture_opts.h has never needed ringbuffer.h, but it was accidentally add in commit c14ea41233fa92a1cb97ef29d1f9ded6587e45a5. Remove it from the header. (capture_opts.c does, however, need it.) However, some other files did need some of the WTAP_ defines, and got them through a chain of includes including ringbuffer.h. Add wiretap/wtap.h to those files. (A separate issue is that many files include wtap.h only for the various WTAP_ENCAP macros, and all files other than dumpcap only need ringbuffer.h for macros like RINGBUFFER_MAX_NUM_FILES.) Ping #19127
2025-01-07 22:56:45 -05:00
#include <wireshark.h>
Support for writing compressed captures on the fly Add support for writing compressed captures on the fly (gzip and LZ4, as supported for compressing while writing elsewhere) through writecap, by linking in file_wrappers statically. Remove the "compress a multiple file (but not ringbuffer) capture at file rotation time" option in preference to this. Fix #9311. Fix #19159
2025-01-21 09:47:46 -05:00
#include <writecap/pcapio.h>
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
Ringbuffer rework. Almost completely rewritten in order to: - be able to use a unlimited number of ringbuffer files 0 specified with -b argument or in the GUI, means that the number of file is unlimited. else the maximum number of ring buffer files is arbitrarily set to 1024. - close the current file and open (truncating it) 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). svn path=/trunk/; revision=7912
2003-06-22 16:09:04 +00:00
#define RINGBUFFER_UNLIMITED_FILES 0
Set RINGBUFFER_MAX_NUM_FILES to 100000. Use it to generate file names. Add RINGBUFFER_WARN_NUM_FILES and use it to print a warning. Print warnings when we change the number of ringbuffer files. svn path=/trunk/; revision=32998
2010-05-27 18:00:46 +00:00
/* Minimum number of ringbuffer files */
Ringbuffer rework. Almost completely rewritten in order to: - be able to use a unlimited number of ringbuffer files 0 specified with -b argument or in the GUI, means that the number of file is unlimited. else the maximum number of ring buffer files is arbitrarily set to 1024. - close the current file and open (truncating it) 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). svn path=/trunk/; revision=7912
2003-06-22 16:09:04 +00:00
#define RINGBUFFER_MIN_NUM_FILES 0
Set RINGBUFFER_MAX_NUM_FILES to 100000. Use it to generate file names. Add RINGBUFFER_WARN_NUM_FILES and use it to print a warning. Print warnings when we change the number of ringbuffer files. svn path=/trunk/; revision=32998
2010-05-27 18:00:46 +00:00
/* Maximum number of ringbuffer files */
/* Avoid crashes on very large numbers. Should be a power of 10 */
#define RINGBUFFER_MAX_NUM_FILES 100000
/* Maximum number for FAT filesystems */
#define RINGBUFFER_WARN_NUM_FILES 65535
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
Support for writing compressed captures on the fly Add support for writing compressed captures on the fly (gzip and LZ4, as supported for compressing while writing elsewhere) through writecap, by linking in file_wrappers statically. Remove the "compress a multiple file (but not ringbuffer) capture at file rotation time" option in preference to this. Fix #9311. Fix #19159
2025-01-21 09:47:46 -05:00
int ringbuf_init(const char *capture_name, unsigned num_files, bool group_read_access,
const char *compress_type, bool nametimenum);
Convert ringbuffer, frame_tvbuff, and file_packet_provider to C99 Convert more files in the root directory to use C99 types. Ping #19116
2024-07-07 09:29:58 -04:00
bool ringbuf_is_initialized(void);
const char *ringbuf_current_filename(void);
Support for writing compressed captures on the fly Add support for writing compressed captures on the fly (gzip and LZ4, as supported for compressing while writing elsewhere) through writecap, by linking in file_wrappers statically. Remove the "compress a multiple file (but not ringbuffer) capture at file rotation time" option in preference to this. Fix #9311. Fix #19159
2025-01-21 09:47:46 -05:00
pcapio_writer* ringbuf_init_libpcap_fdopen(int *err);
bool ringbuf_switch_file(pcapio_writer* *pdh, char **save_file, int *save_file_fd,
Make ringbuffer.[ch] file format agnostic. Move write routines to dumpcap.c This is a preparation for pcapng support. svn path=/trunk/; revision=28155
2009-04-26 15:51:25 +00:00
int *err);
Convert ringbuffer, frame_tvbuff, and file_packet_provider to C99 Convert more files in the root directory to use C99 types. Ping #19116
2024-07-07 09:29:58 -04:00
bool ringbuf_libpcap_dump_close(char **save_file, int *err);
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
void ringbuf_free(void);
void ringbuf_error_cleanup(void);
Convert ringbuffer, frame_tvbuff, and file_packet_provider to C99 Convert more files in the root directory to use C99 types. Ping #19116
2024-07-07 09:29:58 -04:00
bool ringbuf_set_print_name(char *name, int *err);
Make the bytes-written information from Wiretap a long, as we allow files to get that big. From Thomas Wittwer and Matthias Nyffenegger: Support for "ring buffer mode", wherein there's a ring buffer of N capture files; as each capture file reaches its maximum size (the ring buffer works only with a maximum capture file size specified), Ethereal rolls over to the next capture file in the ring buffer, replacing whatever packets might be in it with new packets. svn path=/trunk/; revision=4324
2001-12-04 08:45:04 +00:00
Always put editor-modelines at the end of the file ... ... to ensure that there are no potential issues with respect to editors limiting the number of lines scanned at the end of the file when checking for editor modelines. Change-Id: Ic85cbb108bb5159d6ec4116fea11f5eebb4e44a4 Reviewed-on: https://code.wireshark.org/review/4688 Reviewed-by: Bill Meier <wmeier@newsguy.com>
2014-10-14 15:58:21 -04:00
#endif /* ringbuffer.h */
Reference in New Issue Copy Permalink