EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Modules / zlib / FAQ

\r
                Frequently Asked Questions about zlib\r
\r
\r
If your question is not there, please check the zlib home page\r
http://www.zlib.org which may have more recent information.\r
The lastest zlib FAQ is at http://www.gzip.org/zlib/zlib_faq.html\r
\r
\r
 1. Is zlib Y2K-compliant?\r
\r
    Yes. zlib doesn't handle dates.\r
\r
 2. Where can I get a Windows DLL version?\r
\r
    The zlib sources can be compiled without change to produce a DLL.\r
    See the file win32/DLL_FAQ.txt in the zlib distribution.\r
    Pointers to the precompiled DLL are found in the zlib web site at\r
    http://www.zlib.org.\r
\r
 3. Where can I get a Visual Basic interface to zlib?\r
\r
    See\r
        * http://www.dogma.net/markn/articles/zlibtool/zlibtool.htm\r
        * contrib/visual-basic.txt in the zlib distribution\r
        * win32/DLL_FAQ.txt in the zlib distribution\r
\r
 4. compress() returns Z_BUF_ERROR.\r
\r
    Make sure that before the call of compress, the length of the compressed\r
    buffer is equal to the total size of the compressed buffer and not\r
    zero. For Visual Basic, check that this parameter is passed by reference\r
    ("as any"), not by value ("as long").\r
\r
 5. deflate() or inflate() returns Z_BUF_ERROR.\r
\r
    Before making the call, make sure that avail_in and avail_out are not\r
    zero. When setting the parameter flush equal to Z_FINISH, also make sure\r
    that avail_out is big enough to allow processing all pending input.\r
    Note that a Z_BUF_ERROR is not fatal--another call to deflate() or\r
    inflate() can be made with more input or output space. A Z_BUF_ERROR\r
    may in fact be unavoidable depending on how the functions are used, since\r
    it is not possible to tell whether or not there is more output pending\r
    when strm.avail_out returns with zero.\r
\r
 6. Where's the zlib documentation (man pages, etc.)?\r
\r
    It's in zlib.h for the moment, and Francis S. Lin has converted it to a\r
    web page zlib.html. Volunteers to transform this to Unix-style man pages,\r
    please contact us (zlib@gzip.org). Examples of zlib usage are in the files\r
    example.c and minigzip.c.\r
\r
 7. Why don't you use GNU autoconf or libtool or ...?\r
\r
    Because we would like to keep zlib as a very small and simple\r
    package. zlib is rather portable and doesn't need much configuration.\r
\r
 8. I found a bug in zlib.\r
\r
    Most of the time, such problems are due to an incorrect usage of\r
    zlib. Please try to reproduce the problem with a small program and send\r
    the corresponding source to us at zlib@gzip.org . Do not send\r
    multi-megabyte data files without prior agreement.\r
\r
 9. Why do I get "undefined reference to gzputc"?\r
\r
    If "make test" produces something like\r
