1
0
Fork 0

Adding upstream version 0.2.

Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-24 03:23:29 +01:00
parent 63d771d1a1
commit e748b84dff
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
21 changed files with 1267 additions and 2163 deletions

View file

@ -1,3 +1,10 @@
2010-01-17 Antonio Diaz Diaz <ant_diaz@teleline.es>
* Version 0.2 released.
* Implemented option "--dictionary-size".
* Implemented option "--match-length".
* "lacos_rbtree" has been replaced with a circular buffer.
2009-12-05 Antonio Diaz Diaz <ant_diaz@teleline.es> 2009-12-05 Antonio Diaz Diaz <ant_diaz@teleline.es>
* Version 0.1 released. * Version 0.1 released.
@ -14,7 +21,7 @@
until something better appears on the net. until something better appears on the net.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This file is a collection of facts, and thus it is not copyrightable, This file is a collection of facts, and thus it is not copyrightable,
but just in case, I give you unlimited permission to copy, distribute but just in case, I give you unlimited permission to copy, distribute

View file

@ -3,6 +3,7 @@ Requirements
You will need a C++ compiler and the lzlib compression library installed. You will need a C++ compiler and the lzlib compression library installed.
I use gcc 4.3.4 and 3.3.6, but the code should compile with any I use gcc 4.3.4 and 3.3.6, but the code should compile with any
standards compliant compiler. standards compliant compiler.
Lzlib must be version 0.8 or newer.
Gcc is available at http://gcc.gnu.org. Gcc is available at http://gcc.gnu.org.
Lzlib is available at http://www.nongnu.org/lzip/lzlib.html. Lzlib is available at http://www.nongnu.org/lzip/lzlib.html.
@ -51,7 +52,7 @@ After running `configure', you can run `make' and `make install' as
explained above. explained above.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This file is free documentation: you have unlimited permission to copy, This file is free documentation: you have unlimited permission to copy,
distribute and modify it. distribute and modify it.

View file

@ -1,5 +1,5 @@
DISTNAME = $(progname)-$(progversion) DISTNAME = $(pkgname)-$(pkgversion)
INSTALL = install INSTALL = install
INSTALL_PROGRAM = $(INSTALL) -p -m 755 INSTALL_PROGRAM = $(INSTALL) -p -m 755
INSTALL_DATA = $(INSTALL) -p -m 644 INSTALL_DATA = $(INSTALL) -p -m 644
@ -7,7 +7,7 @@ INSTALL_DIR = $(INSTALL) -d -m 755
LIBS = -llz -lpthread LIBS = -llz -lpthread
SHELL = /bin/sh SHELL = /bin/sh
objs = arg_parser.o lacos_rbtree.o plzip.o main.o objs = arg_parser.o plzip.o main.o
.PHONY : all install install-info install-man install-strip \ .PHONY : all install install-info install-man install-strip \
@ -23,23 +23,22 @@ $(progname)_profiled : $(objs)
$(CXX) $(LDFLAGS) -pg -o $(progname)_profiled $(objs) $(LIBS) $(CXX) $(LDFLAGS) -pg -o $(progname)_profiled $(objs) $(LIBS)
main.o : main.cc main.o : main.cc
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -DPROGVERSION=\"$(progversion)\" -c -o $@ $< $(CXX) $(CPPFLAGS) $(CXXFLAGS) -DPROGVERSION=\"$(pkgversion)\" -c -o $@ $<
%.o : %.cc %.o : %.cc
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $< $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $<
$(objs) : Makefile $(objs) : Makefile
arg_parser.o : arg_parser.h arg_parser.o : arg_parser.h
lacos_rbtree.o: lacos_rbtree.h
main.o : arg_parser.h main.h plzip.h main.o : arg_parser.h main.h plzip.h
plzip.o : lacos_rbtree.h main.h plzip.h plzip.o : main.h plzip.h
doc : info man doc : info man
info : $(VPATH)/doc/$(progname).info info : $(VPATH)/doc/$(pkgname).info
$(VPATH)/doc/$(progname).info : $(VPATH)/doc/$(progname).texinfo $(VPATH)/doc/$(pkgname).info : $(VPATH)/doc/$(pkgname).texinfo
cd $(VPATH)/doc && makeinfo $(progname).texinfo cd $(VPATH)/doc && makeinfo $(pkgname).texinfo
man : $(VPATH)/doc/$(progname).1 man : $(VPATH)/doc/$(progname).1
@ -50,20 +49,20 @@ $(VPATH)/doc/$(progname).1 : $(progname)
Makefile : $(VPATH)/configure $(VPATH)/Makefile.in Makefile : $(VPATH)/configure $(VPATH)/Makefile.in
./config.status ./config.status
check : all $(VPATH)/testsuite/check.sh check : all
@$(VPATH)/testsuite/check.sh $(VPATH)/testsuite @$(VPATH)/testsuite/check.sh $(VPATH)/testsuite
install : all install-info install-man install : all install-info install-man
if test ! -d $(DESTDIR)$(bindir) ; then $(INSTALL_DIR) $(DESTDIR)$(bindir) ; fi if [ ! -d $(DESTDIR)$(bindir) ] ; then $(INSTALL_DIR) $(DESTDIR)$(bindir) ; fi
$(INSTALL_PROGRAM) ./$(progname) $(DESTDIR)$(bindir)/$(progname) $(INSTALL_PROGRAM) ./$(progname) $(DESTDIR)$(bindir)/$(progname)
install-info : install-info :
if test ! -d $(DESTDIR)$(infodir) ; then $(INSTALL_DIR) $(DESTDIR)$(infodir) ; fi if [ ! -d $(DESTDIR)$(infodir) ] ; then $(INSTALL_DIR) $(DESTDIR)$(infodir) ; fi
$(INSTALL_DATA) $(VPATH)/doc/$(progname).info $(DESTDIR)$(infodir)/$(progname).info $(INSTALL_DATA) $(VPATH)/doc/$(pkgname).info $(DESTDIR)$(infodir)/$(pkgname).info
-install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$(progname).info -install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$(pkgname).info
install-man : install-man :
if test ! -d $(DESTDIR)$(mandir)/man1 ; then $(INSTALL_DIR) $(DESTDIR)$(mandir)/man1 ; fi if [ ! -d $(DESTDIR)$(mandir)/man1 ] ; then $(INSTALL_DIR) $(DESTDIR)$(mandir)/man1 ; fi
$(INSTALL_DATA) $(VPATH)/doc/$(progname).1 $(DESTDIR)$(mandir)/man1/$(progname).1 $(INSTALL_DATA) $(VPATH)/doc/$(progname).1 $(DESTDIR)$(mandir)/man1/$(progname).1
install-strip : all install-strip : all
@ -73,13 +72,13 @@ uninstall : uninstall-info uninstall-man
-rm -f $(DESTDIR)$(bindir)/$(progname) -rm -f $(DESTDIR)$(bindir)/$(progname)
uninstall-info : uninstall-info :
-install-info --info-dir=$(DESTDIR)$(infodir) --remove $(DESTDIR)$(infodir)/$(progname).info -install-info --info-dir=$(DESTDIR)$(infodir) --remove $(DESTDIR)$(infodir)/$(pkgname).info
-rm -f $(DESTDIR)$(infodir)/$(progname).info -rm -f $(DESTDIR)$(infodir)/$(pkgname).info
uninstall-man : uninstall-man :
-rm -f $(DESTDIR)$(mandir)/man1/$(progname).1 -rm -f $(DESTDIR)$(mandir)/man1/$(progname).1
dist : dist : doc
ln -sf $(VPATH) $(DISTNAME) ln -sf $(VPATH) $(DISTNAME)
tar -cvf $(DISTNAME).tar \ tar -cvf $(DISTNAME).tar \
$(DISTNAME)/AUTHORS \ $(DISTNAME)/AUTHORS \
@ -91,10 +90,11 @@ dist :
$(DISTNAME)/README \ $(DISTNAME)/README \
$(DISTNAME)/configure \ $(DISTNAME)/configure \
$(DISTNAME)/doc/$(progname).1 \ $(DISTNAME)/doc/$(progname).1 \
$(DISTNAME)/doc/$(progname).info \ $(DISTNAME)/doc/$(pkgname).info \
$(DISTNAME)/doc/$(progname).texinfo \ $(DISTNAME)/doc/$(pkgname).texinfo \
$(DISTNAME)/testsuite/COPYING.lz \
$(DISTNAME)/testsuite/check.sh \ $(DISTNAME)/testsuite/check.sh \
$(DISTNAME)/testsuite/test1 \
$(DISTNAME)/testsuite/test1.lz \
$(DISTNAME)/*.h \ $(DISTNAME)/*.h \
$(DISTNAME)/*.cc $(DISTNAME)/*.cc
rm -f $(DISTNAME) rm -f $(DISTNAME)

5
NEWS
View file

@ -1,3 +1,4 @@
Changes in version 0.1: Changes in version 0.2:
Initial release. Lzip options "--dictionary-size" and "--match-length" have been
implemented.

4
README
View file

@ -2,7 +2,7 @@ Description
Plzip is a parallel version of the lzip data compressor. Currently only Plzip is a parallel version of the lzip data compressor. Currently only
compression is performed in parallel. Parallel decompression is planned compression is performed in parallel. Parallel decompression is planned
to be implemented soon. to be implemented later.
Lzip is a lossless data compressor based on the LZMA algorithm, with Lzip is a lossless data compressor based on the LZMA algorithm, with
very safe integrity checking and a user interface similar to the one of very safe integrity checking and a user interface similar to the one of
@ -11,7 +11,7 @@ better than bzip2, which makes it well suited for software distribution
and data archiving. and data archiving.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This file is free documentation: you have unlimited permission to copy, This file is free documentation: you have unlimited permission to copy,
distribute and modify it. distribute and modify it.

View file

@ -1,18 +1,28 @@
/* Arg_parser - A POSIX/GNU command line argument parser. /* Arg_parser - A POSIX/GNU command line argument parser. (C++ version)
Copyright (C) 2006, 2007, 2008, 2009 Antonio Diaz Diaz. Copyright (C) 2006, 2007, 2008, 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify This library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this library. If not, see <http://www.gnu.org/licenses/>.
As a special exception, you may use this file as part of a free
software library without restriction. Specifically, if other files
instantiate templates or use macros or inline functions from this
file, or you compile this file and link it with other files to
produce an executable, this file does not by itself cause the
resulting executable to be covered by the GNU General Public
License. This exception does not however invalidate any other
reasons why the executable file might be covered by the GNU General
Public License.
*/ */
#include <cstring> #include <cstring>

View file

