| 1 |
m(easuring) buffer |
| 2 |
================== |
| 3 |
AUTHOR: Thomas Maier-Komor |
| 4 |
e-mail: [email protected] |
| 5 |
homepage: http://www.maier-komor.de/mbuffer.html |
| 6 |
|
| 7 |
|
| 8 |
LICENSE: |
| 9 |
======== |
| 10 |
GNU GPLv3 (see file LICENSE for details) |
| 11 |
|
| 12 |
|
| 13 |
DESCRIPTION: |
| 14 |
============ |
| 15 |
mbuffer is a replacement for buffer with additional functionality: |
| 16 |
|
| 17 |
# display of i/o speed |
| 18 |
# optional use of memory mapped i/o for huge buffer files |
| 19 |
# multithreaded instead of sharedmemory ipc |
| 20 |
# multi-volume support |
| 21 |
# auto-loader support |
| 22 |
# network support |
| 23 |
# buffer compatible command-line options |
| 24 |
|
| 25 |
|
| 26 |
NETWORKING: |
| 27 |
=========== |
| 28 |
The included networking code is based on TCP/IP. To use it you should |
| 29 |
know the basics of TCP/IP. Use it only on a trusted LAN, as there is no |
| 30 |
builtin security. |
| 31 |
|
| 32 |
|
| 33 |
TESTING: |
| 34 |
======== |
| 35 |
to test the program I do the following: |
| 36 |
# tar cf - /usr | mbuffer | tar tf - > out |
| 37 |
# tar cf - /usr | mbuffer -t | tar tf - > out |
| 38 |
|
| 39 |
|
| 40 |
ARCHITECTURES and PLATFORMS: |
| 41 |
============================ |
| 42 |
This software has been tested under the following operating systems: |
| 43 |
- solaris 8 (SPARC and x86) and later |
| 44 |
- no known issues |
| 45 |
- do not put your temporary files on a tmpfs filesystem, |
| 46 |
as this is equivalent to a normal memory allocated buffer |
| 47 |
- linux 2.2 (x86) and later |
| 48 |
- some pthread versions of linux seem to have problems with |
| 49 |
cancellation, causing a segmentation fault upon SIGINTR |
| 50 |
- tru64-alpha |
| 51 |
- broken display |
| 52 |
- FreeBSD 5.x (x86) |
| 53 |
|
| 54 |
|
| 55 |
MacOS: |
| 56 |
====== |
| 57 |
mbuffer compiles and runs on macOS. |
| 58 |
|
| 59 |
Previous versions required sem_getvalue(), which macOS does not implement for |
| 60 |
unnamed semaphores. This limitation was overcome With the usage of POSIX |
| 61 |
condition variables. |
| 62 |
|
| 63 |
macOS-specific features: |
| 64 |
- Memory detection using Mach VM APIs (host_statistics64) |
| 65 |
- Proper fsync error handling for APFS and other macOS filesystems |
| 66 |
|
| 67 |
|
| 68 |
Buffer limitations: |
| 69 |
=================== |
| 70 |
Buffer size is only limited by available system memory and address model. |
| 71 |
|
| 72 |
The number of blocks within a buffer can be limited by the infrastructure on |
| 73 |
specific platforms. This limit is high enough to be no practical issue, as it |
| 74 |
is adviced to create buffers with less than 10000 blocks. Increasing the number |
| 75 |
of block further can impact performance negatively. |
| 76 |
|
| 77 |
If the maximum buffer size should be possible larger than 2GB, you need to |
| 78 |
compile mbuffer as a 64bit executable. This is usually the default on machines |
| 79 |
with 64-bit address space. In special cases you must consult the compiler |
| 80 |
manual to add the necessary compiler switches to CFLAGS. |
| 81 |
|
| 82 |
|
| 83 |
TODO: |
| 84 |
===== |
| 85 |
# fix: unknown bugs |
| 86 |
|
| 87 |
|
| 88 |
FEEDBACK: |
| 89 |
========= |
| 90 |
It is always nice to get feedback. If you encounter |
| 91 |
a problem or a bug, send me a note. Requests for enhancements |
| 92 |
are also welcome. |
| 93 |
([email protected]) |
| 94 |
|
| 95 |
|
| 96 |
DONATIONS: |
| 97 |
========== |
| 98 |
If you like this software, and use it for production purposes in your |
| 99 |
company, please consider making a donation to support this work. |
| 100 |
You can donate via PayPal to the author's e-mail address: |
| 101 |
[email protected] |