\r
       example.o(.text+0x154): undefined reference to `gzputc'\r
\r
    check that you don't have old files libz.* in /usr/lib, /usr/local/lib or\r
    /usr/X11R6/lib. Remove any old versions, then do "make install".\r
\r
10. I need a Delphi interface to zlib.\r
\r
    See the contrib/delphi directory in the zlib distribution.\r
\r
11. Can zlib handle .zip archives?\r
\r
    Not by itself, no.  See the directory contrib/minizip in the zlib\r
    distribution.\r
\r
12. Can zlib handle .Z files?\r
\r
    No, sorry. You have to spawn an uncompress or gunzip subprocess, or adapt\r
    the code of uncompress on your own.\r
\r
13. How can I make a Unix shared library?\r
\r
    make clean\r
    ./configure -s\r
    make\r
\r
14. How do I install a shared zlib library on Unix?\r
\r
    After the above, then:\r
\r
    make install\r
\r
    However, many flavors of Unix come with a shared zlib already installed.\r
    Before going to the trouble of compiling a shared version of zlib and\r
    trying to install it, you may want to check if it's already there! If you\r
    can #include <zlib.h>, it's there. The -lz option will probably link to it.\r
\r
15. I have a question about OttoPDF.\r
\r
    We are not the authors of OttoPDF. The real author is on the OttoPDF web\r
    site: Joel Hainley, jhainley@myndkryme.com.\r
\r
16. Can zlib decode Flate data in an Adobe PDF file?\r
\r
    Yes. See http://www.fastio.com/ (ClibPDF), or http://www.pdflib.com/ .\r
    To modify PDF forms, see http://sourceforge.net/projects/acroformtool/ .\r
\r
17. Why am I getting this "register_frame_info not found" error on Solaris?\r
\r
    After installing zlib 1.1.4 on Solaris 2.6, running applications using zlib\r
    generates an error such as:\r
\r
        ld.so.1: rpm: fatal: relocation error: file /usr/local/lib/libz.so:\r
        symbol __register_frame_info: referenced symbol not found\r
\r
    The symbol __register_frame_info is not part of zlib, it is generated by\r
    the C compiler (cc or gcc). You must recompile applications using zlib\r
    which have this problem. This problem is specific to Solaris. See\r
    http://www.sunfreeware.com for Solaris versions of zlib and applications\r
    using zlib.\r
\r
18. Why does gzip give an error on a file I make with compress/deflate?\r
\r
    The compress and deflate functions produce data in the zlib format, which\r
    is different and incompatible with the gzip format. The gz* functions in\r
    zlib on the other hand use the gzip format. Both the zlib and gzip\r
    formats use the same compressed data format internally, but have different\r
    headers and trailers around the compressed data.\r
\r
19. Ok, so why are there two different formats?\r
\r
    The gzip format was designed to retain the directory information about\r
    a single file, such as the name and last modification date. The zlib\r
    format on the other hand was designed for in-memory and communication\r
    channel applications, and has a much more compact header and trailer and\r
    uses a faster integrity check than gzip.\r
\r
20. Well that's nice, but how do I make a gzip file in memory?\r
\r
    You can request that deflate write the gzip format instead of the zlib\r
    format using deflateInit2(). You can also request that inflate decode\r
    the gzip format using inflateInit2(). Read zlib.h for more details.\r
\r
21. Is zlib thread-safe?\r
\r
    Yes. However any library routines that zlib uses and any application-\r
    provided memory allocation routines must also be thread-safe. zlib's gz*\r
    functions use stdio library routines, and most of zlib's functions use the\r
    library memory allocation routines by default. zlib's Init functions allow\r
    for the application to provide custom memory allocation routines.\r
\r
    Of course, you should only operate on any given zlib or gzip stream from a\r
    single thread at a time.\r
\r
22. Can I use zlib in my commercial application?\r
\r
    Yes. Please read the license in zlib.h.\r
\r
23. Is zlib under the GNU license?\r
\r
    No. Please read the license in zlib.h.\r
\r
24. The license says that altered source versions must be "plainly marked". So\r
    what exactly do I need to do to meet that requirement?\r
\r
    You need to change the ZLIB_VERSION and ZLIB_VERNUM #defines in zlib.h. In\r
    particular, the final version number needs to be changed to "f", and an\r
    identification string should be appended to ZLIB_VERSION. Version numbers\r
    x.x.x.f are reserved for modifications to zlib by others than the zlib\r
    maintainers. For example, if the version of the base zlib you are altering\r
    is "1.2.3.4", then in zlib.h you should change ZLIB_VERNUM to 0x123f, and\r
    ZLIB_VERSION to something like "1.2.3.f-zachary-mods-v3". You can also\r
    update the version strings in deflate.c and inftrees.c.\r
\r
    For altered source distributions, you should also note the origin and\r
    nature of the changes in zlib.h, as well as in ChangeLog and README, along\r
    with the dates of the alterations. The origin should include at least your\r
    name (or your company's name), and an email address to contact for help or\r
    issues with the library.\r
\r
    Note that distributing a compiled zlib library along with zlib.h and\r
    zconf.h is also a source distribution, and so you should change\r
    ZLIB_VERSION and ZLIB_VERNUM and note the origin and nature of the changes\r
    in zlib.h as you would for a full source distribution.\r
\r
25. Will zlib work on a big-endian or little-endian architecture, and can I\r
    exchange compressed data between them?\r
\r
    Yes and yes.\r
\r
26. Will zlib work on a 64-bit machine?\r
\r
    It should. It has been tested on 64-bit machines, and has no dependence\r
    on any data types being limited to 32-bits in length. If you have any\r
    difficulties, please provide a complete problem report to zlib@gzip.org\r
\r
27. Will zlib decompress data from the PKWare Data Compression Library?\r
\r
    No. The PKWare DCL uses a completely different compressed data format\r
    than does PKZIP and zlib. However, you can look in zlib's contrib/blast\r
    directory for a possible solution to your problem.\r
\r
28. Can I access data randomly in a compressed stream?\r
\r
    No, not without some preparation. If when compressing you periodically\r
    use Z_FULL_FLUSH, carefully write all the pending data at those points,\r
    and keep an index of those locations, then you can start decompression\r
    at those points. You have to be careful to not use Z_FULL_FLUSH too\r
    often, since it can significantly degrade compression.\r
\r
29. Does zlib work on MVS, OS/390, CICS, etc.?\r
\r
    We don't know for sure. We have heard occasional reports of success on\r
    these systems. If you do use it on one of these, please provide us with\r
    a report, instructions, and patches that we can reference when we get\r
    these questions. Thanks.\r
\r
30. Is there some simpler, easier to read version of inflate I can look at\r
    to understand the deflate format?\r
\r
    First off, you should read RFC 1951. Second, yes. Look in zlib's\r
    contrib/puff directory.\r
\r
31. Does zlib infringe on any patents?\r
\r
    As far as we know, no. In fact, that was originally the whole point behind\r
    zlib. Look here for some more information:\r
\r
    http://www.gzip.org/#faq11\r
\r
32. Can zlib work with greater than 4 GB of data?\r
\r
    Yes. inflate() and deflate() will process any amount of data correctly.\r
    Each call of inflate() or deflate() is limited to input and output chunks\r
    of the maximum value that can be stored in the compiler's "unsigned int"\r
    type, but there is no limit to the number of chunks. Note however that the\r
    strm.total_in and strm_total_out counters may be limited to 4 GB. These\r
    counters are provided as a convenience and are not used internally by\r
    inflate() or deflate(). The application can easily set up its own counters\r
    updated after each call of inflate() or deflate() to count beyond 4 GB.\r
    compress() and uncompress() may be limited to 4 GB, since they operate in a\r
    single call. gzseek() and gztell() may be limited to 4 GB depending on how\r
    zlib is compiled. See the zlibCompileFlags() function in zlib.h.\r
\r
    The word "may" appears several times above since there is a 4 GB limit\r
    only if the compiler's "long" type is 32 bits. If the compiler's "long"\r
    type is 64 bits, then the limit is 16 exabytes.\r
\r
33. Does zlib have any security vulnerabilities?\r
\r
    The only one that we are aware of is potentially in gzprintf(). If zlib\r
    is compiled to use sprintf() or vsprintf(), then there is no protection\r
    against a buffer overflow of a 4K string space, other than the caller of\r
    gzprintf() assuring that the output will not exceed 4K. On the other\r
    hand, if zlib is compiled to use snprintf() or vsnprintf(), which should\r
    normally be the case, then there is no vulnerability. The ./configure\r
    script will display warnings if an insecure variation of sprintf() will\r
    be used by gzprintf(). Also the zlibCompileFlags() function will return\r
    information on what variant of sprintf() is used by gzprintf().\r
\r
    If you don't have snprintf() or vsnprintf() and would like one, you can\r
    find a portable implementation here:\r
\r
        http://www.ijs.si/software/snprintf/\r
\r
    Note that you should be using the most recent version of zlib. Versions\r
    1.1.3 and before were subject to a double-free vulnerability.\r
\r
34. Is there a Java version of zlib?\r
\r
    Probably what you want is to use zlib in Java. zlib is already included\r
    as part of the Java SDK in the java.util.zip package. If you really want\r
    a version of zlib written in the Java language, look on the zlib home\r
    page for links: http://www.zlib.org/\r
\r
35. I get this or that compiler or source-code scanner warning when I crank it\r
    up to maximally-pedantic. Can't you guys write proper code?\r
\r
    Many years ago, we gave up attempting to avoid warnings on every compiler\r
    in the universe. It just got to be a waste of time, and some compilers\r
    were downright silly. So now, we simply make sure that the code always\r
    works.\r
\r
36. Valgrind (or some similar memory access checker) says that deflate is\r
    performing a conditional jump that depends on an uninitialized value.\r
    Isn't that a bug?\r
\r
    No.  That is intentional for performance reasons, and the output of\r
    deflate is not affected.  This only started showing up recently since\r
    zlib 1.2.x uses malloc() by default for allocations, whereas earlier\r
    versions used calloc(), which zeros out the allocated memory.\r
\r
37. Will zlib read the (insert any ancient or arcane format here) compressed\r
    data format?\r
\r
    Probably not. Look in the comp.compression FAQ for pointers to various\r
    formats and associated software.\r
\r
38. How can I encrypt/decrypt zip files with zlib?\r
\r
    zlib doesn't support encryption. The original PKZIP encryption is very weak\r
    and can be broken with freely available programs. To get strong encryption,\r
    use GnuPG, http://www.gnupg.org/ , which already includes zlib compression.\r
    For PKZIP compatible "encryption", look at http://www.info-zip.org/\r
\r
39. What's the difference between the "gzip" and "deflate" HTTP 1.1 encodings?\r
\r
    "gzip" is the gzip format, and "deflate" is the zlib format. They should\r
    probably have called the second one "zlib" instead to avoid confusion\r
    with the raw deflate compressed data format. While the HTTP 1.1 RFC 2616\r
    correctly points to the zlib specification in RFC 1950 for the "deflate"\r
    transfer encoding, there have been reports of servers and browsers that\r
    incorrectly produce or expect raw deflate data per the deflate\r
    specficiation in RFC 1951, most notably Microsoft. So even though the\r
    "deflate" transfer encoding using the zlib format would be the more\r
    efficient approach (and in fact exactly what the zlib format was designed\r
    for), using the "gzip" transfer encoding is probably more reliable due to\r
    an unfortunate choice of name on the part of the HTTP 1.1 authors.\r
\r
    Bottom line: use the gzip format for HTTP 1.1 encoding.\r
\r
40. Does zlib support the new "Deflate64" format introduced by PKWare?\r
\r
    No. PKWare has apparently decided to keep that format proprietary, since\r
    they have not documented it as they have previous compression formats.\r
    In any case, the compression improvements are so modest compared to other\r
    more modern approaches, that it's not worth the effort to implement.\r
\r
41. Can you please sign these lengthy legal documents and fax them back to us\r
    so that we can use your software in our product?\r
\r
    No. Go away. Shoo.\r