zstd_v03.c 121 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389
  1. /* ******************************************************************
  2. Error codes and messages
  3. Copyright (C) 2013-2015, Yann Collet
  4. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  5. Redistribution and use in source and binary forms, with or without
  6. modification, are permitted provided that the following conditions are
  7. met:
  8. * Redistributions of source code must retain the above copyright
  9. notice, this list of conditions and the following disclaimer.
  10. * Redistributions in binary form must reproduce the above
  11. copyright notice, this list of conditions and the following disclaimer
  12. in the documentation and/or other materials provided with the
  13. distribution.
  14. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. You can contact the author at :
  26. - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  27. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  28. ****************************************************************** */
  29. #ifndef ERROR_H_MODULE
  30. #define ERROR_H_MODULE
  31. #if defined (__cplusplus)
  32. extern "C" {
  33. #endif
  34. #include <stddef.h> /* size_t, ptrdiff_t */
  35. #include "zstd_v03.h"
  36. /******************************************
  37. * Compiler-specific
  38. ******************************************/
  39. #if defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
  40. # define ERR_STATIC static inline
  41. #elif defined(_MSC_VER)
  42. # define ERR_STATIC static __inline
  43. #elif defined(__GNUC__)
  44. # define ERR_STATIC static __attribute__((unused))
  45. #else
  46. # define ERR_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */
  47. #endif
  48. /******************************************
  49. * Error Management
  50. ******************************************/
  51. #define PREFIX(name) ZSTD_error_##name
  52. #define ERROR(name) (size_t)-PREFIX(name)
  53. #define ERROR_LIST(ITEM) \
  54. ITEM(PREFIX(No_Error)) ITEM(PREFIX(GENERIC)) \
  55. ITEM(PREFIX(memory_allocation)) \
  56. ITEM(PREFIX(dstSize_tooSmall)) ITEM(PREFIX(srcSize_wrong)) \
  57. ITEM(PREFIX(prefix_unknown)) ITEM(PREFIX(corruption_detected)) \
  58. ITEM(PREFIX(tableLog_tooLarge)) ITEM(PREFIX(maxSymbolValue_tooLarge)) ITEM(PREFIX(maxSymbolValue_tooSmall)) \
  59. ITEM(PREFIX(maxCode))
  60. #define ERROR_GENERATE_ENUM(ENUM) ENUM,
  61. typedef enum { ERROR_LIST(ERROR_GENERATE_ENUM) } ERR_codes; /* enum is exposed, to detect & handle specific errors; compare function result to -enum value */
  62. #define ERROR_CONVERTTOSTRING(STRING) #STRING,
  63. #define ERROR_GENERATE_STRING(EXPR) ERROR_CONVERTTOSTRING(EXPR)
  64. ERR_STATIC unsigned ERR_isError(size_t code) { return (code > ERROR(maxCode)); }
  65. #if defined (__cplusplus)
  66. }
  67. #endif
  68. #endif /* ERROR_H_MODULE */
  69. /* ******************************************************************
  70. mem.h
  71. low-level memory access routines
  72. Copyright (C) 2013-2015, Yann Collet.
  73. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  74. Redistribution and use in source and binary forms, with or without
  75. modification, are permitted provided that the following conditions are
  76. met:
  77. * Redistributions of source code must retain the above copyright
  78. notice, this list of conditions and the following disclaimer.
  79. * Redistributions in binary form must reproduce the above
  80. copyright notice, this list of conditions and the following disclaimer
  81. in the documentation and/or other materials provided with the
  82. distribution.
  83. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  84. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  85. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  86. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  87. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  88. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  89. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  90. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  91. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  92. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  93. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  94. You can contact the author at :
  95. - FSE source repository : https://github.com/Cyan4973/FiniteStateEntropy
  96. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  97. ****************************************************************** */
  98. #ifndef MEM_H_MODULE
  99. #define MEM_H_MODULE
  100. #if defined (__cplusplus)
  101. extern "C" {
  102. #endif
  103. /******************************************
  104. * Includes
  105. ******************************************/
  106. #include <stddef.h> /* size_t, ptrdiff_t */
  107. #include <string.h> /* memcpy */
  108. /******************************************
  109. * Compiler-specific
  110. ******************************************/
  111. #if defined(__GNUC__)
  112. # define MEM_STATIC static __attribute__((unused))
  113. #elif defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
  114. # define MEM_STATIC static inline
  115. #elif defined(_MSC_VER)
  116. # define MEM_STATIC static __inline
  117. #else
  118. # define MEM_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */
  119. #endif
  120. /****************************************************************
  121. * Basic Types
  122. *****************************************************************/
  123. #if defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
  124. # include <stdint.h>
  125. typedef uint8_t BYTE;
  126. typedef uint16_t U16;
  127. typedef int16_t S16;
  128. typedef uint32_t U32;
  129. typedef int32_t S32;
  130. typedef uint64_t U64;
  131. typedef int64_t S64;
  132. #else
  133. typedef unsigned char BYTE;
  134. typedef unsigned short U16;
  135. typedef signed short S16;
  136. typedef unsigned int U32;
  137. typedef signed int S32;
  138. typedef unsigned long long U64;
  139. typedef signed long long S64;
  140. #endif
  141. /****************************************************************
  142. * Memory I/O
  143. *****************************************************************/
  144. /* MEM_FORCE_MEMORY_ACCESS
  145. * By default, access to unaligned memory is controlled by `memcpy()`, which is safe and portable.
  146. * Unfortunately, on some target/compiler combinations, the generated assembly is sub-optimal.
  147. * The below switch allow to select different access method for improved performance.
  148. * Method 0 (default) : use `memcpy()`. Safe and portable.
  149. * Method 1 : `__packed` statement. It depends on compiler extension (ie, not portable).
  150. * This method is safe if your compiler supports it, and *generally* as fast or faster than `memcpy`.
  151. * Method 2 : direct access. This method is portable but violate C standard.
  152. * It can generate buggy code on targets generating assembly depending on alignment.
  153. * But in some circumstances, it's the only known way to get the most performance (ie GCC + ARMv6)
  154. * See http://fastcompression.blogspot.fr/2015/08/accessing-unaligned-memory.html for details.
  155. * Prefer these methods in priority order (0 > 1 > 2)
  156. */
  157. #ifndef MEM_FORCE_MEMORY_ACCESS /* can be defined externally, on command line for example */
  158. # if defined(__GNUC__) && ( defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_6T2__) )
  159. # define MEM_FORCE_MEMORY_ACCESS 2
  160. # elif defined(__INTEL_COMPILER) || \
  161. (defined(__GNUC__) && ( defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7S__) ))
  162. # define MEM_FORCE_MEMORY_ACCESS 1
  163. # endif
  164. #endif
  165. MEM_STATIC unsigned MEM_32bits(void) { return sizeof(void*)==4; }
  166. MEM_STATIC unsigned MEM_64bits(void) { return sizeof(void*)==8; }
  167. MEM_STATIC unsigned MEM_isLittleEndian(void)
  168. {
  169. const union { U32 u; BYTE c[4]; } one = { 1 }; /* don't use static : performance detrimental */
  170. return one.c[0];
  171. }
  172. #if defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==2)
  173. /* violates C standard on structure alignment.
  174. Only use if no other choice to achieve best performance on target platform */
  175. MEM_STATIC U16 MEM_read16(const void* memPtr) { return *(const U16*) memPtr; }
  176. MEM_STATIC U32 MEM_read32(const void* memPtr) { return *(const U32*) memPtr; }
  177. MEM_STATIC U64 MEM_read64(const void* memPtr) { return *(const U64*) memPtr; }
  178. MEM_STATIC void MEM_write16(void* memPtr, U16 value) { *(U16*)memPtr = value; }
  179. MEM_STATIC void MEM_write32(void* memPtr, U32 value) { *(U32*)memPtr = value; }
  180. MEM_STATIC void MEM_write64(void* memPtr, U64 value) { *(U64*)memPtr = value; }
  181. #elif defined(MEM_FORCE_MEMORY_ACCESS) && (MEM_FORCE_MEMORY_ACCESS==1)
  182. /* __pack instructions are safer, but compiler specific, hence potentially problematic for some compilers */
  183. /* currently only defined for gcc and icc */
  184. typedef union { U16 u16; U32 u32; U64 u64; } __attribute__((packed)) unalign;
  185. MEM_STATIC U16 MEM_read16(const void* ptr) { return ((const unalign*)ptr)->u16; }
  186. MEM_STATIC U32 MEM_read32(const void* ptr) { return ((const unalign*)ptr)->u32; }
  187. MEM_STATIC U64 MEM_read64(const void* ptr) { return ((const unalign*)ptr)->u64; }
  188. MEM_STATIC void MEM_write16(void* memPtr, U16 value) { ((unalign*)memPtr)->u16 = value; }
  189. MEM_STATIC void MEM_write32(void* memPtr, U32 value) { ((unalign*)memPtr)->u32 = value; }
  190. MEM_STATIC void MEM_write64(void* memPtr, U64 value) { ((unalign*)memPtr)->u64 = value; }
  191. #else
  192. /* default method, safe and standard.
  193. can sometimes prove slower */
  194. MEM_STATIC U16 MEM_read16(const void* memPtr)
  195. {
  196. U16 val; memcpy(&val, memPtr, sizeof(val)); return val;
  197. }
  198. MEM_STATIC U32 MEM_read32(const void* memPtr)
  199. {
  200. U32 val; memcpy(&val, memPtr, sizeof(val)); return val;
  201. }
  202. MEM_STATIC U64 MEM_read64(const void* memPtr)
  203. {
  204. U64 val; memcpy(&val, memPtr, sizeof(val)); return val;
  205. }
  206. MEM_STATIC void MEM_write16(void* memPtr, U16 value)
  207. {
  208. memcpy(memPtr, &value, sizeof(value));
  209. }
  210. MEM_STATIC void MEM_write32(void* memPtr, U32 value)
  211. {
  212. memcpy(memPtr, &value, sizeof(value));
  213. }
  214. MEM_STATIC void MEM_write64(void* memPtr, U64 value)
  215. {
  216. memcpy(memPtr, &value, sizeof(value));
  217. }
  218. #endif // MEM_FORCE_MEMORY_ACCESS
  219. MEM_STATIC U16 MEM_readLE16(const void* memPtr)
  220. {
  221. if (MEM_isLittleEndian())
  222. return MEM_read16(memPtr);
  223. else
  224. {
  225. const BYTE* p = (const BYTE*)memPtr;
  226. return (U16)(p[0] + (p[1]<<8));
  227. }
  228. }
  229. MEM_STATIC void MEM_writeLE16(void* memPtr, U16 val)
  230. {
  231. if (MEM_isLittleEndian())
  232. {
  233. MEM_write16(memPtr, val);
  234. }
  235. else
  236. {
  237. BYTE* p = (BYTE*)memPtr;
  238. p[0] = (BYTE)val;
  239. p[1] = (BYTE)(val>>8);
  240. }
  241. }
  242. MEM_STATIC U32 MEM_readLE32(const void* memPtr)
  243. {
  244. if (MEM_isLittleEndian())
  245. return MEM_read32(memPtr);
  246. else
  247. {
  248. const BYTE* p = (const BYTE*)memPtr;
  249. return (U32)((U32)p[0] + ((U32)p[1]<<8) + ((U32)p[2]<<16) + ((U32)p[3]<<24));
  250. }
  251. }
  252. MEM_STATIC void MEM_writeLE32(void* memPtr, U32 val32)
  253. {
  254. if (MEM_isLittleEndian())
  255. {
  256. MEM_write32(memPtr, val32);
  257. }
  258. else
  259. {
  260. BYTE* p = (BYTE*)memPtr;
  261. p[0] = (BYTE)val32;
  262. p[1] = (BYTE)(val32>>8);
  263. p[2] = (BYTE)(val32>>16);
  264. p[3] = (BYTE)(val32>>24);
  265. }
  266. }
  267. MEM_STATIC U64 MEM_readLE64(const void* memPtr)
  268. {
  269. if (MEM_isLittleEndian())
  270. return MEM_read64(memPtr);
  271. else
  272. {
  273. const BYTE* p = (const BYTE*)memPtr;
  274. return (U64)((U64)p[0] + ((U64)p[1]<<8) + ((U64)p[2]<<16) + ((U64)p[3]<<24)
  275. + ((U64)p[4]<<32) + ((U64)p[5]<<40) + ((U64)p[6]<<48) + ((U64)p[7]<<56));
  276. }
  277. }
  278. MEM_STATIC void MEM_writeLE64(void* memPtr, U64 val64)
  279. {
  280. if (MEM_isLittleEndian())
  281. {
  282. MEM_write64(memPtr, val64);
  283. }
  284. else
  285. {
  286. BYTE* p = (BYTE*)memPtr;
  287. p[0] = (BYTE)val64;
  288. p[1] = (BYTE)(val64>>8);
  289. p[2] = (BYTE)(val64>>16);
  290. p[3] = (BYTE)(val64>>24);
  291. p[4] = (BYTE)(val64>>32);
  292. p[5] = (BYTE)(val64>>40);
  293. p[6] = (BYTE)(val64>>48);
  294. p[7] = (BYTE)(val64>>56);
  295. }
  296. }
  297. MEM_STATIC size_t MEM_readLEST(const void* memPtr)
  298. {
  299. if (MEM_32bits())
  300. return (size_t)MEM_readLE32(memPtr);
  301. else
  302. return (size_t)MEM_readLE64(memPtr);
  303. }
  304. MEM_STATIC void MEM_writeLEST(void* memPtr, size_t val)
  305. {
  306. if (MEM_32bits())
  307. MEM_writeLE32(memPtr, (U32)val);
  308. else
  309. MEM_writeLE64(memPtr, (U64)val);
  310. }
  311. #if defined (__cplusplus)
  312. }
  313. #endif
  314. #endif /* MEM_H_MODULE */
  315. /* ******************************************************************
  316. bitstream
  317. Part of NewGen Entropy library
  318. header file (to include)
  319. Copyright (C) 2013-2015, Yann Collet.
  320. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  321. Redistribution and use in source and binary forms, with or without
  322. modification, are permitted provided that the following conditions are
  323. met:
  324. * Redistributions of source code must retain the above copyright
  325. notice, this list of conditions and the following disclaimer.
  326. * Redistributions in binary form must reproduce the above
  327. copyright notice, this list of conditions and the following disclaimer
  328. in the documentation and/or other materials provided with the
  329. distribution.
  330. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  331. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  332. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  333. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  334. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  335. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  336. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  337. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  338. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  339. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  340. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  341. You can contact the author at :
  342. - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  343. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  344. ****************************************************************** */
  345. #ifndef BITSTREAM_H_MODULE
  346. #define BITSTREAM_H_MODULE
  347. #if defined (__cplusplus)
  348. extern "C" {
  349. #endif
  350. /*
  351. * This API consists of small unitary functions, which highly benefit from being inlined.
  352. * Since link-time-optimization is not available for all compilers,
  353. * these functions are defined into a .h to be included.
  354. */
  355. /**********************************************
  356. * bitStream decompression API (read backward)
  357. **********************************************/
  358. typedef struct
  359. {
  360. size_t bitContainer;
  361. unsigned bitsConsumed;
  362. const char* ptr;
  363. const char* start;
  364. } BIT_DStream_t;
  365. typedef enum { BIT_DStream_unfinished = 0,
  366. BIT_DStream_endOfBuffer = 1,
  367. BIT_DStream_completed = 2,
  368. BIT_DStream_overflow = 3 } BIT_DStream_status; /* result of BIT_reloadDStream() */
  369. /* 1,2,4,8 would be better for bitmap combinations, but slows down performance a bit ... :( */
  370. MEM_STATIC size_t BIT_initDStream(BIT_DStream_t* bitD, const void* srcBuffer, size_t srcSize);
  371. MEM_STATIC size_t BIT_readBits(BIT_DStream_t* bitD, unsigned nbBits);
  372. MEM_STATIC BIT_DStream_status BIT_reloadDStream(BIT_DStream_t* bitD);
  373. MEM_STATIC unsigned BIT_endOfDStream(const BIT_DStream_t* bitD);
  374. /*
  375. * Start by invoking BIT_initDStream().
  376. * A chunk of the bitStream is then stored into a local register.
  377. * Local register size is 64-bits on 64-bits systems, 32-bits on 32-bits systems (size_t).
  378. * You can then retrieve bitFields stored into the local register, **in reverse order**.
  379. * Local register is manually filled from memory by the BIT_reloadDStream() method.
  380. * A reload guarantee a minimum of ((8*sizeof(size_t))-7) bits when its result is BIT_DStream_unfinished.
  381. * Otherwise, it can be less than that, so proceed accordingly.
  382. * Checking if DStream has reached its end can be performed with BIT_endOfDStream()
  383. */
  384. /******************************************
  385. * unsafe API
  386. ******************************************/
  387. MEM_STATIC size_t BIT_readBitsFast(BIT_DStream_t* bitD, unsigned nbBits);
  388. /* faster, but works only if nbBits >= 1 */
  389. /****************************************************************
  390. * Helper functions
  391. ****************************************************************/
  392. MEM_STATIC unsigned BIT_highbit32 (register U32 val)
  393. {
  394. # if defined(_MSC_VER) /* Visual */
  395. unsigned long r=0;
  396. _BitScanReverse ( &r, val );
  397. return (unsigned) r;
  398. # elif defined(__GNUC__) && (__GNUC__ >= 3) /* Use GCC Intrinsic */
  399. return 31 - __builtin_clz (val);
  400. # else /* Software version */
  401. static const unsigned DeBruijnClz[32] = { 0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31 };
  402. U32 v = val;
  403. unsigned r;
  404. v |= v >> 1;
  405. v |= v >> 2;
  406. v |= v >> 4;
  407. v |= v >> 8;
  408. v |= v >> 16;
  409. r = DeBruijnClz[ (U32) (v * 0x07C4ACDDU) >> 27];
  410. return r;
  411. # endif
  412. }
  413. /**********************************************************
  414. * bitStream decoding
  415. **********************************************************/
  416. /*!BIT_initDStream
  417. * Initialize a BIT_DStream_t.
  418. * @bitD : a pointer to an already allocated BIT_DStream_t structure
  419. * @srcBuffer must point at the beginning of a bitStream
  420. * @srcSize must be the exact size of the bitStream
  421. * @result : size of stream (== srcSize) or an errorCode if a problem is detected
  422. */
  423. MEM_STATIC size_t BIT_initDStream(BIT_DStream_t* bitD, const void* srcBuffer, size_t srcSize)
  424. {
  425. if (srcSize < 1) { memset(bitD, 0, sizeof(*bitD)); return ERROR(srcSize_wrong); }
  426. if (srcSize >= sizeof(size_t)) /* normal case */
  427. {
  428. U32 contain32;
  429. bitD->start = (const char*)srcBuffer;
  430. bitD->ptr = (const char*)srcBuffer + srcSize - sizeof(size_t);
  431. bitD->bitContainer = MEM_readLEST(bitD->ptr);
  432. contain32 = ((const BYTE*)srcBuffer)[srcSize-1];
  433. if (contain32 == 0) return ERROR(GENERIC); /* endMark not present */
  434. bitD->bitsConsumed = 8 - BIT_highbit32(contain32);
  435. }
  436. else
  437. {
  438. U32 contain32;
  439. bitD->start = (const char*)srcBuffer;
  440. bitD->ptr = bitD->start;
  441. bitD->bitContainer = *(const BYTE*)(bitD->start);
  442. switch(srcSize)
  443. {
  444. case 7: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[6]) << (sizeof(size_t)*8 - 16);
  445. case 6: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[5]) << (sizeof(size_t)*8 - 24);
  446. case 5: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[4]) << (sizeof(size_t)*8 - 32);
  447. case 4: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[3]) << 24;
  448. case 3: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[2]) << 16;
  449. case 2: bitD->bitContainer += (size_t)(((const BYTE*)(bitD->start))[1]) << 8;
  450. default:;
  451. }
  452. contain32 = ((const BYTE*)srcBuffer)[srcSize-1];
  453. if (contain32 == 0) return ERROR(GENERIC); /* endMark not present */
  454. bitD->bitsConsumed = 8 - BIT_highbit32(contain32);
  455. bitD->bitsConsumed += (U32)(sizeof(size_t) - srcSize)*8;
  456. }
  457. return srcSize;
  458. }
  459. /*!BIT_lookBits
  460. * Provides next n bits from local register
  461. * local register is not modified (bits are still present for next read/look)
  462. * On 32-bits, maxNbBits==25
  463. * On 64-bits, maxNbBits==57
  464. * @return : value extracted
  465. */
  466. MEM_STATIC size_t BIT_lookBits(BIT_DStream_t* bitD, U32 nbBits)
  467. {
  468. const U32 bitMask = sizeof(bitD->bitContainer)*8 - 1;
  469. return ((bitD->bitContainer << (bitD->bitsConsumed & bitMask)) >> 1) >> ((bitMask-nbBits) & bitMask);
  470. }
  471. /*! BIT_lookBitsFast :
  472. * unsafe version; only works only if nbBits >= 1 */
  473. MEM_STATIC size_t BIT_lookBitsFast(BIT_DStream_t* bitD, U32 nbBits)
  474. {
  475. const U32 bitMask = sizeof(bitD->bitContainer)*8 - 1;
  476. return (bitD->bitContainer << (bitD->bitsConsumed & bitMask)) >> (((bitMask+1)-nbBits) & bitMask);
  477. }
  478. MEM_STATIC void BIT_skipBits(BIT_DStream_t* bitD, U32 nbBits)
  479. {
  480. bitD->bitsConsumed += nbBits;
  481. }
  482. /*!BIT_readBits
  483. * Read next n bits from local register.
  484. * pay attention to not read more than nbBits contained into local register.
  485. * @return : extracted value.
  486. */
  487. MEM_STATIC size_t BIT_readBits(BIT_DStream_t* bitD, U32 nbBits)
  488. {
  489. size_t value = BIT_lookBits(bitD, nbBits);
  490. BIT_skipBits(bitD, nbBits);
  491. return value;
  492. }
  493. /*!BIT_readBitsFast :
  494. * unsafe version; only works only if nbBits >= 1 */
  495. MEM_STATIC size_t BIT_readBitsFast(BIT_DStream_t* bitD, U32 nbBits)
  496. {
  497. size_t value = BIT_lookBitsFast(bitD, nbBits);
  498. BIT_skipBits(bitD, nbBits);
  499. return value;
  500. }
  501. MEM_STATIC BIT_DStream_status BIT_reloadDStream(BIT_DStream_t* bitD)
  502. {
  503. if (bitD->bitsConsumed > (sizeof(bitD->bitContainer)*8)) /* should never happen */
  504. return BIT_DStream_overflow;
  505. if (bitD->ptr >= bitD->start + sizeof(bitD->bitContainer))
  506. {
  507. bitD->ptr -= bitD->bitsConsumed >> 3;
  508. bitD->bitsConsumed &= 7;
  509. bitD->bitContainer = MEM_readLEST(bitD->ptr);
  510. return BIT_DStream_unfinished;
  511. }
  512. if (bitD->ptr == bitD->start)
  513. {
  514. if (bitD->bitsConsumed < sizeof(bitD->bitContainer)*8) return BIT_DStream_endOfBuffer;
  515. return BIT_DStream_completed;
  516. }
  517. {
  518. U32 nbBytes = bitD->bitsConsumed >> 3;
  519. BIT_DStream_status result = BIT_DStream_unfinished;
  520. if (bitD->ptr - nbBytes < bitD->start)
  521. {
  522. nbBytes = (U32)(bitD->ptr - bitD->start); /* ptr > start */
  523. result = BIT_DStream_endOfBuffer;
  524. }
  525. bitD->ptr -= nbBytes;
  526. bitD->bitsConsumed -= nbBytes*8;
  527. bitD->bitContainer = MEM_readLEST(bitD->ptr); /* reminder : srcSize > sizeof(bitD) */
  528. return result;
  529. }
  530. }
  531. /*! BIT_endOfDStream
  532. * @return Tells if DStream has reached its exact end
  533. */
  534. MEM_STATIC unsigned BIT_endOfDStream(const BIT_DStream_t* DStream)
  535. {
  536. return ((DStream->ptr == DStream->start) && (DStream->bitsConsumed == sizeof(DStream->bitContainer)*8));
  537. }
  538. #if defined (__cplusplus)
  539. }
  540. #endif
  541. #endif /* BITSTREAM_H_MODULE */
  542. /* ******************************************************************
  543. Error codes and messages
  544. Copyright (C) 2013-2015, Yann Collet
  545. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  546. Redistribution and use in source and binary forms, with or without
  547. modification, are permitted provided that the following conditions are
  548. met:
  549. * Redistributions of source code must retain the above copyright
  550. notice, this list of conditions and the following disclaimer.
  551. * Redistributions in binary form must reproduce the above
  552. copyright notice, this list of conditions and the following disclaimer
  553. in the documentation and/or other materials provided with the
  554. distribution.
  555. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  556. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  557. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  558. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  559. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  560. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  561. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  562. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  563. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  564. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  565. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  566. You can contact the author at :
  567. - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  568. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  569. ****************************************************************** */
  570. #ifndef ERROR_H_MODULE
  571. #define ERROR_H_MODULE
  572. #if defined (__cplusplus)
  573. extern "C" {
  574. #endif
  575. /******************************************
  576. * Compiler-specific
  577. ******************************************/
  578. #if defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
  579. # define ERR_STATIC static inline
  580. #elif defined(_MSC_VER)
  581. # define ERR_STATIC static __inline
  582. #elif defined(__GNUC__)
  583. # define ERR_STATIC static __attribute__((unused))
  584. #else
  585. # define ERR_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */
  586. #endif
  587. /******************************************
  588. * Error Management
  589. ******************************************/
  590. #define PREFIX(name) ZSTD_error_##name
  591. #define ERROR(name) (size_t)-PREFIX(name)
  592. #define ERROR_LIST(ITEM) \
  593. ITEM(PREFIX(No_Error)) ITEM(PREFIX(GENERIC)) \
  594. ITEM(PREFIX(dstSize_tooSmall)) ITEM(PREFIX(srcSize_wrong)) \
  595. ITEM(PREFIX(prefix_unknown)) ITEM(PREFIX(corruption_detected)) \
  596. ITEM(PREFIX(tableLog_tooLarge)) ITEM(PREFIX(maxSymbolValue_tooLarge)) ITEM(PREFIX(maxSymbolValue_tooSmall)) \
  597. ITEM(PREFIX(maxCode))
  598. #define ERROR_GENERATE_ENUM(ENUM) ENUM,
  599. typedef enum { ERROR_LIST(ERROR_GENERATE_ENUM) } ERR_codes; /* enum is exposed, to detect & handle specific errors; compare function result to -enum value */
  600. #define ERROR_CONVERTTOSTRING(STRING) #STRING,
  601. #define ERROR_GENERATE_STRING(EXPR) ERROR_CONVERTTOSTRING(EXPR)
  602. static const char* ERR_strings[] = { ERROR_LIST(ERROR_GENERATE_STRING) };
  603. ERR_STATIC unsigned ERR_isError(size_t code) { return (code > ERROR(maxCode)); }
  604. ERR_STATIC const char* ERR_getErrorName(size_t code)
  605. {
  606. static const char* codeError = "Unspecified error code";
  607. if (ERR_isError(code)) return ERR_strings[-(int)(code)];
  608. return codeError;
  609. }
  610. #if defined (__cplusplus)
  611. }
  612. #endif
  613. #endif /* ERROR_H_MODULE */
  614. /*
  615. Constructor and Destructor of type FSE_CTable
  616. Note that its size depends on 'tableLog' and 'maxSymbolValue' */
  617. typedef unsigned FSE_CTable; /* don't allocate that. It's just a way to be more restrictive than void* */
  618. typedef unsigned FSE_DTable; /* don't allocate that. It's just a way to be more restrictive than void* */
  619. /* ******************************************************************
  620. FSE : Finite State Entropy coder
  621. header file for static linking (only)
  622. Copyright (C) 2013-2015, Yann Collet
  623. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  624. Redistribution and use in source and binary forms, with or without
  625. modification, are permitted provided that the following conditions are
  626. met:
  627. * Redistributions of source code must retain the above copyright
  628. notice, this list of conditions and the following disclaimer.
  629. * Redistributions in binary form must reproduce the above
  630. copyright notice, this list of conditions and the following disclaimer
  631. in the documentation and/or other materials provided with the
  632. distribution.
  633. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  634. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  635. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  636. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  637. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  638. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  639. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  640. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  641. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  642. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  643. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  644. You can contact the author at :
  645. - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  646. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  647. ****************************************************************** */
  648. #if defined (__cplusplus)
  649. extern "C" {
  650. #endif
  651. /******************************************
  652. * Static allocation
  653. ******************************************/
  654. /* FSE buffer bounds */
  655. #define FSE_NCOUNTBOUND 512
  656. #define FSE_BLOCKBOUND(size) (size + (size>>7))
  657. #define FSE_COMPRESSBOUND(size) (FSE_NCOUNTBOUND + FSE_BLOCKBOUND(size)) /* Macro version, useful for static allocation */
  658. /* You can statically allocate FSE CTable/DTable as a table of unsigned using below macro */
  659. #define FSE_CTABLE_SIZE_U32(maxTableLog, maxSymbolValue) (1 + (1<<(maxTableLog-1)) + ((maxSymbolValue+1)*2))
  660. #define FSE_DTABLE_SIZE_U32(maxTableLog) (1 + (1<<maxTableLog))
  661. /******************************************
  662. * FSE advanced API
  663. ******************************************/
  664. static size_t FSE_buildDTable_raw (FSE_DTable* dt, unsigned nbBits);
  665. /* build a fake FSE_DTable, designed to read an uncompressed bitstream where each symbol uses nbBits */
  666. static size_t FSE_buildDTable_rle (FSE_DTable* dt, unsigned char symbolValue);
  667. /* build a fake FSE_DTable, designed to always generate the same symbolValue */
  668. /******************************************
  669. * FSE symbol decompression API
  670. ******************************************/
  671. typedef struct
  672. {
  673. size_t state;
  674. const void* table; /* precise table may vary, depending on U16 */
  675. } FSE_DState_t;
  676. static void FSE_initDState(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD, const FSE_DTable* dt);
  677. static unsigned char FSE_decodeSymbol(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD);
  678. static unsigned FSE_endOfDState(const FSE_DState_t* DStatePtr);
  679. /*
  680. Let's now decompose FSE_decompress_usingDTable() into its unitary components.
  681. You will decode FSE-encoded symbols from the bitStream,
  682. and also any other bitFields you put in, **in reverse order**.
  683. You will need a few variables to track your bitStream. They are :
  684. BIT_DStream_t DStream; // Stream context
  685. FSE_DState_t DState; // State context. Multiple ones are possible
  686. FSE_DTable* DTablePtr; // Decoding table, provided by FSE_buildDTable()
  687. The first thing to do is to init the bitStream.
  688. errorCode = BIT_initDStream(&DStream, srcBuffer, srcSize);
  689. You should then retrieve your initial state(s)
  690. (in reverse flushing order if you have several ones) :
  691. errorCode = FSE_initDState(&DState, &DStream, DTablePtr);
  692. You can then decode your data, symbol after symbol.
  693. For information the maximum number of bits read by FSE_decodeSymbol() is 'tableLog'.
  694. Keep in mind that symbols are decoded in reverse order, like a LIFO stack (last in, first out).
  695. unsigned char symbol = FSE_decodeSymbol(&DState, &DStream);
  696. You can retrieve any bitfield you eventually stored into the bitStream (in reverse order)
  697. Note : maximum allowed nbBits is 25, for 32-bits compatibility
  698. size_t bitField = BIT_readBits(&DStream, nbBits);
  699. All above operations only read from local register (which size depends on size_t).
  700. Refueling the register from memory is manually performed by the reload method.
  701. endSignal = FSE_reloadDStream(&DStream);
  702. BIT_reloadDStream() result tells if there is still some more data to read from DStream.
  703. BIT_DStream_unfinished : there is still some data left into the DStream.
  704. BIT_DStream_endOfBuffer : Dstream reached end of buffer. Its container may no longer be completely filled.
  705. BIT_DStream_completed : Dstream reached its exact end, corresponding in general to decompression completed.
  706. BIT_DStream_tooFar : Dstream went too far. Decompression result is corrupted.
  707. When reaching end of buffer (BIT_DStream_endOfBuffer), progress slowly, notably if you decode multiple symbols per loop,
  708. to properly detect the exact end of stream.
  709. After each decoded symbol, check if DStream is fully consumed using this simple test :
  710. BIT_reloadDStream(&DStream) >= BIT_DStream_completed
  711. When it's done, verify decompression is fully completed, by checking both DStream and the relevant states.
  712. Checking if DStream has reached its end is performed by :
  713. BIT_endOfDStream(&DStream);
  714. Check also the states. There might be some symbols left there, if some high probability ones (>50%) are possible.
  715. FSE_endOfDState(&DState);
  716. */
  717. /******************************************
  718. * FSE unsafe API
  719. ******************************************/
  720. static unsigned char FSE_decodeSymbolFast(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD);
  721. /* faster, but works only if nbBits is always >= 1 (otherwise, result will be corrupted) */
  722. /******************************************
  723. * Implementation of inline functions
  724. ******************************************/
  725. /* decompression */
  726. typedef struct {
  727. U16 tableLog;
  728. U16 fastMode;
  729. } FSE_DTableHeader; /* sizeof U32 */
  730. typedef struct
  731. {
  732. unsigned short newState;
  733. unsigned char symbol;
  734. unsigned char nbBits;
  735. } FSE_decode_t; /* size == U32 */
  736. MEM_STATIC void FSE_initDState(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD, const FSE_DTable* dt)
  737. {
  738. FSE_DTableHeader DTableH;
  739. memcpy(&DTableH, dt, sizeof(DTableH));
  740. DStatePtr->state = BIT_readBits(bitD, DTableH.tableLog);
  741. BIT_reloadDStream(bitD);
  742. DStatePtr->table = dt + 1;
  743. }
  744. MEM_STATIC BYTE FSE_decodeSymbol(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD)
  745. {
  746. const FSE_decode_t DInfo = ((const FSE_decode_t*)(DStatePtr->table))[DStatePtr->state];
  747. const U32 nbBits = DInfo.nbBits;
  748. BYTE symbol = DInfo.symbol;
  749. size_t lowBits = BIT_readBits(bitD, nbBits);
  750. DStatePtr->state = DInfo.newState + lowBits;
  751. return symbol;
  752. }
  753. MEM_STATIC BYTE FSE_decodeSymbolFast(FSE_DState_t* DStatePtr, BIT_DStream_t* bitD)
  754. {
  755. const FSE_decode_t DInfo = ((const FSE_decode_t*)(DStatePtr->table))[DStatePtr->state];
  756. const U32 nbBits = DInfo.nbBits;
  757. BYTE symbol = DInfo.symbol;
  758. size_t lowBits = BIT_readBitsFast(bitD, nbBits);
  759. DStatePtr->state = DInfo.newState + lowBits;
  760. return symbol;
  761. }
  762. MEM_STATIC unsigned FSE_endOfDState(const FSE_DState_t* DStatePtr)
  763. {
  764. return DStatePtr->state == 0;
  765. }
  766. #if defined (__cplusplus)
  767. }
  768. #endif
  769. /* ******************************************************************
  770. Huff0 : Huffman coder, part of New Generation Entropy library
  771. header file for static linking (only)
  772. Copyright (C) 2013-2015, Yann Collet
  773. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  774. Redistribution and use in source and binary forms, with or without
  775. modification, are permitted provided that the following conditions are
  776. met:
  777. * Redistributions of source code must retain the above copyright
  778. notice, this list of conditions and the following disclaimer.
  779. * Redistributions in binary form must reproduce the above
  780. copyright notice, this list of conditions and the following disclaimer
  781. in the documentation and/or other materials provided with the
  782. distribution.
  783. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  784. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  785. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  786. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  787. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  788. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  789. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  790. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  791. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  792. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  793. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  794. You can contact the author at :
  795. - Source repository : https://github.com/Cyan4973/FiniteStateEntropy
  796. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  797. ****************************************************************** */
  798. #if defined (__cplusplus)
  799. extern "C" {
  800. #endif
  801. /******************************************
  802. * Static allocation macros
  803. ******************************************/
  804. /* Huff0 buffer bounds */
  805. #define HUF_CTABLEBOUND 129
  806. #define HUF_BLOCKBOUND(size) (size + (size>>8) + 8) /* only true if incompressible pre-filtered with fast heuristic */
  807. #define HUF_COMPRESSBOUND(size) (HUF_CTABLEBOUND + HUF_BLOCKBOUND(size)) /* Macro version, useful for static allocation */
  808. /* static allocation of Huff0's DTable */
  809. #define HUF_DTABLE_SIZE(maxTableLog) (1 + (1<<maxTableLog)) /* nb Cells; use unsigned short for X2, unsigned int for X4 */
  810. #define HUF_CREATE_STATIC_DTABLEX2(DTable, maxTableLog) \
  811. unsigned short DTable[HUF_DTABLE_SIZE(maxTableLog)] = { maxTableLog }
  812. #define HUF_CREATE_STATIC_DTABLEX4(DTable, maxTableLog) \
  813. unsigned int DTable[HUF_DTABLE_SIZE(maxTableLog)] = { maxTableLog }
  814. #define HUF_CREATE_STATIC_DTABLEX6(DTable, maxTableLog) \
  815. unsigned int DTable[HUF_DTABLE_SIZE(maxTableLog) * 3 / 2] = { maxTableLog }
  816. /******************************************
  817. * Advanced functions
  818. ******************************************/
  819. static size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* single-symbol decoder */
  820. static size_t HUF_decompress4X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize); /* double-symbols decoder */
  821. #if defined (__cplusplus)
  822. }
  823. #endif
  824. /*
  825. zstd - standard compression library
  826. Header File
  827. Copyright (C) 2014-2015, Yann Collet.
  828. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  829. Redistribution and use in source and binary forms, with or without
  830. modification, are permitted provided that the following conditions are
  831. met:
  832. * Redistributions of source code must retain the above copyright
  833. notice, this list of conditions and the following disclaimer.
  834. * Redistributions in binary form must reproduce the above
  835. copyright notice, this list of conditions and the following disclaimer
  836. in the documentation and/or other materials provided with the
  837. distribution.
  838. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  839. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  840. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  841. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  842. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  843. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  844. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  845. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  846. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  847. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  848. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  849. You can contact the author at :
  850. - zstd source repository : https://github.com/Cyan4973/zstd
  851. - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
  852. */
  853. #if defined (__cplusplus)
  854. extern "C" {
  855. #endif
  856. /* *************************************
  857. * Includes
  858. ***************************************/
  859. #include <stddef.h> /* size_t */
  860. /* *************************************
  861. * Version
  862. ***************************************/
  863. #define ZSTD_VERSION_MAJOR 0 /* for breaking interface changes */
  864. #define ZSTD_VERSION_MINOR 2 /* for new (non-breaking) interface capabilities */
  865. #define ZSTD_VERSION_RELEASE 2 /* for tweaks, bug-fixes, or development */
  866. #define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
  867. /* *************************************
  868. * Advanced functions
  869. ***************************************/
  870. typedef struct ZSTD_CCtx_s ZSTD_CCtx; /* incomplete type */
  871. #if defined (__cplusplus)
  872. }
  873. #endif
  874. /*
  875. zstd - standard compression library
  876. Header File for static linking only
  877. Copyright (C) 2014-2015, Yann Collet.
  878. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  879. Redistribution and use in source and binary forms, with or without
  880. modification, are permitted provided that the following conditions are
  881. met:
  882. * Redistributions of source code must retain the above copyright
  883. notice, this list of conditions and the following disclaimer.
  884. * Redistributions in binary form must reproduce the above
  885. copyright notice, this list of conditions and the following disclaimer
  886. in the documentation and/or other materials provided with the
  887. distribution.
  888. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  889. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  890. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  891. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  892. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  893. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  894. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  895. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  896. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  897. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  898. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  899. You can contact the author at :
  900. - zstd source repository : https://github.com/Cyan4973/zstd
  901. - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
  902. */
  903. /* The objects defined into this file should be considered experimental.
  904. * They are not labelled stable, as their prototype may change in the future.
  905. * You can use them for tests, provide feedback, or if you can endure risk of future changes.
  906. */
  907. #if defined (__cplusplus)
  908. extern "C" {
  909. #endif
  910. /* *************************************
  911. * Streaming functions
  912. ***************************************/
  913. typedef struct ZSTD_DCtx_s ZSTD_DCtx;
  914. /*
  915. Use above functions alternatively.
  916. ZSTD_nextSrcSizeToDecompress() tells how much bytes to provide as 'srcSize' to ZSTD_decompressContinue().
  917. ZSTD_decompressContinue() will use previous data blocks to improve compression if they are located prior to current block.
  918. Result is the number of bytes regenerated within 'dst'.
  919. It can be zero, which is not an error; it just means ZSTD_decompressContinue() has decoded some header.
  920. */
  921. /* *************************************
  922. * Prefix - version detection
  923. ***************************************/
  924. #define ZSTD_magicNumber 0xFD2FB523 /* v0.3 */
  925. #if defined (__cplusplus)
  926. }
  927. #endif
  928. /* ******************************************************************
  929. FSE : Finite State Entropy coder
  930. Copyright (C) 2013-2015, Yann Collet.
  931. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  932. Redistribution and use in source and binary forms, with or without
  933. modification, are permitted provided that the following conditions are
  934. met:
  935. * Redistributions of source code must retain the above copyright
  936. notice, this list of conditions and the following disclaimer.
  937. * Redistributions in binary form must reproduce the above
  938. copyright notice, this list of conditions and the following disclaimer
  939. in the documentation and/or other materials provided with the
  940. distribution.
  941. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  942. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  943. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  944. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  945. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  946. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  947. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  948. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  949. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  950. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  951. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  952. You can contact the author at :
  953. - FSE source repository : https://github.com/Cyan4973/FiniteStateEntropy
  954. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  955. ****************************************************************** */
  956. #ifndef FSE_COMMONDEFS_ONLY
  957. /****************************************************************
  958. * Tuning parameters
  959. ****************************************************************/
  960. /* MEMORY_USAGE :
  961. * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
  962. * Increasing memory usage improves compression ratio
  963. * Reduced memory usage can improve speed, due to cache effect
  964. * Recommended max value is 14, for 16KB, which nicely fits into Intel x86 L1 cache */
  965. #define FSE_MAX_MEMORY_USAGE 14
  966. #define FSE_DEFAULT_MEMORY_USAGE 13
  967. /* FSE_MAX_SYMBOL_VALUE :
  968. * Maximum symbol value authorized.
  969. * Required for proper stack allocation */
  970. #define FSE_MAX_SYMBOL_VALUE 255
  971. /****************************************************************
  972. * template functions type & suffix
  973. ****************************************************************/
  974. #define FSE_FUNCTION_TYPE BYTE
  975. #define FSE_FUNCTION_EXTENSION
  976. /****************************************************************
  977. * Byte symbol type
  978. ****************************************************************/
  979. #endif /* !FSE_COMMONDEFS_ONLY */
  980. /****************************************************************
  981. * Compiler specifics
  982. ****************************************************************/
  983. #ifdef _MSC_VER /* Visual Studio */
  984. # define FORCE_INLINE static __forceinline
  985. # include <intrin.h> /* For Visual 2005 */
  986. # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
  987. # pragma warning(disable : 4214) /* disable: C4214: non-int bitfields */
  988. #else
  989. # ifdef __GNUC__
  990. # define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
  991. # define FORCE_INLINE static inline __attribute__((always_inline))
  992. # else
  993. # define FORCE_INLINE static inline
  994. # endif
  995. #endif
  996. /****************************************************************
  997. * Includes
  998. ****************************************************************/
  999. #include <stdlib.h> /* malloc, free, qsort */
  1000. #include <string.h> /* memcpy, memset */
  1001. #include <stdio.h> /* printf (debug) */
  1002. /****************************************************************
  1003. * Constants
  1004. *****************************************************************/
  1005. #define FSE_MAX_TABLELOG (FSE_MAX_MEMORY_USAGE-2)
  1006. #define FSE_MAX_TABLESIZE (1U<<FSE_MAX_TABLELOG)
  1007. #define FSE_MAXTABLESIZE_MASK (FSE_MAX_TABLESIZE-1)
  1008. #define FSE_DEFAULT_TABLELOG (FSE_DEFAULT_MEMORY_USAGE-2)
  1009. #define FSE_MIN_TABLELOG 5
  1010. #define FSE_TABLELOG_ABSOLUTE_MAX 15
  1011. #if FSE_MAX_TABLELOG > FSE_TABLELOG_ABSOLUTE_MAX
  1012. #error "FSE_MAX_TABLELOG > FSE_TABLELOG_ABSOLUTE_MAX is not supported"
  1013. #endif
  1014. /****************************************************************
  1015. * Error Management
  1016. ****************************************************************/
  1017. #define FSE_STATIC_ASSERT(c) { enum { FSE_static_assert = 1/(int)(!!(c)) }; } /* use only *after* variable declarations */
  1018. /****************************************************************
  1019. * Complex types
  1020. ****************************************************************/
  1021. typedef U32 DTable_max_t[FSE_DTABLE_SIZE_U32(FSE_MAX_TABLELOG)];
  1022. /****************************************************************
  1023. * Templates
  1024. ****************************************************************/
  1025. /*
  1026. designed to be included
  1027. for type-specific functions (template emulation in C)
  1028. Objective is to write these functions only once, for improved maintenance
  1029. */
  1030. /* safety checks */
  1031. #ifndef FSE_FUNCTION_EXTENSION
  1032. # error "FSE_FUNCTION_EXTENSION must be defined"
  1033. #endif
  1034. #ifndef FSE_FUNCTION_TYPE
  1035. # error "FSE_FUNCTION_TYPE must be defined"
  1036. #endif
  1037. /* Function names */
  1038. #define FSE_CAT(X,Y) X##Y
  1039. #define FSE_FUNCTION_NAME(X,Y) FSE_CAT(X,Y)
  1040. #define FSE_TYPE_NAME(X,Y) FSE_CAT(X,Y)
  1041. /* Function templates */
  1042. #define FSE_DECODE_TYPE FSE_decode_t
  1043. static U32 FSE_tableStep(U32 tableSize) { return (tableSize>>1) + (tableSize>>3) + 3; }
  1044. static size_t FSE_buildDTable
  1045. (FSE_DTable* dt, const short* normalizedCounter, unsigned maxSymbolValue, unsigned tableLog)
  1046. {
  1047. void* ptr = dt+1;
  1048. FSE_DTableHeader DTableH;
  1049. FSE_DECODE_TYPE* const tableDecode = (FSE_DECODE_TYPE*)ptr;
  1050. const U32 tableSize = 1 << tableLog;
  1051. const U32 tableMask = tableSize-1;
  1052. const U32 step = FSE_tableStep(tableSize);
  1053. U16 symbolNext[FSE_MAX_SYMBOL_VALUE+1];
  1054. U32 position = 0;
  1055. U32 highThreshold = tableSize-1;
  1056. const S16 largeLimit= (S16)(1 << (tableLog-1));
  1057. U32 noLarge = 1;
  1058. U32 s;
  1059. /* Sanity Checks */
  1060. if (maxSymbolValue > FSE_MAX_SYMBOL_VALUE) return ERROR(maxSymbolValue_tooLarge);
  1061. if (tableLog > FSE_MAX_TABLELOG) return ERROR(tableLog_tooLarge);
  1062. /* Init, lay down lowprob symbols */
  1063. DTableH.tableLog = (U16)tableLog;
  1064. for (s=0; s<=maxSymbolValue; s++)
  1065. {
  1066. if (normalizedCounter[s]==-1)
  1067. {
  1068. tableDecode[highThreshold--].symbol = (FSE_FUNCTION_TYPE)s;
  1069. symbolNext[s] = 1;
  1070. }
  1071. else
  1072. {
  1073. if (normalizedCounter[s] >= largeLimit) noLarge=0;
  1074. symbolNext[s] = normalizedCounter[s];
  1075. }
  1076. }
  1077. /* Spread symbols */
  1078. for (s=0; s<=maxSymbolValue; s++)
  1079. {
  1080. int i;
  1081. for (i=0; i<normalizedCounter[s]; i++)
  1082. {
  1083. tableDecode[position].symbol = (FSE_FUNCTION_TYPE)s;
  1084. position = (position + step) & tableMask;
  1085. while (position > highThreshold) position = (position + step) & tableMask; /* lowprob area */
  1086. }
  1087. }
  1088. if (position!=0) return ERROR(GENERIC); /* position must reach all cells once, otherwise normalizedCounter is incorrect */
  1089. /* Build Decoding table */
  1090. {
  1091. U32 i;
  1092. for (i=0; i<tableSize; i++)
  1093. {
  1094. FSE_FUNCTION_TYPE symbol = (FSE_FUNCTION_TYPE)(tableDecode[i].symbol);
  1095. U16 nextState = symbolNext[symbol]++;
  1096. tableDecode[i].nbBits = (BYTE) (tableLog - BIT_highbit32 ((U32)nextState) );
  1097. tableDecode[i].newState = (U16) ( (nextState << tableDecode[i].nbBits) - tableSize);
  1098. }
  1099. }
  1100. DTableH.fastMode = (U16)noLarge;
  1101. memcpy(dt, &DTableH, sizeof(DTableH));
  1102. return 0;
  1103. }
  1104. #ifndef FSE_COMMONDEFS_ONLY
  1105. /******************************************
  1106. * FSE helper functions
  1107. ******************************************/
  1108. static unsigned FSE_isError(size_t code) { return ERR_isError(code); }
  1109. /****************************************************************
  1110. * FSE NCount encoding-decoding
  1111. ****************************************************************/
  1112. static short FSE_abs(short a)
  1113. {
  1114. return a<0 ? -a : a;
  1115. }
  1116. static size_t FSE_readNCount (short* normalizedCounter, unsigned* maxSVPtr, unsigned* tableLogPtr,
  1117. const void* headerBuffer, size_t hbSize)
  1118. {
  1119. const BYTE* const istart = (const BYTE*) headerBuffer;
  1120. const BYTE* const iend = istart + hbSize;
  1121. const BYTE* ip = istart;
  1122. int nbBits;
  1123. int remaining;
  1124. int threshold;
  1125. U32 bitStream;
  1126. int bitCount;
  1127. unsigned charnum = 0;
  1128. int previous0 = 0;
  1129. if (hbSize < 4) return ERROR(srcSize_wrong);
  1130. bitStream = MEM_readLE32(ip);
  1131. nbBits = (bitStream & 0xF) + FSE_MIN_TABLELOG; /* extract tableLog */
  1132. if (nbBits > FSE_TABLELOG_ABSOLUTE_MAX) return ERROR(tableLog_tooLarge);
  1133. bitStream >>= 4;
  1134. bitCount = 4;
  1135. *tableLogPtr = nbBits;
  1136. remaining = (1<<nbBits)+1;
  1137. threshold = 1<<nbBits;
  1138. nbBits++;
  1139. while ((remaining>1) && (charnum<=*maxSVPtr))
  1140. {
  1141. if (previous0)
  1142. {
  1143. unsigned n0 = charnum;
  1144. while ((bitStream & 0xFFFF) == 0xFFFF)
  1145. {
  1146. n0+=24;
  1147. if (ip < iend-5)
  1148. {
  1149. ip+=2;
  1150. bitStream = MEM_readLE32(ip) >> bitCount;
  1151. }
  1152. else
  1153. {
  1154. bitStream >>= 16;
  1155. bitCount+=16;
  1156. }
  1157. }
  1158. while ((bitStream & 3) == 3)
  1159. {
  1160. n0+=3;
  1161. bitStream>>=2;
  1162. bitCount+=2;
  1163. }
  1164. n0 += bitStream & 3;
  1165. bitCount += 2;
  1166. if (n0 > *maxSVPtr) return ERROR(maxSymbolValue_tooSmall);
  1167. while (charnum < n0) normalizedCounter[charnum++] = 0;
  1168. if ((ip <= iend-7) || (ip + (bitCount>>3) <= iend-4))
  1169. {
  1170. ip += bitCount>>3;
  1171. bitCount &= 7;
  1172. bitStream = MEM_readLE32(ip) >> bitCount;
  1173. }
  1174. else
  1175. bitStream >>= 2;
  1176. }
  1177. {
  1178. const short max = (short)((2*threshold-1)-remaining);
  1179. short count;
  1180. if ((bitStream & (threshold-1)) < (U32)max)
  1181. {
  1182. count = (short)(bitStream & (threshold-1));
  1183. bitCount += nbBits-1;
  1184. }
  1185. else
  1186. {
  1187. count = (short)(bitStream & (2*threshold-1));
  1188. if (count >= threshold) count -= max;
  1189. bitCount += nbBits;
  1190. }
  1191. count--; /* extra accuracy */
  1192. remaining -= FSE_abs(count);
  1193. normalizedCounter[charnum++] = count;
  1194. previous0 = !count;
  1195. while (remaining < threshold)
  1196. {
  1197. nbBits--;
  1198. threshold >>= 1;
  1199. }
  1200. {
  1201. if ((ip <= iend-7) || (ip + (bitCount>>3) <= iend-4))
  1202. {
  1203. ip += bitCount>>3;
  1204. bitCount &= 7;
  1205. }
  1206. else
  1207. {
  1208. bitCount -= (int)(8 * (iend - 4 - ip));
  1209. ip = iend - 4;
  1210. }
  1211. bitStream = MEM_readLE32(ip) >> (bitCount & 31);
  1212. }
  1213. }
  1214. }
  1215. if (remaining != 1) return ERROR(GENERIC);
  1216. *maxSVPtr = charnum-1;
  1217. ip += (bitCount+7)>>3;
  1218. if ((size_t)(ip-istart) > hbSize) return ERROR(srcSize_wrong);
  1219. return ip-istart;
  1220. }
  1221. /*********************************************************
  1222. * Decompression (Byte symbols)
  1223. *********************************************************/
  1224. static size_t FSE_buildDTable_rle (FSE_DTable* dt, BYTE symbolValue)
  1225. {
  1226. void* ptr = dt;
  1227. FSE_DTableHeader* const DTableH = (FSE_DTableHeader*)ptr;
  1228. FSE_decode_t* const cell = (FSE_decode_t*)(ptr) + 1;
  1229. DTableH->tableLog = 0;
  1230. DTableH->fastMode = 0;
  1231. cell->newState = 0;
  1232. cell->symbol = symbolValue;
  1233. cell->nbBits = 0;
  1234. return 0;
  1235. }
  1236. static size_t FSE_buildDTable_raw (FSE_DTable* dt, unsigned nbBits)
  1237. {
  1238. void* ptr = dt;
  1239. FSE_DTableHeader* const DTableH = (FSE_DTableHeader*)ptr;
  1240. FSE_decode_t* const dinfo = (FSE_decode_t*)(ptr) + 1;
  1241. const unsigned tableSize = 1 << nbBits;
  1242. const unsigned tableMask = tableSize - 1;
  1243. const unsigned maxSymbolValue = tableMask;
  1244. unsigned s;
  1245. /* Sanity checks */
  1246. if (nbBits < 1) return ERROR(GENERIC); /* min size */
  1247. /* Build Decoding Table */
  1248. DTableH->tableLog = (U16)nbBits;
  1249. DTableH->fastMode = 1;
  1250. for (s=0; s<=maxSymbolValue; s++)
  1251. {
  1252. dinfo[s].newState = 0;
  1253. dinfo[s].symbol = (BYTE)s;
  1254. dinfo[s].nbBits = (BYTE)nbBits;
  1255. }
  1256. return 0;
  1257. }
  1258. FORCE_INLINE size_t FSE_decompress_usingDTable_generic(
  1259. void* dst, size_t maxDstSize,
  1260. const void* cSrc, size_t cSrcSize,
  1261. const FSE_DTable* dt, const unsigned fast)
  1262. {
  1263. BYTE* const ostart = (BYTE*) dst;
  1264. BYTE* op = ostart;
  1265. BYTE* const omax = op + maxDstSize;
  1266. BYTE* const olimit = omax-3;
  1267. BIT_DStream_t bitD;
  1268. FSE_DState_t state1;
  1269. FSE_DState_t state2;
  1270. size_t errorCode;
  1271. /* Init */
  1272. errorCode = BIT_initDStream(&bitD, cSrc, cSrcSize); /* replaced last arg by maxCompressed Size */
  1273. if (FSE_isError(errorCode)) return errorCode;
  1274. FSE_initDState(&state1, &bitD, dt);
  1275. FSE_initDState(&state2, &bitD, dt);
  1276. #define FSE_GETSYMBOL(statePtr) fast ? FSE_decodeSymbolFast(statePtr, &bitD) : FSE_decodeSymbol(statePtr, &bitD)
  1277. /* 4 symbols per loop */
  1278. for ( ; (BIT_reloadDStream(&bitD)==BIT_DStream_unfinished) && (op<olimit) ; op+=4)
  1279. {
  1280. op[0] = FSE_GETSYMBOL(&state1);
  1281. if (FSE_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
  1282. BIT_reloadDStream(&bitD);
  1283. op[1] = FSE_GETSYMBOL(&state2);
  1284. if (FSE_MAX_TABLELOG*4+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
  1285. { if (BIT_reloadDStream(&bitD) > BIT_DStream_unfinished) { op+=2; break; } }
  1286. op[2] = FSE_GETSYMBOL(&state1);
  1287. if (FSE_MAX_TABLELOG*2+7 > sizeof(bitD.bitContainer)*8) /* This test must be static */
  1288. BIT_reloadDStream(&bitD);
  1289. op[3] = FSE_GETSYMBOL(&state2);
  1290. }
  1291. /* tail */
  1292. /* note : BIT_reloadDStream(&bitD) >= FSE_DStream_partiallyFilled; Ends at exactly BIT_DStream_completed */
  1293. while (1)
  1294. {
  1295. if ( (BIT_reloadDStream(&bitD)>BIT_DStream_completed) || (op==omax) || (BIT_endOfDStream(&bitD) && (fast || FSE_endOfDState(&state1))) )
  1296. break;
  1297. *op++ = FSE_GETSYMBOL(&state1);
  1298. if ( (BIT_reloadDStream(&bitD)>BIT_DStream_completed) || (op==omax) || (BIT_endOfDStream(&bitD) && (fast || FSE_endOfDState(&state2))) )
  1299. break;
  1300. *op++ = FSE_GETSYMBOL(&state2);
  1301. }
  1302. /* end ? */
  1303. if (BIT_endOfDStream(&bitD) && FSE_endOfDState(&state1) && FSE_endOfDState(&state2))
  1304. return op-ostart;
  1305. if (op==omax) return ERROR(dstSize_tooSmall); /* dst buffer is full, but cSrc unfinished */
  1306. return ERROR(corruption_detected);
  1307. }
  1308. static size_t FSE_decompress_usingDTable(void* dst, size_t originalSize,
  1309. const void* cSrc, size_t cSrcSize,
  1310. const FSE_DTable* dt)
  1311. {
  1312. FSE_DTableHeader DTableH;
  1313. memcpy(&DTableH, dt, sizeof(DTableH));
  1314. /* select fast mode (static) */
  1315. if (DTableH.fastMode) return FSE_decompress_usingDTable_generic(dst, originalSize, cSrc, cSrcSize, dt, 1);
  1316. return FSE_decompress_usingDTable_generic(dst, originalSize, cSrc, cSrcSize, dt, 0);
  1317. }
  1318. static size_t FSE_decompress(void* dst, size_t maxDstSize, const void* cSrc, size_t cSrcSize)
  1319. {
  1320. const BYTE* const istart = (const BYTE*)cSrc;
  1321. const BYTE* ip = istart;
  1322. short counting[FSE_MAX_SYMBOL_VALUE+1];
  1323. DTable_max_t dt; /* Static analyzer seems unable to understand this table will be properly initialized later */
  1324. unsigned tableLog;
  1325. unsigned maxSymbolValue = FSE_MAX_SYMBOL_VALUE;
  1326. size_t errorCode;
  1327. if (cSrcSize<2) return ERROR(srcSize_wrong); /* too small input size */
  1328. /* normal FSE decoding mode */
  1329. errorCode = FSE_readNCount (counting, &maxSymbolValue, &tableLog, istart, cSrcSize);
  1330. if (FSE_isError(errorCode)) return errorCode;
  1331. if (errorCode >= cSrcSize) return ERROR(srcSize_wrong); /* too small input size */
  1332. ip += errorCode;
  1333. cSrcSize -= errorCode;
  1334. errorCode = FSE_buildDTable (dt, counting, maxSymbolValue, tableLog);
  1335. if (FSE_isError(errorCode)) return errorCode;
  1336. /* always return, even if it is an error code */
  1337. return FSE_decompress_usingDTable (dst, maxDstSize, ip, cSrcSize, dt);
  1338. }
  1339. #endif /* FSE_COMMONDEFS_ONLY */
  1340. /* ******************************************************************
  1341. Huff0 : Huffman coder, part of New Generation Entropy library
  1342. Copyright (C) 2013-2015, Yann Collet.
  1343. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  1344. Redistribution and use in source and binary forms, with or without
  1345. modification, are permitted provided that the following conditions are
  1346. met:
  1347. * Redistributions of source code must retain the above copyright
  1348. notice, this list of conditions and the following disclaimer.
  1349. * Redistributions in binary form must reproduce the above
  1350. copyright notice, this list of conditions and the following disclaimer
  1351. in the documentation and/or other materials provided with the
  1352. distribution.
  1353. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  1354. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  1355. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  1356. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  1357. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  1358. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  1359. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  1360. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  1361. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  1362. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  1363. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  1364. You can contact the author at :
  1365. - FSE+Huff0 source repository : https://github.com/Cyan4973/FiniteStateEntropy
  1366. - Public forum : https://groups.google.com/forum/#!forum/lz4c
  1367. ****************************************************************** */
  1368. /****************************************************************
  1369. * Compiler specifics
  1370. ****************************************************************/
  1371. #if defined (__cplusplus) || (defined (__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) /* C99 */)
  1372. /* inline is defined */
  1373. #elif defined(_MSC_VER)
  1374. # define inline __inline
  1375. #else
  1376. # define inline /* disable inline */
  1377. #endif
  1378. #ifdef _MSC_VER /* Visual Studio */
  1379. # define FORCE_INLINE static __forceinline
  1380. # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
  1381. #else
  1382. # ifdef __GNUC__
  1383. # define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
  1384. # define FORCE_INLINE static inline __attribute__((always_inline))
  1385. # else
  1386. # define FORCE_INLINE static inline
  1387. # endif
  1388. #endif
  1389. /****************************************************************
  1390. * Includes
  1391. ****************************************************************/
  1392. #include <stdlib.h> /* malloc, free, qsort */
  1393. #include <string.h> /* memcpy, memset */
  1394. #include <stdio.h> /* printf (debug) */
  1395. /****************************************************************
  1396. * Error Management
  1397. ****************************************************************/
  1398. #define HUF_STATIC_ASSERT(c) { enum { HUF_static_assert = 1/(int)(!!(c)) }; } /* use only *after* variable declarations */
  1399. /******************************************
  1400. * Helper functions
  1401. ******************************************/
  1402. static unsigned HUF_isError(size_t code) { return ERR_isError(code); }
  1403. #define HUF_ABSOLUTEMAX_TABLELOG 16 /* absolute limit of HUF_MAX_TABLELOG. Beyond that value, code does not work */
  1404. #define HUF_MAX_TABLELOG 12 /* max configured tableLog (for static allocation); can be modified up to HUF_ABSOLUTEMAX_TABLELOG */
  1405. #define HUF_DEFAULT_TABLELOG HUF_MAX_TABLELOG /* tableLog by default, when not specified */
  1406. #define HUF_MAX_SYMBOL_VALUE 255
  1407. #if (HUF_MAX_TABLELOG > HUF_ABSOLUTEMAX_TABLELOG)
  1408. # error "HUF_MAX_TABLELOG is too large !"
  1409. #endif
  1410. /*********************************************************
  1411. * Huff0 : Huffman block decompression
  1412. *********************************************************/
  1413. typedef struct { BYTE byte; BYTE nbBits; } HUF_DEltX2; /* single-symbol decoding */
  1414. typedef struct { U16 sequence; BYTE nbBits; BYTE length; } HUF_DEltX4; /* double-symbols decoding */
  1415. typedef struct { BYTE symbol; BYTE weight; } sortedSymbol_t;
  1416. /*! HUF_readStats
  1417. Read compact Huffman tree, saved by HUF_writeCTable
  1418. @huffWeight : destination buffer
  1419. @return : size read from `src`
  1420. */
  1421. static size_t HUF_readStats(BYTE* huffWeight, size_t hwSize, U32* rankStats,
  1422. U32* nbSymbolsPtr, U32* tableLogPtr,
  1423. const void* src, size_t srcSize)
  1424. {
  1425. U32 weightTotal;
  1426. U32 tableLog;
  1427. const BYTE* ip = (const BYTE*) src;
  1428. size_t iSize = ip[0];
  1429. size_t oSize;
  1430. U32 n;
  1431. //memset(huffWeight, 0, hwSize); /* is not necessary, even though some analyzer complain ... */
  1432. if (iSize >= 128) /* special header */
  1433. {
  1434. if (iSize >= (242)) /* RLE */
  1435. {
  1436. static int l[14] = { 1, 2, 3, 4, 7, 8, 15, 16, 31, 32, 63, 64, 127, 128 };
  1437. oSize = l[iSize-242];
  1438. memset(huffWeight, 1, hwSize);
  1439. iSize = 0;
  1440. }
  1441. else /* Incompressible */
  1442. {
  1443. oSize = iSize - 127;
  1444. iSize = ((oSize+1)/2);
  1445. if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
  1446. if (oSize >= hwSize) return ERROR(corruption_detected);
  1447. ip += 1;
  1448. for (n=0; n<oSize; n+=2)
  1449. {
  1450. huffWeight[n] = ip[n/2] >> 4;
  1451. huffWeight[n+1] = ip[n/2] & 15;
  1452. }
  1453. }
  1454. }
  1455. else /* header compressed with FSE (normal case) */
  1456. {
  1457. if (iSize+1 > srcSize) return ERROR(srcSize_wrong);
  1458. oSize = FSE_decompress(huffWeight, hwSize-1, ip+1, iSize); /* max (hwSize-1) values decoded, as last one is implied */
  1459. if (FSE_isError(oSize)) return oSize;
  1460. }
  1461. /* collect weight stats */
  1462. memset(rankStats, 0, (HUF_ABSOLUTEMAX_TABLELOG + 1) * sizeof(U32));
  1463. weightTotal = 0;
  1464. for (n=0; n<oSize; n++)
  1465. {
  1466. if (huffWeight[n] >= HUF_ABSOLUTEMAX_TABLELOG) return ERROR(corruption_detected);
  1467. rankStats[huffWeight[n]]++;
  1468. weightTotal += (1 << huffWeight[n]) >> 1;
  1469. }
  1470. /* get last non-null symbol weight (implied, total must be 2^n) */
  1471. tableLog = BIT_highbit32(weightTotal) + 1;
  1472. if (tableLog > HUF_ABSOLUTEMAX_TABLELOG) return ERROR(corruption_detected);
  1473. {
  1474. U32 total = 1 << tableLog;
  1475. U32 rest = total - weightTotal;
  1476. U32 verif = 1 << BIT_highbit32(rest);
  1477. U32 lastWeight = BIT_highbit32(rest) + 1;
  1478. if (verif != rest) return ERROR(corruption_detected); /* last value must be a clean power of 2 */
  1479. huffWeight[oSize] = (BYTE)lastWeight;
  1480. rankStats[lastWeight]++;
  1481. }
  1482. /* check tree construction validity */
  1483. if ((rankStats[1] < 2) || (rankStats[1] & 1)) return ERROR(corruption_detected); /* by construction : at least 2 elts of rank 1, must be even */
  1484. /* results */
  1485. *nbSymbolsPtr = (U32)(oSize+1);
  1486. *tableLogPtr = tableLog;
  1487. return iSize+1;
  1488. }
  1489. /**************************/
  1490. /* single-symbol decoding */
  1491. /**************************/
  1492. static size_t HUF_readDTableX2 (U16* DTable, const void* src, size_t srcSize)
  1493. {
  1494. BYTE huffWeight[HUF_MAX_SYMBOL_VALUE + 1];
  1495. U32 rankVal[HUF_ABSOLUTEMAX_TABLELOG + 1]; /* large enough for values from 0 to 16 */
  1496. U32 tableLog = 0;
  1497. const BYTE* ip = (const BYTE*) src;
  1498. size_t iSize = ip[0];
  1499. U32 nbSymbols = 0;
  1500. U32 n;
  1501. U32 nextRankStart;
  1502. void* ptr = DTable+1;
  1503. HUF_DEltX2* const dt = (HUF_DEltX2*)(ptr);
  1504. HUF_STATIC_ASSERT(sizeof(HUF_DEltX2) == sizeof(U16)); /* if compilation fails here, assertion is false */
  1505. //memset(huffWeight, 0, sizeof(huffWeight)); /* is not necessary, even though some analyzer complain ... */
  1506. iSize = HUF_readStats(huffWeight, HUF_MAX_SYMBOL_VALUE + 1, rankVal, &nbSymbols, &tableLog, src, srcSize);
  1507. if (HUF_isError(iSize)) return iSize;
  1508. /* check result */
  1509. if (tableLog > DTable[0]) return ERROR(tableLog_tooLarge); /* DTable is too small */
  1510. DTable[0] = (U16)tableLog; /* maybe should separate sizeof DTable, as allocated, from used size of DTable, in case of DTable re-use */
  1511. /* Prepare ranks */
  1512. nextRankStart = 0;
  1513. for (n=1; n<=tableLog; n++)
  1514. {
  1515. U32 current = nextRankStart;
  1516. nextRankStart += (rankVal[n] << (n-1));
  1517. rankVal[n] = current;
  1518. }
  1519. /* fill DTable */
  1520. for (n=0; n<nbSymbols; n++)
  1521. {
  1522. const U32 w = huffWeight[n];
  1523. const U32 length = (1 << w) >> 1;
  1524. U32 i;
  1525. HUF_DEltX2 D;
  1526. D.byte = (BYTE)n; D.nbBits = (BYTE)(tableLog + 1 - w);
  1527. for (i = rankVal[w]; i < rankVal[w] + length; i++)
  1528. dt[i] = D;
  1529. rankVal[w] += length;
  1530. }
  1531. return iSize;
  1532. }
  1533. static BYTE HUF_decodeSymbolX2(BIT_DStream_t* Dstream, const HUF_DEltX2* dt, const U32 dtLog)
  1534. {
  1535. const size_t val = BIT_lookBitsFast(Dstream, dtLog); /* note : dtLog >= 1 */
  1536. const BYTE c = dt[val].byte;
  1537. BIT_skipBits(Dstream, dt[val].nbBits);
  1538. return c;
  1539. }
  1540. #define HUF_DECODE_SYMBOLX2_0(ptr, DStreamPtr) \
  1541. *ptr++ = HUF_decodeSymbolX2(DStreamPtr, dt, dtLog)
  1542. #define HUF_DECODE_SYMBOLX2_1(ptr, DStreamPtr) \
  1543. if (MEM_64bits() || (HUF_MAX_TABLELOG<=12)) \
  1544. HUF_DECODE_SYMBOLX2_0(ptr, DStreamPtr)
  1545. #define HUF_DECODE_SYMBOLX2_2(ptr, DStreamPtr) \
  1546. if (MEM_64bits()) \
  1547. HUF_DECODE_SYMBOLX2_0(ptr, DStreamPtr)
  1548. static inline size_t HUF_decodeStreamX2(BYTE* p, BIT_DStream_t* const bitDPtr, BYTE* const pEnd, const HUF_DEltX2* const dt, const U32 dtLog)
  1549. {
  1550. BYTE* const pStart = p;
  1551. /* up to 4 symbols at a time */
  1552. while ((BIT_reloadDStream(bitDPtr) == BIT_DStream_unfinished) && (p <= pEnd-4))
  1553. {
  1554. HUF_DECODE_SYMBOLX2_2(p, bitDPtr);
  1555. HUF_DECODE_SYMBOLX2_1(p, bitDPtr);
  1556. HUF_DECODE_SYMBOLX2_2(p, bitDPtr);
  1557. HUF_DECODE_SYMBOLX2_0(p, bitDPtr);
  1558. }
  1559. /* closer to the end */
  1560. while ((BIT_reloadDStream(bitDPtr) == BIT_DStream_unfinished) && (p < pEnd))
  1561. HUF_DECODE_SYMBOLX2_0(p, bitDPtr);
  1562. /* no more data to retrieve from bitstream, hence no need to reload */
  1563. while (p < pEnd)
  1564. HUF_DECODE_SYMBOLX2_0(p, bitDPtr);
  1565. return pEnd-pStart;
  1566. }
  1567. static size_t HUF_decompress4X2_usingDTable(
  1568. void* dst, size_t dstSize,
  1569. const void* cSrc, size_t cSrcSize,
  1570. const U16* DTable)
  1571. {
  1572. if (cSrcSize < 10) return ERROR(corruption_detected); /* strict minimum : jump table + 1 byte per stream */
  1573. {
  1574. const BYTE* const istart = (const BYTE*) cSrc;
  1575. BYTE* const ostart = (BYTE*) dst;
  1576. BYTE* const oend = ostart + dstSize;
  1577. const void* ptr = DTable;
  1578. const HUF_DEltX2* const dt = ((const HUF_DEltX2*)ptr) +1;
  1579. const U32 dtLog = DTable[0];
  1580. size_t errorCode;
  1581. /* Init */
  1582. BIT_DStream_t bitD1;
  1583. BIT_DStream_t bitD2;
  1584. BIT_DStream_t bitD3;
  1585. BIT_DStream_t bitD4;
  1586. const size_t length1 = MEM_readLE16(istart);
  1587. const size_t length2 = MEM_readLE16(istart+2);
  1588. const size_t length3 = MEM_readLE16(istart+4);
  1589. size_t length4;
  1590. const BYTE* const istart1 = istart + 6; /* jumpTable */
  1591. const BYTE* const istart2 = istart1 + length1;
  1592. const BYTE* const istart3 = istart2 + length2;
  1593. const BYTE* const istart4 = istart3 + length3;
  1594. const size_t segmentSize = (dstSize+3) / 4;
  1595. BYTE* const opStart2 = ostart + segmentSize;
  1596. BYTE* const opStart3 = opStart2 + segmentSize;
  1597. BYTE* const opStart4 = opStart3 + segmentSize;
  1598. BYTE* op1 = ostart;
  1599. BYTE* op2 = opStart2;
  1600. BYTE* op3 = opStart3;
  1601. BYTE* op4 = opStart4;
  1602. U32 endSignal;
  1603. length4 = cSrcSize - (length1 + length2 + length3 + 6);
  1604. if (length4 > cSrcSize) return ERROR(corruption_detected); /* overflow */
  1605. errorCode = BIT_initDStream(&bitD1, istart1, length1);
  1606. if (HUF_isError(errorCode)) return errorCode;
  1607. errorCode = BIT_initDStream(&bitD2, istart2, length2);
  1608. if (HUF_isError(errorCode)) return errorCode;
  1609. errorCode = BIT_initDStream(&bitD3, istart3, length3);
  1610. if (HUF_isError(errorCode)) return errorCode;
  1611. errorCode = BIT_initDStream(&bitD4, istart4, length4);
  1612. if (HUF_isError(errorCode)) return errorCode;
  1613. /* 16-32 symbols per loop (4-8 symbols per stream) */
  1614. endSignal = BIT_reloadDStream(&bitD1) | BIT_reloadDStream(&bitD2) | BIT_reloadDStream(&bitD3) | BIT_reloadDStream(&bitD4);
  1615. for ( ; (endSignal==BIT_DStream_unfinished) && (op4<(oend-7)) ; )
  1616. {
  1617. HUF_DECODE_SYMBOLX2_2(op1, &bitD1);
  1618. HUF_DECODE_SYMBOLX2_2(op2, &bitD2);
  1619. HUF_DECODE_SYMBOLX2_2(op3, &bitD3);
  1620. HUF_DECODE_SYMBOLX2_2(op4, &bitD4);
  1621. HUF_DECODE_SYMBOLX2_1(op1, &bitD1);
  1622. HUF_DECODE_SYMBOLX2_1(op2, &bitD2);
  1623. HUF_DECODE_SYMBOLX2_1(op3, &bitD3);
  1624. HUF_DECODE_SYMBOLX2_1(op4, &bitD4);
  1625. HUF_DECODE_SYMBOLX2_2(op1, &bitD1);
  1626. HUF_DECODE_SYMBOLX2_2(op2, &bitD2);
  1627. HUF_DECODE_SYMBOLX2_2(op3, &bitD3);
  1628. HUF_DECODE_SYMBOLX2_2(op4, &bitD4);
  1629. HUF_DECODE_SYMBOLX2_0(op1, &bitD1);
  1630. HUF_DECODE_SYMBOLX2_0(op2, &bitD2);
  1631. HUF_DECODE_SYMBOLX2_0(op3, &bitD3);
  1632. HUF_DECODE_SYMBOLX2_0(op4, &bitD4);
  1633. endSignal = BIT_reloadDStream(&bitD1) | BIT_reloadDStream(&bitD2) | BIT_reloadDStream(&bitD3) | BIT_reloadDStream(&bitD4);
  1634. }
  1635. /* check corruption */
  1636. if (op1 > opStart2) return ERROR(corruption_detected);
  1637. if (op2 > opStart3) return ERROR(corruption_detected);
  1638. if (op3 > opStart4) return ERROR(corruption_detected);
  1639. /* note : op4 supposed already verified within main loop */
  1640. /* finish bitStreams one by one */
  1641. HUF_decodeStreamX2(op1, &bitD1, opStart2, dt, dtLog);
  1642. HUF_decodeStreamX2(op2, &bitD2, opStart3, dt, dtLog);
  1643. HUF_decodeStreamX2(op3, &bitD3, opStart4, dt, dtLog);
  1644. HUF_decodeStreamX2(op4, &bitD4, oend, dt, dtLog);
  1645. /* check */
  1646. endSignal = BIT_endOfDStream(&bitD1) & BIT_endOfDStream(&bitD2) & BIT_endOfDStream(&bitD3) & BIT_endOfDStream(&bitD4);
  1647. if (!endSignal) return ERROR(corruption_detected);
  1648. /* decoded size */
  1649. return dstSize;
  1650. }
  1651. }
  1652. static size_t HUF_decompress4X2 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
  1653. {
  1654. HUF_CREATE_STATIC_DTABLEX2(DTable, HUF_MAX_TABLELOG);
  1655. const BYTE* ip = (const BYTE*) cSrc;
  1656. size_t errorCode;
  1657. errorCode = HUF_readDTableX2 (DTable, cSrc, cSrcSize);
  1658. if (HUF_isError(errorCode)) return errorCode;
  1659. if (errorCode >= cSrcSize) return ERROR(srcSize_wrong);
  1660. ip += errorCode;
  1661. cSrcSize -= errorCode;
  1662. return HUF_decompress4X2_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
  1663. }
  1664. /***************************/
  1665. /* double-symbols decoding */
  1666. /***************************/
  1667. static void HUF_fillDTableX4Level2(HUF_DEltX4* DTable, U32 sizeLog, const U32 consumed,
  1668. const U32* rankValOrigin, const int minWeight,
  1669. const sortedSymbol_t* sortedSymbols, const U32 sortedListSize,
  1670. U32 nbBitsBaseline, U16 baseSeq)
  1671. {
  1672. HUF_DEltX4 DElt;
  1673. U32 rankVal[HUF_ABSOLUTEMAX_TABLELOG + 1];
  1674. U32 s;
  1675. /* get pre-calculated rankVal */
  1676. memcpy(rankVal, rankValOrigin, sizeof(rankVal));
  1677. /* fill skipped values */
  1678. if (minWeight>1)
  1679. {
  1680. U32 i, skipSize = rankVal[minWeight];
  1681. MEM_writeLE16(&(DElt.sequence), baseSeq);
  1682. DElt.nbBits = (BYTE)(consumed);
  1683. DElt.length = 1;
  1684. for (i = 0; i < skipSize; i++)
  1685. DTable[i] = DElt;
  1686. }
  1687. /* fill DTable */
  1688. for (s=0; s<sortedListSize; s++) /* note : sortedSymbols already skipped */
  1689. {
  1690. const U32 symbol = sortedSymbols[s].symbol;
  1691. const U32 weight = sortedSymbols[s].weight;
  1692. const U32 nbBits = nbBitsBaseline - weight;
  1693. const U32 length = 1 << (sizeLog-nbBits);
  1694. const U32 start = rankVal[weight];
  1695. U32 i = start;
  1696. const U32 end = start + length;
  1697. MEM_writeLE16(&(DElt.sequence), (U16)(baseSeq + (symbol << 8)));
  1698. DElt.nbBits = (BYTE)(nbBits + consumed);
  1699. DElt.length = 2;
  1700. do { DTable[i++] = DElt; } while (i<end); /* since length >= 1 */
  1701. rankVal[weight] += length;
  1702. }
  1703. }
  1704. typedef U32 rankVal_t[HUF_ABSOLUTEMAX_TABLELOG][HUF_ABSOLUTEMAX_TABLELOG + 1];
  1705. static void HUF_fillDTableX4(HUF_DEltX4* DTable, const U32 targetLog,
  1706. const sortedSymbol_t* sortedList, const U32 sortedListSize,
  1707. const U32* rankStart, rankVal_t rankValOrigin, const U32 maxWeight,
  1708. const U32 nbBitsBaseline)
  1709. {
  1710. U32 rankVal[HUF_ABSOLUTEMAX_TABLELOG + 1];
  1711. const int scaleLog = nbBitsBaseline - targetLog; /* note : targetLog >= srcLog, hence scaleLog <= 1 */
  1712. const U32 minBits = nbBitsBaseline - maxWeight;
  1713. U32 s;
  1714. memcpy(rankVal, rankValOrigin, sizeof(rankVal));
  1715. /* fill DTable */
  1716. for (s=0; s<sortedListSize; s++)
  1717. {
  1718. const U16 symbol = sortedList[s].symbol;
  1719. const U32 weight = sortedList[s].weight;
  1720. const U32 nbBits = nbBitsBaseline - weight;
  1721. const U32 start = rankVal[weight];
  1722. const U32 length = 1 << (targetLog-nbBits);
  1723. if (targetLog-nbBits >= minBits) /* enough room for a second symbol */
  1724. {
  1725. U32 sortedRank;
  1726. int minWeight = nbBits + scaleLog;
  1727. if (minWeight < 1) minWeight = 1;
  1728. sortedRank = rankStart[minWeight];
  1729. HUF_fillDTableX4Level2(DTable+start, targetLog-nbBits, nbBits,
  1730. rankValOrigin[nbBits], minWeight,
  1731. sortedList+sortedRank, sortedListSize-sortedRank,
  1732. nbBitsBaseline, symbol);
  1733. }
  1734. else
  1735. {
  1736. U32 i;
  1737. const U32 end = start + length;
  1738. HUF_DEltX4 DElt;
  1739. MEM_writeLE16(&(DElt.sequence), symbol);
  1740. DElt.nbBits = (BYTE)(nbBits);
  1741. DElt.length = 1;
  1742. for (i = start; i < end; i++)
  1743. DTable[i] = DElt;
  1744. }
  1745. rankVal[weight] += length;
  1746. }
  1747. }
  1748. static size_t HUF_readDTableX4 (U32* DTable, const void* src, size_t srcSize)
  1749. {
  1750. BYTE weightList[HUF_MAX_SYMBOL_VALUE + 1];
  1751. sortedSymbol_t sortedSymbol[HUF_MAX_SYMBOL_VALUE + 1];
  1752. U32 rankStats[HUF_ABSOLUTEMAX_TABLELOG + 1] = { 0 };
  1753. U32 rankStart0[HUF_ABSOLUTEMAX_TABLELOG + 2] = { 0 };
  1754. U32* const rankStart = rankStart0+1;
  1755. rankVal_t rankVal;
  1756. U32 tableLog, maxW, sizeOfSort, nbSymbols;
  1757. const U32 memLog = DTable[0];
  1758. const BYTE* ip = (const BYTE*) src;
  1759. size_t iSize = ip[0];
  1760. void* ptr = DTable;
  1761. HUF_DEltX4* const dt = ((HUF_DEltX4*)ptr) + 1;
  1762. HUF_STATIC_ASSERT(sizeof(HUF_DEltX4) == sizeof(U32)); /* if compilation fails here, assertion is false */
  1763. if (memLog > HUF_ABSOLUTEMAX_TABLELOG) return ERROR(tableLog_tooLarge);
  1764. //memset(weightList, 0, sizeof(weightList)); /* is not necessary, even though some analyzer complain ... */
  1765. iSize = HUF_readStats(weightList, HUF_MAX_SYMBOL_VALUE + 1, rankStats, &nbSymbols, &tableLog, src, srcSize);
  1766. if (HUF_isError(iSize)) return iSize;
  1767. /* check result */
  1768. if (tableLog > memLog) return ERROR(tableLog_tooLarge); /* DTable can't fit code depth */
  1769. /* find maxWeight */
  1770. for (maxW = tableLog; rankStats[maxW]==0; maxW--)
  1771. { if (!maxW) return ERROR(GENERIC); } /* necessarily finds a solution before maxW==0 */
  1772. /* Get start index of each weight */
  1773. {
  1774. U32 w, nextRankStart = 0;
  1775. for (w=1; w<=maxW; w++)
  1776. {
  1777. U32 current = nextRankStart;
  1778. nextRankStart += rankStats[w];
  1779. rankStart[w] = current;
  1780. }
  1781. rankStart[0] = nextRankStart; /* put all 0w symbols at the end of sorted list*/
  1782. sizeOfSort = nextRankStart;
  1783. }
  1784. /* sort symbols by weight */
  1785. {
  1786. U32 s;
  1787. for (s=0; s<nbSymbols; s++)
  1788. {
  1789. U32 w = weightList[s];
  1790. U32 r = rankStart[w]++;
  1791. sortedSymbol[r].symbol = (BYTE)s;
  1792. sortedSymbol[r].weight = (BYTE)w;
  1793. }
  1794. rankStart[0] = 0; /* forget 0w symbols; this is beginning of weight(1) */
  1795. }
  1796. /* Build rankVal */
  1797. {
  1798. const U32 minBits = tableLog+1 - maxW;
  1799. U32 nextRankVal = 0;
  1800. U32 w, consumed;
  1801. const int rescale = (memLog-tableLog) - 1; /* tableLog <= memLog */
  1802. U32* rankVal0 = rankVal[0];
  1803. for (w=1; w<=maxW; w++)
  1804. {
  1805. U32 current = nextRankVal;
  1806. nextRankVal += rankStats[w] << (w+rescale);
  1807. rankVal0[w] = current;
  1808. }
  1809. for (consumed = minBits; consumed <= memLog - minBits; consumed++)
  1810. {
  1811. U32* rankValPtr = rankVal[consumed];
  1812. for (w = 1; w <= maxW; w++)
  1813. {
  1814. rankValPtr[w] = rankVal0[w] >> consumed;
  1815. }
  1816. }
  1817. }
  1818. HUF_fillDTableX4(dt, memLog,
  1819. sortedSymbol, sizeOfSort,
  1820. rankStart0, rankVal, maxW,
  1821. tableLog+1);
  1822. return iSize;
  1823. }
  1824. static U32 HUF_decodeSymbolX4(void* op, BIT_DStream_t* DStream, const HUF_DEltX4* dt, const U32 dtLog)
  1825. {
  1826. const size_t val = BIT_lookBitsFast(DStream, dtLog); /* note : dtLog >= 1 */
  1827. memcpy(op, dt+val, 2);
  1828. BIT_skipBits(DStream, dt[val].nbBits);
  1829. return dt[val].length;
  1830. }
  1831. static U32 HUF_decodeLastSymbolX4(void* op, BIT_DStream_t* DStream, const HUF_DEltX4* dt, const U32 dtLog)
  1832. {
  1833. const size_t val = BIT_lookBitsFast(DStream, dtLog); /* note : dtLog >= 1 */
  1834. memcpy(op, dt+val, 1);
  1835. if (dt[val].length==1) BIT_skipBits(DStream, dt[val].nbBits);
  1836. else
  1837. {
  1838. if (DStream->bitsConsumed < (sizeof(DStream->bitContainer)*8))
  1839. {
  1840. BIT_skipBits(DStream, dt[val].nbBits);
  1841. if (DStream->bitsConsumed > (sizeof(DStream->bitContainer)*8))
  1842. DStream->bitsConsumed = (sizeof(DStream->bitContainer)*8); /* ugly hack; works only because it's the last symbol. Note : can't easily extract nbBits from just this symbol */
  1843. }
  1844. }
  1845. return 1;
  1846. }
  1847. #define HUF_DECODE_SYMBOLX4_0(ptr, DStreamPtr) \
  1848. ptr += HUF_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
  1849. #define HUF_DECODE_SYMBOLX4_1(ptr, DStreamPtr) \
  1850. if (MEM_64bits() || (HUF_MAX_TABLELOG<=12)) \
  1851. ptr += HUF_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
  1852. #define HUF_DECODE_SYMBOLX4_2(ptr, DStreamPtr) \
  1853. if (MEM_64bits()) \
  1854. ptr += HUF_decodeSymbolX4(ptr, DStreamPtr, dt, dtLog)
  1855. static inline size_t HUF_decodeStreamX4(BYTE* p, BIT_DStream_t* bitDPtr, BYTE* const pEnd, const HUF_DEltX4* const dt, const U32 dtLog)
  1856. {
  1857. BYTE* const pStart = p;
  1858. /* up to 8 symbols at a time */
  1859. while ((BIT_reloadDStream(bitDPtr) == BIT_DStream_unfinished) && (p < pEnd-7))
  1860. {
  1861. HUF_DECODE_SYMBOLX4_2(p, bitDPtr);
  1862. HUF_DECODE_SYMBOLX4_1(p, bitDPtr);
  1863. HUF_DECODE_SYMBOLX4_2(p, bitDPtr);
  1864. HUF_DECODE_SYMBOLX4_0(p, bitDPtr);
  1865. }
  1866. /* closer to the end */
  1867. while ((BIT_reloadDStream(bitDPtr) == BIT_DStream_unfinished) && (p <= pEnd-2))
  1868. HUF_DECODE_SYMBOLX4_0(p, bitDPtr);
  1869. while (p <= pEnd-2)
  1870. HUF_DECODE_SYMBOLX4_0(p, bitDPtr); /* no need to reload : reached the end of DStream */
  1871. if (p < pEnd)
  1872. p += HUF_decodeLastSymbolX4(p, bitDPtr, dt, dtLog);
  1873. return p-pStart;
  1874. }
  1875. static size_t HUF_decompress4X4_usingDTable(
  1876. void* dst, size_t dstSize,
  1877. const void* cSrc, size_t cSrcSize,
  1878. const U32* DTable)
  1879. {
  1880. if (cSrcSize < 10) return ERROR(corruption_detected); /* strict minimum : jump table + 1 byte per stream */
  1881. {
  1882. const BYTE* const istart = (const BYTE*) cSrc;
  1883. BYTE* const ostart = (BYTE*) dst;
  1884. BYTE* const oend = ostart + dstSize;
  1885. const void* ptr = DTable;
  1886. const HUF_DEltX4* const dt = ((const HUF_DEltX4*)ptr) +1;
  1887. const U32 dtLog = DTable[0];
  1888. size_t errorCode;
  1889. /* Init */
  1890. BIT_DStream_t bitD1;
  1891. BIT_DStream_t bitD2;
  1892. BIT_DStream_t bitD3;
  1893. BIT_DStream_t bitD4;
  1894. const size_t length1 = MEM_readLE16(istart);
  1895. const size_t length2 = MEM_readLE16(istart+2);
  1896. const size_t length3 = MEM_readLE16(istart+4);
  1897. size_t length4;
  1898. const BYTE* const istart1 = istart + 6; /* jumpTable */
  1899. const BYTE* const istart2 = istart1 + length1;
  1900. const BYTE* const istart3 = istart2 + length2;
  1901. const BYTE* const istart4 = istart3 + length3;
  1902. const size_t segmentSize = (dstSize+3) / 4;
  1903. BYTE* const opStart2 = ostart + segmentSize;
  1904. BYTE* const opStart3 = opStart2 + segmentSize;
  1905. BYTE* const opStart4 = opStart3 + segmentSize;
  1906. BYTE* op1 = ostart;
  1907. BYTE* op2 = opStart2;
  1908. BYTE* op3 = opStart3;
  1909. BYTE* op4 = opStart4;
  1910. U32 endSignal;
  1911. length4 = cSrcSize - (length1 + length2 + length3 + 6);
  1912. if (length4 > cSrcSize) return ERROR(corruption_detected); /* overflow */
  1913. errorCode = BIT_initDStream(&bitD1, istart1, length1);
  1914. if (HUF_isError(errorCode)) return errorCode;
  1915. errorCode = BIT_initDStream(&bitD2, istart2, length2);
  1916. if (HUF_isError(errorCode)) return errorCode;
  1917. errorCode = BIT_initDStream(&bitD3, istart3, length3);
  1918. if (HUF_isError(errorCode)) return errorCode;
  1919. errorCode = BIT_initDStream(&bitD4, istart4, length4);
  1920. if (HUF_isError(errorCode)) return errorCode;
  1921. /* 16-32 symbols per loop (4-8 symbols per stream) */
  1922. endSignal = BIT_reloadDStream(&bitD1) | BIT_reloadDStream(&bitD2) | BIT_reloadDStream(&bitD3) | BIT_reloadDStream(&bitD4);
  1923. for ( ; (endSignal==BIT_DStream_unfinished) && (op4<(oend-7)) ; )
  1924. {
  1925. HUF_DECODE_SYMBOLX4_2(op1, &bitD1);
  1926. HUF_DECODE_SYMBOLX4_2(op2, &bitD2);
  1927. HUF_DECODE_SYMBOLX4_2(op3, &bitD3);
  1928. HUF_DECODE_SYMBOLX4_2(op4, &bitD4);
  1929. HUF_DECODE_SYMBOLX4_1(op1, &bitD1);
  1930. HUF_DECODE_SYMBOLX4_1(op2, &bitD2);
  1931. HUF_DECODE_SYMBOLX4_1(op3, &bitD3);
  1932. HUF_DECODE_SYMBOLX4_1(op4, &bitD4);
  1933. HUF_DECODE_SYMBOLX4_2(op1, &bitD1);
  1934. HUF_DECODE_SYMBOLX4_2(op2, &bitD2);
  1935. HUF_DECODE_SYMBOLX4_2(op3, &bitD3);
  1936. HUF_DECODE_SYMBOLX4_2(op4, &bitD4);
  1937. HUF_DECODE_SYMBOLX4_0(op1, &bitD1);
  1938. HUF_DECODE_SYMBOLX4_0(op2, &bitD2);
  1939. HUF_DECODE_SYMBOLX4_0(op3, &bitD3);
  1940. HUF_DECODE_SYMBOLX4_0(op4, &bitD4);
  1941. endSignal = BIT_reloadDStream(&bitD1) | BIT_reloadDStream(&bitD2) | BIT_reloadDStream(&bitD3) | BIT_reloadDStream(&bitD4);
  1942. }
  1943. /* check corruption */
  1944. if (op1 > opStart2) return ERROR(corruption_detected);
  1945. if (op2 > opStart3) return ERROR(corruption_detected);
  1946. if (op3 > opStart4) return ERROR(corruption_detected);
  1947. /* note : op4 supposed already verified within main loop */
  1948. /* finish bitStreams one by one */
  1949. HUF_decodeStreamX4(op1, &bitD1, opStart2, dt, dtLog);
  1950. HUF_decodeStreamX4(op2, &bitD2, opStart3, dt, dtLog);
  1951. HUF_decodeStreamX4(op3, &bitD3, opStart4, dt, dtLog);
  1952. HUF_decodeStreamX4(op4, &bitD4, oend, dt, dtLog);
  1953. /* check */
  1954. endSignal = BIT_endOfDStream(&bitD1) & BIT_endOfDStream(&bitD2) & BIT_endOfDStream(&bitD3) & BIT_endOfDStream(&bitD4);
  1955. if (!endSignal) return ERROR(corruption_detected);
  1956. /* decoded size */
  1957. return dstSize;
  1958. }
  1959. }
  1960. static size_t HUF_decompress4X4 (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
  1961. {
  1962. HUF_CREATE_STATIC_DTABLEX4(DTable, HUF_MAX_TABLELOG);
  1963. const BYTE* ip = (const BYTE*) cSrc;
  1964. size_t hSize = HUF_readDTableX4 (DTable, cSrc, cSrcSize);
  1965. if (HUF_isError(hSize)) return hSize;
  1966. if (hSize >= cSrcSize) return ERROR(srcSize_wrong);
  1967. ip += hSize;
  1968. cSrcSize -= hSize;
  1969. return HUF_decompress4X4_usingDTable (dst, dstSize, ip, cSrcSize, DTable);
  1970. }
  1971. /**********************************/
  1972. /* Generic decompression selector */
  1973. /**********************************/
  1974. typedef struct { U32 tableTime; U32 decode256Time; } algo_time_t;
  1975. static const algo_time_t algoTime[16 /* Quantization */][3 /* single, double, quad */] =
  1976. {
  1977. /* single, double, quad */
  1978. {{0,0}, {1,1}, {2,2}}, /* Q==0 : impossible */
  1979. {{0,0}, {1,1}, {2,2}}, /* Q==1 : impossible */
  1980. {{ 38,130}, {1313, 74}, {2151, 38}}, /* Q == 2 : 12-18% */
  1981. {{ 448,128}, {1353, 74}, {2238, 41}}, /* Q == 3 : 18-25% */
  1982. {{ 556,128}, {1353, 74}, {2238, 47}}, /* Q == 4 : 25-32% */
  1983. {{ 714,128}, {1418, 74}, {2436, 53}}, /* Q == 5 : 32-38% */
  1984. {{ 883,128}, {1437, 74}, {2464, 61}}, /* Q == 6 : 38-44% */
  1985. {{ 897,128}, {1515, 75}, {2622, 68}}, /* Q == 7 : 44-50% */
  1986. {{ 926,128}, {1613, 75}, {2730, 75}}, /* Q == 8 : 50-56% */
  1987. {{ 947,128}, {1729, 77}, {3359, 77}}, /* Q == 9 : 56-62% */
  1988. {{1107,128}, {2083, 81}, {4006, 84}}, /* Q ==10 : 62-69% */
  1989. {{1177,128}, {2379, 87}, {4785, 88}}, /* Q ==11 : 69-75% */
  1990. {{1242,128}, {2415, 93}, {5155, 84}}, /* Q ==12 : 75-81% */
  1991. {{1349,128}, {2644,106}, {5260,106}}, /* Q ==13 : 81-87% */
  1992. {{1455,128}, {2422,124}, {4174,124}}, /* Q ==14 : 87-93% */
  1993. {{ 722,128}, {1891,145}, {1936,146}}, /* Q ==15 : 93-99% */
  1994. };
  1995. typedef size_t (*decompressionAlgo)(void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize);
  1996. static size_t HUF_decompress (void* dst, size_t dstSize, const void* cSrc, size_t cSrcSize)
  1997. {
  1998. static const decompressionAlgo decompress[3] = { HUF_decompress4X2, HUF_decompress4X4, NULL };
  1999. /* estimate decompression time */
  2000. U32 Q;
  2001. const U32 D256 = (U32)(dstSize >> 8);
  2002. U32 Dtime[3];
  2003. U32 algoNb = 0;
  2004. int n;
  2005. /* validation checks */
  2006. if (dstSize == 0) return ERROR(dstSize_tooSmall);
  2007. if (cSrcSize > dstSize) return ERROR(corruption_detected); /* invalid */
  2008. if (cSrcSize == dstSize) { memcpy(dst, cSrc, dstSize); return dstSize; } /* not compressed */
  2009. if (cSrcSize == 1) { memset(dst, *(const BYTE*)cSrc, dstSize); return dstSize; } /* RLE */
  2010. /* decoder timing evaluation */
  2011. Q = (U32)(cSrcSize * 16 / dstSize); /* Q < 16 since dstSize > cSrcSize */
  2012. for (n=0; n<3; n++)
  2013. Dtime[n] = algoTime[Q][n].tableTime + (algoTime[Q][n].decode256Time * D256);
  2014. Dtime[1] += Dtime[1] >> 4; Dtime[2] += Dtime[2] >> 3; /* advantage to algorithms using less memory, for cache eviction */
  2015. if (Dtime[1] < Dtime[0]) algoNb = 1;
  2016. return decompress[algoNb](dst, dstSize, cSrc, cSrcSize);
  2017. //return HUF_decompress4X2(dst, dstSize, cSrc, cSrcSize); /* multi-streams single-symbol decoding */
  2018. //return HUF_decompress4X4(dst, dstSize, cSrc, cSrcSize); /* multi-streams double-symbols decoding */
  2019. //return HUF_decompress4X6(dst, dstSize, cSrc, cSrcSize); /* multi-streams quad-symbols decoding */
  2020. }
  2021. /*
  2022. zstd - standard compression library
  2023. Copyright (C) 2014-2015, Yann Collet.
  2024. BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
  2025. Redistribution and use in source and binary forms, with or without
  2026. modification, are permitted provided that the following conditions are
  2027. met:
  2028. * Redistributions of source code must retain the above copyright
  2029. notice, this list of conditions and the following disclaimer.
  2030. * Redistributions in binary form must reproduce the above
  2031. copyright notice, this list of conditions and the following disclaimer
  2032. in the documentation and/or other materials provided with the
  2033. distribution.
  2034. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  2035. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  2036. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  2037. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  2038. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  2039. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  2040. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  2041. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  2042. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  2043. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  2044. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  2045. You can contact the author at :
  2046. - zstd source repository : https://github.com/Cyan4973/zstd
  2047. - ztsd public forum : https://groups.google.com/forum/#!forum/lz4c
  2048. */
  2049. /* ***************************************************************
  2050. * Tuning parameters
  2051. *****************************************************************/
  2052. /*!
  2053. * MEMORY_USAGE :
  2054. * Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
  2055. * Increasing memory usage improves compression ratio
  2056. * Reduced memory usage can improve speed, due to cache effect
  2057. */
  2058. #define ZSTD_MEMORY_USAGE 17
  2059. /*!
  2060. * HEAPMODE :
  2061. * Select how default compression functions will allocate memory for their hash table,
  2062. * in memory stack (0, fastest), or in memory heap (1, requires malloc())
  2063. * Note that compression context is fairly large, as a consequence heap memory is recommended.
  2064. */
  2065. #ifndef ZSTD_HEAPMODE
  2066. # define ZSTD_HEAPMODE 1
  2067. #endif /* ZSTD_HEAPMODE */
  2068. /*!
  2069. * LEGACY_SUPPORT :
  2070. * decompressor can decode older formats (starting from Zstd 0.1+)
  2071. */
  2072. #ifndef ZSTD_LEGACY_SUPPORT
  2073. # define ZSTD_LEGACY_SUPPORT 1
  2074. #endif
  2075. /* *******************************************************
  2076. * Includes
  2077. *********************************************************/
  2078. #include <stdlib.h> /* calloc */
  2079. #include <string.h> /* memcpy, memmove */
  2080. #include <stdio.h> /* debug : printf */
  2081. /* *******************************************************
  2082. * Compiler specifics
  2083. *********************************************************/
  2084. #ifdef __AVX2__
  2085. # include <immintrin.h> /* AVX2 intrinsics */
  2086. #endif
  2087. #ifdef _MSC_VER /* Visual Studio */
  2088. # define FORCE_INLINE static __forceinline
  2089. # include <intrin.h> /* For Visual 2005 */
  2090. # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
  2091. # pragma warning(disable : 4324) /* disable: C4324: padded structure */
  2092. #else
  2093. # define GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
  2094. # ifdef __GNUC__
  2095. # define FORCE_INLINE static inline __attribute__((always_inline))
  2096. # else
  2097. # define FORCE_INLINE static inline
  2098. # endif
  2099. #endif
  2100. /* *******************************************************
  2101. * Constants
  2102. *********************************************************/
  2103. #define HASH_LOG (ZSTD_MEMORY_USAGE - 2)
  2104. #define HASH_TABLESIZE (1 << HASH_LOG)
  2105. #define HASH_MASK (HASH_TABLESIZE - 1)
  2106. #define KNUTH 2654435761
  2107. #define BIT7 128
  2108. #define BIT6 64
  2109. #define BIT5 32
  2110. #define BIT4 16
  2111. #define BIT1 2
  2112. #define BIT0 1
  2113. #define KB *(1 <<10)
  2114. #define MB *(1 <<20)
  2115. #define GB *(1U<<30)
  2116. #define BLOCKSIZE (128 KB) /* define, for static allocation */
  2117. #define MIN_SEQUENCES_SIZE (2 /*seqNb*/ + 2 /*dumps*/ + 3 /*seqTables*/ + 1 /*bitStream*/)
  2118. #define MIN_CBLOCK_SIZE (3 /*litCSize*/ + MIN_SEQUENCES_SIZE)
  2119. #define IS_RAW BIT0
  2120. #define IS_RLE BIT1
  2121. #define WORKPLACESIZE (BLOCKSIZE*3)
  2122. #define MINMATCH 4
  2123. #define MLbits 7
  2124. #define LLbits 6
  2125. #define Offbits 5
  2126. #define MaxML ((1<<MLbits )-1)
  2127. #define MaxLL ((1<<LLbits )-1)
  2128. #define MaxOff 31
  2129. #define LitFSELog 11
  2130. #define MLFSELog 10
  2131. #define LLFSELog 10
  2132. #define OffFSELog 9
  2133. #define MAX(a,b) ((a)<(b)?(b):(a))
  2134. #define MaxSeq MAX(MaxLL, MaxML)
  2135. #define LITERAL_NOENTROPY 63
  2136. #define COMMAND_NOENTROPY 7 /* to remove */
  2137. static const size_t ZSTD_blockHeaderSize = 3;
  2138. static const size_t ZSTD_frameHeaderSize = 4;
  2139. /* *******************************************************
  2140. * Memory operations
  2141. **********************************************************/
  2142. static void ZSTD_copy4(void* dst, const void* src) { memcpy(dst, src, 4); }
  2143. static void ZSTD_copy8(void* dst, const void* src) { memcpy(dst, src, 8); }
  2144. #define COPY8(d,s) { ZSTD_copy8(d,s); d+=8; s+=8; }
  2145. /*! ZSTD_wildcopy : custom version of memcpy(), can copy up to 7-8 bytes too many */
  2146. static void ZSTD_wildcopy(void* dst, const void* src, size_t length)
  2147. {
  2148. const BYTE* ip = (const BYTE*)src;
  2149. BYTE* op = (BYTE*)dst;
  2150. BYTE* const oend = op + length;
  2151. do COPY8(op, ip) while (op < oend);
  2152. }
  2153. /* **************************************
  2154. * Local structures
  2155. ****************************************/
  2156. typedef enum { bt_compressed, bt_raw, bt_rle, bt_end } blockType_t;
  2157. typedef struct
  2158. {
  2159. blockType_t blockType;
  2160. U32 origSize;
  2161. } blockProperties_t;
  2162. typedef struct {
  2163. void* buffer;
  2164. U32* offsetStart;
  2165. U32* offset;
  2166. BYTE* offCodeStart;
  2167. BYTE* offCode;
  2168. BYTE* litStart;
  2169. BYTE* lit;
  2170. BYTE* litLengthStart;
  2171. BYTE* litLength;
  2172. BYTE* matchLengthStart;
  2173. BYTE* matchLength;
  2174. BYTE* dumpsStart;
  2175. BYTE* dumps;
  2176. } seqStore_t;
  2177. /* *************************************
  2178. * Error Management
  2179. ***************************************/
  2180. /*! ZSTD_isError
  2181. * tells if a return value is an error code */
  2182. static unsigned ZSTD_isError(size_t code) { return ERR_isError(code); }
  2183. /* *************************************
  2184. * Function body to include
  2185. ***************************************/
  2186. static size_t ZSTD_read_ARCH(const void* p) { size_t r; memcpy(&r, p, sizeof(r)); return r; }
  2187. MEM_STATIC unsigned ZSTD_NbCommonBytes (register size_t val)
  2188. {
  2189. if (MEM_isLittleEndian())
  2190. {
  2191. if (MEM_64bits())
  2192. {
  2193. # if defined(_MSC_VER) && defined(_WIN64) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2194. unsigned long r = 0;
  2195. _BitScanForward64( &r, (U64)val );
  2196. return (int)(r>>3);
  2197. # elif defined(__GNUC__) && (__GNUC__ >= 3) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2198. return (__builtin_ctzll((U64)val) >> 3);
  2199. # else
  2200. static const int DeBruijnBytePos[64] = { 0, 0, 0, 0, 0, 1, 1, 2, 0, 3, 1, 3, 1, 4, 2, 7, 0, 2, 3, 6, 1, 5, 3, 5, 1, 3, 4, 4, 2, 5, 6, 7, 7, 0, 1, 2, 3, 3, 4, 6, 2, 6, 5, 5, 3, 4, 5, 6, 7, 1, 2, 4, 6, 4, 4, 5, 7, 2, 6, 5, 7, 6, 7, 7 };
  2201. return DeBruijnBytePos[((U64)((val & -(long long)val) * 0x0218A392CDABBD3FULL)) >> 58];
  2202. # endif
  2203. }
  2204. else /* 32 bits */
  2205. {
  2206. # if defined(_MSC_VER) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2207. unsigned long r;
  2208. _BitScanForward( &r, (U32)val );
  2209. return (int)(r>>3);
  2210. # elif defined(__GNUC__) && (__GNUC__ >= 3) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2211. return (__builtin_ctz((U32)val) >> 3);
  2212. # else
  2213. static const int DeBruijnBytePos[32] = { 0, 0, 3, 0, 3, 1, 3, 0, 3, 2, 2, 1, 3, 2, 0, 1, 3, 3, 1, 2, 2, 2, 2, 0, 3, 1, 2, 0, 1, 0, 1, 1 };
  2214. return DeBruijnBytePos[((U32)((val & -(S32)val) * 0x077CB531U)) >> 27];
  2215. # endif
  2216. }
  2217. }
  2218. else /* Big Endian CPU */
  2219. {
  2220. if (MEM_32bits())
  2221. {
  2222. # if defined(_MSC_VER) && defined(_WIN64) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2223. unsigned long r = 0;
  2224. _BitScanReverse64( &r, val );
  2225. return (unsigned)(r>>3);
  2226. # elif defined(__GNUC__) && (__GNUC__ >= 3) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2227. return (__builtin_clzll(val) >> 3);
  2228. # else
  2229. unsigned r;
  2230. const unsigned n32 = sizeof(size_t)*4; /* calculate this way due to compiler complaining in 32-bits mode */
  2231. if (!(val>>n32)) { r=4; } else { r=0; val>>=n32; }
  2232. if (!(val>>16)) { r+=2; val>>=8; } else { val>>=24; }
  2233. r += (!val);
  2234. return r;
  2235. # endif
  2236. }
  2237. else /* 32 bits */
  2238. {
  2239. # if defined(_MSC_VER) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2240. unsigned long r = 0;
  2241. _BitScanReverse( &r, (unsigned long)val );
  2242. return (unsigned)(r>>3);
  2243. # elif defined(__GNUC__) && (__GNUC__ >= 3) && !defined(LZ4_FORCE_SW_BITCOUNT)
  2244. return (__builtin_clz((U32)val) >> 3);
  2245. # else
  2246. unsigned r;
  2247. if (!(val>>16)) { r=2; val>>=8; } else { r=0; val>>=24; }
  2248. r += (!val);
  2249. return r;
  2250. # endif
  2251. }
  2252. }
  2253. }
  2254. MEM_STATIC size_t ZSTD_count(const BYTE* pIn, const BYTE* pMatch, const BYTE* pInLimit)
  2255. {
  2256. const BYTE* const pStart = pIn;
  2257. while ((pIn<pInLimit-(sizeof(size_t)-1)))
  2258. {
  2259. size_t diff = ZSTD_read_ARCH(pMatch) ^ ZSTD_read_ARCH(pIn);
  2260. if (!diff) { pIn+=sizeof(size_t); pMatch+=sizeof(size_t); continue; }
  2261. pIn += ZSTD_NbCommonBytes(diff);
  2262. return (size_t)(pIn - pStart);
  2263. }
  2264. if (MEM_32bits()) if ((pIn<(pInLimit-3)) && (MEM_read32(pMatch) == MEM_read32(pIn))) { pIn+=4; pMatch+=4; }
  2265. if ((pIn<(pInLimit-1)) && (MEM_read16(pMatch) == MEM_read16(pIn))) { pIn+=2; pMatch+=2; }
  2266. if ((pIn<pInLimit) && (*pMatch == *pIn)) pIn++;
  2267. return (size_t)(pIn - pStart);
  2268. }
  2269. /* *************************************************************
  2270. * Decompression section
  2271. ***************************************************************/
  2272. struct ZSTD_DCtx_s
  2273. {
  2274. U32 LLTable[FSE_DTABLE_SIZE_U32(LLFSELog)];
  2275. U32 OffTable[FSE_DTABLE_SIZE_U32(OffFSELog)];
  2276. U32 MLTable[FSE_DTABLE_SIZE_U32(MLFSELog)];
  2277. void* previousDstEnd;
  2278. void* base;
  2279. size_t expected;
  2280. blockType_t bType;
  2281. U32 phase;
  2282. const BYTE* litPtr;
  2283. size_t litBufSize;
  2284. size_t litSize;
  2285. BYTE litBuffer[BLOCKSIZE + 8 /* margin for wildcopy */];
  2286. }; /* typedef'd to ZSTD_Dctx within "zstd_static.h" */
  2287. static size_t ZSTD_getcBlockSize(const void* src, size_t srcSize, blockProperties_t* bpPtr)
  2288. {
  2289. const BYTE* const in = (const BYTE* const)src;
  2290. BYTE headerFlags;
  2291. U32 cSize;
  2292. if (srcSize < 3) return ERROR(srcSize_wrong);
  2293. headerFlags = *in;
  2294. cSize = in[2] + (in[1]<<8) + ((in[0] & 7)<<16);
  2295. bpPtr->blockType = (blockType_t)(headerFlags >> 6);
  2296. bpPtr->origSize = (bpPtr->blockType == bt_rle) ? cSize : 0;
  2297. if (bpPtr->blockType == bt_end) return 0;
  2298. if (bpPtr->blockType == bt_rle) return 1;
  2299. return cSize;
  2300. }
  2301. static size_t ZSTD_copyUncompressedBlock(void* dst, size_t maxDstSize, const void* src, size_t srcSize)
  2302. {
  2303. if (srcSize > maxDstSize) return ERROR(dstSize_tooSmall);
  2304. memcpy(dst, src, srcSize);
  2305. return srcSize;
  2306. }
  2307. /** ZSTD_decompressLiterals
  2308. @return : nb of bytes read from src, or an error code*/
  2309. static size_t ZSTD_decompressLiterals(void* dst, size_t* maxDstSizePtr,
  2310. const void* src, size_t srcSize)
  2311. {
  2312. const BYTE* ip = (const BYTE*)src;
  2313. const size_t litSize = (MEM_readLE32(src) & 0x1FFFFF) >> 2; /* no buffer issue : srcSize >= MIN_CBLOCK_SIZE */
  2314. const size_t litCSize = (MEM_readLE32(ip+2) & 0xFFFFFF) >> 5; /* no buffer issue : srcSize >= MIN_CBLOCK_SIZE */
  2315. if (litSize > *maxDstSizePtr) return ERROR(corruption_detected);
  2316. if (litCSize + 5 > srcSize) return ERROR(corruption_detected);
  2317. if (HUF_isError(HUF_decompress(dst, litSize, ip+5, litCSize))) return ERROR(corruption_detected);
  2318. *maxDstSizePtr = litSize;
  2319. return litCSize + 5;
  2320. }
  2321. /** ZSTD_decodeLiteralsBlock
  2322. @return : nb of bytes read from src (< srcSize )*/
  2323. static size_t ZSTD_decodeLiteralsBlock(void* ctx,
  2324. const void* src, size_t srcSize)
  2325. {
  2326. ZSTD_DCtx* dctx = (ZSTD_DCtx*)ctx;
  2327. const BYTE* const istart = (const BYTE* const)src;
  2328. /* any compressed block with literals segment must be at least this size */
  2329. if (srcSize < MIN_CBLOCK_SIZE) return ERROR(corruption_detected);
  2330. switch(*istart & 3)
  2331. {
  2332. default:
  2333. case 0:
  2334. {
  2335. size_t litSize = BLOCKSIZE;
  2336. const size_t readSize = ZSTD_decompressLiterals(dctx->litBuffer, &litSize, src, srcSize);
  2337. dctx->litPtr = dctx->litBuffer;
  2338. dctx->litBufSize = BLOCKSIZE;
  2339. dctx->litSize = litSize;
  2340. return readSize; /* works if it's an error too */
  2341. }
  2342. case IS_RAW:
  2343. {
  2344. const size_t litSize = (MEM_readLE32(istart) & 0xFFFFFF) >> 2; /* no buffer issue : srcSize >= MIN_CBLOCK_SIZE */
  2345. if (litSize > srcSize-11) /* risk of reading too far with wildcopy */
  2346. {
  2347. if (litSize > srcSize-3) return ERROR(corruption_detected);
  2348. memcpy(dctx->litBuffer, istart, litSize);
  2349. dctx->litPtr = dctx->litBuffer;
  2350. dctx->litBufSize = BLOCKSIZE;
  2351. dctx->litSize = litSize;
  2352. return litSize+3;
  2353. }
  2354. /* direct reference into compressed stream */
  2355. dctx->litPtr = istart+3;
  2356. dctx->litBufSize = srcSize-3;
  2357. dctx->litSize = litSize;
  2358. return litSize+3;
  2359. }
  2360. case IS_RLE:
  2361. {
  2362. const size_t litSize = (MEM_readLE32(istart) & 0xFFFFFF) >> 2; /* no buffer issue : srcSize >= MIN_CBLOCK_SIZE */
  2363. if (litSize > BLOCKSIZE) return ERROR(corruption_detected);
  2364. memset(dctx->litBuffer, istart[3], litSize);
  2365. dctx->litPtr = dctx->litBuffer;
  2366. dctx->litBufSize = BLOCKSIZE;
  2367. dctx->litSize = litSize;
  2368. return 4;
  2369. }
  2370. }
  2371. }
  2372. static size_t ZSTD_decodeSeqHeaders(int* nbSeq, const BYTE** dumpsPtr, size_t* dumpsLengthPtr,
  2373. FSE_DTable* DTableLL, FSE_DTable* DTableML, FSE_DTable* DTableOffb,
  2374. const void* src, size_t srcSize)
  2375. {
  2376. const BYTE* const istart = (const BYTE* const)src;
  2377. const BYTE* ip = istart;
  2378. const BYTE* const iend = istart + srcSize;
  2379. U32 LLtype, Offtype, MLtype;
  2380. U32 LLlog, Offlog, MLlog;
  2381. size_t dumpsLength;
  2382. /* check */
  2383. if (srcSize < 5) return ERROR(srcSize_wrong);
  2384. /* SeqHead */
  2385. *nbSeq = MEM_readLE16(ip); ip+=2;
  2386. LLtype = *ip >> 6;
  2387. Offtype = (*ip >> 4) & 3;
  2388. MLtype = (*ip >> 2) & 3;
  2389. if (*ip & 2)
  2390. {
  2391. dumpsLength = ip[2];
  2392. dumpsLength += ip[1] << 8;
  2393. ip += 3;
  2394. }
  2395. else
  2396. {
  2397. dumpsLength = ip[1];
  2398. dumpsLength += (ip[0] & 1) << 8;
  2399. ip += 2;
  2400. }
  2401. *dumpsPtr = ip;
  2402. ip += dumpsLength;
  2403. *dumpsLengthPtr = dumpsLength;
  2404. /* check */
  2405. if (ip > iend-3) return ERROR(srcSize_wrong); /* min : all 3 are "raw", hence no header, but at least xxLog bits per type */
  2406. /* sequences */
  2407. {
  2408. S16 norm[MaxML+1]; /* assumption : MaxML >= MaxLL and MaxOff */
  2409. size_t headerSize;
  2410. /* Build DTables */
  2411. switch(LLtype)
  2412. {
  2413. U32 max;
  2414. case bt_rle :
  2415. LLlog = 0;
  2416. FSE_buildDTable_rle(DTableLL, *ip++); break;
  2417. case bt_raw :
  2418. LLlog = LLbits;
  2419. FSE_buildDTable_raw(DTableLL, LLbits); break;
  2420. default :
  2421. max = MaxLL;
  2422. headerSize = FSE_readNCount(norm, &max, &LLlog, ip, iend-ip);
  2423. if (FSE_isError(headerSize)) return ERROR(GENERIC);
  2424. if (LLlog > LLFSELog) return ERROR(corruption_detected);
  2425. ip += headerSize;
  2426. FSE_buildDTable(DTableLL, norm, max, LLlog);
  2427. }
  2428. switch(Offtype)
  2429. {
  2430. U32 max;
  2431. case bt_rle :
  2432. Offlog = 0;
  2433. if (ip > iend-2) return ERROR(srcSize_wrong); /* min : "raw", hence no header, but at least xxLog bits */
  2434. FSE_buildDTable_rle(DTableOffb, *ip++ & MaxOff); /* if *ip > MaxOff, data is corrupted */
  2435. break;
  2436. case bt_raw :
  2437. Offlog = Offbits;
  2438. FSE_buildDTable_raw(DTableOffb, Offbits); break;
  2439. default :
  2440. max = MaxOff;
  2441. headerSize = FSE_readNCount(norm, &max, &Offlog, ip, iend-ip);
  2442. if (FSE_isError(headerSize)) return ERROR(GENERIC);
  2443. if (Offlog > OffFSELog) return ERROR(corruption_detected);
  2444. ip += headerSize;
  2445. FSE_buildDTable(DTableOffb, norm, max, Offlog);
  2446. }
  2447. switch(MLtype)
  2448. {
  2449. U32 max;
  2450. case bt_rle :
  2451. MLlog = 0;
  2452. if (ip > iend-2) return ERROR(srcSize_wrong); /* min : "raw", hence no header, but at least xxLog bits */
  2453. FSE_buildDTable_rle(DTableML, *ip++); break;
  2454. case bt_raw :
  2455. MLlog = MLbits;
  2456. FSE_buildDTable_raw(DTableML, MLbits); break;
  2457. default :
  2458. max = MaxML;
  2459. headerSize = FSE_readNCount(norm, &max, &MLlog, ip, iend-ip);
  2460. if (FSE_isError(headerSize)) return ERROR(GENERIC);
  2461. if (MLlog > MLFSELog) return ERROR(corruption_detected);
  2462. ip += headerSize;
  2463. FSE_buildDTable(DTableML, norm, max, MLlog);
  2464. }
  2465. }
  2466. return ip-istart;
  2467. }
  2468. typedef struct {
  2469. size_t litLength;
  2470. size_t offset;
  2471. size_t matchLength;
  2472. } seq_t;
  2473. typedef struct {
  2474. BIT_DStream_t DStream;
  2475. FSE_DState_t stateLL;
  2476. FSE_DState_t stateOffb;
  2477. FSE_DState_t stateML;
  2478. size_t prevOffset;
  2479. const BYTE* dumps;
  2480. const BYTE* dumpsEnd;
  2481. } seqState_t;
  2482. static void ZSTD_decodeSequence(seq_t* seq, seqState_t* seqState)
  2483. {
  2484. size_t litLength;
  2485. size_t prevOffset;
  2486. size_t offset;
  2487. size_t matchLength;
  2488. const BYTE* dumps = seqState->dumps;
  2489. const BYTE* const de = seqState->dumpsEnd;
  2490. /* Literal length */
  2491. litLength = FSE_decodeSymbol(&(seqState->stateLL), &(seqState->DStream));
  2492. prevOffset = litLength ? seq->offset : seqState->prevOffset;
  2493. seqState->prevOffset = seq->offset;
  2494. if (litLength == MaxLL)
  2495. {
  2496. U32 add = *dumps++;
  2497. if (add < 255) litLength += add;
  2498. else
  2499. {
  2500. litLength = MEM_readLE32(dumps) & 0xFFFFFF; /* no pb : dumps is always followed by seq tables > 1 byte */
  2501. dumps += 3;
  2502. }
  2503. if (dumps >= de) dumps = de-1; /* late correction, to avoid read overflow (data is now corrupted anyway) */
  2504. }
  2505. /* Offset */
  2506. {
  2507. static const size_t offsetPrefix[MaxOff+1] = { /* note : size_t faster than U32 */
  2508. 1 /*fake*/, 1, 2, 4, 8, 16, 32, 64, 128, 256,
  2509. 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144,
  2510. 524288, 1048576, 2097152, 4194304, 8388608, 16777216, 33554432, /*fake*/ 1, 1, 1, 1, 1 };
  2511. U32 offsetCode, nbBits;
  2512. offsetCode = FSE_decodeSymbol(&(seqState->stateOffb), &(seqState->DStream)); /* <= maxOff, by table construction */
  2513. if (MEM_32bits()) BIT_reloadDStream(&(seqState->DStream));
  2514. nbBits = offsetCode - 1;
  2515. if (offsetCode==0) nbBits = 0; /* cmove */
  2516. offset = offsetPrefix[offsetCode] + BIT_readBits(&(seqState->DStream), nbBits);
  2517. if (MEM_32bits()) BIT_reloadDStream(&(seqState->DStream));
  2518. if (offsetCode==0) offset = prevOffset; /* cmove */
  2519. }
  2520. /* MatchLength */
  2521. matchLength = FSE_decodeSymbol(&(seqState->stateML), &(seqState->DStream));
  2522. if (matchLength == MaxML)
  2523. {
  2524. U32 add = *dumps++;
  2525. if (add < 255) matchLength += add;
  2526. else
  2527. {
  2528. matchLength = MEM_readLE32(dumps) & 0xFFFFFF; /* no pb : dumps is always followed by seq tables > 1 byte */
  2529. dumps += 3;
  2530. }
  2531. if (dumps >= de) dumps = de-1; /* late correction, to avoid read overflow (data is now corrupted anyway) */
  2532. }
  2533. matchLength += MINMATCH;
  2534. /* save result */
  2535. seq->litLength = litLength;
  2536. seq->offset = offset;
  2537. seq->matchLength = matchLength;
  2538. seqState->dumps = dumps;
  2539. }
  2540. static size_t ZSTD_execSequence(BYTE* op,
  2541. seq_t sequence,
  2542. const BYTE** litPtr, const BYTE* const litLimit,
  2543. BYTE* const base, BYTE* const oend)
  2544. {
  2545. static const int dec32table[] = {0, 1, 2, 1, 4, 4, 4, 4}; /* added */
  2546. static const int dec64table[] = {8, 8, 8, 7, 8, 9,10,11}; /* substracted */
  2547. const BYTE* const ostart = op;
  2548. BYTE* const oLitEnd = op + sequence.litLength;
  2549. BYTE* const oMatchEnd = op + sequence.litLength + sequence.matchLength; /* risk : address space overflow (32-bits) */
  2550. BYTE* const oend_8 = oend-8;
  2551. const BYTE* const litEnd = *litPtr + sequence.litLength;
  2552. /* checks */
  2553. if (oLitEnd > oend_8) return ERROR(dstSize_tooSmall); /* last match must start at a minimum distance of 8 from oend */
  2554. if (oMatchEnd > oend) return ERROR(dstSize_tooSmall); /* overwrite beyond dst buffer */
  2555. if (litEnd > litLimit-8) return ERROR(corruption_detected); /* overRead beyond lit buffer */
  2556. /* copy Literals */
  2557. ZSTD_wildcopy(op, *litPtr, sequence.litLength); /* note : oLitEnd <= oend-8 : no risk of overwrite beyond oend */
  2558. op = oLitEnd;
  2559. *litPtr = litEnd; /* update for next sequence */
  2560. /* copy Match */
  2561. {
  2562. const BYTE* match = op - sequence.offset;
  2563. /* check */
  2564. if (sequence.offset > (size_t)op) return ERROR(corruption_detected); /* address space overflow test (this test seems kept by clang optimizer) */
  2565. //if (match > op) return ERROR(corruption_detected); /* address space overflow test (is clang optimizer removing this test ?) */
  2566. if (match < base) return ERROR(corruption_detected);
  2567. /* close range match, overlap */
  2568. if (sequence.offset < 8)
  2569. {
  2570. const int dec64 = dec64table[sequence.offset];
  2571. op[0] = match[0];
  2572. op[1] = match[1];
  2573. op[2] = match[2];
  2574. op[3] = match[3];
  2575. match += dec32table[sequence.offset];
  2576. ZSTD_copy4(op+4, match);
  2577. match -= dec64;
  2578. }
  2579. else
  2580. {
  2581. ZSTD_copy8(op, match);
  2582. }
  2583. op += 8; match += 8;
  2584. if (oMatchEnd > oend-12)
  2585. {
  2586. if (op < oend_8)
  2587. {
  2588. ZSTD_wildcopy(op, match, oend_8 - op);
  2589. match += oend_8 - op;
  2590. op = oend_8;
  2591. }
  2592. while (op < oMatchEnd) *op++ = *match++;
  2593. }
  2594. else
  2595. {
  2596. ZSTD_wildcopy(op, match, sequence.matchLength-8); /* works even if matchLength < 8 */
  2597. }
  2598. }
  2599. return oMatchEnd - ostart;
  2600. }
  2601. static size_t ZSTD_decompressSequences(
  2602. void* ctx,
  2603. void* dst, size_t maxDstSize,
  2604. const void* seqStart, size_t seqSize)
  2605. {
  2606. ZSTD_DCtx* dctx = (ZSTD_DCtx*)ctx;
  2607. const BYTE* ip = (const BYTE*)seqStart;
  2608. const BYTE* const iend = ip + seqSize;
  2609. BYTE* const ostart = (BYTE* const)dst;
  2610. BYTE* op = ostart;
  2611. BYTE* const oend = ostart + maxDstSize;
  2612. size_t errorCode, dumpsLength;
  2613. const BYTE* litPtr = dctx->litPtr;
  2614. const BYTE* const litMax = litPtr + dctx->litBufSize;
  2615. const BYTE* const litEnd = litPtr + dctx->litSize;
  2616. int nbSeq;
  2617. const BYTE* dumps;
  2618. U32* DTableLL = dctx->LLTable;
  2619. U32* DTableML = dctx->MLTable;
  2620. U32* DTableOffb = dctx->OffTable;
  2621. BYTE* const base = (BYTE*) (dctx->base);
  2622. /* Build Decoding Tables */
  2623. errorCode = ZSTD_decodeSeqHeaders(&nbSeq, &dumps, &dumpsLength,
  2624. DTableLL, DTableML, DTableOffb,
  2625. ip, iend-ip);
  2626. if (ZSTD_isError(errorCode)) return errorCode;
  2627. ip += errorCode;
  2628. /* Regen sequences */
  2629. {
  2630. seq_t sequence;
  2631. seqState_t seqState;
  2632. memset(&sequence, 0, sizeof(sequence));
  2633. seqState.dumps = dumps;
  2634. seqState.dumpsEnd = dumps + dumpsLength;
  2635. seqState.prevOffset = sequence.offset = 4;
  2636. errorCode = BIT_initDStream(&(seqState.DStream), ip, iend-ip);
  2637. if (ERR_isError(errorCode)) return ERROR(corruption_detected);
  2638. FSE_initDState(&(seqState.stateLL), &(seqState.DStream), DTableLL);
  2639. FSE_initDState(&(seqState.stateOffb), &(seqState.DStream), DTableOffb);
  2640. FSE_initDState(&(seqState.stateML), &(seqState.DStream), DTableML);
  2641. for ( ; (BIT_reloadDStream(&(seqState.DStream)) <= BIT_DStream_completed) && (nbSeq>0) ; )
  2642. {
  2643. size_t oneSeqSize;
  2644. nbSeq--;
  2645. ZSTD_decodeSequence(&sequence, &seqState);
  2646. oneSeqSize = ZSTD_execSequence(op, sequence, &litPtr, litMax, base, oend);
  2647. if (ZSTD_isError(oneSeqSize)) return oneSeqSize;
  2648. op += oneSeqSize;
  2649. }
  2650. /* check if reached exact end */
  2651. if ( !BIT_endOfDStream(&(seqState.DStream)) ) return ERROR(corruption_detected); /* requested too much : data is corrupted */
  2652. if (nbSeq<0) return ERROR(corruption_detected); /* requested too many sequences : data is corrupted */
  2653. /* last literal segment */
  2654. {
  2655. size_t lastLLSize = litEnd - litPtr;
  2656. if (litPtr > litEnd) return ERROR(corruption_detected);
  2657. if (op+lastLLSize > oend) return ERROR(dstSize_tooSmall);
  2658. if (op != litPtr) memmove(op, litPtr, lastLLSize);
  2659. op += lastLLSize;
  2660. }
  2661. }
  2662. return op-ostart;
  2663. }
  2664. static size_t ZSTD_decompressBlock(
  2665. void* ctx,
  2666. void* dst, size_t maxDstSize,
  2667. const void* src, size_t srcSize)
  2668. {
  2669. /* blockType == blockCompressed */
  2670. const BYTE* ip = (const BYTE*)src;
  2671. /* Decode literals sub-block */
  2672. size_t litCSize = ZSTD_decodeLiteralsBlock(ctx, src, srcSize);
  2673. if (ZSTD_isError(litCSize)) return litCSize;
  2674. ip += litCSize;
  2675. srcSize -= litCSize;
  2676. return ZSTD_decompressSequences(ctx, dst, maxDstSize, ip, srcSize);
  2677. }
  2678. static size_t ZSTD_decompressDCtx(void* ctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize)
  2679. {
  2680. const BYTE* ip = (const BYTE*)src;
  2681. const BYTE* iend = ip + srcSize;
  2682. BYTE* const ostart = (BYTE* const)dst;
  2683. BYTE* op = ostart;
  2684. BYTE* const oend = ostart + maxDstSize;
  2685. size_t remainingSize = srcSize;
  2686. U32 magicNumber;
  2687. blockProperties_t blockProperties;
  2688. /* Frame Header */
  2689. if (srcSize < ZSTD_frameHeaderSize+ZSTD_blockHeaderSize) return ERROR(srcSize_wrong);
  2690. magicNumber = MEM_readLE32(src);
  2691. if (magicNumber != ZSTD_magicNumber) return ERROR(prefix_unknown);
  2692. ip += ZSTD_frameHeaderSize; remainingSize -= ZSTD_frameHeaderSize;
  2693. /* Loop on each block */
  2694. while (1)
  2695. {
  2696. size_t decodedSize=0;
  2697. size_t cBlockSize = ZSTD_getcBlockSize(ip, iend-ip, &blockProperties);
  2698. if (ZSTD_isError(cBlockSize)) return cBlockSize;
  2699. ip += ZSTD_blockHeaderSize;
  2700. remainingSize -= ZSTD_blockHeaderSize;
  2701. if (cBlockSize > remainingSize) return ERROR(srcSize_wrong);
  2702. switch(blockProperties.blockType)
  2703. {
  2704. case bt_compressed:
  2705. decodedSize = ZSTD_decompressBlock(ctx, op, oend-op, ip, cBlockSize);
  2706. break;
  2707. case bt_raw :
  2708. decodedSize = ZSTD_copyUncompressedBlock(op, oend-op, ip, cBlockSize);
  2709. break;
  2710. case bt_rle :
  2711. return ERROR(GENERIC); /* not yet supported */
  2712. break;
  2713. case bt_end :
  2714. /* end of frame */
  2715. if (remainingSize) return ERROR(srcSize_wrong);
  2716. break;
  2717. default:
  2718. return ERROR(GENERIC); /* impossible */
  2719. }
  2720. if (cBlockSize == 0) break; /* bt_end */
  2721. if (ZSTD_isError(decodedSize)) return decodedSize;
  2722. op += decodedSize;
  2723. ip += cBlockSize;
  2724. remainingSize -= cBlockSize;
  2725. }
  2726. return op-ostart;
  2727. }
  2728. static size_t ZSTD_decompress(void* dst, size_t maxDstSize, const void* src, size_t srcSize)
  2729. {
  2730. ZSTD_DCtx ctx;
  2731. ctx.base = dst;
  2732. return ZSTD_decompressDCtx(&ctx, dst, maxDstSize, src, srcSize);
  2733. }
  2734. /*******************************
  2735. * Streaming Decompression API
  2736. *******************************/
  2737. static size_t ZSTD_resetDCtx(ZSTD_DCtx* dctx)
  2738. {
  2739. dctx->expected = ZSTD_frameHeaderSize;
  2740. dctx->phase = 0;
  2741. dctx->previousDstEnd = NULL;
  2742. dctx->base = NULL;
  2743. return 0;
  2744. }
  2745. static ZSTD_DCtx* ZSTD_createDCtx(void)
  2746. {
  2747. ZSTD_DCtx* dctx = (ZSTD_DCtx*)malloc(sizeof(ZSTD_DCtx));
  2748. if (dctx==NULL) return NULL;
  2749. ZSTD_resetDCtx(dctx);
  2750. return dctx;
  2751. }
  2752. static size_t ZSTD_freeDCtx(ZSTD_DCtx* dctx)
  2753. {
  2754. free(dctx);
  2755. return 0;
  2756. }
  2757. static size_t ZSTD_nextSrcSizeToDecompress(ZSTD_DCtx* dctx)
  2758. {
  2759. return dctx->expected;
  2760. }
  2761. static size_t ZSTD_decompressContinue(ZSTD_DCtx* ctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize)
  2762. {
  2763. /* Sanity check */
  2764. if (srcSize != ctx->expected) return ERROR(srcSize_wrong);
  2765. if (dst != ctx->previousDstEnd) /* not contiguous */
  2766. ctx->base = dst;
  2767. /* Decompress : frame header */
  2768. if (ctx->phase == 0)
  2769. {
  2770. /* Check frame magic header */
  2771. U32 magicNumber = MEM_readLE32(src);
  2772. if (magicNumber != ZSTD_magicNumber) return ERROR(prefix_unknown);
  2773. ctx->phase = 1;
  2774. ctx->expected = ZSTD_blockHeaderSize;
  2775. return 0;
  2776. }
  2777. /* Decompress : block header */
  2778. if (ctx->phase == 1)
  2779. {
  2780. blockProperties_t bp;
  2781. size_t blockSize = ZSTD_getcBlockSize(src, ZSTD_blockHeaderSize, &bp);
  2782. if (ZSTD_isError(blockSize)) return blockSize;
  2783. if (bp.blockType == bt_end)
  2784. {
  2785. ctx->expected = 0;
  2786. ctx->phase = 0;
  2787. }
  2788. else
  2789. {
  2790. ctx->expected = blockSize;
  2791. ctx->bType = bp.blockType;
  2792. ctx->phase = 2;
  2793. }
  2794. return 0;
  2795. }
  2796. /* Decompress : block content */
  2797. {
  2798. size_t rSize;
  2799. switch(ctx->bType)
  2800. {
  2801. case bt_compressed:
  2802. rSize = ZSTD_decompressBlock(ctx, dst, maxDstSize, src, srcSize);
  2803. break;
  2804. case bt_raw :
  2805. rSize = ZSTD_copyUncompressedBlock(dst, maxDstSize, src, srcSize);
  2806. break;
  2807. case bt_rle :
  2808. return ERROR(GENERIC); /* not yet handled */
  2809. break;
  2810. case bt_end : /* should never happen (filtered at phase 1) */
  2811. rSize = 0;
  2812. break;
  2813. default:
  2814. return ERROR(GENERIC);
  2815. }
  2816. ctx->phase = 1;
  2817. ctx->expected = ZSTD_blockHeaderSize;
  2818. ctx->previousDstEnd = (void*)( ((char*)dst) + rSize);
  2819. return rSize;
  2820. }
  2821. }
  2822. /* wrapper layer */
  2823. unsigned ZSTDv03_isError(size_t code)
  2824. {
  2825. return ZSTD_isError(code);
  2826. }
  2827. size_t ZSTDv03_decompress( void* dst, size_t maxOriginalSize,
  2828. const void* src, size_t compressedSize)
  2829. {
  2830. return ZSTD_decompress(dst, maxOriginalSize, src, compressedSize);
  2831. }
  2832. ZSTDv03_Dctx* ZSTDv03_createDCtx(void)
  2833. {
  2834. return (ZSTDv03_Dctx*)ZSTD_createDCtx();
  2835. }
  2836. size_t ZSTDv03_freeDCtx(ZSTDv03_Dctx* dctx)
  2837. {
  2838. return ZSTD_freeDCtx((ZSTD_DCtx*)dctx);
  2839. }
  2840. size_t ZSTDv03_resetDCtx(ZSTDv03_Dctx* dctx)
  2841. {
  2842. return ZSTD_resetDCtx((ZSTD_DCtx*)dctx);
  2843. }
  2844. size_t ZSTDv03_nextSrcSizeToDecompress(ZSTDv03_Dctx* dctx)
  2845. {
  2846. return ZSTD_nextSrcSizeToDecompress((ZSTD_DCtx*)dctx);
  2847. }
  2848. size_t ZSTDv03_decompressContinue(ZSTDv03_Dctx* dctx, void* dst, size_t maxDstSize, const void* src, size_t srcSize)
  2849. {
  2850. return ZSTD_decompressContinue((ZSTD_DCtx*)dctx, dst, maxDstSize, src, srcSize);
  2851. }