@ -1,18 +1,28 @@
/* Arg_parser - A POSIX/GNU command line argument parser. /* Arg_parser - A POSIX/GNU command line argument parser. (C++ version)
Copyright (C) 2006, 2007, 2008, 2009 Antonio Diaz Diaz. Copyright (C) 2006, 2007, 2008, 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify This library is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. (at your option) any later version.
This program is distributed in the hope that it will be useful, This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details. GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this library. If not, see <http://www.gnu.org/licenses/>.
As a special exception, you may use this file as part of a free
software library without restriction. Specifically, if other files
instantiate templates or use macros or inline functions from this
file, or you compile this file and link it with other files to
produce an executable, this file does not by itself cause the
resulting executable to be covered by the GNU General Public
License. This exception does not however invalidate any other
reasons why the executable file might be covered by the GNU General
Public License.
*/ */
/* Arg_parser reads the arguments in `argv' and creates a number of /* Arg_parser reads the arguments in `argv' and creates a number of

45
configure vendored
View file

@ -1,16 +1,17 @@
#! /bin/sh #! /bin/sh
# configure script for Plzip - A parallel version of the lzip data compressor # configure script for Plzip - A parallel version of the lzip data compressor
# Copyright (C) 2009 Antonio Diaz Diaz. # Copyright (C) 2009, 2010 Antonio Diaz Diaz.
# #
# This configure script is free software: you have unlimited permission # This configure script is free software: you have unlimited permission
# to copy, distribute and modify it. # to copy, distribute and modify it.
# #
# Date of this version: 2009-09-05 # Date of this version: 2010-01-17
args= args=
no_create= no_create=
pkgname=plzip
pkgversion=0.2
progname=plzip progname=plzip
progversion=0.1
srctrigger=plzip.h srctrigger=plzip.h
# clear some things potentially inherited from environment. # clear some things potentially inherited from environment.
@ -24,15 +25,13 @@ datadir='$(prefix)/share'
infodir='$(datadir)/info' infodir='$(datadir)/info'
mandir='$(datadir)/man' mandir='$(datadir)/man'
sysconfdir='$(prefix)/etc' sysconfdir='$(prefix)/etc'
CC=
CXX= CXX=
CPPFLAGS= CPPFLAGS=
CFLAGS='-Wall -W -O2'
CXXFLAGS='-Wall -W -O2' CXXFLAGS='-Wall -W -O2'
LDFLAGS= LDFLAGS=
# Loop over all args # Loop over all args
while [ x"$1" != x ] ; do while [ -n "$1" ] ; do
# Get the first arg, and shuffle # Get the first arg, and shuffle
option=$1 option=$1
@ -62,16 +61,14 @@ while [ x"$1" != x ] ; do
echo " --infodir=DIR info files directory [${infodir}]" echo " --infodir=DIR info files directory [${infodir}]"
echo " --mandir=DIR man pages directory [${mandir}]" echo " --mandir=DIR man pages directory [${mandir}]"
echo " --sysconfdir=DIR read-only single-machine data directory [${sysconfdir}]" echo " --sysconfdir=DIR read-only single-machine data directory [${sysconfdir}]"
echo " CC=COMPILER C compiler to use [gcc]"
echo " CXX=COMPILER C++ compiler to use [g++]" echo " CXX=COMPILER C++ compiler to use [g++]"
echo " CPPFLAGS=OPTIONS command line options for the preprocessor [${CPPFLAGS}]" echo " CPPFLAGS=OPTIONS command line options for the preprocessor [${CPPFLAGS}]"
echo " CFLAGS=OPTIONS command line options for the C compiler [${CFLAGS}]"
echo " CXXFLAGS=OPTIONS command line options for the C++ compiler [${CXXFLAGS}]" echo " CXXFLAGS=OPTIONS command line options for the C++ compiler [${CXXFLAGS}]"
echo " LDFLAGS=OPTIONS command line options for the linker [${LDFLAGS}]" echo " LDFLAGS=OPTIONS command line options for the linker [${LDFLAGS}]"
echo echo
exit 0 ;; exit 0 ;;
--version | --ve* | -V) --version | --ve* | -V)
echo "Configure script for ${progname} version ${progversion}" echo "Configure script for ${pkgname} version ${pkgversion}"
exit 0 ;; exit 0 ;;
--srcdir* | --sr*) --srcdir* | --sr*)
srcdir=`echo ${optarg} | sed -e 's,/$,,'` ;; srcdir=`echo ${optarg} | sed -e 's,/$,,'` ;;
@ -92,10 +89,8 @@ while [ x"$1" != x ] ; do
--no-create | --no-c*) --no-create | --no-c*)
no_create=yes ;; no_create=yes ;;
CC=*) CC=${optarg} ;;
CXX=*) CXX=${optarg} ;; CXX=*) CXX=${optarg} ;;
CPPFLAGS=*) CPPFLAGS=${optarg} ;; CPPFLAGS=*) CPPFLAGS=${optarg} ;;
CFLAGS=*) CFLAGS=${optarg} ;;
CXXFLAGS=*) CXXFLAGS=${optarg} ;; CXXFLAGS=*) CXXFLAGS=${optarg} ;;
LDFLAGS=*) LDFLAGS=${optarg} ;; LDFLAGS=*) LDFLAGS=${optarg} ;;
@ -108,7 +103,7 @@ done
# Find the source files, if location was not specified. # Find the source files, if location was not specified.
srcdirtext= srcdirtext=
if [ x"${srcdir}" = x ] ; then if [ -z "${srcdir}" ] ; then
srcdirtext="or . or .." ; srcdir=. srcdirtext="or . or .." ; srcdir=.
if [ ! -r ${srcdir}/${srctrigger} ] ; then srcdir=.. ; fi if [ ! -r ${srcdir}/${srctrigger} ] ; then srcdir=.. ; fi
if [ ! -r ${srcdir}/${srctrigger} ] ; then if [ ! -r ${srcdir}/${srctrigger} ] ; then
@ -128,19 +123,8 @@ fi
# Set srcdir to . if that's what it is. # Set srcdir to . if that's what it is.
if [ "`pwd`" = "`cd ${srcdir} ; pwd`" ] ; then srcdir=. ; fi if [ "`pwd`" = "`cd ${srcdir} ; pwd`" ] ; then srcdir=. ; fi
# checking whether we are using GNU C.
if [ x"${CC}" = x ] ; then # Let the user override the test.
if [ -x /bin/gcc ] ||
[ -x /usr/bin/gcc ] ||
[ -x /usr/local/bin/gcc ] ; then
CC="gcc"
else
CC="cc"
fi
fi
# checking whether we are using GNU C++. # checking whether we are using GNU C++.
if [ x"${CXX}" = x ] ; then # Let the user override the test. if [ -z "${CXX}" ] ; then # Let the user override the test.
if [ -x /bin/g++ ] || if [ -x /bin/g++ ] ||
[ -x /usr/bin/g++ ] || [ -x /usr/bin/g++ ] ||
[ -x /usr/local/bin/g++ ] ; then [ -x /usr/local/bin/g++ ] ; then
@ -151,7 +135,7 @@ if [ x"${CXX}" = x ] ; then # Let the user override the test.
fi fi
echo echo
if [ x${no_create} = x ] ; then if [ -z ${no_create} ] ; then
echo "creating config.status" echo "creating config.status"
rm -f config.status rm -f config.status
cat > config.status << EOF cat > config.status << EOF
@ -176,23 +160,22 @@ echo "datadir = ${datadir}"
echo "infodir = ${infodir}" echo "infodir = ${infodir}"
echo "mandir = ${mandir}" echo "mandir = ${mandir}"
echo "sysconfdir = ${sysconfdir}" echo "sysconfdir = ${sysconfdir}"
echo "CC = ${CC}"
echo "CXX = ${CXX}" echo "CXX = ${CXX}"
echo "CPPFLAGS = ${CPPFLAGS}" echo "CPPFLAGS = ${CPPFLAGS}"
echo "CFLAGS = ${CFLAGS}"
echo "CXXFLAGS = ${CXXFLAGS}" echo "CXXFLAGS = ${CXXFLAGS}"
echo "LDFLAGS = ${LDFLAGS}" echo "LDFLAGS = ${LDFLAGS}"
rm -f Makefile rm -f Makefile
cat > Makefile << EOF cat > Makefile << EOF
# Makefile for Plzip - A parallel version of the lzip data compressor # Makefile for Plzip - A parallel version of the lzip data compressor
# Copyright (C) 2009 Antonio Diaz Diaz. # Copyright (C) 2009, 2010 Antonio Diaz Diaz.
# This file was generated automatically by configure. Do not edit. # This file was generated automatically by configure. Do not edit.
# #
# This Makefile is free software: you have unlimited permission # This Makefile is free software: you have unlimited permission
# to copy, distribute and modify it. # to copy, distribute and modify it.
pkgname = ${pkgname}
pkgversion = ${pkgversion}
progname = ${progname} progname = ${progname}
progversion = ${progversion}
VPATH = ${srcdir} VPATH = ${srcdir}
prefix = ${prefix} prefix = ${prefix}
exec_prefix = ${exec_prefix} exec_prefix = ${exec_prefix}
@ -201,13 +184,13 @@ datadir = ${datadir}
infodir = ${infodir} infodir = ${infodir}
mandir = ${mandir} mandir = ${mandir}
sysconfdir = ${sysconfdir} sysconfdir = ${sysconfdir}
CC = ${CC}
CXX = ${CXX} CXX = ${CXX}
CPPFLAGS = ${CPPFLAGS} CPPFLAGS = ${CPPFLAGS}
CFLAGS = ${CFLAGS}
CXXFLAGS = ${CXXFLAGS} CXXFLAGS = ${CXXFLAGS}
LDFLAGS = ${LDFLAGS} LDFLAGS = ${LDFLAGS}
EOF EOF
cat ${srcdir}/Makefile.in >> Makefile cat ${srcdir}/Makefile.in >> Makefile
echo "OK. Now you can run make." echo "OK. Now you can run make."
echo "If make fails, verify that the lzlib compression library is correctly"
echo "installed. (see INSTALL)"

View file

@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
.TH PLZIP "1" "December 2009" "Plzip 0.1" "User Commands" .TH PLZIP "1" "January 2010" "Plzip 0.2" "User Commands"
.SH NAME .SH NAME
Plzip \- data compressor based on the LZMA algorithm Plzip \- data compressor based on the LZMA algorithm
.SH SYNOPSIS .SH SYNOPSIS
@ -21,12 +21,27 @@ send output to standard output
\fB\-d\fR, \fB\-\-decompress\fR \fB\-d\fR, \fB\-\-decompress\fR
decompress decompress
.TP .TP
\fB\-f\fR, \fB\-\-force\fR
overwrite existing output files
.TP
\fB\-k\fR, \fB\-\-keep\fR
keep (don't delete) input files
.TP
\fB\-m\fR, \fB\-\-match\-length=\fR<n>
set match length limit in bytes [80]
.TP
\fB\-n\fR, \fB\-\-threads=\fR<n> \fB\-n\fR, \fB\-\-threads=\fR<n>
set the number of (de)compression threads set the number of (de)compression threads
.TP .TP
\fB\-o\fR, \fB\-\-output=\fR<file>
if reading stdin, place the output into <file>
.TP
\fB\-q\fR, \fB\-\-quiet\fR \fB\-q\fR, \fB\-\-quiet\fR
suppress all messages suppress all messages
.TP .TP
\fB\-s\fR, \fB\-\-dictionary\-size=\fR<n>
set dictionary size limit in bytes [8MiB]
.TP
\fB\-t\fR, \fB\-\-test\fR \fB\-t\fR, \fB\-\-test\fR
test compressed file integrity test compressed file integrity
.TP .TP
@ -48,11 +63,11 @@ Numbers may be followed by a multiplier: k = kB = 10^3 = 1000,
Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc... Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc...
.SH "REPORTING BUGS" .SH "REPORTING BUGS"
Report bugs to lzip\-bug@nongnu.org Report bugs to lzip\-bug@nongnu.org
Lzip home page: http://www.nongnu.org/lzip/lzip.html Plzip home page: http://www.nongnu.org/lzip/plzip.html
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2009 Laszlo Ersek. Copyright \(co 2009 Laszlo Ersek.
.br .br
Copyright \(co 2009 Antonio Diaz Diaz. Copyright \(co 2010 Antonio Diaz Diaz.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br .br
This is free software: you are free to change and redistribute it. This is free software: you are free to change and redistribute it.

View file

@ -12,7 +12,7 @@ File: plzip.info, Node: Top, Next: Introduction, Up: (dir)
Plzip Manual Plzip Manual
************ ************
This manual is for Plzip (version 0.1, 5 December 2009). This manual is for Plzip (version 0.2, 17 January 2010).
* Menu: * Menu:
@ -23,7 +23,7 @@ This manual is for Plzip (version 0.1, 5 December 2009).
* Concept Index:: Index of concepts * Concept Index:: Index of concepts
Copyright (C) 2008, 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This manual is free documentation: you have unlimited permission to This manual is free documentation: you have unlimited permission to
copy, distribute and modify it. copy, distribute and modify it.
@ -36,7 +36,7 @@ File: plzip.info, Node: Introduction, Next: Invoking Plzip, Prev: Top, Up: T
Plzip is a parallel version of the lzip data compressor. Currently only Plzip is a parallel version of the lzip data compressor. Currently only
compression is performed in parallel. Parallel decompression is planned compression is performed in parallel. Parallel decompression is planned
to be implemented soon. to be implemented later.
Lzip is a lossless data compressor based on the LZMA algorithm, with Lzip is a lossless data compressor based on the LZMA algorithm, with
very safe integrity checking and a user interface similar to the one of very safe integrity checking and a user interface similar to the one of
@ -295,9 +295,9 @@ Concept Index
Tag Table: Tag Table:
Node: Top227 Node: Top227
Node: Introduction750 Node: Introduction750
Node: Invoking Plzip3401 Node: Invoking Plzip3402
Node: File Format6746 Node: File Format6747
Node: Problems8702 Node: Problems8703
Node: Concept Index9231 Node: Concept Index9232
 
End Tag Table End Tag Table

View file

@ -5,8 +5,8 @@
@finalout @finalout
@c %**end of header @c %**end of header
@set UPDATED 5 December 2009 @set UPDATED 17 January 2010
@set VERSION 0.1 @set VERSION 0.2
@dircategory Data Compression @dircategory Data Compression
@direntry @direntry
@ -40,7 +40,7 @@ This manual is for Plzip (version @value{VERSION}, @value{UPDATED}).
@end menu @end menu
@sp 1 @sp 1
Copyright @copyright{} 2008, 2009 Antonio Diaz Diaz. Copyright @copyright{} 2009, 2010 Antonio Diaz Diaz.
This manual is free documentation: you have unlimited permission This manual is free documentation: you have unlimited permission
to copy, distribute and modify it. to copy, distribute and modify it.
@ -52,7 +52,7 @@ to copy, distribute and modify it.
Plzip is a parallel version of the lzip data compressor. Currently only Plzip is a parallel version of the lzip data compressor. Currently only
compression is performed in parallel. Parallel decompression is planned compression is performed in parallel. Parallel decompression is planned
to be implemented soon. to be implemented later.
Lzip is a lossless data compressor based on the LZMA algorithm, with Lzip is a lossless data compressor based on the LZMA algorithm, with
very safe integrity checking and a user interface similar to the one of very safe integrity checking and a user interface similar to the one of

View file

@ -1,418 +0,0 @@
/* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz.
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 3 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, see <http://www.gnu.org/licenses/>.
*/
#define _FILE_OFFSET_BITS 64
#include <cstddef>
#include "lacos_rbtree.h"
enum lacos_rbtree_color {
LACOS_RBTREE_RED,
LACOS_RBTREE_BLACK
};
struct lacos_rbtree_node {
void *data;
lacos_rbtree_node *parent,
*left,
*right;
lacos_rbtree_color color;
};
lacos_rbtree_node *
lacos_rbtree_find( lacos_rbtree_node *root, const void *key,
int (*cmp)(const void *cmp_key, const void *cmp_data))
{
int cmp_res;
while (root && (cmp_res = (*cmp)(key, root->data)))
root = cmp_res < 0 ? root->left : root->right;
return root;
}
lacos_rbtree_node *
lacos_rbtree_min( lacos_rbtree_node *root)
{
lacos_rbtree_node *tmp;
if (!root)
return 0;
while ((tmp = root->left))
root = tmp;
return root;
}
lacos_rbtree_node *
lacos_rbtree_max( lacos_rbtree_node *root)
{
lacos_rbtree_node *tmp;
if (!root)
return 0;
while ((tmp = root->right))
root = tmp;
return root;
}
lacos_rbtree_node *
lacos_rbtree_next( lacos_rbtree_node *current)
{
lacos_rbtree_node *tmp;
if (!current)
return 0;
if ((tmp = current->right)) {
while ((current = tmp->left))
tmp = current;
return tmp;
}
while ((tmp = current->parent) && current == tmp->right)
current = tmp;
return tmp;
}
lacos_rbtree_node *
lacos_rbtree_prev( lacos_rbtree_node *current)
{
lacos_rbtree_node *tmp;
if (!current)
return 0;
if ((tmp = current->left)) {
while ((current = tmp->right))
tmp = current;
return tmp;
}
while ((tmp = current->parent) && current == tmp->left)
current = tmp;
return tmp;
}
static void
lacos_rbtree_rotate_left( lacos_rbtree_node **new_root,
lacos_rbtree_node *rotation_root)
{
lacos_rbtree_node
*parent = rotation_root->parent,
*rc = rotation_root->right,
*rlc = rc->left;
rotation_root->right = rlc;
if (rlc)
rlc->parent = rotation_root;
rc->parent = parent;
if (parent)
if (rotation_root == parent->left)
parent->left = rc;
else
parent->right = rc;
else
*new_root = rc;
rc->left = rotation_root;
rotation_root->parent = rc;
}
static void
lacos_rbtree_rotate_right( lacos_rbtree_node **new_root,
lacos_rbtree_node *rotation_root)
{
lacos_rbtree_node
*parent = rotation_root->parent,
*lc = rotation_root->left,
*lrc = lc->right;
rotation_root->left = lrc;
if (lrc)
lrc->parent = rotation_root;
lc->parent = parent;
if (parent)
if (rotation_root == parent->left)
parent->left = lc;
else
parent->right = lc;
else
*new_root = lc;
lc->right = rotation_root;
rotation_root->parent = lc;
}
int
lacos_rbtree_insert( lacos_rbtree_node **new_root,
lacos_rbtree_node **new_node, void *new_data,
int (*cmp)(const void *cmp_new_data, const void *cmp_data),
void *(*alloc)(size_t size, void *alloc_ctl), void *alloc_ctl)
{
int cmp_res = 0;
lacos_rbtree_node *tmp = *new_root, *parent = 0;
while (tmp && (cmp_res = (*cmp)(new_data, tmp->data))) {
parent = tmp;
tmp = cmp_res < 0 ? tmp->left : tmp->right;
}
if (tmp) {
*new_node = tmp;
return -1;
}
if (!(*new_node = tmp = (lacos_rbtree_node *)(*alloc)(sizeof(lacos_rbtree_node),
alloc_ctl)))
return -1;
tmp->data = new_data;
tmp->parent = parent;
tmp->left = 0;
tmp->right = 0;
if (parent)
if (cmp_res < 0)
parent->left = tmp;
else
parent->right = tmp;
else {
*new_root = tmp;
tmp->color = LACOS_RBTREE_BLACK;
return 0;
}
{
lacos_rbtree_node *root = *new_root, *grandparent, *uncle;
tmp->color = LACOS_RBTREE_RED;
while (tmp != root && LACOS_RBTREE_RED == parent->color) {
grandparent = parent->parent;
if (parent == grandparent->left) {
uncle = grandparent->right;
if (uncle && LACOS_RBTREE_RED == uncle->color) {
parent->color = LACOS_RBTREE_BLACK;
uncle->color = LACOS_RBTREE_BLACK;
grandparent->color = LACOS_RBTREE_RED;
tmp = grandparent;
parent = tmp->parent;
}
else {
if (tmp == parent->right) {
tmp = parent;
lacos_rbtree_rotate_left(&root, tmp);
parent = tmp->parent;
grandparent = parent->parent;
}
parent->color = LACOS_RBTREE_BLACK;
grandparent->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_right(&root, grandparent);
}
}
else {
uncle = grandparent->left;
if (uncle && LACOS_RBTREE_RED == uncle->color) {
parent->color = LACOS_RBTREE_BLACK;
uncle->color = LACOS_RBTREE_BLACK;
grandparent->color = LACOS_RBTREE_RED;
tmp = grandparent;
parent = tmp->parent;
}
else {
if (tmp == parent->left) {
tmp = parent;
lacos_rbtree_rotate_right(&root, tmp);
parent = tmp->parent;
grandparent = parent->parent;
}
parent->color = LACOS_RBTREE_BLACK;
grandparent->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_left(&root, grandparent);
}
}
}
root->color = LACOS_RBTREE_BLACK;
*new_root = root;
}
return 0;
}
void
lacos_rbtree_delete( lacos_rbtree_node **new_root,
lacos_rbtree_node *old_node, void **old_data,
void (*dealloc)(void *ptr, void *alloc_ctl), void *alloc_ctl)
{
lacos_rbtree_node *child, *parent, *root = *new_root,
*old_node_left = old_node->left,
*old_node_right = old_node->right,
*old_node_parent = old_node->parent;
lacos_rbtree_color color_of_firstly_unlinked;
if (old_data)
*old_data = old_node->data;
if (old_node_left && old_node_right) {
lacos_rbtree_node
*to_relink = old_node_right,
*tmp = to_relink->left;
if (tmp) {
do {
to_relink = tmp;
tmp = tmp->left;
} while (tmp);
parent = to_relink->parent;
child = to_relink->right;
parent->left = child;
if (child)
child->parent = parent;
to_relink->right = old_node_right;
old_node_right->parent = to_relink;
}
else {
parent = old_node_right;
child = old_node_right->right;
}
to_relink->left = old_node_left;
old_node_left->parent = to_relink;
color_of_firstly_unlinked = to_relink->color;
to_relink->color = old_node->color;
to_relink->parent = old_node_parent;
if (old_node_parent)
if (old_node == old_node_parent->left)
old_node_parent->left = to_relink;
else
old_node_parent->right = to_relink;
else
root = to_relink;
}
else {
parent = old_node_parent;
child = old_node_left ? old_node_left : old_node_right;
color_of_firstly_unlinked = old_node->color;
if (child)
child->parent = parent;
if (old_node_parent)
if (old_node == old_node_parent->left)
old_node_parent->left = child;
else
old_node_parent->right = child;
else
root = child;
}
(*dealloc)(old_node, alloc_ctl);
if (LACOS_RBTREE_BLACK == color_of_firstly_unlinked) {
lacos_rbtree_node *brother, *left_nephew, *right_nephew;
int left_black, right_black;
while (child != root && (!child || LACOS_RBTREE_BLACK == child->color))
if (child == parent->left) {
brother = parent->right;
if (LACOS_RBTREE_RED == brother->color) {
brother->color = LACOS_RBTREE_BLACK;
parent->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_left(&root, parent);
brother = parent->right;
}
left_nephew = brother->left;
right_nephew = brother->right;
right_black = !right_nephew
|| LACOS_RBTREE_BLACK == right_nephew->color;
if ((!left_nephew || LACOS_RBTREE_BLACK == left_nephew->color)
&& right_black) {
brother->color = LACOS_RBTREE_RED;
child = parent;
parent = parent->parent;
}
else {
if (right_black) {
left_nephew->color = LACOS_RBTREE_BLACK;
brother->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_right(&root, brother);
brother = parent->right;
right_nephew = brother->right;
}
brother->color = parent->color;
parent->color = LACOS_RBTREE_BLACK;
right_nephew->color = LACOS_RBTREE_BLACK;
lacos_rbtree_rotate_left(&root, parent);
child = root;
break;
}
}
else {
brother = parent->left;
if (LACOS_RBTREE_RED == brother->color) {
brother->color = LACOS_RBTREE_BLACK;
parent->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_right(&root, parent);
brother = parent->left;
}
right_nephew = brother->right;
left_nephew = brother->left;
left_black = !left_nephew || LACOS_RBTREE_BLACK == left_nephew->color;
if ((!right_nephew || LACOS_RBTREE_BLACK == right_nephew->color)
&& left_black) {
brother->color = LACOS_RBTREE_RED;
child = parent;
parent = parent->parent;
}
else {
if (left_black) {
right_nephew->color = LACOS_RBTREE_BLACK;
brother->color = LACOS_RBTREE_RED;
lacos_rbtree_rotate_left(&root, brother);
brother = parent->left;
left_nephew = brother->left;
}
brother->color = parent->color;
parent->color = LACOS_RBTREE_BLACK;
left_nephew->color = LACOS_RBTREE_BLACK;
lacos_rbtree_rotate_right(&root, parent);
child = root;
break;
}
}
if (child)
child->color = LACOS_RBTREE_BLACK;
}
*new_root = root;
}

