EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.10 / 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://zlib.net/ which may have more recent information.\r
The lastest zlib FAQ is at http://zlib.net/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.  See the\r
    file win32/DLL_FAQ.txt in the zlib distribution.  Pointers to the\r
    precompiled DLL are found in the zlib web site at http://zlib.net/ .\r
\r
 3. Where can I get a Visual Basic interface to zlib?\r
\r
    See\r
        * http://marknelson.us/1997/01/01/zlib-engine/\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 available 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 zero.\r
    When setting the parameter flush equal to Z_FINISH, also make sure that\r
    avail_out is big enough to allow processing all pending input.  Note that a\r
    Z_BUF_ERROR is not fatal--another call to deflate() or inflate() can be\r
    made with more input or output space.  A Z_BUF_ERROR may in fact be\r
    unavoidable depending on how the functions are used, since it is not\r
    possible to tell whether or not there is more output pending when\r
    strm.avail_out returns with zero.  See http://zlib.net/zlib_how.html for a\r
    heavily annotated example.\r
\r
 6. Where's the zlib documentation (man pages, etc.)?\r
\r
    It's in zlib.h .  Examples of zlib usage are in the files test/example.c\r
    and test/minigzip.c, with more in examples/ .\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 package.\r
    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 zlib.\r
    Please try to reproduce the problem with a small program and send the\r
    corresponding source to us at zlib@gzip.org .  Do not send multi-megabyte\r
    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
    By default a shared (and a static) library is built for Unix.  So:\r
\r
    make distclean\r
    ./configure\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\r
    it.  You can check the version at the top of zlib.h or with the\r
    ZLIB_VERSION symbol defined in zlib.h .\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.pdflib.com/ . To modify PDF forms, see\r
    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 formats\r
    use the same compressed data format internally, but have different headers\r
    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 a\r
    single file, such as the name and last modification date.  The zlib format\r
    on the other hand was designed for in-memory and communication channel\r
    applications, and has a much more compact header and trailer and uses a\r
    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 the\r
    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\r
    allow 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
    Yes.  It has been tested on 64-bit machines, and has no dependence on any\r
    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 than\r
    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 use\r
    Z_FULL_FLUSH, carefully write all the pending data at those points, and\r
    keep an index of those locations, then you can start decompression at those\r
    points.  You have to be careful to not use Z_FULL_FLUSH too often, since it\r
    can significantly degrade compression.  Alternatively, you can scan a\r
    deflate stream once to generate an index, and then use that index for\r
    random access.  See examples/zran.c .\r
\r
29. Does zlib work on MVS, OS/390, CICS, etc.?\r
\r
    It has in the past, but we have not heard of any recent evidence.  There\r
    were working ports of zlib 1.1.4 to MVS, but those links no longer work.\r
    If you know of recent, successful applications of zlib on these operating\r
    systems, please let us know.  Thanks.\r
\r
30. Is there some simpler, easier to read version of inflate I can look at to\r
    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 only\r
    if the compiler's "long" type is 32 bits.  If the compiler's "long" type is\r
    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 is\r
    compiled to use sprintf() or vsprintf(), then there is no protection\r
    against a buffer overflow of an 8K string space (or other value as set by\r
    gzbuffer()), other than the caller of gzprintf() assuring that the output\r
    will not exceed 8K.  On the other hand, if zlib is compiled to use\r
    snprintf() or vsnprintf(), which should normally be the case, then there is\r
    no vulnerability.  The ./configure script will display warnings if an\r
    insecure variation of sprintf() will be used by gzprintf().  Also the\r
    zlibCompileFlags() function will return information on what variant of\r
    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, and versions\r
    1.2.1 and 1.2.2 were subject to an access exception when decompressing\r
    invalid compressed data.\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://zlib.net/ .\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 as well as contradicted each other.  So now, we simply\r
    make sure that the code always 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 deflate\r
    is not affected.  This only started showing up recently since zlib 1.2.x\r
    uses malloc() by default for allocations, whereas earlier versions used\r
    calloc(), which zeros out the allocated memory.  Even though the code was\r
    correct, versions 1.2.4 and later was changed to not stimulate these\r
    checkers.\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\r
    weak and can be broken with freely available programs.  To get strong\r
    encryption, use GnuPG, http://www.gnupg.org/ , which already includes zlib\r
    compression.  For PKZIP compatible "encryption", look at\r
    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 with\r
    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
    specification 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.  In\r
    any case, the compression improvements are so modest compared to other more\r
    modern approaches, that it's not worth the effort to implement.\r
\r
41. I'm having a problem with the zip functions in zlib, can you help?\r
\r
    There are no zip functions in zlib.  You are probably using minizip by\r
    Giles Vollant, which is found in the contrib directory of zlib.  It is not\r
    part of zlib.  In fact none of the stuff in contrib is part of zlib.  The\r
    files in there are not supported by the zlib authors.  You need to contact\r
    the authors of the respective contribution for help.\r
\r
42. The match.asm code in contrib is under the GNU General Public License.\r
    Since it's part of zlib, doesn't that mean that all of zlib falls under the\r
    GNU GPL?\r
\r
    No.  The files in contrib are not part of zlib.  They were contributed by\r
    other authors and are provided as a convenience to the user within the zlib\r
    distribution.  Each item in contrib has its own license.\r
\r
43. Is zlib subject to export controls?  What is its ECCN?\r
\r
    zlib is not subject to export controls, and so is classified as EAR99.\r
\r
44. 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