annotate packages/services/compress/zlib/current/src/FAQ @ 1651:91a37e2314f4

Upgrade to zlib-1.2.1
author gthomas
date Mon, 24 May 2004 19:33:34 +0000
parents c92d7972c02c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
1
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
2 Frequently Asked Questions about zlib
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
3
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
4
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
5 If your question is not there, please check the zlib home page
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
6 http://www.zlib.org which may have more recent information.
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
7 The lastest zlib FAQ is at http://www.gzip.org/zlib/zlib_faq.html
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
8
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
9
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
10 1. Is zlib Y2K-compliant?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
11
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
12 Yes. zlib doesn't handle dates.
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
13
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
14 2. Where can I get a Windows DLL version?
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
15
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
16 The zlib sources can be compiled without change to produce a DLL.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
17 See the file win32/DLL_FAQ.txt in the zlib distribution.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
18 Pointers to the precompiled DLL are found in the zlib web site at
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
19 http://www.zlib.org.
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
20
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
21 3. Where can I get a Visual Basic interface to zlib?
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
22
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
23 See
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
24 * http://www.winimage.com/zLibDll/
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
25 * http://www.dogma.net/markn/articles/zlibtool/zlibtool.htm
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
26 * contrib/visual-basic.txt in the zlib distribution
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
27
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
28 4. compress() returns Z_BUF_ERROR
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
29
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
30 Make sure that before the call of compress, the length of the compressed
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
31 buffer is equal to the total size of the compressed buffer and not
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
32 zero. For Visual Basic, check that this parameter is passed by reference
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
33 ("as any"), not by value ("as long").
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
34
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
35 5. deflate() or inflate() returns Z_BUF_ERROR
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
36
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
37 Before making the call, make sure that avail_in and avail_out are not
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
38 zero. When setting the parameter flush equal to Z_FINISH, also make sure
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
39 that avail_out is big enough to allow processing all pending input.
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
40 Note that a Z_BUF_ERROR is not fatal--another call to deflate() or
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
41 inflate() can be made with more input or output space. A Z_BUF_ERROR
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
42 may in fact be unavoidable depending on how the functions are used, since
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
43 it is not possible to tell whether or not there is more output pending
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
44 when strm.avail_out returns with zero.
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
45
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
46 6. Where's the zlib documentation (man pages, etc.)?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
47
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
48 It's in zlib.h for the moment, and Francis S. Lin has converted it to a
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
49 web page zlib.html. Volunteers to transform this to Unix-style man pages,
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
50 please contact Jean-loup Gailly (jloup@gzip.org). Examples of zlib usage
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
51 are in the files example.c and minigzip.c.
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
52
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
53 7. Why don't you use GNU autoconf or libtool or ...?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
54
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
55 Because we would like to keep zlib as a very small and simple
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
56 package. zlib is rather portable and doesn't need much configuration.
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
57
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
58 8. I found a bug in zlib.
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
59
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
60 Most of the time, such problems are due to an incorrect usage of
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
61 zlib. Please try to reproduce the problem with a small program and send
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
62 the corresponding source to us at zlib@gzip.org . Do not send
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
63 multi-megabyte data files without prior agreement.
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
64
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
65 9. Why do I get "undefined reference to gzputc"?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
66
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
67 If "make test" produces something like
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
68
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
69 example.o(.text+0x154): undefined reference to `gzputc'
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
70
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
71 check that you don't have old files libz.* in /usr/lib, /usr/local/lib or
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
72 /usr/X11R6/lib. Remove any old versions, then do "make install".
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
73
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
74 10. I need a Delphi interface to zlib.
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
75
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
76 See the contrib/delphi directory in the zlib distribution.
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
77
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
78 11. Can zlib handle .zip archives?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
79
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
80 See the directory contrib/minizip in the zlib distribution.
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
81
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
82 12. Can zlib handle .Z files?
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
83
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
84 No, sorry. You have to spawn an uncompress or gunzip subprocess, or adapt
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
85 the code of uncompress on your own.
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
86
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
87 13. How can I make a Unix shared library?
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
88
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
89 make clean
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
90 ./configure -s
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
91 make
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
92
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
93 14. How do I install a shared zlib library on Unix?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
94
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
95 make install
156
b939e9cada46 Merge from eCos master repository on 2001-03-29-21:44:39-BST
jlarmour
parents:
diff changeset
96
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
97 However, many flavors of Unix come with a shared zlib already installed.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
98 Before going to the trouble of compiling a shared version of zlib and
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
99 trying to install it, you may want to check if it's already there! If you
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
100 can #include <zlib.h>, it's there. The -lz option will probably link to it.
1369
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
101
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
102 15. I have a question about OttoPDF
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
103
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
104 We are not the authors of OttoPDF. The real author is on the OttoPDF web
c92d7972c02c * tests/zlib[12].c: Modified the text to the gcc3.3 friendly.
asl
parents: 156
diff changeset
105 site Joel Hainley jhainley@myndkryme.com.
1651
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
106
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
107 16. Why does gzip give an error on a file I make with compress/deflate?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
108
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
109 The compress and deflate functions produce data in the zlib format, which
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
110 is different and incompatible with the gzip format. The gz* functions in
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
111 zlib on the other hand use the gzip format. Both the zlib and gzip
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
112 formats use the same compressed data format internally, but have different
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
113 headers and trailers around the compressed data.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
114
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
115 17. Ok, so why are there two different formats?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
116
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
117 The gzip format was designed to retain the directory information about
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
118 a single file, such as the name and last modification date. The zlib
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
119 format on the other hand was designed for in-memory and communication
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
120 channel applications, and has a much more compact header and trailer and
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
121 uses a faster integrity check than gzip.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
122
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
123 18. Well that's nice, but how do I make a gzip file in memory?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
124
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
125 You can request that deflate write the gzip format instead of the zlib
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
126 format using deflateInit2(). You can also request that inflate decode
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
127 the gzip format using inflateInit2(). Read zlib.h for more details.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
128
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
129 Note that you cannot specify special gzip header contents (e.g. a file
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
130 name or modification date), nor will inflate tell you what was in the
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
131 gzip header. If you need to customize the header or see what's in it,
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
132 you can use the raw deflate and inflate operations and the crc32()
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
133 function and roll your own gzip encoding and decoding. Read the gzip
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
134 RFC 1952 for details of the header and trailer format.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
135
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
136 19. Is zlib thread-safe?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
137
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
138 Yes. However any library routines that zlib uses and any application-
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
139 provided memory allocation routines must also be thread-safe. zlib's gz*
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
140 functions use stdio library routines, and most of zlib's functions use the
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
141 library memory allocation routines by default. zlib's Init functions allow
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
142 for the application to provide custom memory allocation routines.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
143
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
144 Of course, you should only operate on any given zlib or gzip stream from a
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
145 single thread at a time.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
146
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
147 20. Can I use zlib in my commercial application?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
148
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
149 Yes. Please read the license in zlib.h.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
150
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
151 21. Is zlib under the GNU license?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
152
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
153 No. Please read the license in zlib.h.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
154
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
155 22. The license says that altered source versions must be "plainly marked". So
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
156 what exactly do I need to do to meet that requirement?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
157
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
158 You need to change the ZLIB_VERSION and ZLIB_VERNUM #defines in zlib.h. In
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
159 particular, the final version number needs to be changed to "f", and an
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
160 identification string should be appended to ZLIB_VERSION. Version numbers
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
161 x.x.x.f are reserved for modifications to zlib by others than the zlib
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
162 maintainers. For example, if the version of the base zlib you are altering
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
163 is "1.2.3.4", then in zlib.h you should change ZLIB_VERNUM to 0x123f, and
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
164 ZLIB_VERSION to something like "1.2.3.f-zachary-mods-v3". You can also
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
165 update the version strings in deflate.c and inftrees.c.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
166
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
167 For altered source distributions, you should also note the origin and
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
168 nature of the changes in zlib.h, as well as in ChangeLog and README, along
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
169 with the dates of the alterations. The origin should include at least your
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
170 name (or your company's name), and an email address to contact for help or
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
171 issues with the library.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
172
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
173 Note that distributing a compiled zlib library along with zlib.h and
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
174 zconf.h is also a source distribution, and so you should change
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
175 ZLIB_VERSION and ZLIB_VERNUM and note the origin and nature of the changes
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
176 in zlib.h as you would for a full source distribution.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
177
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
178 23. Will zlib work on a big-endian or little-endian architecture, and can I
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
179 exchange compressed data between them?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
180
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
181 Yes and yes.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
182
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
183 24. Will zlib work on a 64-bit machine?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
184
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
185 It should. It has been tested on 64-bit machines, and has no dependence
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
186 on any data types being limited to 32-bits in length. If you have any
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
187 difficulties, please provide a complete problem report to zlib@gzip.org
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
188
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
189 25. Will zlib decompress data from the PKWare Data Compression Library?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
190
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
191 No. The PKWare DCL uses a completely different compressed data format
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
192 than does PKZIP and zlib. However, you can look in zlib's contrib/blast
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
193 directory for a possible solution to your problem.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
194
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
195 26. Can I access data randomly in a compressed stream?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
196
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
197 No, not without some preparation. If when compressing you periodically
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
198 use Z_FULL_FLUSH, carefully write all the pending data at those points,
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
199 and keep an index of those locations, then you can start decompression
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
200 at those points. You have to be careful to not use Z_FULL_FLUSH too
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
201 often, since it can significantly degrade compression.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
202
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
203 27. Does zlib work on MVS, OS/390, CICS, etc.?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
204
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
205 We don't know for sure. We have heard occasional reports of success on
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
206 these systems. If you do use it on one of these, please provide us with
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
207 a report, instructions, and patches that we can reference when we get
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
208 these questions. Thanks.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
209
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
210 28. Is there some simpler, easier to read version of inflate I can look at
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
211 to understand the deflate format?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
212
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
213 First off, you should read RFC 1951. Second, yes. Look in zlib's
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
214 contrib/puff directory.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
215
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
216 29. Does zlib infringe on any patents?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
217
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
218 As far as we know, no. In fact, that was originally the whole point behind
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
219 zlib. Look here for some more information:
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
220
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
221 http://www.gzip.org/#faq11
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
222
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
223 30. Can zlib work with greater than 4 GB of data?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
224
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
225 Yes. inflate() and deflate() will process any amount of data correctly.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
226 Each call of inflate() or deflate() is limited to input and output chunks
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
227 of the maximum value that can be stored in the compiler's "unsigned int"
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
228 type, but there is no limit to the number of chunks. Note however that the
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
229 strm.total_in and strm_total_out counters may be limited to 4 GB. These
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
230 counters are provided as a convenience and are not used internally by
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
231 inflate() or deflate(). The application can easily set up its own counters
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
232 updated after each call of inflate() or deflate() to count beyond 4 GB.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
233 compress() and uncompress() may be limited to 4 GB, since they operate in a
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
234 single call. gzseek() and gztell() may be limited to 4 GB depending on how
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
235 zlib is compiled. See the zlibCompileFlags() function in zlib.h.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
236
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
237 The word "may" appears several times above since there is a 4 GB limit
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
238 only if the compiler's "long" type is 32 bits. If the compiler's "long"
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
239 type is 64 bits, then the limit is 16 exabytes.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
240
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
241 31. Does zlib have any security vulnerabilities?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
242
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
243 The only one that we are aware of is potentially in gzprintf(). If zlib
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
244 is compiled to use sprintf() or vsprintf(), then there is no protection
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
245 against a buffer overflow of a 4K string space, other than the caller of
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
246 gzprintf() assuring that the output will not exceed 4K. On the other
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
247 hand, if zlib is compiled to use snprintf() or vsnprintf(), which should
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
248 normally be the case, then there is no vulnerability. The ./configure
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
249 script will display warnings if an insecure variation of sprintf() will
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
250 be used by gzprintf(). Also the zlibCompileFlags() function will return
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
251 information on what variant of sprintf() is used by gzprintf().
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
252
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
253 If you don't have snprintf() or vsnprintf() and would like one, you can
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
254 find a portable implementation here:
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
255
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
256 http://www.ijs.si/software/snprintf/
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
257
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
258 Note that you should be using the most recent version of zlib. Versions
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
259 1.1.3 and before were subject to a double-free vulnerability.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
260
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
261 32. Is there a Java version of zlib?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
262
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
263 Probably what you want is to use zlib in Java. zlib is already included
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
264 as part of the Java SDK in the java.util.zip package. If you really want
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
265 a version of zlib written in the Java language, look on the zlib home
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
266 page for links: http://www.zlib.org/
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
267
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
268 33. I get this or that compiler or source-code scanner warning when I crank it
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
269 up to maximally-pendantic. Can't you guys write proper code?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
270
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
271 Many years ago, we gave up attempting to avoid warnings on every compiler
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
272 in the universe. It just got to be a waste of time, and some compilers
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
273 were downright silly. So now, we simply make sure that the code always
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
274 works.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
275
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
276 34. Will zlib read the (insert any ancient or arcane format here) compressed
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
277 data format?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
278
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
279 Probably not. Look in the comp.compression FAQ for pointers to various
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
280 formats and associated software.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
281
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
282 35. How can I encrypt/decrypt zip files with zlib?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
283
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
284 zlib doesn't support encryption. The original PKZIP encryption is very weak
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
285 and can be broken with freely available programs. To get strong encryption,
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
286 use gpg ( http://www.gnupg.org/ ) which already includes zlib compression.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
287 For PKZIP compatible "encryption", look at http://www.info-zip.org/
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
288
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
289 36. What's the difference between the "gzip" and "deflate" HTTP 1.1 encodings?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
290
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
291 "gzip" is the gzip format, and "deflate" is the zlib format. They should
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
292 probably have called the second one "zlib" instead to avoid confusion
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
293 with the raw deflate compressed data format. While the HTTP 1.1 RFC 2616
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
294 correctly points to the zlib specification in RFC 1950 for the "deflate"
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
295 transfer encoding, there have been reports of servers and browsers that
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
296 incorrectly produce or expect raw deflate data per the deflate
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
297 specficiation in RFC 1951, most notably Microsoft. So even though the
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
298 "deflate" transfer encoding using the zlib format would be the more
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
299 efficient approach (and in fact exactly what the zlib format was designed
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
300 for), using the "gzip" transfer encoding is probably more reliable due to
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
301 an unfortunate choice of name on the part of the HTTP 1.1 authors.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
302
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
303 Bottom line: use the gzip format for HTTP 1.1 encoding.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
304
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
305 37. Does zlib support the new "Deflate64" format introduced by PKWare?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
306
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
307 No. PKWare has apparently decided to keep that format proprietary, since
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
308 they have not documented it as they have previous compression formats.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
309 In any case, the compression improvements are so modest compared to other
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
310 more modern approaches, that it's not worth the effort to implement.
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
311
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
312 38. Can you please sign these lengthy legal documents and fax them back to us
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
313 so that we can use your software in our product?
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
314
91a37e2314f4 Upgrade to zlib-1.2.1
gthomas
parents: 1369
diff changeset
315 No. Go away. Shoo.