View file

@ -1,249 +0,0 @@
/* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz.
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 3 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, see <http://www.gnu.org/licenses/>.
*/
#ifdef __cplusplus
extern "C" {
#endif
struct lacos_rbtree_node;
/*
Opaque data type for red-black binary tree nodes. To get its data pointer,
cast a (struct lacos_rbtree_node *) object to (void **) and derefer it once.
Empty trees equal to (struct lacos_rbtree_node *)0.
This group of functions is generally not thread-safe (although it doesn't use
any static data), because the non-read-only operations must exclude all
operations on the same tree via external locking in a multi-threaded
environment.
If you want to alter the (your own) "key" field in an element, you mustn't do
that in one step. It must involve one delete and one insert operation, in the
order of your choice. Delete-insert is probably faster than insert-delete.
*/
/*
The functions below all return and mainly take pointers to nodes, not
elements (pointers to void). However, for simplicity of language, they are
described as if they operated on pointers to void (elements).
*/
lacos_rbtree_node *
lacos_rbtree_find( lacos_rbtree_node *root, const void *key,
int (*cmp)(const void *cmp_key, const void *cmp_data));
/*
USAGE:
Find an element in the tree.
ARGUMENTS:
root:
Root of the tree.
key:
This specifies which element should be found. This doesn't need to be an
element, it can be a standalone key too, if you write the "cmp" function
accordingly.
cmp:
A function which should return an integer less than, equal to, or greater
than zero if the "key" argument compares less than, equal to, or greater
than the currently inspected element in the tree.
RETURN VALUE:
If the key is found, this function returns the element (actually the
address of the containing node). If it is not found, 0 is returned.
READ-ONLY OPERATION:
Yes.
*/
lacos_rbtree_node *
lacos_rbtree_min( lacos_rbtree_node *root);
/*
USAGE:
Get the smallest element in the tree.
ARGUMENTS:
root:
Root of the tree.
RETURN VALUE:
If the tree is empty ("root" is null), 0 is returned. Otherwise, the
smallest element is returned.
READ-ONLY OPERATION:
Yes.
*/
lacos_rbtree_node *
lacos_rbtree_max( lacos_rbtree_node *root);
/*
USAGE:
Get the greatest element in the tree.
ARGUMENTS:
root:
Root of the tree.
RETURN VALUE:
If the tree is empty ("root" is null), 0 is returned. Otherwise, the
greatest element is returned.
READ-ONLY OPERATION:
Yes.
*/
lacos_rbtree_node *
lacos_rbtree_next( lacos_rbtree_node *current);
/*
USAGE:
Get the smallest element greater than "current".
ARGUMENTS:
current:
An element.
RETURN VALUE:
If "current" is null or the last element in the tree, 0 is returned.
Otherwise, the smallest element greater than "current" is returned.
READ-ONLY OPERATION:
Yes.
*/
lacos_rbtree_node *
lacos_rbtree_prev( lacos_rbtree_node *current);
/*
USAGE:
Get the greatest element smaller than "current".
ARGUMENTS:
current:
An element.
RETURN VALUE:
If "current" is null or the first element in the tree, 0 is returned.
Otherwise, the greatest element smaller than "current" is returned.
READ-ONLY OPERATION:
Yes.
*/
int
lacos_rbtree_insert( lacos_rbtree_node **new_root,
lacos_rbtree_node **new_node, void *new_data,
int (*cmp)(const void *cmp_new_data, const void *cmp_data),
void *(*alloc)(size_t size, void *alloc_ctl), void *alloc_ctl);
/*
USAGE:
Insert an element into the tree.
ARGUMENTS:
new_root:
Address of the tree's root; "*new_root" is the root of the tree. Both
input and output.
new_node:
Output only.
new_data:
The data to insert. This must not be a standalone key, this must be a
full element. It will only be linked in, not copied.
cmp:
A function which should return an integer less than, equal to, or greater
than zero if the "new_data" argument compares less than, equal to, or
greater than the currently inspected element in the tree.
alloc:
A memory allocator function whose externally observable behavior is
consistent with that of "malloc". It must work together with the
"dealloc" function passed to "lacos_rbtree_delete".
alloc_ctl:
A pointer to a custom data type to supply the "alloc" function with
optional auxiliary control information (arena etc).
RETURN VALUE:
If the insertion succeeds, 0 is returned, the new element is stored into
"*new_node", and "*new_root" is updated to the new root of the tree.
Otherwise, "*new_root" is not modified, and -1 is returned because of one
of the following errors:
- An element with a colliding key was found in the tree. In this case, the
colliding element is stored into "*new_node".
- There was not enough memory to allocate a new node object. In this case,
0 is stored into "*new_node".
Existing node pointers remain valid in any case.
READ-ONLY OPERATION:
No.
*/
void
lacos_rbtree_delete( lacos_rbtree_node **new_root,
lacos_rbtree_node *old_node, void **old_data,
void (*dealloc)(void *ptr, void *alloc_ctl), void *alloc_ctl);
/*
USAGE:
Remove an element from the tree.
ARGUMENTS:
new_root:
Address of the tree's root; "*new_root" is the root of the tree. Both
input and output.
old_node:
The element to remove. This must be a valid node pointer into the tree.
old_data:
The deleted element (the data of the deleted node, which was specified by
the "new_data" argument of the corresponding "lacos_rbtree_insert" call).
You could get the data also through "*(void **)old_node" before calling
this function. The data pointer of the node to delete is only accessed
and stored into "*old_data" if "old_data" is not 0.
dealloc:
A memory deallocator function whose externally observable behavior is
consistent with that of "free". It must work together with the "alloc"
function passed to "lacos_rbtree_insert".
alloc_ctl:
A pointer to a custom data type to supply the "dealloc" function with
optional auxiliary control information (arena etc).
Existing node pointers different from "old_node" remain valid.
READ-ONLY OPERATION:
No.
*/
#ifdef __cplusplus
}
#endif

