/* zlibmodule.c -- gzip-compatible data compression */ /* See http://zlib.net/ */ /* Windows users: read Python's PCbuild\readme.txt */ #ifndef Py_BUILD_CORE_BUILTIN #define Py_BUILD_CORE_MODULE … #endif #include "Python.h" #include "zlib.h" #include "stdbool.h" #include <stddef.h> // offsetof() #if defined(ZLIB_VERNUM) && ZLIB_VERNUM < 0x1221 #error "At least zlib version 1.2.2.1 is required" #endif // Blocks output buffer wrappers #include "pycore_blocks_output_buffer.h" #if OUTPUT_BUFFER_MAX_BLOCK_SIZE > UINT32_MAX #error "The maximum block size accepted by zlib is UINT32_MAX." #endif /* On success, return value >= 0 On failure, return -1 */ static inline Py_ssize_t OutputBuffer_InitAndGrow(_BlocksOutputBuffer *buffer, Py_ssize_t max_length, Bytef **next_out, uint32_t *avail_out) { … } /* On success, return value >= 0 On failure, return -1 */ static inline Py_ssize_t OutputBuffer_Grow(_BlocksOutputBuffer *buffer, Bytef **next_out, uint32_t *avail_out) { … } static inline Py_ssize_t OutputBuffer_GetDataSize(_BlocksOutputBuffer *buffer, uint32_t avail_out) { … } static inline PyObject * OutputBuffer_Finish(_BlocksOutputBuffer *buffer, uint32_t avail_out) { … } static inline void OutputBuffer_OnError(_BlocksOutputBuffer *buffer) { … } /* The max buffer size accepted by zlib is UINT32_MAX, the initial buffer size `init_size` may > it in 64-bit build. These wrapper functions maintain an UINT32_MAX sliding window for the first block: 1. OutputBuffer_WindowInitWithSize() 2. OutputBuffer_WindowGrow() 3. OutputBuffer_WindowFinish() 4. OutputBuffer_WindowOnError() ==== is the sliding window: 1. ====------ ^ next_posi, left_bytes is 6 2. ----====-- ^ next_posi, left_bytes is 2 3. --------== ^ next_posi, left_bytes is 0 */ _Uint32Window; /* Initialize the buffer with an initial buffer size. On success, return value >= 0 On failure, return value < 0 */ static inline Py_ssize_t OutputBuffer_WindowInitWithSize(_BlocksOutputBuffer *buffer, _Uint32Window *window, Py_ssize_t init_size, Bytef **next_out, uint32_t *avail_out) { … } /* Grow the buffer. On success, return value >= 0 On failure, return value < 0 */ static inline Py_ssize_t OutputBuffer_WindowGrow(_BlocksOutputBuffer *buffer, _Uint32Window *window, Bytef **next_out, uint32_t *avail_out) { … } /* Finish the buffer. On success, return a bytes object On failure, return NULL */ static inline PyObject * OutputBuffer_WindowFinish(_BlocksOutputBuffer *buffer, _Uint32Window *window, uint32_t avail_out) { … } static inline void OutputBuffer_WindowOnError(_BlocksOutputBuffer *buffer, _Uint32Window *window) { … } #define ENTER_ZLIB(obj) … #define LEAVE_ZLIB(obj) … /* The following parameters are copied from zutil.h, version 0.95 */ #define DEFLATED … #if MAX_MEM_LEVEL >= 8 #define DEF_MEM_LEVEL … #else #define DEF_MEM_LEVEL … #endif /* Initial buffer size. */ #define DEF_BUF_SIZE … #define DEF_MAX_INITIAL_BUF_SIZE … static PyModuleDef zlibmodule; zlibstate; static inline zlibstate* get_zlib_state(PyObject *module) { … } compobject; static void zlib_error(zlibstate *state, z_stream zst, int err, const char *msg) { … } /*[clinic input] module zlib class zlib.Compress "compobject *" "&Comptype" class zlib.Decompress "compobject *" "&Decomptype" [clinic start generated code]*/ /*[clinic end generated code: output=da39a3ee5e6b4b0d input=093935115c3e3158]*/ static compobject * newcompobject(PyTypeObject *type) { … } static void* PyZlib_Malloc(voidpf ctx, uInt items, uInt size) { … } static void PyZlib_Free(voidpf ctx, void *ptr) { … } static void arrange_input_buffer(z_stream *zst, Py_ssize_t *remains) { … } /*[clinic input] zlib.compress data: Py_buffer Binary data to be compressed. / level: int(c_default="Z_DEFAULT_COMPRESSION") = Z_DEFAULT_COMPRESSION Compression level, in 0-9 or -1. wbits: int(c_default="MAX_WBITS") = MAX_WBITS The window buffer size and container format. Returns a bytes object containing compressed data. [clinic start generated code]*/ static PyObject * zlib_compress_impl(PyObject *module, Py_buffer *data, int level, int wbits) /*[clinic end generated code: output=46bd152fadd66df2 input=c4d06ee5782a7e3f]*/ { … } /*[clinic input] zlib.decompress data: Py_buffer Compressed data. / wbits: int(c_default="MAX_WBITS") = MAX_WBITS The window buffer size and container format. bufsize: Py_ssize_t(c_default="DEF_BUF_SIZE") = DEF_BUF_SIZE The initial output buffer size. Returns a bytes object containing the uncompressed data. [clinic start generated code]*/ static PyObject * zlib_decompress_impl(PyObject *module, Py_buffer *data, int wbits, Py_ssize_t bufsize) /*[clinic end generated code: output=77c7e35111dc8c42 input=a9ac17beff1f893f]*/ { … } /*[clinic input] zlib.compressobj level: int(c_default="Z_DEFAULT_COMPRESSION") = Z_DEFAULT_COMPRESSION The compression level (an integer in the range 0-9 or -1; default is currently equivalent to 6). Higher compression levels are slower, but produce smaller results. method: int(c_default="DEFLATED") = DEFLATED The compression algorithm. If given, this must be DEFLATED. wbits: int(c_default="MAX_WBITS") = MAX_WBITS +9 to +15: The base-two logarithm of the window size. Include a zlib container. -9 to -15: Generate a raw stream. +25 to +31: Include a gzip container. memLevel: int(c_default="DEF_MEM_LEVEL") = DEF_MEM_LEVEL Controls the amount of memory used for internal compression state. Valid values range from 1 to 9. Higher values result in higher memory usage, faster compression, and smaller output. strategy: int(c_default="Z_DEFAULT_STRATEGY") = Z_DEFAULT_STRATEGY Used to tune the compression algorithm. Possible values are Z_DEFAULT_STRATEGY, Z_FILTERED, and Z_HUFFMAN_ONLY. zdict: Py_buffer = None The predefined compression dictionary - a sequence of bytes containing subsequences that are likely to occur in the input data. Return a compressor object. [clinic start generated code]*/ static PyObject * zlib_compressobj_impl(PyObject *module, int level, int method, int wbits, int memLevel, int strategy, Py_buffer *zdict) /*[clinic end generated code: output=8b5bed9c8fc3814d input=2fa3d026f90ab8d5]*/ { … } static int set_inflate_zdict(zlibstate *state, compobject *self) { … } /*[clinic input] zlib.decompressobj wbits: int(c_default="MAX_WBITS") = MAX_WBITS The window buffer size and container format. zdict: object(c_default="NULL") = b'' The predefined compression dictionary. This must be the same dictionary as used by the compressor that produced the input data. Return a decompressor object. [clinic start generated code]*/ static PyObject * zlib_decompressobj_impl(PyObject *module, int wbits, PyObject *zdict) /*[clinic end generated code: output=3069b99994f36906 input=d3832b8511fc977b]*/ { … } static void Dealloc(compobject *self) { … } static void Comp_dealloc(compobject *self) { … } static void Decomp_dealloc(compobject *self) { … } /*[clinic input] zlib.Compress.compress cls: defining_class data: Py_buffer Binary data to be compressed. / Returns a bytes object containing compressed data. After calling this function, some of the input data may still be stored in internal buffers for later processing. Call the flush() method to clear these buffers. [clinic start generated code]*/ static PyObject * zlib_Compress_compress_impl(compobject *self, PyTypeObject *cls, Py_buffer *data) /*[clinic end generated code: output=6731b3f0ff357ca6 input=04d00f65ab01d260]*/ { … } /* Helper for objdecompress() and flush(). Saves any unconsumed input data in self->unused_data or self->unconsumed_tail, as appropriate. */ static int save_unconsumed_input(compobject *self, Py_buffer *data, int err) { … } /*[clinic input] zlib.Decompress.decompress cls: defining_class data: Py_buffer The binary data to decompress. / max_length: Py_ssize_t = 0 The maximum allowable length of the decompressed data. Unconsumed input data will be stored in the unconsumed_tail attribute. Return a bytes object containing the decompressed version of the data. After calling this function, some of the input data may still be stored in internal buffers for later processing. Call the flush() method to clear these buffers. [clinic start generated code]*/ static PyObject * zlib_Decompress_decompress_impl(compobject *self, PyTypeObject *cls, Py_buffer *data, Py_ssize_t max_length) /*[clinic end generated code: output=b024a93c2c922d57 input=bfb37b3864cfb606]*/ { … } /*[clinic input] zlib.Compress.flush cls: defining_class mode: int(c_default="Z_FINISH") = zlib.Z_FINISH One of the constants Z_SYNC_FLUSH, Z_FULL_FLUSH, Z_FINISH. If mode == Z_FINISH, the compressor object can no longer be used after calling the flush() method. Otherwise, more data can still be compressed. / Return a bytes object containing any remaining compressed data. [clinic start generated code]*/ static PyObject * zlib_Compress_flush_impl(compobject *self, PyTypeObject *cls, int mode) /*[clinic end generated code: output=c7efd13efd62add2 input=286146e29442eb6c]*/ { … } #ifdef HAVE_ZLIB_COPY /*[clinic input] zlib.Compress.copy cls: defining_class Return a copy of the compression object. [clinic start generated code]*/ static PyObject * zlib_Compress_copy_impl(compobject *self, PyTypeObject *cls) /*[clinic end generated code: output=c4d2cfb4b0d7350b input=235497e482d40986]*/ { … } /*[clinic input] zlib.Compress.__copy__ cls: defining_class [clinic start generated code]*/ static PyObject * zlib_Compress___copy___impl(compobject *self, PyTypeObject *cls) /*[clinic end generated code: output=074613db332cb668 input=5c0188367ab0fe64]*/ { … } /*[clinic input] zlib.Compress.__deepcopy__ cls: defining_class memo: object / [clinic start generated code]*/ static PyObject * zlib_Compress___deepcopy___impl(compobject *self, PyTypeObject *cls, PyObject *memo) /*[clinic end generated code: output=24b3aed785f54033 input=c90347319a514430]*/ { … } /*[clinic input] zlib.Decompress.copy cls: defining_class Return a copy of the decompression object. [clinic start generated code]*/ static PyObject * zlib_Decompress_copy_impl(compobject *self, PyTypeObject *cls) /*[clinic end generated code: output=a7ddc016e1d0a781 input=20ef3aa208282ff2]*/ { … } /*[clinic input] zlib.Decompress.__copy__ cls: defining_class [clinic start generated code]*/ static PyObject * zlib_Decompress___copy___impl(compobject *self, PyTypeObject *cls) /*[clinic end generated code: output=cf1e6473744f53fa input=cc3143067b622bdf]*/ { … } /*[clinic input] zlib.Decompress.__deepcopy__ cls: defining_class memo: object / [clinic start generated code]*/ static PyObject * zlib_Decompress___deepcopy___impl(compobject *self, PyTypeObject *cls, PyObject *memo) /*[clinic end generated code: output=34f7b719a0c0d51b input=fc13b9c58622544e]*/ { … } #endif /*[clinic input] zlib.Decompress.flush cls: defining_class length: Py_ssize_t(c_default="DEF_BUF_SIZE") = zlib.DEF_BUF_SIZE the initial size of the output buffer. / Return a bytes object containing any remaining decompressed data. [clinic start generated code]*/ static PyObject * zlib_Decompress_flush_impl(compobject *self, PyTypeObject *cls, Py_ssize_t length) /*[clinic end generated code: output=4532fc280bd0f8f2 input=42f1f4b75230e2cd]*/ { … } ZlibDecompressor; /*[clinic input] class zlib.ZlibDecompressor "ZlibDecompressor *" "&ZlibDecompressorType" [clinic start generated code]*/ /*[clinic end generated code: output=da39a3ee5e6b4b0d input=0658178ab94645df]*/ static void ZlibDecompressor_dealloc(ZlibDecompressor *self) { … } static int set_inflate_zdict_ZlibDecompressor(zlibstate *state, ZlibDecompressor *self) { … } static Py_ssize_t arrange_output_buffer_with_maximum(uint32_t *avail_out, uint8_t **next_out, PyObject **buffer, Py_ssize_t length, Py_ssize_t max_length) { … } /* Decompress data of length self->avail_in_real in self->state.next_in. The output buffer is allocated dynamically and returned. If the max_length is of sufficiently low size, max_length is allocated immediately. At most max_length bytes are returned, so some of the input may not be consumed. self->state.next_in and self->avail_in_real are updated to reflect the consumed input. */ static PyObject* decompress_buf(ZlibDecompressor *self, Py_ssize_t max_length) { … } static PyObject * decompress(ZlibDecompressor *self, uint8_t *data, size_t len, Py_ssize_t max_length) { … } /*[clinic input] zlib.ZlibDecompressor.decompress data: Py_buffer max_length: Py_ssize_t=-1 Decompress *data*, returning uncompressed data as bytes. If *max_length* is nonnegative, returns at most *max_length* bytes of decompressed data. If this limit is reached and further output can be produced, *self.needs_input* will be set to ``False``. In this case, the next call to *decompress()* may provide *data* as b'' to obtain more of the output. If all of the input data was decompressed and returned (either because this was less than *max_length* bytes, or because *max_length* was negative), *self.needs_input* will be set to True. Attempting to decompress data after the end of stream is reached raises an EOFError. Any data found after the end of the stream is ignored and saved in the unused_data attribute. [clinic start generated code]*/ static PyObject * zlib_ZlibDecompressor_decompress_impl(ZlibDecompressor *self, Py_buffer *data, Py_ssize_t max_length) /*[clinic end generated code: output=990d32787b775f85 input=0b29d99715250b96]*/ { … } PyDoc_STRVAR(ZlibDecompressor__new____doc__, "_ZlibDecompressor(wbits=15, zdict=b\'\')\n" "--\n" "\n" "Create a decompressor object for decompressing data incrementally.\n" "\n" " wbits = 15\n" " zdict\n" " The predefined compression dictionary. This is a sequence of bytes\n" " (such as a bytes object) containing subsequences that are expected\n" " to occur frequently in the data that is to be compressed. Those\n" " subsequences that are expected to be most common should come at the\n" " end of the dictionary. This must be the same dictionary as used by the\n" " compressor that produced the input data.\n" "\n"); static PyObject * ZlibDecompressor__new__(PyTypeObject *cls, PyObject *args, PyObject *kwargs) { … } #include "clinic/zlibmodule.c.h" static PyMethodDef comp_methods[] = …; static PyMethodDef Decomp_methods[] = …; static PyMethodDef ZlibDecompressor_methods[] = …; #define COMP_OFF(x) … static PyMemberDef Decomp_members[] = …; PyDoc_STRVAR(ZlibDecompressor_eof__doc__, "True if the end-of-stream marker has been reached."); PyDoc_STRVAR(ZlibDecompressor_unused_data__doc__, "Data found after the end of the compressed stream."); PyDoc_STRVAR(ZlibDecompressor_needs_input_doc, "True if more input is needed before more decompressed data can be produced."); static PyMemberDef ZlibDecompressor_members[] = …; /*[clinic input] zlib.adler32 data: Py_buffer value: unsigned_int(bitwise=True) = 1 Starting value of the checksum. / Compute an Adler-32 checksum of data. The returned checksum is an integer. [clinic start generated code]*/ static PyObject * zlib_adler32_impl(PyObject *module, Py_buffer *data, unsigned int value) /*[clinic end generated code: output=422106f5ca8c92c0 input=6ff4557872160e88]*/ { … } /*[clinic input] zlib.crc32 -> unsigned_int data: Py_buffer value: unsigned_int(bitwise=True) = 0 Starting value of the checksum. / Compute a CRC-32 checksum of data. The returned checksum is an integer. [clinic start generated code]*/ static unsigned int zlib_crc32_impl(PyObject *module, Py_buffer *data, unsigned int value) /*[clinic end generated code: output=b217562e4fe6d6a6 input=1229cb2fb5ea948a]*/ { … } static PyMethodDef zlib_methods[] = …; static PyType_Slot Comptype_slots[] = …; static PyType_Spec Comptype_spec = …; static PyType_Slot Decomptype_slots[] = …; static PyType_Spec Decomptype_spec = …; static PyType_Slot ZlibDecompressor_type_slots[] = …; static PyType_Spec ZlibDecompressor_type_spec = …; PyDoc_STRVAR(zlib_module_documentation, "The functions in this module allow compression and decompression using the\n" "zlib library, which is based on GNU zip.\n" "\n" "adler32(string[, start]) -- Compute an Adler-32 checksum.\n" "compress(data[, level]) -- Compress data, with compression level 0-9 or -1.\n" "compressobj([level[, ...]]) -- Return a compressor object.\n" "crc32(string[, start]) -- Compute a CRC-32 checksum.\n" "decompress(string,[wbits],[bufsize]) -- Decompresses a compressed string.\n" "decompressobj([wbits[, zdict]]) -- Return a decompressor object.\n" "\n" "'wbits' is window buffer size and container format.\n" "Compressor objects support compress() and flush() methods; decompressor\n" "objects support decompress() and flush()."); static int zlib_clear(PyObject *mod) { … } static int zlib_traverse(PyObject *mod, visitproc visit, void *arg) { … } static void zlib_free(void *mod) { … } static int zlib_exec(PyObject *mod) { … } static PyModuleDef_Slot zlib_slots[] = …; static struct PyModuleDef zlibmodule = …; PyMODINIT_FUNC PyInit_zlib(void) { … }
Codebase Browser
cpython