Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
igbinary ======== Igbinary is a drop in replacement for the standard php serializer. Instead of time and space consuming textual representation, igbinary stores php data structures in a compact binary form. Savings are significant when using memcached or similar memory based storages for serialized data. You can expect about 50% reduction in storage requirement and speed is at least on par with the standard PHP serializer. Specific numbers depend on your data, of course. But where does the name "igbinary" come from? There was once a similar project called fbinary but it has disappeared from the Internet a long time ago. Its architecture wasn't particularly clean either. IG is an abbreviation for a finnish social networking site IRC-Galleria (http://irc-galleria.net/) Features -------- - Supports same data types as the standard PHP serializer: null, bool, int, float, string, array and objects. - ``__autoload`` & ``unserialize_callback_func`` - ``__sleep`` & ``__wakeup`` - Serializable -interface - Data portability between platforms (32/64bit, endianess) - Tested on Linux amd64, Mac OSX x86, HP-UX PA-RISC and NetBSD sparc64 - Compatible with PHP5 (tested with 5.2.4 and 5.2.5) Implementation details ---------------------- Storing complex PHP data structures like arrays of associative arrays with the standard PHP serializer is not very space efficient. The main reasons in order of significance are (at least in our applications): 1. Array keys are repeated redundantly. 2. Numerical values are plain text. 3. Human readability adds some overhead. Igbinary uses two specific strategies to minimize the size of the serialized output. 1. Strings are stored only once by using a hash table. Arrays of associate arrays with very verbose keys are stored very compactly. 2. Numerical values are stored in the smallest primitive data type available: *123* = ``int8_t``, *1234* = ``int16_t``, *123456* = ``int32_t`` ... and so on. 3. Well, it is not human readable ;) How to use ---------- Add the following lines to your php.ini: # Load igbinary extension extension=igbinary.so # Use igbinary as session serializer session.serialize_handler=igbinary .. and in your php code replace serialize and unserialize function calls with ``igbinary_serialize`` and ``igbinary_unserialize``. Installing ---------- Note: Sometimes you may have to substitute phpize with phpize5. In such cases you probably should add "--with-php-config=.../php-config5" as an option to configure script. Compiling: 1. phpize If you use GCC: 2. ./configure CFLAGS="-O2 -g" --enable-igbinary If you use ICC (Intel C Compiler) 2. ./configure CFLAGS=" -no-prec-div -O3 -xO -unroll2 -g" CC=icc --enable-igbinary 3. make 4. ( make test) 5. make install 6. igbinary.so is installed in the default extensions directory Bugs & Contributions -------------------- To report bugs or to contribute fixes and improvements send email to firstname.lastname@example.org You can also fork at GitHub: http://github.com/dynamoid/igbinary Utilizing in other extensions ----------------------------- You can call igbinary from other extensions fairly easily. Igbinary installs its header file to ext/igbinary/igbinary.h. There are just two straighforward functions: igbinary_serialize and igbinary_unserialize. Look at igbinary.h for prototypes and usage. Add PHP_ADD_EXTENSION_DEP(yourextension, igbinary) to your config.m4 in case someone wants to compile both of them statically into php.