445
main.cc
View file

@ -1,6 +1,6 @@
/* Plzip - A parallel version of the lzip data compressor /* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek. Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -29,14 +29,14 @@
#include <cerrno> #include <cerrno>
#include <climits> #include <climits>
#include <csignal> #include <csignal>
#include <cstdarg> /* va_list */ #include <cstdarg>
#include <cstddef> #include <cstddef>
#include <cstdio> /* flockfile() */ #include <cstdio>
#include <cstdlib> #include <cstdlib>
#include <cstring> /* strerror() */ #include <cstring>
#include <string> #include <string>
#include <vector> #include <vector>
#include <fcntl.h> /* open() */ #include <fcntl.h>
#include <stdint.h> #include <stdint.h>
#include <pthread.h> #include <pthread.h>
#include <unistd.h> #include <unistd.h>
@ -63,8 +63,6 @@
#endif #endif
void internal_error( const char * msg ); void internal_error( const char * msg );
int readblock( const int fd, char * buf, const int size ) throw();
int writeblock( const int fd, const char * buf, const int size ) throw();
namespace { namespace {
@ -72,7 +70,7 @@ namespace {
const char * invocation_name = 0; const char * invocation_name = 0;
const char * const Program_name = "Plzip"; const char * const Program_name = "Plzip";
const char * const program_name = "plzip"; const char * const program_name = "plzip";
const char * const program_year = "2009"; const char * const program_year = "2010";
struct { const char * from; const char * to; } const known_extensions[] = { struct { const char * from; const char * to; } const known_extensions[] = {
{ ".lz", "" }, { ".lz", "" },
@ -89,7 +87,6 @@ enum Mode { m_compress = 0, m_decompress, m_test };
std::string output_filename; std::string output_filename;
int outhandle = -1; int outhandle = -1;
int verbosity = 0;
bool delete_output_on_interrupt = false; bool delete_output_on_interrupt = false;
class Pretty_print class Pretty_print
@ -137,13 +134,13 @@ void show_help() throw()
// std::printf( " -b, --member-size=<n> set member size limit in bytes\n" ); // std::printf( " -b, --member-size=<n> set member size limit in bytes\n" );
std::printf( " -c, --stdout send output to standard output\n" ); std::printf( " -c, --stdout send output to standard output\n" );
std::printf( " -d, --decompress decompress\n" ); std::printf( " -d, --decompress decompress\n" );
// std::printf( " -f, --force overwrite existing output files\n" ); std::printf( " -f, --force overwrite existing output files\n" );
// std::printf( " -k, --keep keep (don't delete) input files\n" ); std::printf( " -k, --keep keep (don't delete) input files\n" );
// std::printf( " -m, --match-length=<n> set match length limit in bytes [80]\n" ); std::printf( " -m, --match-length=<n> set match length limit in bytes [80]\n" );
std::printf( " -n, --threads=<n> set the number of (de)compression threads\n" ); std::printf( " -n, --threads=<n> set the number of (de)compression threads\n" );
// std::printf( " -o, --output=<file> if reading stdin, place the output into <file>\n" ); std::printf( " -o, --output=<file> if reading stdin, place the output into <file>\n" );
std::printf( " -q, --quiet suppress all messages\n" ); std::printf( " -q, --quiet suppress all messages\n" );
// std::printf( " -s, --dictionary-size=<n> set dictionary size limit in bytes [8MiB]\n" ); std::printf( " -s, --dictionary-size=<n> set dictionary size limit in bytes [8MiB]\n" );
// std::printf( " -S, --volume-size=<n> set volume size limit in bytes\n" ); // std::printf( " -S, --volume-size=<n> set volume size limit in bytes\n" );
std::printf( " -t, --test test compressed file integrity\n" ); std::printf( " -t, --test test compressed file integrity\n" );
std::printf( " -v, --verbose be verbose (a 2nd -v gives more)\n" ); std::printf( " -v, --verbose be verbose (a 2nd -v gives more)\n" );
@ -159,7 +156,7 @@ void show_help() throw()
std::printf( "Numbers may be followed by a multiplier: k = kB = 10^3 = 1000,\n" ); std::printf( "Numbers may be followed by a multiplier: k = kB = 10^3 = 1000,\n" );
std::printf( "Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc...\n" ); std::printf( "Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc...\n" );
std::printf( "\nReport bugs to lzip-bug@nongnu.org\n" ); std::printf( "\nReport bugs to lzip-bug@nongnu.org\n" );
std::printf( "Lzip home page: http://www.nongnu.org/lzip/lzip.html\n" ); std::printf( "Plzip home page: http://www.nongnu.org/lzip/plzip.html\n" );
} }
@ -236,9 +233,10 @@ int get_dict_size( const char * arg ) throw()
{ {
char *tail; char *tail;
int bits = std::strtol( arg, &tail, 0 ); int bits = std::strtol( arg, &tail, 0 );
if( bits >= min_dictionary_bits && bits <= max_dictionary_bits && *tail == 0 ) if( bits >= LZ_min_dictionary_bits() &&
bits <= LZ_max_dictionary_bits() && *tail == 0 )
return ( 1 << bits ); return ( 1 << bits );
return getnum( arg, 0, min_dictionary_size, max_dictionary_size ); return getnum( arg, 0, LZ_min_dictionary_size(), LZ_max_dictionary_size() );
} }
@ -380,75 +378,59 @@ void cleanup_and_fail( const int retval ) throw()
// Set permissions, owner and times. // Set permissions, owner and times.
void close_and_set_permissions( const struct stat * in_statsp, int * retvalp ) void close_and_set_permissions( const struct stat * const in_statsp )
{ {
int tmp = 0; bool error = false;
if( in_statsp ) if( in_statsp )
{ {
if( fchmod( outhandle, in_statsp->st_mode ) != 0 ) tmp = 1; if( fchmod( outhandle, in_statsp->st_mode ) != 0 ) error = true;
if( !tmp ) (void)fchown( outhandle, in_statsp->st_uid, in_statsp->st_gid ); else (void)fchown( outhandle, in_statsp->st_uid, in_statsp->st_gid );
// fchown will in many cases return with EPERM, which can be safely ignored. // fchown will in many cases return with EPERM, which can be safely ignored.
} }
if( close( outhandle ) == 0 ) outhandle = -1; if( close( outhandle ) == 0 ) outhandle = -1;
else cleanup_and_fail( 1 ); else cleanup_and_fail( 1 );
delete_output_on_interrupt = false; delete_output_on_interrupt = false;
if( !in_statsp ) return; if( !in_statsp ) return;
if( !tmp ) if( !error )
{ {
struct utimbuf t; struct utimbuf t;
t.actime = in_statsp->st_atime; t.actime = in_statsp->st_atime;
t.modtime = in_statsp->st_mtime; t.modtime = in_statsp->st_mtime;
if( utime( output_filename.c_str(), &t ) != 0 ) tmp = 1; if( utime( output_filename.c_str(), &t ) != 0 ) error = true;
} }
if( tmp ) if( error )
{ {
if( tmp > *retvalp ) *retvalp = tmp;
show_error( "I can't change output file attributes." ); show_error( "I can't change output file attributes." );
cleanup_and_fail( *retvalp ); cleanup_and_fail( 1 );
} }
} }
int decompress( const int inhandle, const Pretty_print & pp, int do_decompress( LZ_Decoder * const decoder, const int inhandle,
const bool testing ) const Pretty_print & pp, const bool testing )
{ {
void * decoder = LZ_decompress_open();
if( !decoder || LZ_decompress_errno( decoder ) != LZ_ok )
{
LZ_decompress_close( decoder );
pp( "not enough memory. Find a machine with more memory" );
return 1;
}
if( verbosity >= 1 ) pp();
const int in_buffer_size = 65536, out_buffer_size = 8 * in_buffer_size; const int in_buffer_size = 65536, out_buffer_size = 8 * in_buffer_size;
uint8_t in_buffer[in_buffer_size], out_buffer[out_buffer_size]; uint8_t in_buffer[in_buffer_size], out_buffer[out_buffer_size];
int in_pos = 0, in_stream_pos = 0;
bool finished = false; if( verbosity >= 1 ) pp();
while( true ) while( true )
{ {
int in_size = 0; int in_size = std::min( LZ_decompress_write_size( decoder ), in_buffer_size );
if( !finished ) if( in_size > 0 )
{ {
if( in_stream_pos == 0 ) const int max_in_size = in_size;
in_stream_pos = readblock( inhandle, (char *)in_buffer, in_buffer_size ); in_size = readblock( inhandle, (char *)in_buffer, max_in_size );
if( in_pos < in_stream_pos ) if( in_size != max_in_size && errno )
{ { pp(); show_error( "read error", errno ); return 1; }
in_size = LZ_decompress_write( decoder, in_buffer + in_pos, in_stream_pos - in_pos ); if( in_size == 0 ) LZ_decompress_finish( decoder );
in_pos += in_size; else if( in_size != LZ_decompress_write( decoder, in_buffer, in_size ) )
} internal_error( "library error (LZ_decompress_write)" );
if( in_pos >= in_stream_pos )
{
if( in_stream_pos < in_buffer_size )
{ finished = true; LZ_decompress_finish( decoder ); }
in_stream_pos = 0; in_pos = 0;
}
} }
int out_size = LZ_decompress_read( decoder, out_buffer, out_buffer_size ); int out_size = LZ_decompress_read( decoder, out_buffer, out_buffer_size );
// std::fprintf( stderr, "%5d in_size, %6d out_size.\n", in_size, out_size ); // std::fprintf( stderr, "%5d in_size, %6d out_size.\n", in_size, out_size );
if( out_size < 0 ) if( out_size < 0 )
{ {
const LZ_errno lz_errno = LZ_decompress_errno( decoder ); const LZ_Errno lz_errno = LZ_decompress_errno( decoder );
if( lz_errno == LZ_header_error ) if( lz_errno == LZ_header_error )
{ {
if( LZ_decompress_total_out_size( decoder ) > 0 ) if( LZ_decompress_total_out_size( decoder ) > 0 )
@ -461,15 +443,18 @@ int decompress( const int inhandle, const Pretty_print & pp,
pp( "not enough memory. Find a machine with more memory" ); pp( "not enough memory. Find a machine with more memory" );
return 1; return 1;
} }
pp();
if( lz_errno == LZ_unexpected_eof ) if( lz_errno == LZ_unexpected_eof )
{ {
if( verbosity >= 0 ) if( verbosity >= 0 )
{ pp();
std::fprintf( stderr, "file ends unexpectedly at pos %lld\n", std::fprintf( stderr, "file ends unexpectedly at pos %lld\n",
LZ_decompress_total_in_size( decoder ) ); } LZ_decompress_total_in_size( decoder ) );
return 2; return 2;
} }
pp(); show_error( "read error", errno ); return 1; if( verbosity >= 0 )
std::fprintf( stderr, "LZ_decompress_read error: %s.\n",
LZ_strerror( LZ_decompress_errno( decoder ) ) );
return 1;
} }
else if( out_size > 0 && outhandle >= 0 ) else if( out_size > 0 && outhandle >= 0 )
{ {
@ -478,17 +463,33 @@ int decompress( const int inhandle, const Pretty_print & pp,
{ pp(); show_error( "write error", errno ); return 1; } { pp(); show_error( "write error", errno ); return 1; }
} }
if( LZ_decompress_finished( decoder ) == 1 ) break; if( LZ_decompress_finished( decoder ) == 1 ) break;
if( finished && in_size == 0 && out_size == 0 ) if( in_size == 0 && out_size == 0 )
internal_error( "library error (LZ_decompress_read)" ); internal_error( "library error (LZ_decompress_read)" );
} }
if( verbosity >= 1 ) if( verbosity >= 1 )
{ if( testing ) std::fprintf( stderr, "ok\n" ); { if( testing ) std::fprintf( stderr, "ok\n" );
else std::fprintf( stderr, "done\n" ); } else std::fprintf( stderr, "done\n" ); }
LZ_decompress_close( decoder );
return 0; return 0;
} }
int decompress( const int inhandle, const Pretty_print & pp,
const bool testing )
{
LZ_Decoder * const decoder = LZ_decompress_open();
int retval;
if( !decoder || LZ_decompress_errno( decoder ) != LZ_ok )
{
pp( "not enough memory" );
retval = 1;
}
else retval = do_decompress( decoder, inhandle, pp, testing );
LZ_decompress_close( decoder );
return retval;
}
extern "C" void signal_handler( int ) throw() extern "C" void signal_handler( int ) throw()
{ {
show_error( "Control-C or similar caught, quitting." ); show_error( "Control-C or similar caught, quitting." );
@ -506,6 +507,9 @@ void set_signals() throw()
} // end namespace } // end namespace
int verbosity = 0;
void Pretty_print::operator()( const char * const msg ) const throw() void Pretty_print::operator()( const char * const msg ) const throw()
{ {
if( verbosity >= 0 ) if( verbosity >= 0 )
@ -523,6 +527,30 @@ void Pretty_print::operator()( const char * const msg ) const throw()
} }
void show_error( const char * msg, const int errcode, const bool help ) throw()
{
if( verbosity >= 0 )
{
if( msg && msg[0] != 0 )
{
std::fprintf( stderr, "%s: %s", program_name, msg );
if( errcode > 0 ) std::fprintf( stderr, ": %s", std::strerror( errcode ) );
std::fprintf( stderr, "\n" );
}
if( help && invocation_name && invocation_name[0] != 0 )
std::fprintf( stderr, "Try `%s --help' for more information.\n", invocation_name );
}
}
void internal_error( const char * msg )
{
std::string s( "internal error: " ); s += msg;
show_error( s.c_str() );
std::exit( 3 );
}
/* Private stuff needed by fatal(). */ /* Private stuff needed by fatal(). */
static pthread_t main_thread; static pthread_t main_thread;
@ -530,16 +558,12 @@ static pid_t pid;
/* Public utility variables and functions. */ /* Public utility variables and functions. */
void *(*mallocf)(size_t size);
void (*freef)(void *ptr);
/* /*
This can be called from any thread, main thread or sub-threads alike, since This can be called from any thread, main thread or sub-threads alike, since
they all call common helper functions that call fatal() in case of an error. they all call common helper functions that call fatal() in case of an error.
*/ */
void void fatal()
fatal(void)
{ {
if( pthread_equal(pthread_self(), main_thread) ) if( pthread_equal(pthread_self(), main_thread) )
cleanup_and_fail( 1 ); cleanup_and_fail( 1 );
@ -548,7 +572,7 @@ fatal(void)
if( 0 == kill(pid, SIGUSR1) ) if( 0 == kill(pid, SIGUSR1) )
pthread_exit(0); pthread_exit(0);
} }
_exit(EXIT_FAILURE); _exit( 1 );
} }
@ -572,67 +596,51 @@ fail(const char *fmt, int err, ...)
} }
void *
xalloc(size_t size)
{
void *ret = (*mallocf)(size);
if (0 == ret) {
fail("(*mallocf)()", errno);
}
return ret;
}
void void
xinit(Cond *cond) xinit(Cond *cond)
{ {
int ret;
pthread_mutexattr_t attr; pthread_mutexattr_t attr;
ret = pthread_mutexattr_init(&attr); int ret = pthread_mutexattr_init(&attr);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_mutexattr_init()", ret); fail("pthread_mutexattr_init()", ret);
} }
ret = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK); ret = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_mutexattr_settype()", ret); fail("pthread_mutexattr_settype()", ret);
} }
ret = pthread_mutex_init(&cond->lock, &attr); ret = pthread_mutex_init(&cond->lock, &attr);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_mutex_init()", ret); fail("pthread_mutex_init()", ret);
} }
ret = pthread_mutexattr_destroy(&attr); ret = pthread_mutexattr_destroy(&attr);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_mutexattr_destroy()", ret); fail("pthread_mutexattr_destroy()", ret);
} }
ret = pthread_cond_init(&cond->cond, 0); ret = pthread_cond_init(&cond->cond, 0);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_cond_init()", ret); fail("pthread_cond_init()", ret);
} }
cond->ccount = 0lu; cond->ccount = 0;
cond->wcount = 0lu; cond->wcount = 0;
} }
void void
xdestroy(Cond *cond) xdestroy(Cond *cond)
{ {
int ret; int ret = pthread_cond_destroy(&cond->cond);
if( ret != 0 ) {
ret = pthread_cond_destroy(&cond->cond);
if (0 != ret) {
fail("pthread_cond_destroy()", ret); fail("pthread_cond_destroy()", ret);
} }
ret = pthread_mutex_destroy(&cond->lock); ret = pthread_mutex_destroy(&cond->lock);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_mutex_destroy()", ret); fail("pthread_mutex_destroy()", ret);
} }
} }
@ -641,10 +649,8 @@ xdestroy(Cond *cond)
void void
xlock(Cond *cond) xlock(Cond *cond)
{ {
int ret; int ret = pthread_mutex_lock(&cond->lock);
if( ret != 0 ) {
ret = pthread_mutex_lock(&cond->lock);
if (0 != ret) {
fail("pthread_mutex_lock()", ret); fail("pthread_mutex_lock()", ret);
} }
} }
@ -661,10 +667,8 @@ xlock_pred(Cond *cond)
void void
xunlock(Cond *cond) xunlock(Cond *cond)
{ {
int ret; int ret = pthread_mutex_unlock(&cond->lock);
if( ret != 0 ) {
ret = pthread_mutex_unlock(&cond->lock);
if (0 != ret) {
fail("pthread_mutex_unlock()", ret); fail("pthread_mutex_unlock()", ret);
} }
} }
@ -673,11 +677,9 @@ xunlock(Cond *cond)
void void
xwait(Cond *cond) xwait(Cond *cond)
{ {
int ret;
++cond->wcount; ++cond->wcount;
ret = pthread_cond_wait(&cond->cond, &cond->lock); int ret = pthread_cond_wait(&cond->cond, &cond->lock);
if (0 != ret) { if( ret != 0 ) {
fail("pthread_cond_wait()", ret); fail("pthread_cond_wait()", ret);
} }
++cond->ccount; ++cond->ccount;
@ -687,10 +689,8 @@ xwait(Cond *cond)
void void
xsignal(Cond *cond) xsignal(Cond *cond)
{ {
int ret; int ret = pthread_cond_signal(&cond->cond);
if( ret != 0 ) {
ret = pthread_cond_signal(&cond->cond);
if (0 != ret) {
fail("pthread_cond_signal()", ret); fail("pthread_cond_signal()", ret);
} }
} }
@ -699,10 +699,8 @@ xsignal(Cond *cond)
void void
xbroadcast(Cond *cond) xbroadcast(Cond *cond)
{ {
int ret; int ret = pthread_cond_broadcast(&cond->cond);
if( ret != 0 ) {
ret = pthread_cond_broadcast(&cond->cond);
if (0 != ret) {
fail("pthread_cond_broadcast()", ret); fail("pthread_cond_broadcast()", ret);
} }
} }
@ -711,10 +709,8 @@ xbroadcast(Cond *cond)
void void
xcreate(pthread_t *thread, void *(*routine)(void *), void *arg) xcreate(pthread_t *thread, void *(*routine)(void *), void *arg)
{ {
int ret; int ret = pthread_create(thread, 0, routine, arg);
if( ret != 0 ) {
ret = pthread_create(thread, 0, routine, arg);
if (0 != ret) {
fail("pthread_create()", ret); fail("pthread_create()", ret);
} }
} }
@ -723,10 +719,8 @@ xcreate(pthread_t *thread, void *(*routine)(void *), void *arg)
void void
xjoin(pthread_t thread) xjoin(pthread_t thread)
{ {
int ret; int ret = pthread_join(thread, 0);
if( ret != 0 ) {
ret = pthread_join(thread, 0);
if (0 != ret) {
fail("pthread_join()", ret); fail("pthread_join()", ret);
} }
} }
@ -743,54 +737,6 @@ xraise(int sig)
/* Private stuff part 2. */ /* Private stuff part 2. */
struct Opts
{
unsigned num_worker; /* Start this many worker threads. */
unsigned clidx; /* Compression level index in [0u .. 8u]. */
int print_cctrs; /* Print condition variable counters. */
};
/* Backlog factor for all workers together. */
static const unsigned blf = 3u;
/* Separator characters in environment variable values. No escaping. */
static const char envsep[] = " \t";
static void *
trace_malloc(size_t size)
{
void *ret;
int save_errno = 0;
ret = malloc(size);
if (0 == ret) {
save_errno = errno;
}
if (0 > fprintf(stderr, "%lu: malloc(%lu) == %p\n", (long unsigned)pid,
(long unsigned)size, ret)
) {
fatal();
}
if (0 == ret) {
errno = save_errno;
}
return ret;
}
static void
trace_free(void *ptr)
{
if (0 > fprintf(stderr, "%lu: free(%p)\n", (long unsigned)pid, ptr)) {
fatal();
}
free(ptr);
}
static void static void
xsigemptyset(sigset_t *set) xsigemptyset(sigset_t *set)
@ -813,10 +759,8 @@ xsigaddset(sigset_t *set, int signo)
static void static void
xsigmask(int how, const sigset_t *set, sigset_t *oset) xsigmask(int how, const sigset_t *set, sigset_t *oset)
{ {
int ret; int ret = pthread_sigmask(how, set, oset);
if( ret != 0 ) {
ret = pthread_sigmask(how, set, oset);
if (0 != ret) {
fail("pthread_sigmask()", ret); fail("pthread_sigmask()", ret);
} }
} }
@ -837,47 +781,28 @@ xsigaction(int sig, void (*handler)(int))
} }
enum caught_sig enum Caught_sig { CS_INT = 1, CS_TERM, CS_USR1, CS_USR2 };
{
CS_INT = 1,
CS_TERM,
CS_USR1,
CS_USR2
};
static volatile sig_atomic_t caught_sig; static volatile sig_atomic_t caught_sig;
static void extern "C" void sighandler( int sig )
sighandler(int sig)
{ {
/* sig_atomic_t is nowhere required to be able to hold signal values. */ /* sig_atomic_t is nowhere required to be able to hold signal values. */
switch (sig) { switch( sig )
case SIGINT: {
caught_sig = CS_INT; case SIGINT : caught_sig = CS_INT; break;
break; case SIGTERM: caught_sig = CS_TERM; break;
case SIGUSR1: caught_sig = CS_USR1; break;
case SIGTERM: case SIGUSR2: caught_sig = CS_USR2; break;
caught_sig = CS_TERM; default: internal_error( "caught signal not in set" );
break;
case SIGUSR1:
caught_sig = CS_USR1;
break;
case SIGUSR2:
caught_sig = CS_USR2;
break;
default:
assert(0);
} }
} }
static void static void compress( const lzma_options & encoder_options, const int num_workers,
process( const Opts *opts, unsigned num_slot, int debug_level, int num_slots, int infd, int outfd,
int infd, int outfd, const Pretty_print & pp, const sigset_t *unblocked ) const Pretty_print & pp, const sigset_t *unblocked )
{ {
/* /*
We could wait for signals with either sigwait() or sigsuspend(). SUSv2 We could wait for signals with either sigwait() or sigsuspend(). SUSv2
@ -896,18 +821,19 @@ process( const Opts *opts, unsigned num_slot,
13-OCT-2009 lacos 13-OCT-2009 lacos
*/ */
Plzip_arg muxer_arg; if( verbosity >= 1 ) pp();
pthread_t muxer;
if( verbosity >= 1 ) pp( "" ); Muxer_arg muxer_arg;
muxer_arg.dictionary_size = encoder_options.dictionary_size;
muxer_arg.num_worker = opts->num_worker; muxer_arg.match_len_limit = encoder_options.match_len_limit;
muxer_arg.num_slot = num_slot; muxer_arg.num_workers = num_workers;
muxer_arg.clidx = opts->clidx; muxer_arg.num_slots = num_slots;
muxer_arg.print_cctrs = opts->print_cctrs; muxer_arg.debug_level = debug_level;
muxer_arg.infd = infd; muxer_arg.infd = infd;
muxer_arg.outfd = outfd; muxer_arg.outfd = outfd;
xcreate(&muxer, plzip_wrap, &muxer_arg);
pthread_t muxer_thread;
xcreate(&muxer_thread, muxer, &muxer_arg);
/* Unblock signals, wait for them, then block them again. */ /* Unblock signals, wait for them, then block them again. */
{ {
@ -951,7 +877,7 @@ process( const Opts *opts, unsigned num_slot,
assert(0); assert(0);
} }
xjoin(muxer); xjoin(muxer_thread);
} }
@ -987,30 +913,6 @@ sigs_mod(int block_n_catch, sigset_t *oset)
} }
void show_error( const char * msg, const int errcode, const bool help ) throw()
{
if( verbosity >= 0 )
{
if( msg && msg[0] != 0 )
{
std::fprintf( stderr, "%s: %s", program_name, msg );
if( errcode > 0 ) std::fprintf( stderr, ": %s", std::strerror( errcode ) );
std::fprintf( stderr, "\n" );
}
if( help && invocation_name && invocation_name[0] != 0 )
std::fprintf( stderr, "Try `%s --help' for more information.\n", invocation_name );
}
}
void internal_error( const char * msg )
{
std::string s( "internal error: " ); s += msg;
show_error( s.c_str() );
std::exit( 3 );
}
// Returns the number of bytes really read. // Returns the number of bytes really read.
// If (returned value < size) and (errno == 0), means EOF was reached. // If (returned value < size) and (errno == 0), means EOF was reached.
// //
@ -1050,7 +952,6 @@ int writeblock( const int fd, const char * buf, const int size ) throw()
int main( const int argc, const char * argv[] ) int main( const int argc, const char * argv[] )
{ {
Opts opts;
// Mapping from gzip/bzip2 style 1..9 compression modes // Mapping from gzip/bzip2 style 1..9 compression modes
// to the corresponding LZMA compression modes. // to the corresponding LZMA compression modes.
const lzma_options option_mapping[] = const lzma_options option_mapping[] =
@ -1065,7 +966,9 @@ int main( const int argc, const char * argv[] )
{ 1 << 24, 163 }, // -8 { 1 << 24, 163 }, // -8
{ 1 << 25, 273 } }; // -9 { 1 << 25, 273 } }; // -9
lzma_options encoder_options = option_mapping[5]; // default = "-6" lzma_options encoder_options = option_mapping[5]; // default = "-6"
int debug_level = 0;
int inhandle = -1; int inhandle = -1;
int num_workers = 0; // Start this many worker threads
Mode program_mode = m_compress; Mode program_mode = m_compress;
bool force = false; bool force = false;
bool keep_input_files = false; bool keep_input_files = false;
@ -1081,30 +984,15 @@ int main( const int argc, const char * argv[] )
main_thread = pthread_self(); main_thread = pthread_self();
pid = getpid(); pid = getpid();
mallocf = malloc;
freef = free;
xsigaction(SIGPIPE, SIG_IGN); xsigaction(SIGPIPE, SIG_IGN);
xsigaction(SIGXFSZ, SIG_IGN); xsigaction(SIGXFSZ, SIG_IGN);
/* Effectuate option defaults. */ const int slots_per_worker = 2;
long max_worker = sysconf(_SC_THREAD_THREADS_MAX); long max_workers = sysconf( _SC_THREAD_THREADS_MAX );
if (-1L == max_worker) { if( max_workers < 1 || max_workers > INT_MAX / slots_per_worker )
max_worker = LONG_MAX; max_workers = INT_MAX / slots_per_worker;
} if( max_workers > INT_MAX / (int)sizeof( pthread_t ) )
if (UINT_MAX < (long unsigned)max_worker) { max_workers = INT_MAX / sizeof( pthread_t );
max_worker = UINT_MAX;
}
if (UINT_MAX / blf < (unsigned)max_worker) {
max_worker = UINT_MAX / blf;
}
if ((size_t)-1 / sizeof(pthread_t) < (unsigned)max_worker) {
max_worker = (size_t)-1 / sizeof(pthread_t);
}
opts.num_worker = 0u;
opts.clidx = 5u;
opts.print_cctrs = 0;
const Arg_parser::Option options[] = const Arg_parser::Option options[] =
{ {
@ -1150,25 +1038,24 @@ int main( const int argc, const char * argv[] )
case '1': case '2': case '3': case '1': case '2': case '3':
case '4': case '5': case '6': case '4': case '5': case '6':
case '7': case '8': case '9': case '7': case '8': case '9':
opts.clidx = code - '1';
encoder_options = option_mapping[code-'1']; break; encoder_options = option_mapping[code-'1']; break;
case 'b': break;
case 'c': to_stdout = true; break; case 'c': to_stdout = true; break;
case 'd': program_mode = m_decompress; break; case 'd': program_mode = m_decompress; break;
case 'D': { int debug_level = getnum( arg, 0, 0, 3 ); case 'D': debug_level = getnum( arg, 0, 0, 3 );
if( debug_level & 1 ) opts.print_cctrs = 1;
if( debug_level & 2 )
{ mallocf = trace_malloc; freef = trace_free; } }
break; break;
case 'f': force = true; break; case 'f': force = true; break;
case 'h': show_help(); return 0; case 'h': show_help(); return 0;
case 'k': keep_input_files = true; break; case 'k': keep_input_files = true; break;
case 'm': encoder_options.match_len_limit = case 'm': encoder_options.match_len_limit =
getnum( arg, 0, 5, 273 ); break; getnum( arg, 0, LZ_min_match_len_limit(),
LZ_max_match_len_limit() ); break;
case 'o': default_output_filename = arg; break; case 'o': default_output_filename = arg; break;
case 'n': opts.num_worker = getnum( arg, 0, 1, max_worker ); break; case 'n': num_workers = getnum( arg, 0, 1, max_workers ); break;
case 'q': verbosity = -1; break; case 'q': verbosity = -1; break;
case 's': encoder_options.dictionary_size = get_dict_size( arg ); case 's': encoder_options.dictionary_size = get_dict_size( arg );
break; break;
case 'S': break;
case 't': program_mode = m_test; break; case 't': program_mode = m_test; break;
case 'v': if( verbosity < 4 ) ++verbosity; break; case 'v': if( verbosity < 4 ) ++verbosity; break;
case 'V': show_version(); return 0; case 'V': show_version(); return 0;
@ -1176,23 +1063,13 @@ int main( const int argc, const char * argv[] )
} }
} }
if( opts.num_worker <= 0 ) if( num_workers <= 0 )
{ {
#ifdef _SC_NPROCESSORS_ONLN
long num_online = sysconf( _SC_NPROCESSORS_ONLN ); long num_online = sysconf( _SC_NPROCESSORS_ONLN );
if( num_online <= 0 ) if( num_online <= 0 ) num_online = 2;
{ num_workers = std::min( num_online, max_workers );
show_error( "number of online processors unavailable.", 0, true );
fatal();
} }
opts.num_worker = std::min( num_online, max_worker ); const int num_slots = num_workers * slots_per_worker;
#else
show_error( "number of (de)compression threads not set.", 0, true );
fatal();
#endif
}
assert(UINT_MAX / blf >= opts.num_worker);
unsigned num_slot = opts.num_worker * blf;
bool filenames_given = false; bool filenames_given = false;
for( ; argind < parser.arguments(); ++argind ) for( ; argind < parser.arguments(); ++argind )
@ -1265,14 +1142,14 @@ int main( const int argc, const char * argv[] )
if( output_filename.size() && !to_stdout && program_mode != m_test ) if( output_filename.size() && !to_stdout && program_mode != m_test )
delete_output_on_interrupt = true; delete_output_on_interrupt = true;
const struct stat * in_statsp = input_filename.size() ? &in_stats : 0; const struct stat * const in_statsp = input_filename.size() ? &in_stats : 0;
pp.set_name( input_filename ); pp.set_name( input_filename );
int tmp = 0; int tmp = 0;
if( program_mode == m_compress ) if( program_mode == m_compress )
{ {
sigset_t unblocked; sigset_t unblocked;
sigs_mod(1, &unblocked); sigs_mod(1, &unblocked);
process( &opts, num_slot, inhandle, outhandle, pp, &unblocked ); compress( encoder_options, num_workers, debug_level, num_slots, inhandle, outhandle, pp, &unblocked );
sigs_mod(0, &unblocked); sigs_mod(0, &unblocked);
} }
else else
@ -1281,7 +1158,7 @@ int main( const int argc, const char * argv[] )
if( tmp && program_mode != m_test ) cleanup_and_fail( retval ); if( tmp && program_mode != m_test ) cleanup_and_fail( retval );
if( delete_output_on_interrupt ) if( delete_output_on_interrupt )
close_and_set_permissions( in_statsp, &retval ); close_and_set_permissions( in_statsp );
if( input_filename.size() ) if( input_filename.size() )
{ {
close( inhandle ); inhandle = -1; close( inhandle ); inhandle = -1;

13
main.h
View file

@ -1,6 +1,6 @@
/* Plzip - A parallel version of the lzip data compressor /* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek. Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -17,8 +17,8 @@
*/ */
void show_error( const char * msg, const int errcode = 0, const bool help = false ) throw(); void show_error( const char * msg, const int errcode = 0, const bool help = false ) throw();
extern void *(*mallocf)(size_t size); int readblock( const int fd, char * buf, const int size ) throw();
extern void (*freef)(void *ptr); int writeblock( const int fd, const char * buf, const int size ) throw();
struct Cond struct Cond
@ -30,9 +30,8 @@ struct Cond
}; };
/* Terminate the process with EXIT_FAILURE. */ /* Terminate the process. */
void void fatal();
fatal(void);
/* Format operation and append resolved error, then call fatal(). */ /* Format operation and append resolved error, then call fatal(). */
void void
@ -43,8 +42,6 @@ __attribute__((format(printf, 1, 3)))
; ;
/* If these primitives fail, they call fail(), which in turn calls fatal(). */ /* If these primitives fail, they call fail(), which in turn calls fatal(). */
void *
xalloc(size_t size);
void void
xinit(Cond *cond); xinit(Cond *cond);

