From c63f81c1053873f169fc70753de8f6d7d81a9a2b Mon Sep 17 00:00:00 2001 From: "yann.collet.73@gmail.com" Date: Wed, 25 Sep 2013 09:00:37 +0000 Subject: Makefile : New install script and man page, contributed by Prasad Pandit lz4cli.c : Minor modifications, for easier extensibility COPYING : added license file LZ4_Streaming_Format.odt : modified file name to remove white space characters exe : .exe suffix now properly added only for Windows target git-svn-id: https://lz4.googlecode.com/svn/trunk@105 650e7d94-2a16-8b24-b05c-7c0b3f6821cd --- COPYING | 339 +++++++++++++++++++++++++++++++++++++++++++++++ LZ4 Streaming Format.odt | Bin 92660 -> 0 bytes LZ4_Streaming_Format.odt | Bin 0 -> 92652 bytes Makefile | 61 +++++++-- NEWS | 6 + bench.c | 29 ++-- lz4.1 | 84 ++++++++++++ lz4.c | 2 +- lz4cli.c | 207 ++++++++++++++++------------- 9 files changed, 607 insertions(+), 121 deletions(-) create mode 100644 COPYING delete mode 100644 LZ4 Streaming Format.odt create mode 100644 LZ4_Streaming_Format.odt create mode 100644 NEWS create mode 100644 lz4.1 diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/LZ4 Streaming Format.odt b/LZ4 Streaming Format.odt deleted file mode 100644 index 0d8e988..0000000 Binary files a/LZ4 Streaming Format.odt and /dev/null differ diff --git a/LZ4_Streaming_Format.odt b/LZ4_Streaming_Format.odt new file mode 100644 index 0000000..6dd488a Binary files /dev/null and b/LZ4_Streaming_Format.odt differ diff --git a/Makefile b/Makefile index e81ba77..1d6102e 100644 --- a/Makefile +++ b/Makefile @@ -19,6 +19,7 @@ # # You can contact the author at : # - LZ4 source repository : http://code.google.com/p/lz4/ +# - LZ4 forum froup : https://groups.google.com/forum/#!forum/lz4c # ################################################################ # lz4 : Command Line Utility, supporting gzip-like arguments # lz4c : CLU, supporting also legacy lz4demo arguments @@ -29,42 +30,80 @@ # fullbench32: Same as fullbench, but forced to compile in 32-bits mode # ################################################################ +RELEASE=r105 +PREFIX=/usr +BINDIR=$(PREFIX)/bin +MANDIR=$(PREFIX)/share/man/man1 +DISTNAME=lz4-$(RELEASE).tar.gz CC=gcc CFLAGS=-I. -std=c99 -Wall -W -Wundef -Wno-implicit-function-declaration # Define *.exe as extension for Windows systems -OS := $(shell uname) -ifeq ($(OS),Linux) -EXT = -else +# ifeq ($(OS),Windows_NT) +ifneq (,$(filter Windows%,$(OS))) EXT =.exe +else +EXT = endif -default: lz4c +SOURCES = bench.c bench.h fullbench.c fuzzer.c lz4.1 lz4.c lz4cli.c \ + lz4_format_description.txt lz4.h lz4hc.c lz4hc.h \ + LZ4_Streaming_Format.odt Makefile xxhash.c xxhash.h \ + NEWS COPYING \ + cmake/CMakeLists.txt cmake/pack/release_COPYING.txt \ + cmake/pack/CMakeLists.txt + + +default: lz4 lz4c all: lz4 lz4c lz4c32 fuzzer fuzzer32 fullbench fullbench32 lz4: lz4.c lz4hc.c bench.c xxhash.c lz4cli.c $(CC) -O3 $(CFLAGS) -DDISABLE_LZ4C_LEGACY_OPTIONS $^ -o $@$(EXT) -lz4c: lz4.c lz4hc.c bench.c xxhash.c lz4cli.c +lz4c : lz4.c lz4hc.c bench.c xxhash.c lz4cli.c $(CC) -O3 $(CFLAGS) $^ -o $@$(EXT) lz4c32: lz4.c lz4hc.c bench.c xxhash.c lz4cli.c $(CC) -m32 -O3 $(CFLAGS) $^ -o $@$(EXT) -fuzzer : lz4.c lz4hc.c fuzzer.c +fuzzer : lz4.c lz4hc.c fuzzer.c @echo fuzzer is a test tool to check lz4 integrity on target platform $(CC) -O3 $(CFLAGS) $^ -o $@$(EXT) -fuzzer32 : lz4.c lz4hc.c fuzzer.c +fuzzer32: lz4.c lz4hc.c fuzzer.c $(CC) -m32 -O3 $(CFLAGS) $^ -o $@$(EXT) -fullbench : lz4.c lz4hc.c xxhash.c fullbench.c +fullbench : lz4.c lz4hc.c xxhash.c fullbench.c $(CC) -O3 $(CFLAGS) $^ -o $@$(EXT) -fullbench32 : lz4.c lz4hc.c xxhash.c fullbench.c +fullbench32: lz4.c lz4hc.c xxhash.c fullbench.c $(CC) -m32 -O3 $(CFLAGS) $^ -o $@$(EXT) clean: - rm -f core *.o lz4$(EXT) lz4c$(EXT) lz4c32$(EXT) fuzzer$(EXT) fuzzer32$(EXT) fullbench$(EXT) fullbench32$(EXT) + @rm -f core *.o lz4$(EXT) lz4c$(EXT) lz4c32$(EXT) \ + fuzzer$(EXT) fuzzer32$(EXT) fullbench$(EXT) fullbench32$(EXT) + @echo Cleaning completed + + +ifeq ($(shell uname),Linux) + +install: lz4 + @install -d -m 755 $(BINDIR)/ $(MANDIR)/ + @install -m 755 lz4 $(BINDIR)/lz4 + @install -m 644 lz4.1 $(MANDIR)/lz4.1 + +uninstall: + [ -x $(BINDIR)/lz4 ] && rm -f $(BINDIR)/lz4 + [ -f $(MANDIR)/lz4.1 ] && rm -f $(MANDIR)/lz4.1 + +dist: clean + @install -dD -m 700 lz4-$(RELEASE)/cmake/pack/ + @for f in $(SOURCES); do \ + install -m 600 $$f lz4-$(RELEASE)/$$f; \ + done + @tar -czf $(DISTNAME) lz4-$(RELEASE)/ + @rm -rf lz4-$(RELEASE) + @echo Distribution $(DISTNAME) built + +endif diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..b278986 --- /dev/null +++ b/NEWS @@ -0,0 +1,6 @@ +r105 : +Makefile : New install script and man page, contributed by Prasad Pandit +lz4cli.c : Minor modifications, for easier extensibility +COPYING : added license file +LZ4_Streaming_Format.odt : modified file name to remove white space characters +exe : .exe suffix now properly added only for Windows target \ No newline at end of file diff --git a/bench.c b/bench.c index 7191c2a..bc42475 100644 --- a/bench.c +++ b/bench.c @@ -105,9 +105,13 @@ #define NBLOOPS 3 #define TIMELOOP 2000 -#define KNUTH 2654435761U -#define MAX_MEM (1984<<20) -#define DEFAULT_CHUNKSIZE (4<<20) +#define KB *(1U<<10) +#define MB *(1U<<20) +#define GB *(1U<<30) + +#define KNUTH 2654435761U +#define MAX_MEM (2 GB - 64 MB) +#define DEFAULT_CHUNKSIZE (4 MB) //************************************** @@ -151,10 +155,7 @@ void BMK_SetNbIterations(int nbLoops) DISPLAY("- %i iterations -\n", nbIterations); } -void BMK_SetPause() -{ - BMK_pause = 1; -} +void BMK_SetPause() { BMK_pause = 1; } //********************************************************* @@ -202,10 +203,10 @@ static int BMK_GetMilliSpan( int nTimeStart ) static size_t BMK_findMaxMem(U64 requiredMem) { - size_t step = (64U<<20); // 64 MB + size_t step = (64 MB); BYTE* testmem=NULL; - requiredMem = (((requiredMem >> 25) + 1) << 26); + requiredMem = (((requiredMem >> 26) + 1) << 26); if (requiredMem > MAX_MEM) requiredMem = MAX_MEM; requiredMem += 2*step; @@ -244,6 +245,7 @@ int BMK_benchFile(char** fileNamesTable, int nbFiles, int cLevel) int fileIdx=0; char* orig_buff; struct compressionParameters compP; + int cfunctionId; U64 totals = 0; U64 totalz = 0; @@ -252,7 +254,8 @@ int BMK_benchFile(char** fileNamesTable, int nbFiles, int cLevel) // Init - switch (cLevel) + if (cLevel <3) cfunctionId = 0; else cfunctionId = 1; + switch (cfunctionId) { #ifdef COMPRESSOR0 case 0 : compP.compressionFunction = COMPRESSOR0; break; @@ -395,13 +398,7 @@ int BMK_benchFile(char** fileNamesTable, int nbFiles, int cLevel) while(BMK_GetMilliSpan(milliTime) < TIMELOOP) { for (chunkNb=0; chunkNb project. ++\" ++ ++\" No hyphenation ++.hy 0 ++.nr HY 0 + +.TH lz4 man +.SH NAME +\fBlz4\fR - Extremely fast compression algorithm + +.SH SYNOPSIS +.TP 5 +\fBlz4\fR [\fBOPTIONS\fR] [-|INPUT-FILE] + +.SH DESCRIPTION +.PP +\fBlz4\fR is an extremely fast lossless compression algorithm. It is based on +the \fBLZ77\fR family of compression scheme. At the compression speed of 400 +MB/s per core, \fBlz4\fR is also scalable with multi-core CPUs. It features +an extremely fast decoder, with speed in multiple GB/s per core, typically +reaching the RAM speed limits on multi-core systems. \fBlz4\fR supports +following options + +.SH OPTIONS +.TP +.B \-1 + fast compression (default) +.TP +.B \-9 + high compression +.TP +.B \-d + decompression +.TP +.B \-f + overwrite output without prompting +.TP +.B \-h/\-H + display help/long help and exit +.TP +.B \-V + display Version number and exit +.TP +.B \-v + verbose mode +.TP +.B \-q + suppress warnings; specify twice to suppress errors too +.TP +.B \-c + force write to standard output, even if it is the console +.TP +.B \-t + test compressed file integrity +.TP +.B \-z + force compression +.TP +.B \-B# + block size [4-7](default : 7) +.TP +.B \-BD + block dependency (improve compression ratio) +.TP +.B \-BX + enable block checksum (default:disabled) +.TP +.B \-Sx + disable stream checksum (default:enabled) +.TP +.B \-b + benchmark file(s) +.TP +.B \-i# + iteration loops [1-9](default : 3), benchmark mode only + +.SH BUGS +Report bugs at:- https://code.google.com/p/lz4/ + +.SH AUTHOR +Yann Collet \ No newline at end of file diff --git a/lz4.c b/lz4.c index 9852bbf..606633d 100644 --- a/lz4.c +++ b/lz4.c @@ -27,8 +27,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. You can contact the author at : - - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html - LZ4 source repository : http://code.google.com/p/lz4/ + - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c */ //************************************** diff --git a/lz4cli.c b/lz4cli.c index 00ea2f6..8ae779d 100644 --- a/lz4cli.c +++ b/lz4cli.c @@ -18,8 +18,8 @@ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. You can contact the author at : - - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html - LZ4 source repository : http://code.google.com/p/lz4/ + - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c */ /* Note : this is stand-alone program. @@ -57,12 +57,12 @@ //**************************** #include // fprintf, fopen, fread, _fileno, stdin, stdout #include // malloc -#include // strcmp +#include // strcmp, strlen #include // clock #include "lz4.h" #include "lz4hc.h" -#include "bench.h" #include "xxhash.h" +#include "bench.h" //**************************** @@ -103,11 +103,11 @@ // Constants //**************************** #define COMPRESSOR_NAME "LZ4 Compression CLI" -#define COMPRESSOR_VERSION "1.0.4" +#define COMPRESSOR_VERSION "v1.0.5" #define COMPILED __DATE__ #define AUTHOR "Yann Collet" -#define EXTENSION ".lz4" -#define WELCOME_MESSAGE "*** %s %s %i-bits, by %s (%s) ***\n", COMPRESSOR_NAME, COMPRESSOR_VERSION, (int)(sizeof(void*)*8), AUTHOR, COMPILED +#define LZ4_EXTENSION ".lz4" +#define WELCOME_MESSAGE "*** %s %i-bits %s, by %s (%s) ***\n", COMPRESSOR_NAME, (int)(sizeof(void*)*8), COMPRESSOR_VERSION, AUTHOR, COMPILED #define KB *(1U<<10) #define MB *(1U<<20) @@ -119,7 +119,7 @@ #define _4BITS 0x0F #define _8BITS 0xFF -#define MAGICNUMBER_SIZE 4 +#define MAGICNUMBER_SIZE 4 #define LZ4S_MAGICNUMBER 0x184D2204 #define LZ4S_SKIPPABLE0 0x184D2A50 #define LZ4S_SKIPPABLEMASK 0xFFFFFFF0 @@ -183,13 +183,22 @@ static int blockIndependence = 1; #define EXM_THROW(error, ...) \ { \ DEBUGOUTPUT("Error defined at %s, line %i : \n", __FILE__, __LINE__); \ - DISPLAYLEVEL(1, "Error %i : ", error); \ - DISPLAYLEVEL(1, __VA_ARGS__); \ - DISPLAYLEVEL(1, "\n"); \ + DISPLAYLEVEL(1, "Error %i : ", error); \ + DISPLAYLEVEL(1, __VA_ARGS__); \ + DISPLAYLEVEL(1, "\n"); \ exit(error); \ } +//************************************** +// Version modifiers +//************************************** +#define EXTENDED_ARGUMENTS +#define EXTENDED_HELP +#define EXTENDED_FORMAT +#define DEFAULT_COMPRESSOR compress_file +#define DEFAULT_DECOMPRESSOR decodeLZ4S + //**************************** // Functions @@ -204,7 +213,8 @@ int usage() DISPLAY( "Arguments :\n"); DISPLAY( " -1 : Fast compression (default) \n"); DISPLAY( " -9 : High compression \n"); - DISPLAY( " -d : decompression \n"); + DISPLAY( " -d : decompression (default for %s extension)\n", LZ4_EXTENSION); + DISPLAY( " -z : force compression\n"); DISPLAY( " -f : overwrite output without prompting \n"); DISPLAY( " -h/-H : display help/long help and exit\n"); return 0; @@ -221,7 +231,6 @@ int usage_advanced() DISPLAY( " -q : suppress warnings; specify twice to suppress errors too\n"); DISPLAY( " -c : force write to standard output, even if it is the console\n"); DISPLAY( " -t : test compressed file integrity\n"); - DISPLAY( " -z : force compression\n"); DISPLAY( " -B# : Block size [4-7](default : 7)\n"); DISPLAY( " -BD : Block dependency (improve compression ratio)\n"); DISPLAY( " -BX : enable block checksum (default:disabled)\n"); @@ -237,6 +246,7 @@ int usage_advanced() DISPLAY( " -y : overwrite output without prompting \n"); DISPLAY( " -s : suppress warnings \n"); #endif // DISABLE_LZ4C_LEGACY_OPTIONS + EXTENDED_HELP; return 0; } @@ -250,9 +260,9 @@ int usage_longhelp() DISPLAY( "[output] can be left empty. In this case, it receives the following value : \n"); DISPLAY( " - if stdout is not the console, then [output] = stdout \n"); DISPLAY( " - if stdout is console : \n"); - DISPLAY( " + if compression selected, output to filename%s \n", EXTENSION); - DISPLAY( " + if decompression selected, output to filename without '%s'\n", EXTENSION); - DISPLAY( " > if input filename has no '%s' extension : error\n", EXTENSION); + DISPLAY( " + if compression selected, output to filename%s \n", LZ4_EXTENSION); + DISPLAY( " + if decompression selected, output to filename without '%s'\n", LZ4_EXTENSION); + DISPLAY( " > if input filename has no '%s' extension : error\n", LZ4_EXTENSION); DISPLAY( "\n"); DISPLAY( "Compression levels : \n"); DISPLAY( "There are technically 2 accessible compression levels.\n"); @@ -367,12 +377,7 @@ int legacy_compress_file(char* input_filename, char* output_filename, int compre // Init - switch (compressionlevel) - { - case 0 : compressionFunction = LZ4_compress; break; - case 1 : compressionFunction = LZ4_compressHC; break; - default: compressionFunction = LZ4_compress; - } + if (compressionlevel < 3) compressionFunction = LZ4_compress; else compressionFunction = LZ4_compressHC; start = clock(); get_fileHandle(input_filename, output_filename, &finput, &foutput); if ((displayLevel==2) && (compressionlevel==1)) displayLevel=3; @@ -395,12 +400,12 @@ int legacy_compress_file(char* input_filename, char* output_filename, int compre int inSize = (int) fread(in_buff, (size_t)1, (size_t)LEGACY_BLOCKSIZE, finput); if( inSize<=0 ) break; filesize += inSize; - DISPLAYLEVEL(3, "Read : %i MB \r", (int)(filesize>>20)); + DISPLAYLEVEL(3, "\rRead : %i MB ", (int)(filesize>>20)); // Compress Block outSize = compressionFunction(in_buff, out_buff+4, inSize); compressedfilesize += outSize+4; - DISPLAYLEVEL(3, "Read : %i MB ==> %.2f%%\r", (int)(filesize>>20), (double)compressedfilesize/filesize*100); + DISPLAYLEVEL(3, "\rRead : %i MB ==> %.2f%% ", (int)(filesize>>20), (double)compressedfilesize/filesize*100); // Write Block * (unsigned int*) out_buff = LITTLE_ENDIAN_32(outSize); @@ -449,22 +454,21 @@ int compress_file_blockDependency(char* input_filename, char* output_filename, i // Init start = clock(); - if ((displayLevel==2) && (compressionlevel==1)) displayLevel=3; - switch (compressionlevel) + if ((displayLevel==2) && (compressionlevel>=3)) displayLevel=3; + if (compressionlevel>=3) { - case 0 : - initFunction = LZ4_create; - compressionFunction = LZ4_compress_limitedOutput_continue; - translateFunction = LZ4_slideInputBuffer; - freeFunction = LZ4_free; - break; - case 1 : - default: initFunction = LZ4_createHC; compressionFunction = LZ4_compressHC_limitedOutput_continue; translateFunction = LZ4_slideInputBufferHC; freeFunction = LZ4_freeHC; } + else + { + initFunction = LZ4_create; + compressionFunction = LZ4_compress_limitedOutput_continue; + translateFunction = LZ4_slideInputBuffer; + freeFunction = LZ4_free; + } get_fileHandle(input_filename, output_filename, &finput, &foutput); blockSize = LZ4S_GetBlockSize_FromBlockId (blockSizeId); @@ -503,14 +507,14 @@ int compress_file_blockDependency(char* input_filename, char* output_filename, i inSize = (unsigned int) fread(in_start, (size_t)1, (size_t)blockSize, finput); if( inSize==0 ) break; // No more input : end of compression filesize += inSize; - DISPLAYLEVEL(3, "Read : %i MB \r", (int)(filesize>>20)); + DISPLAYLEVEL(3, "\rRead : %i MB ", (int)(filesize>>20)); if (streamChecksum) XXH32_update(streamChecksumState, in_start, inSize); // Compress Block outSize = compressionFunction(ctx, in_start, out_buff+4, inSize, inSize-1); if (outSize > 0) compressedfilesize += outSize+4; else compressedfilesize += inSize+4; if (blockChecksum) compressedfilesize+=4; - DISPLAYLEVEL(3, "Read : %i MB ==> %.2f%%\r", (int)(filesize>>20), (double)compressedfilesize/filesize*100); + DISPLAYLEVEL(3, "\rRead : %i MB ==> %.2f%% ", (int)(filesize>>20), (double)compressedfilesize/filesize*100); // Write Block if (outSize > 0) @@ -600,13 +604,8 @@ int compress_file(char* input_filename, char* output_filename, int compressionle // Init start = clock(); - if ((displayLevel==2) && (compressionlevel==1)) displayLevel=3; - switch (compressionlevel) - { - case 0 : compressionFunction = LZ4_compress_limitedOutput; break; - case 1 : compressionFunction = LZ4_compressHC_limitedOutput; break; - default: compressionFunction = LZ4_compress_limitedOutput; - } + if ((displayLevel==2) && (compressionlevel>=3)) displayLevel=3; + if (compressionlevel < 3) compressionFunction = LZ4_compress_limitedOutput; else compressionFunction = LZ4_compressHC_limitedOutput; get_fileHandle(input_filename, output_filename, &finput, &foutput); blockSize = LZ4S_GetBlockSize_FromBlockId (blockSizeId); @@ -643,14 +642,14 @@ int compress_file(char* input_filename, char* output_filename, int compressionle unsigned int outSize; filesize += readSize; - DISPLAYLEVEL(3, "Read : %i MB \r", (int)(filesize>>20)); + DISPLAYLEVEL(3, "\rRead : %i MB ", (int)(filesize>>20)); if (streamChecksum) XXH32_update(streamChecksumState, in_buff, (int)readSize); // Compress Block outSize = compressionFunction(in_buff, out_buff+4, (int)readSize, (int)readSize-1); if (outSize > 0) compressedfilesize += outSize+4; else compressedfilesize += readSize+4; if (blockChecksum) compressedfilesize+=4; - DISPLAYLEVEL(3, "Read : %i MB ==> %.2f%%\r", (int)(filesize>>20), (double)compressedfilesize/filesize*100); + DISPLAYLEVEL(3, "\rRead : %i MB ==> %.2f%% ", (int)(filesize>>20), (double)compressedfilesize/filesize*100); // Write Block if (outSize > 0) @@ -736,13 +735,12 @@ unsigned long long decodeLegacyStream(FILE* finput, FILE* foutput) // Main Loop while (1) { - size_t uselessRet; - int sinkint; + int decodeSize; size_t sizeCheck; // Block Size - uselessRet = fread(&blockSize, 1, 4, finput); - if( uselessRet==0 ) break; // Nothing to read : file read is completed + sizeCheck = fread(&blockSize, 1, 4, finput); + if (sizeCheck==0) break; // Nothing to read : file read is completed blockSize = LITTLE_ENDIAN_32(blockSize); // Convert to Little Endian if (blockSize > LZ4_COMPRESSBOUND(LEGACY_BLOCKSIZE)) { // Cannot read next block : maybe new stream ? @@ -751,16 +749,16 @@ unsigned long long decodeLegacyStream(FILE* finput, FILE* foutput) } // Read Block - uselessRet = fread(in_buff, 1, blockSize, finput); + sizeCheck = fread(in_buff, 1, blockSize, finput); // Decode Block - sinkint = LZ4_decompress_safe(in_buff, out_buff, blockSize, LEGACY_BLOCKSIZE); - if (sinkint < 0) EXM_THROW(52, "Decoding Failed ! Corrupted input detected !"); - filesize += sinkint; + decodeSize = LZ4_decompress_safe(in_buff, out_buff, blockSize, LEGACY_BLOCKSIZE); + if (decodeSize < 0) EXM_THROW(52, "Decoding Failed ! Corrupted input detected !"); + filesize += decodeSize; // Write Block - sizeCheck = fwrite(out_buff, 1, sinkint, foutput); - if (sizeCheck != (size_t)sinkint) EXM_THROW(53, "Write error : cannot write decoded block into output\n"); + sizeCheck = fwrite(out_buff, 1, decodeSize, foutput); + if (sizeCheck != (size_t)decodeSize) EXM_THROW(53, "Write error : cannot write decoded block into output\n"); } // Free @@ -905,7 +903,7 @@ unsigned long long decodeLZ4S(FILE* finput, FILE* foutput) if (!blockIndependenceFlag) { out_start += decodedBytes; - if (out_start + maxBlockSize > out_end) + if ((size_t)(out_end - out_start) < (size_t)maxBlockSize) { memcpy(out_buff, out_start - prefix64k, prefix64k); out_start = out_buff + prefix64k; @@ -948,7 +946,7 @@ unsigned long long selectDecoder( FILE* finput, FILE* foutput) switch(magicNumber) { case LZ4S_MAGICNUMBER: - return decodeLZ4S(finput, foutput); + return DEFAULT_DECOMPRESSOR(finput, foutput); case LEGACY_MAGICNUMBER: DISPLAYLEVEL(4, "Detected : Legacy format \n"); return decodeLegacyStream(finput, foutput); @@ -960,6 +958,7 @@ unsigned long long selectDecoder( FILE* finput, FILE* foutput) errorNb = fseek(finput, size, SEEK_CUR); if (errorNb != 0) EXM_THROW(43, "Stream error : cannot skip skippable area"); return selectDecoder(finput, foutput); + EXTENDED_FORMAT; default: if (ftell(finput) == MAGICNUMBER_SIZE) EXM_THROW(44,"Unrecognized header : file cannot be decoded"); // Wrong magic number at the beginning of 1st stream DISPLAYLEVEL(2, "Stream followed by unrecognized data\n"); @@ -989,7 +988,7 @@ int decodeFile(char* input_filename, char* output_filename) // Final Status end = clock(); - DISPLAYLEVEL(2, "Successfully decoded %llu bytes \n", filesize); + DISPLAYLEVEL(2, "Successfully decoded %llu bytes \n", filesize); { double seconds = (double)(end - start)/CLOCKS_PER_SEC; DISPLAYLEVEL(4, "Done in %.2f s ==> %.2f MB/s\n", seconds, (double)filesize / seconds / 1024 / 1024); @@ -1004,6 +1003,13 @@ int decodeFile(char* input_filename, char* output_filename) } +void waitEnter() +{ + DISPLAY("Press enter to continue...\n"); + getchar(); +} + + int main(int argc, char** argv) { int i, @@ -1012,11 +1018,13 @@ int main(int argc, char** argv) bench=0, filenamesStart=2, legacy_format=0, - forceStdout=0; + forceStdout=0, + forceCompress=0, + pause=0; char* input_filename=0; char* output_filename=0; char nullOutput[] = NULL_OUTPUT; - char extension[] = EXTENSION; + char extension[] = LZ4_EXTENSION; // Init programName = argv[0]; @@ -1042,14 +1050,12 @@ int main(int argc, char** argv) argument ++; #if !defined(DISABLE_LZ4C_LEGACY_OPTIONS) - // Legacy options (-c0, -c1, -hc, -y, -s, -b0, -b1) + // Legacy options (-c0, -c1, -hc, -y, -s) if ((argument[0]=='c') && (argument[1]=='0')) { cLevel=0; argument++; continue; } // -c0 (fast compression) - if ((argument[0]=='c') && (argument[1]=='1')) { cLevel=1; argument++; continue; } // -c1 (high compression) - if ((argument[0]=='h') && (argument[1]=='c')) { cLevel=1; argument++; continue; } // -hc (high compression) + if ((argument[0]=='c') && (argument[1]=='1')) { cLevel=9; argument++; continue; } // -c1 (high compression) + if ((argument[0]=='h') && (argument[1]=='c')) { cLevel=9; argument++; continue; } // -hc (high compression) if (*argument=='y') { overwrite=1; continue; } // -y (answer 'yes' to overwrite permission) if (*argument=='s') { displayLevel=1; continue; } // -s (silent mode) - if ((argument[0]=='b') && (argument[1]=='0')) { bench=1; cLevel=0; argument++; continue; } // -b0 (fast bench) - if ((argument[0]=='b') && (argument[1]=='1')) { bench=1; cLevel=1; argument++; continue; } // -b1 (HC bench) #endif // DISABLE_LZ4C_LEGACY_OPTIONS switch(argument[0]) @@ -1060,19 +1066,19 @@ int main(int argc, char** argv) case 'H': usage_advanced(); usage_longhelp(); return 0; // Compression (default) - case 'z': break; + case 'z': forceCompress = 1; break; // Compression level case '0': case '1': - case '2': cLevel=0; break; + case '2': case '3': case '4': case '5': case '6': case '7': case '8': - case '9': cLevel=1; break; + case '9': cLevel=*argument -'0'; break; // Use Legacy format (hidden option) case 'l': legacy_format=1; break; @@ -1141,8 +1147,10 @@ int main(int argc, char** argv) } break; - // Pause at the end (benchmark only) (hidden option) - case 'p': BMK_SetPause(); break; + // Pause at the end (hidden option) + case 'p': pause=1; BMK_SetPause(); break; + + EXTENDED_ARGUMENTS; // Unrecognised command default : badusage(); @@ -1163,59 +1171,72 @@ int main(int argc, char** argv) } } - DISPLAYLEVEL(4, WELCOME_MESSAGE); + DISPLAYLEVEL(3, WELCOME_MESSAGE); DISPLAYLEVEL(4, "Blocks size : %i KB\n", (1 << ((blockSizeId*2)-2))); // No input filename ==> use stdin if(!input_filename) { input_filename=stdinmark; } + // Check if input or output are defined as console; trigger an error in this case + if (!strcmp(input_filename, stdinmark) && IS_CONSOLE(stdin) ) badusage(); + // Check if benchmark is selected if (bench) return BMK_benchFile(argv+filenamesStart, argc-filenamesStart, cLevel); - // No output filename ==> select one automatically (when possible) - if (!output_filename) + // No output filename ==> try to select one automatically (when possible) + while (!output_filename) { - if (!IS_CONSOLE(stdout)) { output_filename=stdoutmark; } - else if (!decode) // compression + if (!IS_CONSOLE(stdout)) { output_filename=stdoutmark; break; } // Default to stdout whenever possible (i.e. not a console) + if ((!decode) && !(forceCompress)) // auto-determine compression or decompression, based on file extension { - int i=0, l=0; - while (input_filename[l]!=0) l++; + size_t l = strlen(input_filename); + if (!strcmp(input_filename+(l-4), LZ4_EXTENSION)) decode=1; + } + if (!decode) // compression to file + { + size_t l = strlen(input_filename); output_filename = (char*)calloc(1,l+5); - for (i=0;i4) while ((outl >= inl-4) && (input_filename[outl] == extension[outl-inl+4])) output_filename[outl--]=0; - if (outl != inl-5) { DISPLAYLEVEL(1, "Cannot automatically decide an output filename\n"); badusage(); } + if (outl != inl-5) { DISPLAYLEVEL(1, "Cannot determine an output filename\n"); badusage(); } DISPLAYLEVEL(2, "Decoding file %s \n", output_filename); } } // No warning message in pure pipe mode (stdin + stdout) - if (!strcmp(input_filename, stdinmark) && !strcmp(output_filename,stdoutmark) && (displayLevel>1) && (displayLevel<4)) displayLevel=1; + if (!strcmp(input_filename, stdinmark) && !strcmp(output_filename,stdoutmark) && (displayLevel==2)) displayLevel=1; // Check if input or output are defined as console; trigger an error in this case if (!strcmp(input_filename, stdinmark) && IS_CONSOLE(stdin) ) badusage(); if (!strcmp(output_filename,stdoutmark) && IS_CONSOLE(stdout) && !forceStdout) badusage(); // Decompress input if selected - if (decode) return decodeFile(input_filename, output_filename); - - // compression is default action - if (legacy_format) - { - DISPLAYLEVEL(2, "! Generating compressed LZ4 using Legacy format (deprecated !) ! \n"); - return legacy_compress_file(input_filename, output_filename, cLevel); - } + if (decode) decodeFile(input_filename, output_filename); else + // compression is default action { - return compress_file(input_filename, output_filename, cLevel); + if (legacy_format) + { + DISPLAYLEVEL(2, "! Generating compressed LZ4 using Legacy format (deprecated !) ! \n"); + legacy_compress_file(input_filename, output_filename, cLevel); + } + else + { + DEFAULT_COMPRESSOR(input_filename, output_filename, cLevel); + } } + + if (pause) waitEnter(); } -- cgit v0.12