618
plzip.cc
View file

@ -1,6 +1,6 @@
/* Plzip - A parallel version of the lzip data compressor /* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek. Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -18,27 +18,74 @@
#define _FILE_OFFSET_BITS 64 #define _FILE_OFFSET_BITS 64
#include <algorithm>
#include <cassert> #include <cassert>
#include <cerrno> #include <cerrno>
#include <climits> #include <climits>
#include <csignal> #include <csignal>
#include <cstdio> #include <cstdio>
#include <cstdlib> #include <cstdlib>
#include <vector>
#include <stdint.h> #include <stdint.h>
#include <unistd.h> #include <unistd.h>
#include <lzlib.h> #include <lzlib.h>
#include "main.h" #include "main.h"
#include "plzip.h" #include "plzip.h"
#include "lacos_rbtree.h"
#ifndef LLONG_MAX
#define LLONG_MAX 0x7FFFFFFFFFFFFFFFLL
#endif
#ifndef LLONG_MIN
#define LLONG_MIN (-LLONG_MAX - 1LL)
#endif
#ifndef ULLONG_MAX
#define ULLONG_MAX 0xFFFFFFFFFFFFFFFFULL
#endif
namespace {
long long in_size = 0;
long long out_size = 0;
void *(*mallocf)(size_t size);
void (*freef)(void *ptr);
void * trace_malloc(size_t size)
{
int save_errno = 0;
void * ret = malloc(size);
if( ret == 0 ) save_errno = errno;
fprintf(stderr, "malloc(%lu) == %p\n", (long unsigned)size, ret);
if( ret == 0 ) errno = save_errno;
return ret;
}
void trace_free(void *ptr)
{
fprintf(stderr, "free(%p)\n", ptr);
free(ptr);
}
void * xalloc(size_t size)
{
void *ret = (*mallocf)(size);
if( 0 == ret ) fail("(*mallocf)()", errno);
return ret;
}
struct S2w_blk /* Splitter to workers. */ struct S2w_blk /* Splitter to workers. */
{ {
uint64_t id; /* Block serial number as read from infd. */ unsigned long long id; /* Block serial number as read from infd. */
S2w_blk *next; /* Next in queue. */ S2w_blk *next; /* Next in queue. */
size_t loaded; /* # of bytes in plain, may be 0 for 1st. */ size_t loaded; /* # of bytes in plain, may be 0 for 1st. */
char unsigned plain[1]; /* Data read from infd, allocated: sizeof_plain. */ unsigned char plain[1]; /* Data read from infd, allocated: sizeof_plain. */
}; };
@ -51,7 +98,7 @@ struct S2w_q
}; };
static void void
s2w_q_init(S2w_q *s2w_q) s2w_q_init(S2w_q *s2w_q)
{ {
xinit(&s2w_q->av_or_eof); xinit(&s2w_q->av_or_eof);
@ -61,7 +108,7 @@ s2w_q_init(S2w_q *s2w_q)
} }
static void void
s2w_q_uninit(S2w_q *s2w_q) s2w_q_uninit(S2w_q *s2w_q)
{ {
assert(0 != s2w_q->eof); assert(0 != s2w_q->eof);
@ -71,187 +118,126 @@ s2w_q_uninit(S2w_q *s2w_q)
} }
struct W2m_blk /* Workers to muxer. */ struct W2m_blk /* Workers to muxer data block. */
{ {
uint64_t id; /* Block index as read from infd. */ unsigned long long id; /* Block index as read from infd. */
W2m_blk *next; /* Next block in list (unordered). */ W2m_blk *next; /* Next block in list (unordered). */
size_t produced; /* Number of bytes in compr. */ int produced; /* Number of bytes in compr. */
char unsigned compr[1]; /* Data to write to outfd, alloc.: sizeof_compr. */ unsigned char compr[1]; /* Data to write to outfd, alloc.: sizeof_compr. */
}; };
static int
w2m_blk_cmp(const void *v_a, const void *v_b)
{
uint64_t a,
b;
a = ((const W2m_blk *)v_a)->id;
b = ((const W2m_blk *)v_b)->id;
return
a < b ? -1
: a > b ? 1
: 0;
}
struct W2m_q struct W2m_q
{ {
Cond av_or_exit; /* New block available or all workers exited. */ Cond av_or_exit; /* New block available or all workers exited. */
uint64_t needed; /* Block needed for resuming writing. */ unsigned long long needed; /* Block needed for resuming writing. */
W2m_blk *head; /* Block list (unordered). */ W2m_blk *head; /* Block list (unordered). */
unsigned working; /* Number of workers still running. */ unsigned working; /* Number of workers still running. */
}; };
static void void
w2m_q_init(W2m_q *w2m_q, unsigned num_worker) w2m_q_init(W2m_q *w2m_q, int num_workers)
{ {
assert(0u < num_worker); assert(0 < num_workers);
xinit(&w2m_q->av_or_exit); xinit(&w2m_q->av_or_exit);
w2m_q->needed = 0u; w2m_q->needed = 0;
w2m_q->head = 0; w2m_q->head = 0;
w2m_q->working = num_worker; w2m_q->working = num_workers;
} }
static void void
w2m_q_uninit(W2m_q *w2m_q) w2m_q_uninit(W2m_q *w2m_q)
{ {
assert(0u == w2m_q->working); assert(0 == w2m_q->working);
assert(0 == w2m_q->head); assert(0 == w2m_q->head);
xdestroy(&w2m_q->av_or_exit); xdestroy(&w2m_q->av_or_exit);
} }
struct M2s_q /* Muxer to splitter. */ struct M2s_q // Muxer to splitter queue
{ {
Cond av; /* Free slot available. */ Cond av; // Free slot available
unsigned num_free; /* Number of free slots. */ int num_free; // Number of free slots
M2s_q( const int slots )
{
xinit(&av);
num_free = slots;
}
~M2s_q() { xdestroy(&av); }
}; };
static void struct Splitter_arg
m2s_q_init(M2s_q *m2s_q, unsigned num_free)
{ {
assert(0u < num_free); M2s_q *m2s_q;
xinit(&m2s_q->av); S2w_q *s2w_q;
m2s_q->num_free = num_free; int infd;
} int sizeof_plain;
size_t sizeof_S2w_blk;
};
static void void * splitter( void * arg )
m2s_q_uninit(M2s_q *m2s_q, unsigned num_free)
{ {
assert(m2s_q->num_free == num_free); const Splitter_arg & tmp = *(Splitter_arg *)arg;
xdestroy(&m2s_q->av); M2s_q *m2s_q = tmp.m2s_q;
} S2w_q *s2w_q = tmp.s2w_q;
const int infd = tmp.infd;
const int sizeof_plain = tmp.sizeof_plain;
const size_t sizeof_s2w_blk = tmp.sizeof_S2w_blk;
for( unsigned long long id = 0; ; ++id )
static void
split(M2s_q *m2s_q, S2w_q *s2w_q, int infd,
const size_t sizeof_plain, const size_t sizeof_s2w_blk)
{ {
uint64_t id;
ssize_t rd;
id = 0u;
do {
S2w_blk *s2w_blk;
size_t vacant;
/* Grab a free slot. */ /* Grab a free slot. */
xlock_pred(&m2s_q->av); xlock_pred(&m2s_q->av);
while (0u == m2s_q->num_free) { while( m2s_q->num_free == 0 ) xwait(&m2s_q->av);
xwait(&m2s_q->av);
}
--m2s_q->num_free; --m2s_q->num_free;
xunlock(&m2s_q->av); xunlock(&m2s_q->av);
s2w_blk = (S2w_blk *)xalloc(sizeof_s2w_blk); S2w_blk * s2w_blk = (S2w_blk *)xalloc(sizeof_s2w_blk);
/* Fill block. */ /* Fill block. */
vacant = sizeof_plain; const int rd = readblock( infd, (char *)s2w_blk->plain, sizeof_plain );
do { if( rd != sizeof_plain && errno ) fail("read()", errno);
rd = read(infd, s2w_blk->plain + (sizeof_plain - vacant),
vacant > (size_t)SSIZE_MAX ? (size_t)SSIZE_MAX : vacant);
} while (0 < rd && 0u < (vacant -= (size_t)rd));
/* Read error. */ if( rd == 0 && id != 0 )
if (-1 == rd) { {
fail("read()", errno);
}
if (sizeof_plain == vacant && 0u < id) {
/* EOF on first read, but not for first input block. */ /* EOF on first read, but not for first input block. */
(*freef)(s2w_blk); (*freef)(s2w_blk);
xlock(&m2s_q->av); xlock(&m2s_q->av);
++m2s_q->num_free; ++m2s_q->num_free;
xunlock(&m2s_q->av); xunlock(&m2s_q->av);
} }
else { else
{
s2w_blk->id = id; s2w_blk->id = id;
s2w_blk->next = 0; s2w_blk->next = 0;
s2w_blk->loaded = sizeof_plain - vacant; s2w_blk->loaded = rd;
in_size += rd;
} }
/* We either push a block, or set EOF, or both. */
assert(sizeof_plain > vacant || 0 == rd);
xlock(&s2w_q->av_or_eof); xlock(&s2w_q->av_or_eof);
if (0 == s2w_q->head) { if( s2w_q->head == 0 ) xbroadcast(&s2w_q->av_or_eof);
xbroadcast(&s2w_q->av_or_eof);
}
if (sizeof_plain > vacant || 0u == id) { if( rd > 0 || id == 0 )
if (0 == s2w_q->tail) { {
s2w_q->head = s2w_blk; if( s2w_q->tail == 0 ) s2w_q->head = s2w_blk;
} else s2w_q->tail->next = s2w_blk;
else {
s2w_q->tail->next = s2w_blk;
}
s2w_q->tail = s2w_blk; s2w_q->tail = s2w_blk;
} }
s2w_q->eof = (0 == rd); s2w_q->eof = ( rd == 0 );
xunlock(&s2w_q->av_or_eof); xunlock(&s2w_q->av_or_eof);
/* if( rd <= 0 ) break;
If we didn't push a block, then this is bogus, but then we did set EOF,
so it doesn't matter, because we'll leave immediately.
*/
++id;
} while (0 < rd);
} }
struct Split_arg
{
M2s_q *m2s_q;
S2w_q *s2w_q;
int infd;
size_t sizeof_plain,
sizeof_S2w_blk;
};
static void *
split_wrap(void *v_split_arg)
{
Split_arg *split_arg = (Split_arg *)v_split_arg;
split(
split_arg->m2s_q,
split_arg->s2w_q,
split_arg->infd,
split_arg->sizeof_plain,
split_arg->sizeof_S2w_blk
);
return 0; return 0;
} }
static void void work_lz_rd(W2m_blk *w2m_blk, const int sizeof_compr, LZ_Encoder * lz)
work_lz_rd(W2m_blk *w2m_blk, const size_t sizeof_compr, void *lz)
{ {
int rd; int rd;
@ -262,54 +248,33 @@ work_lz_rd(W2m_blk *w2m_blk, const size_t sizeof_compr, void *lz)
show_error( "LZ_compress_read() failed." ); show_error( "LZ_compress_read() failed." );
fatal(); fatal();
} }
w2m_blk->produced += (size_t)rd; w2m_blk->produced += rd;
} }
struct Compr_lev void work_compr( const int dictionary_size, const int match_len_limit,
{ S2w_blk *s2w_blk, W2m_q *w2m_q,
unsigned dict_size, const int sizeof_compr, const size_t sizeof_w2m_blk )
mx_match;
};
static const Compr_lev compr_lev[] = {
{ 1u * 1024u * 1024u, 10u },
{ 1u * 1024u * 1024u, 12u },
{ 1u * 1024u * 1024u, 17u },
{ 2u * 1024u * 1024u, 26u },
{ 4u * 1024u * 1024u, 44u },
{ 8u * 1024u * 1024u, 80u },
{ 16u * 1024u * 1024u, 108u },
{ 16u * 1024u * 1024u, 163u },
{ 32u * 1024u * 1024u, 273u }
};
static void
work_compr(S2w_blk *s2w_blk, W2m_q *w2m_q, unsigned clidx,
const size_t sizeof_compr, const size_t sizeof_w2m_blk)
{ {
W2m_blk *w2m_blk; W2m_blk *w2m_blk;
assert(0u < s2w_blk->loaded || 0u == s2w_blk->id); assert(0 < s2w_blk->loaded || 0 == s2w_blk->id);
w2m_blk = (W2m_blk *)xalloc(sizeof_w2m_blk); w2m_blk = (W2m_blk *)xalloc(sizeof_w2m_blk);
/* Single member compression. Settings like with lzip -6. */ /* Single member compression. Settings like with lzip -6. */
{ {
void *lz; LZ_Encoder * lz;
size_t written; size_t written;
lz = LZ_compress_open(compr_lev[clidx].dict_size, lz = LZ_compress_open( dictionary_size, match_len_limit, LLONG_MAX );
compr_lev[clidx].mx_match, (uint64_t)-1 / 2u);
if( LZ_ok != LZ_compress_errno(lz) ) { if( LZ_ok != LZ_compress_errno(lz) ) {
show_error( "LZ_compress_open() failed." ); show_error( "LZ_compress_open() failed." );
fatal(); fatal();
} }
written = 0u; written = 0;
w2m_blk->produced = 0u; w2m_blk->produced = 0;
while( written < s2w_blk->loaded ) { while( written < s2w_blk->loaded ) {
int wr; int wr;
@ -352,11 +317,29 @@ work_compr(S2w_blk *s2w_blk, W2m_q *w2m_q, unsigned clidx,
} }
static void struct Worker_arg
work(S2w_q *s2w_q, W2m_q *w2m_q, unsigned clidx, {
const size_t sizeof_compr, const size_t sizeof_w2m_blk) int dictionary_size;
int match_len_limit;
S2w_q *s2w_q;
W2m_q *w2m_q;
int sizeof_compr;
size_t sizeof_W2m_blk;
};
void * worker( void * arg )
{
const Worker_arg & tmp = *(Worker_arg *)arg;
const int dictionary_size = tmp.dictionary_size;
const int match_len_limit = tmp.match_len_limit;
S2w_q *s2w_q = tmp.s2w_q;
W2m_q *w2m_q = tmp.w2m_q;
const int sizeof_compr = tmp.sizeof_compr;
const size_t sizeof_w2m_blk = tmp.sizeof_W2m_blk;
while( true )
{ {
for (;;) {
S2w_blk *s2w_blk; S2w_blk *s2w_blk;
/* Grab a block to work on. */ /* Grab a block to work on. */
@ -376,259 +359,152 @@ work(S2w_q *s2w_q, W2m_q *w2m_q, unsigned clidx,
} }
xunlock(&s2w_q->av_or_eof); xunlock(&s2w_q->av_or_eof);
work_compr(s2w_blk, w2m_q, clidx, sizeof_compr, sizeof_w2m_blk); work_compr( dictionary_size, match_len_limit, s2w_blk, w2m_q,
sizeof_compr, sizeof_w2m_blk );
(*freef)(s2w_blk); (*freef)(s2w_blk);
} }
/* Notify muxer when last worker exits. */ /* Notify muxer when last worker exits. */
xlock(&w2m_q->av_or_exit); xlock(&w2m_q->av_or_exit);
if (0u == --w2m_q->working && 0 == w2m_q->head) { if( 0 == --w2m_q->working && 0 == w2m_q->head ) {
xsignal(&w2m_q->av_or_exit); xsignal(&w2m_q->av_or_exit);
} }
xunlock(&w2m_q->av_or_exit); xunlock(&w2m_q->av_or_exit);
}
struct Work_arg
{
S2w_q *s2w_q;
W2m_q *w2m_q;
unsigned clidx;
size_t sizeof_compr,
sizeof_W2m_blk;
};
static void *
work_wrap(void *v_work_arg)
{
Work_arg *work_arg;
work_arg = (Work_arg *)v_work_arg;
work(
work_arg->s2w_q,
work_arg->w2m_q,
work_arg->clidx,
work_arg->sizeof_compr,
work_arg->sizeof_W2m_blk
);
return 0; return 0;
} }
static void * void muxer_loop( W2m_q *w2m_q, M2s_q *m2s_q, const int num_slots, const int outfd )
reord_alloc(size_t size, void *)
{ {
return (*mallocf)(size); unsigned long long needed_id = 0;
} std::vector< W2m_blk * > circular_buffer( num_slots, (W2m_blk *)0 );
static void
reord_dealloc(void *ptr, void *)
{
(*freef)(ptr);
}
static void
mux_write(M2s_q *m2s_q, lacos_rbtree_node **reord,
uint64_t *reord_needed, int outfd)
{
assert(0 != *reord);
/*
Go on until the tree becomes empty or the next block is found to be
missing.
*/
do {
lacos_rbtree_node *reord_head;
W2m_blk *reord_w2m_blk;
reord_head = lacos_rbtree_min(*reord);
assert(0 != reord_head);
reord_w2m_blk = (W2m_blk *)(*(void **)reord_head);
if (reord_w2m_blk->id != *reord_needed) {
break;
}
/* Write out "reord_w2m_blk". */
if (-1 != outfd) {
char unsigned *cp;
cp = reord_w2m_blk->compr;
while (reord_w2m_blk->produced > 0u) {
ssize_t written;
written = write(outfd, cp, reord_w2m_blk->produced > (size_t)SSIZE_MAX
? (size_t)SSIZE_MAX : reord_w2m_blk->produced);
if (-1 == written) {
fail("write()", errno);
}
reord_w2m_blk->produced -= (size_t)written;
cp += written;
}
}
++*reord_needed;
xlock(&m2s_q->av);
if (0u == m2s_q->num_free++) {
xsignal(&m2s_q->av);
}
xunlock(&m2s_q->av);
lacos_rbtree_delete(
reord, /* new_root */
reord_head, /* old_node */
0, /* old_data */
reord_dealloc, /* dealloc() */
0 /* alloc_ctl */
);
/* Release "reord_w2m_blk". */
(*freef)(reord_w2m_blk);
} while (0 != *reord);
}
static void
mux(W2m_q *w2m_q, M2s_q *m2s_q, int outfd)
{
lacos_rbtree_node *reord;
uint64_t reord_needed;
reord = 0;
reord_needed = 0u;
xlock_pred(&w2m_q->av_or_exit); xlock_pred(&w2m_q->av_or_exit);
for (;;) { while( true )
W2m_blk *w2m_blk; {
/* Grab all available compressed blocks in one step. */ /* Grab all available compressed blocks in one step. */
while (0 == w2m_q->head && 0u < w2m_q->working) { while( w2m_q->head == 0 && w2m_q->working > 0 )
xwait(&w2m_q->av_or_exit); xwait(&w2m_q->av_or_exit);
}
if (0 == w2m_q->head) { if( w2m_q->head == 0 ) break; // queue is empty. all workers exited
/* w2m_q is empty and all workers exited */
break;
}
w2m_blk = w2m_q->head; W2m_blk * w2m_blk = w2m_q->head;
w2m_q->head = 0; w2m_q->head = 0;
xunlock(&w2m_q->av_or_exit); xunlock(&w2m_q->av_or_exit);
/* Merge blocks fetched this time into tree. */ // Merge blocks fetched this time into circular buffer
do { do {
lacos_rbtree_node *new_node; // id collision shouldn't happen
W2m_blk *next; assert( circular_buffer[w2m_blk->id%num_slots] == 0 );
circular_buffer[w2m_blk->id%num_slots] = w2m_blk;
if (-1 == lacos_rbtree_insert( W2m_blk * next = w2m_blk->next;
&reord, /* new_root */
&new_node, /* new_node */
w2m_blk, /* new_data */
w2m_blk_cmp, /* cmp() */
reord_alloc, /* alloc() */
0 /* alloc_ctl */
)) {
/* id collision shouldn't happen */
assert(0 == new_node);
show_error( "lacos_rbtree_insert(): out of memory." );
fatal();
}
next = w2m_blk->next;
w2m_blk->next = 0; w2m_blk->next = 0;
w2m_blk = next; w2m_blk = next;
} while (0 != w2m_blk); } while( w2m_blk != 0 );
/* Write out initial continuous sequence of reordered blocks. */ // Write out initial continuous sequence of reordered blocks
mux_write(m2s_q, &reord, &reord_needed, outfd); while( true )
{
W2m_blk * needed_w2m_blk = circular_buffer[needed_id%num_slots];
if( needed_w2m_blk == 0 ) break;
out_size += needed_w2m_blk->produced;
if( outfd >= 0 )
{
const int wr = writeblock( outfd, (char *)needed_w2m_blk->compr, needed_w2m_blk->produced );
if( wr != needed_w2m_blk->produced ) fail("write()", errno);
}
circular_buffer[needed_id%num_slots] = 0;
++needed_id;
xlock(&m2s_q->av);
if( 0 == m2s_q->num_free++ ) xsignal(&m2s_q->av);
xunlock(&m2s_q->av);
(*freef)(needed_w2m_blk);
}
xlock_pred(&w2m_q->av_or_exit); xlock_pred(&w2m_q->av_or_exit);
w2m_q->needed = reord_needed; w2m_q->needed = needed_id;
} }
xunlock(&w2m_q->av_or_exit); xunlock(&w2m_q->av_or_exit);
assert(0 == reord); for( int i = 0; i < num_slots; ++i )
if( circular_buffer[i] != 0 )
{ show_error( "circular buffer not empty" ); fatal(); }
} }
} // end namespace
static void
plzip(unsigned num_worker, unsigned num_slot, unsigned clidx, int print_cctrs, void * muxer( void * arg )
int infd, int outfd)
{ {
const Muxer_arg & tmp = *(Muxer_arg *)arg;
const int dictionary_size = tmp.dictionary_size;
const int match_len_limit = tmp.match_len_limit;
const int num_workers = tmp.num_workers;
const int num_slots = tmp.num_slots;
const int debug_level = tmp.debug_level;
const int infd = tmp.infd;
const int outfd = tmp.outfd;
S2w_q s2w_q; S2w_q s2w_q;
W2m_q w2m_q; W2m_q w2m_q;
M2s_q m2s_q;
Split_arg split_arg;
pthread_t splitter;
Work_arg work_arg;
pthread_t *worker;
unsigned i;
assert(clidx < sizeof compr_lev / sizeof compr_lev[0]); if( debug_level & 2 ) { mallocf = trace_malloc; freef = trace_free; }
else { mallocf = malloc; freef = free; }
s2w_q_init(&s2w_q); s2w_q_init(&s2w_q);
w2m_q_init(&w2m_q, num_worker); w2m_q_init(&w2m_q, num_workers);
m2s_q_init(&m2s_q, num_slot); M2s_q m2s_q( num_slots );
#define SIZES(struc, arr, arsz_unsigned, arg) \
do { \
unsigned tmp; \
\
tmp = arsz_unsigned; \
if ((size_t)-1 < tmp) { \
show_error( "size_t overflow in sizeof_" #arr "." ); \
fatal(); \
} \
arg ## _arg . sizeof_ ## arr = tmp; \
\
if ((size_t)-1 - sizeof(struc) \
< arg ## _arg . sizeof_ ## arr - (size_t)1) { \
show_error( "size_t overflow in sizeof_" #struc "." ); \
fatal(); \
} \
arg ## _arg . sizeof_ ## struc = sizeof(struc) \
+ (arg ## _arg . sizeof_ ## arr - (size_t)1); \
} while (0)
split_arg.m2s_q = &m2s_q; Splitter_arg splitter_arg;
split_arg.s2w_q = &s2w_q; splitter_arg.m2s_q = &m2s_q;
split_arg.infd = infd; splitter_arg.s2w_q = &s2w_q;
SIZES(S2w_blk, plain, 2u * compr_lev[clidx].dict_size, split); splitter_arg.infd = infd;
xcreate(&splitter, split_wrap, &split_arg); splitter_arg.sizeof_plain = 2 * std::max( 65536, dictionary_size );
splitter_arg.sizeof_S2w_blk = sizeof(S2w_blk) + splitter_arg.sizeof_plain - 1;
work_arg.s2w_q = &s2w_q; pthread_t splitter_thread;
work_arg.w2m_q = &w2m_q; xcreate(&splitter_thread, splitter, &splitter_arg);
work_arg.clidx = clidx;
SIZES(W2m_blk, compr, (4u + 1u + 1u)
+ ((unsigned)split_arg.sizeof_plain * 9u + 7u) / 8u + (4u + 8u + 8u),
work);
#undef SIZES Worker_arg worker_arg;
worker_arg.dictionary_size = dictionary_size;
worker_arg.match_len_limit = match_len_limit;
worker_arg.s2w_q = &s2w_q;
worker_arg.w2m_q = &w2m_q;
worker_arg.sizeof_compr = 6 + 20 + ( ( splitter_arg.sizeof_plain / 8 ) * 9 );
worker_arg.sizeof_W2m_blk = sizeof(W2m_blk) + worker_arg.sizeof_compr - 1;
assert(0u < num_worker); pthread_t * worker_threads = new( std::nothrow ) pthread_t[num_workers];
assert((size_t)-1 / sizeof *worker >= num_worker); if( worker_threads == 0 ) fail("not enough memory.", errno);
worker = (pthread_t *)xalloc(num_worker * sizeof *worker); for( int i = 0; i < num_workers; ++i )
for (i = 0u; i < num_worker; ++i) { xcreate(&worker_threads[i], worker, &worker_arg);
xcreate(&worker[i], work_wrap, &work_arg);
muxer_loop( &w2m_q, &m2s_q, num_slots, outfd );
for( int i = num_workers - 1; i >= 0; --i )
xjoin(worker_threads[i]);
delete[] worker_threads; worker_threads = 0;
xjoin(splitter_thread);
if( verbosity >= 1 )
{
if( in_size <= 0 || out_size <= 0 )
std::fprintf( stderr, "no data compressed.\n" );
else
std::fprintf( stderr, "%6.3f:1, %6.3f bits/byte, "
"%5.2f%% saved, %lld in, %lld out.\n",
(double)in_size / out_size,
( 8.0 * out_size ) / in_size,
100.0 * ( 1.0 - ( (double)out_size / in_size ) ),
in_size, out_size );
} }
mux(&w2m_q, &m2s_q, outfd);
i = num_worker;
do {
xjoin(worker[--i]);
} while (0u < i);
(*freef)(worker);
xjoin(splitter);
const int FW = ( sizeof(long unsigned) * 8 ) / 3 + 1; const int FW = ( sizeof(long unsigned) * 8 ) / 3 + 1;
if (print_cctrs && 0 > fprintf(stderr, if( ( debug_level & 1 ) && 0 > fprintf(stderr,
"any worker tried to consume from splitter: %*lu\n" "any worker tried to consume from splitter: %*lu\n"
"any worker stalled : %*lu\n" "any worker stalled : %*lu\n"
"muxer tried to consume from workers : %*lu\n" "muxer tried to consume from workers : %*lu\n"
@ -645,25 +521,9 @@ plzip(unsigned num_worker, unsigned num_slot, unsigned clidx, int print_cctrs,
fatal(); fatal();
} }
m2s_q_uninit(&m2s_q, num_slot); assert( m2s_q.num_free == num_slots );
w2m_q_uninit(&w2m_q); w2m_q_uninit(&w2m_q);
s2w_q_uninit(&s2w_q); s2w_q_uninit(&s2w_q);
}
void *
plzip_wrap(void *v_arg)
{
Plzip_arg *arg = (Plzip_arg *)v_arg;
plzip(
arg->num_worker,
arg->num_slot,
arg->clidx,
arg->print_cctrs,
arg->infd,
arg->outfd
);
xraise(SIGUSR2); xraise(SIGUSR2);
return 0; return 0;
} }

22
plzip.h
View file

@ -1,6 +1,6 @@
/* Plzip - A parallel version of the lzip data compressor /* Plzip - A parallel version of the lzip data compressor
Copyright (C) 2009 Laszlo Ersek. Copyright (C) 2009 Laszlo Ersek.
Copyright (C) 2009 Antonio Diaz Diaz. Copyright (C) 2009, 2010 Antonio Diaz Diaz.
This program is free software: you can redistribute it and/or modify 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 it under the terms of the GNU General Public License as published by
@ -16,15 +16,17 @@
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
struct Plzip_arg struct Muxer_arg
{ {
unsigned num_worker, int dictionary_size;
num_slot, int match_len_limit;
clidx; int num_workers;
int print_cctrs, int num_slots;
infd, int debug_level;
outfd; int infd;
int outfd;
}; };
void * void * muxer( void * arg );
plzip_wrap(void *v_arg);
extern int verbosity;

View file

@ -1,6 +1,6 @@
#! /bin/sh #! /bin/sh
# check script for Plzip - A parallel version of the lzip data compressor # check script for Plzip - A parallel version of the lzip data compressor
# Copyright (C) 2009 Antonio Diaz Diaz. # Copyright (C) 2009, 2010 Antonio Diaz Diaz.
# #
# This script is free software: you have unlimited permission # This script is free software: you have unlimited permission
# to copy, distribute and modify it. # to copy, distribute and modify it.
@ -22,10 +22,11 @@ mkdir tmp
echo -n "testing plzip..." echo -n "testing plzip..."
cd "${objdir}"/tmp cd "${objdir}"/tmp
cat "${testdir}"/../COPYING > in || framework_failure cat "${testdir}"/test1 > in || framework_failure
cat in in in in in > in5 || framework_failure
fail=0 fail=0
"${LZIP}" -cd "${testdir}"/COPYING.lz > copy || fail=1 "${LZIP}" -cd "${testdir}"/test1.lz > copy || fail=1
cmp in copy || fail=1 cmp in copy || fail=1
for i in s4096 1 2 3 4 5 6 7 8; do for i in s4096 1 2 3 4 5 6 7 8; do
@ -46,7 +47,7 @@ for i in s4096 1 2 3 4 5 6 7 8; do
done done
for i in s4096 1 2 3 4 5 6 7 8; do for i in s4096 1 2 3 4 5 6 7 8; do
"${LZIP}" -c -$i < in > out || fail=1 "${LZIP}" -$i < in > out || fail=1
"${LZIP}" -d < out > copy || fail=1 "${LZIP}" -d < out > copy || fail=1
cmp in copy || fail=1 cmp in copy || fail=1
echo -n . echo -n .
@ -59,6 +60,13 @@ for i in s4096 1 2 3 4 5 6 7 8; do
echo -n . echo -n .
done done
for i in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16; do
"${LZIP}" -s4096 -n$i < in5 > out5 || fail=1
"${LZIP}" -d < out5 > copy5 || fail=1
cmp in5 copy5 || fail=1
echo -n .
done
echo echo
if [ ${fail} = 0 ] ; then if [ ${fail} = 0 ] ; then
echo "tests completed successfully." echo "tests completed successfully."

676
testsuite/test1 Normal file
View file

@ -0,0 +1,676 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. 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
them 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 prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. 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.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey 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;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If 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 convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU 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 that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
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.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
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.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
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
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 3 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, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program 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, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU 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. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.