isdn_bsdcomp.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. /*
  2. * BSD compression module
  3. *
  4. * Patched version for ISDN syncPPP written 1997/1998 by Michael Hipp
  5. * The whole module is now SKB based.
  6. *
  7. */
  8. /*
  9. * Update: The Berkeley copyright was changed, and the change
  10. * is retroactive to all "true" BSD software (ie everything
  11. * from UCB as opposed to other peoples code that just carried
  12. * the same license). The new copyright doesn't clash with the
  13. * GPL, so the module-only restriction has been removed..
  14. */
  15. /*
  16. * Original copyright notice:
  17. *
  18. * Copyright (c) 1985, 1986 The Regents of the University of California.
  19. * All rights reserved.
  20. *
  21. * This code is derived from software contributed to Berkeley by
  22. * James A. Woods, derived from original work by Spencer Thomas
  23. * and Joseph Orost.
  24. *
  25. * Redistribution and use in source and binary forms, with or without
  26. * modification, are permitted provided that the following conditions
  27. * are met:
  28. * 1. Redistributions of source code must retain the above copyright
  29. * notice, this list of conditions and the following disclaimer.
  30. * 2. Redistributions in binary form must reproduce the above copyright
  31. * notice, this list of conditions and the following disclaimer in the
  32. * documentation and/or other materials provided with the distribution.
  33. * 3. All advertising materials mentioning features or use of this software
  34. * must display the following acknowledgement:
  35. * This product includes software developed by the University of
  36. * California, Berkeley and its contributors.
  37. * 4. Neither the name of the University nor the names of its contributors
  38. * may be used to endorse or promote products derived from this software
  39. * without specific prior written permission.
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. */
  53. #include <linux/module.h>
  54. #include <linux/init.h>
  55. #include <linux/kernel.h>
  56. #include <linux/types.h>
  57. #include <linux/fcntl.h>
  58. #include <linux/interrupt.h>
  59. #include <linux/ptrace.h>
  60. #include <linux/ioport.h>
  61. #include <linux/in.h>
  62. #include <linux/slab.h>
  63. #include <linux/tty.h>
  64. #include <linux/errno.h>
  65. #include <linux/string.h> /* used in new tty drivers */
  66. #include <linux/signal.h> /* used in new tty drivers */
  67. #include <linux/bitops.h>
  68. #include <asm/byteorder.h>
  69. #include <asm/types.h>
  70. #include <linux/if.h>
  71. #include <linux/if_ether.h>
  72. #include <linux/netdevice.h>
  73. #include <linux/skbuff.h>
  74. #include <linux/inet.h>
  75. #include <linux/ioctl.h>
  76. #include <linux/vmalloc.h>
  77. #include <linux/ppp_defs.h>
  78. #include <linux/isdn.h>
  79. #include <linux/isdn_ppp.h>
  80. #include <linux/ip.h>
  81. #include <linux/tcp.h>
  82. #include <linux/if_arp.h>
  83. #include <linux/ppp-comp.h>
  84. #include "isdn_ppp.h"
  85. MODULE_DESCRIPTION("ISDN4Linux: BSD Compression for PPP over ISDN");
  86. MODULE_LICENSE("Dual BSD/GPL");
  87. #define BSD_VERSION(x) ((x) >> 5)
  88. #define BSD_NBITS(x) ((x) & 0x1F)
  89. #define BSD_CURRENT_VERSION 1
  90. #define DEBUG 1
  91. /*
  92. * A dictionary for doing BSD compress.
  93. */
  94. struct bsd_dict {
  95. u32 fcode;
  96. u16 codem1; /* output of hash table -1 */
  97. u16 cptr; /* map code to hash table entry */
  98. };
  99. struct bsd_db {
  100. int totlen; /* length of this structure */
  101. unsigned int hsize; /* size of the hash table */
  102. unsigned char hshift; /* used in hash function */
  103. unsigned char n_bits; /* current bits/code */
  104. unsigned char maxbits; /* maximum bits/code */
  105. unsigned char debug; /* non-zero if debug desired */
  106. unsigned char unit; /* ppp unit number */
  107. u16 seqno; /* sequence # of next packet */
  108. unsigned int mru; /* size of receive (decompress) bufr */
  109. unsigned int maxmaxcode; /* largest valid code */
  110. unsigned int max_ent; /* largest code in use */
  111. unsigned int in_count; /* uncompressed bytes, aged */
  112. unsigned int bytes_out; /* compressed bytes, aged */
  113. unsigned int ratio; /* recent compression ratio */
  114. unsigned int checkpoint; /* when to next check the ratio */
  115. unsigned int clear_count; /* times dictionary cleared */
  116. unsigned int incomp_count; /* incompressible packets */
  117. unsigned int incomp_bytes; /* incompressible bytes */
  118. unsigned int uncomp_count; /* uncompressed packets */
  119. unsigned int uncomp_bytes; /* uncompressed bytes */
  120. unsigned int comp_count; /* compressed packets */
  121. unsigned int comp_bytes; /* compressed bytes */
  122. unsigned short *lens; /* array of lengths of codes */
  123. struct bsd_dict *dict; /* dictionary */
  124. int xmit;
  125. };
  126. #define BSD_OVHD 2 /* BSD compress overhead/packet */
  127. #define MIN_BSD_BITS 9
  128. #define BSD_INIT_BITS MIN_BSD_BITS
  129. #define MAX_BSD_BITS 15
  130. /*
  131. * the next two codes should not be changed lightly, as they must not
  132. * lie within the contiguous general code space.
  133. */
  134. #define CLEAR 256 /* table clear output code */
  135. #define FIRST 257 /* first free entry */
  136. #define LAST 255
  137. #define MAXCODE(b) ((1 << (b)) - 1)
  138. #define BADCODEM1 MAXCODE(MAX_BSD_BITS)
  139. #define BSD_HASH(prefix, suffix, hshift) ((((unsigned long)(suffix)) << (hshift)) \
  140. ^ (unsigned long)(prefix))
  141. #define BSD_KEY(prefix, suffix) ((((unsigned long)(suffix)) << 16) \
  142. + (unsigned long)(prefix))
  143. #define CHECK_GAP 10000 /* Ratio check interval */
  144. #define RATIO_SCALE_LOG 8
  145. #define RATIO_SCALE (1 << RATIO_SCALE_LOG)
  146. #define RATIO_MAX (0x7fffffff >> RATIO_SCALE_LOG)
  147. /*
  148. * clear the dictionary
  149. */
  150. static void bsd_clear(struct bsd_db *db)
  151. {
  152. db->clear_count++;
  153. db->max_ent = FIRST - 1;
  154. db->n_bits = BSD_INIT_BITS;
  155. db->bytes_out = 0;
  156. db->in_count = 0;
  157. db->incomp_count = 0;
  158. db->ratio = 0;
  159. db->checkpoint = CHECK_GAP;
  160. }
  161. /*
  162. * If the dictionary is full, then see if it is time to reset it.
  163. *
  164. * Compute the compression ratio using fixed-point arithmetic
  165. * with 8 fractional bits.
  166. *
  167. * Since we have an infinite stream instead of a single file,
  168. * watch only the local compression ratio.
  169. *
  170. * Since both peers must reset the dictionary at the same time even in
  171. * the absence of CLEAR codes (while packets are incompressible), they
  172. * must compute the same ratio.
  173. */
  174. static int bsd_check(struct bsd_db *db) /* 1=output CLEAR */
  175. {
  176. unsigned int new_ratio;
  177. if (db->in_count >= db->checkpoint)
  178. {
  179. /* age the ratio by limiting the size of the counts */
  180. if (db->in_count >= RATIO_MAX || db->bytes_out >= RATIO_MAX)
  181. {
  182. db->in_count -= (db->in_count >> 2);
  183. db->bytes_out -= (db->bytes_out >> 2);
  184. }
  185. db->checkpoint = db->in_count + CHECK_GAP;
  186. if (db->max_ent >= db->maxmaxcode)
  187. {
  188. /* Reset the dictionary only if the ratio is worse,
  189. * or if it looks as if it has been poisoned
  190. * by incompressible data.
  191. *
  192. * This does not overflow, because
  193. * db->in_count <= RATIO_MAX.
  194. */
  195. new_ratio = db->in_count << RATIO_SCALE_LOG;
  196. if (db->bytes_out != 0)
  197. {
  198. new_ratio /= db->bytes_out;
  199. }
  200. if (new_ratio < db->ratio || new_ratio < 1 * RATIO_SCALE)
  201. {
  202. bsd_clear(db);
  203. return 1;
  204. }
  205. db->ratio = new_ratio;
  206. }
  207. }
  208. return 0;
  209. }
  210. /*
  211. * Return statistics.
  212. */
  213. static void bsd_stats(void *state, struct compstat *stats)
  214. {
  215. struct bsd_db *db = (struct bsd_db *) state;
  216. stats->unc_bytes = db->uncomp_bytes;
  217. stats->unc_packets = db->uncomp_count;
  218. stats->comp_bytes = db->comp_bytes;
  219. stats->comp_packets = db->comp_count;
  220. stats->inc_bytes = db->incomp_bytes;
  221. stats->inc_packets = db->incomp_count;
  222. stats->in_count = db->in_count;
  223. stats->bytes_out = db->bytes_out;
  224. }
  225. /*
  226. * Reset state, as on a CCP ResetReq.
  227. */
  228. static void bsd_reset(void *state, unsigned char code, unsigned char id,
  229. unsigned char *data, unsigned len,
  230. struct isdn_ppp_resetparams *rsparm)
  231. {
  232. struct bsd_db *db = (struct bsd_db *) state;
  233. bsd_clear(db);
  234. db->seqno = 0;
  235. db->clear_count = 0;
  236. }
  237. /*
  238. * Release the compression structure
  239. */
  240. static void bsd_free(void *state)
  241. {
  242. struct bsd_db *db = (struct bsd_db *) state;
  243. if (db) {
  244. /*
  245. * Release the dictionary
  246. */
  247. vfree(db->dict);
  248. db->dict = NULL;
  249. /*
  250. * Release the string buffer
  251. */
  252. vfree(db->lens);
  253. db->lens = NULL;
  254. /*
  255. * Finally release the structure itself.
  256. */
  257. kfree(db);
  258. }
  259. }
  260. /*
  261. * Allocate space for a (de) compressor.
  262. */
  263. static void *bsd_alloc(struct isdn_ppp_comp_data *data)
  264. {
  265. int bits;
  266. unsigned int hsize, hshift, maxmaxcode;
  267. struct bsd_db *db;
  268. int decomp;
  269. static unsigned int htab[][2] = {
  270. { 5003 , 4 } , { 5003 , 4 } , { 5003 , 4 } , { 5003 , 4 } ,
  271. { 9001 , 5 } , { 18013 , 6 } , { 35023 , 7 } , { 69001 , 8 }
  272. };
  273. if (data->optlen != 1 || data->num != CI_BSD_COMPRESS
  274. || BSD_VERSION(data->options[0]) != BSD_CURRENT_VERSION)
  275. return NULL;
  276. bits = BSD_NBITS(data->options[0]);
  277. if (bits < 9 || bits > 15)
  278. return NULL;
  279. hsize = htab[bits - 9][0];
  280. hshift = htab[bits - 9][1];
  281. /*
  282. * Allocate the main control structure for this instance.
  283. */
  284. maxmaxcode = MAXCODE(bits);
  285. db = kzalloc(sizeof(struct bsd_db), GFP_KERNEL);
  286. if (!db)
  287. return NULL;
  288. db->xmit = data->flags & IPPP_COMP_FLAG_XMIT;
  289. decomp = db->xmit ? 0 : 1;
  290. /*
  291. * Allocate space for the dictionary. This may be more than one page in
  292. * length.
  293. */
  294. db->dict = vmalloc(array_size(hsize, sizeof(struct bsd_dict)));
  295. if (!db->dict) {
  296. bsd_free(db);
  297. return NULL;
  298. }
  299. /*
  300. * If this is the compression buffer then there is no length data.
  301. * For decompression, the length information is needed as well.
  302. */
  303. if (!decomp)
  304. db->lens = NULL;
  305. else {
  306. db->lens = vmalloc(array_size(sizeof(db->lens[0]),
  307. maxmaxcode + 1));
  308. if (!db->lens) {
  309. bsd_free(db);
  310. return (NULL);
  311. }
  312. }
  313. /*
  314. * Initialize the data information for the compression code
  315. */
  316. db->totlen = sizeof(struct bsd_db) + (sizeof(struct bsd_dict) * hsize);
  317. db->hsize = hsize;
  318. db->hshift = hshift;
  319. db->maxmaxcode = maxmaxcode;
  320. db->maxbits = bits;
  321. return (void *)db;
  322. }
  323. /*
  324. * Initialize the database.
  325. */
  326. static int bsd_init(void *state, struct isdn_ppp_comp_data *data, int unit, int debug)
  327. {
  328. struct bsd_db *db = state;
  329. int indx;
  330. int decomp;
  331. if (!state || !data) {
  332. printk(KERN_ERR "isdn_bsd_init: [%d] ERR, state %lx data %lx\n", unit, (long)state, (long)data);
  333. return 0;
  334. }
  335. decomp = db->xmit ? 0 : 1;
  336. if (data->optlen != 1 || data->num != CI_BSD_COMPRESS
  337. || (BSD_VERSION(data->options[0]) != BSD_CURRENT_VERSION)
  338. || (BSD_NBITS(data->options[0]) != db->maxbits)
  339. || (decomp && db->lens == NULL)) {
  340. printk(KERN_ERR "isdn_bsd: %d %d %d %d %lx\n", data->optlen, data->num, data->options[0], decomp, (unsigned long)db->lens);
  341. return 0;
  342. }
  343. if (decomp)
  344. for (indx = LAST; indx >= 0; indx--)
  345. db->lens[indx] = 1;
  346. indx = db->hsize;
  347. while (indx-- != 0) {
  348. db->dict[indx].codem1 = BADCODEM1;
  349. db->dict[indx].cptr = 0;
  350. }
  351. db->unit = unit;
  352. db->mru = 0;
  353. db->debug = 1;
  354. bsd_reset(db, 0, 0, NULL, 0, NULL);
  355. return 1;
  356. }
  357. /*
  358. * Obtain pointers to the various structures in the compression tables
  359. */
  360. #define dict_ptrx(p, idx) &(p->dict[idx])
  361. #define lens_ptrx(p, idx) &(p->lens[idx])
  362. #ifdef DEBUG
  363. static unsigned short *lens_ptr(struct bsd_db *db, int idx)
  364. {
  365. if ((unsigned int) idx > (unsigned int) db->maxmaxcode) {
  366. printk(KERN_DEBUG "<9>ppp: lens_ptr(%d) > max\n", idx);
  367. idx = 0;
  368. }
  369. return lens_ptrx(db, idx);
  370. }
  371. static struct bsd_dict *dict_ptr(struct bsd_db *db, int idx)
  372. {
  373. if ((unsigned int) idx >= (unsigned int) db->hsize) {
  374. printk(KERN_DEBUG "<9>ppp: dict_ptr(%d) > max\n", idx);
  375. idx = 0;
  376. }
  377. return dict_ptrx(db, idx);
  378. }
  379. #else
  380. #define lens_ptr(db, idx) lens_ptrx(db, idx)
  381. #define dict_ptr(db, idx) dict_ptrx(db, idx)
  382. #endif
  383. /*
  384. * compress a packet
  385. */
  386. static int bsd_compress(void *state, struct sk_buff *skb_in, struct sk_buff *skb_out, int proto)
  387. {
  388. struct bsd_db *db;
  389. int hshift;
  390. unsigned int max_ent;
  391. unsigned int n_bits;
  392. unsigned int bitno;
  393. unsigned long accm;
  394. int ent;
  395. unsigned long fcode;
  396. struct bsd_dict *dictp;
  397. unsigned char c;
  398. int hval, disp, ilen, mxcode;
  399. unsigned char *rptr = skb_in->data;
  400. int isize = skb_in->len;
  401. #define OUTPUT(ent) \
  402. { \
  403. bitno -= n_bits; \
  404. accm |= ((ent) << bitno); \
  405. do { \
  406. if (skb_out && skb_tailroom(skb_out) > 0) \
  407. skb_put_u8(skb_out, (u8)(accm >> 24)); \
  408. accm <<= 8; \
  409. bitno += 8; \
  410. } while (bitno <= 24); \
  411. }
  412. /*
  413. * If the protocol is not in the range we're interested in,
  414. * just return without compressing the packet. If it is,
  415. * the protocol becomes the first byte to compress.
  416. */
  417. printk(KERN_DEBUG "bsd_compress called with %x\n", proto);
  418. ent = proto;
  419. if (proto < 0x21 || proto > 0xf9 || !(proto & 0x1))
  420. return 0;
  421. db = (struct bsd_db *) state;
  422. hshift = db->hshift;
  423. max_ent = db->max_ent;
  424. n_bits = db->n_bits;
  425. bitno = 32;
  426. accm = 0;
  427. mxcode = MAXCODE(n_bits);
  428. /* This is the PPP header information */
  429. if (skb_out && skb_tailroom(skb_out) >= 2) {
  430. char *v = skb_put(skb_out, 2);
  431. /* we only push our own data on the header,
  432. AC,PC and protos is pushed by caller */
  433. v[0] = db->seqno >> 8;
  434. v[1] = db->seqno;
  435. }
  436. ilen = ++isize; /* This is off by one, but that is what is in draft! */
  437. while (--ilen > 0) {
  438. c = *rptr++;
  439. fcode = BSD_KEY(ent, c);
  440. hval = BSD_HASH(ent, c, hshift);
  441. dictp = dict_ptr(db, hval);
  442. /* Validate and then check the entry. */
  443. if (dictp->codem1 >= max_ent)
  444. goto nomatch;
  445. if (dictp->fcode == fcode) {
  446. ent = dictp->codem1 + 1;
  447. continue; /* found (prefix,suffix) */
  448. }
  449. /* continue probing until a match or invalid entry */
  450. disp = (hval == 0) ? 1 : hval;
  451. do {
  452. hval += disp;
  453. if (hval >= db->hsize)
  454. hval -= db->hsize;
  455. dictp = dict_ptr(db, hval);
  456. if (dictp->codem1 >= max_ent)
  457. goto nomatch;
  458. } while (dictp->fcode != fcode);
  459. ent = dictp->codem1 + 1; /* finally found (prefix,suffix) */
  460. continue;
  461. nomatch:
  462. OUTPUT(ent); /* output the prefix */
  463. /* code -> hashtable */
  464. if (max_ent < db->maxmaxcode) {
  465. struct bsd_dict *dictp2;
  466. struct bsd_dict *dictp3;
  467. int indx;
  468. /* expand code size if needed */
  469. if (max_ent >= mxcode) {
  470. db->n_bits = ++n_bits;
  471. mxcode = MAXCODE(n_bits);
  472. }
  473. /*
  474. * Invalidate old hash table entry using
  475. * this code, and then take it over.
  476. */
  477. dictp2 = dict_ptr(db, max_ent + 1);
  478. indx = dictp2->cptr;
  479. dictp3 = dict_ptr(db, indx);
  480. if (dictp3->codem1 == max_ent)
  481. dictp3->codem1 = BADCODEM1;
  482. dictp2->cptr = hval;
  483. dictp->codem1 = max_ent;
  484. dictp->fcode = fcode;
  485. db->max_ent = ++max_ent;
  486. if (db->lens) {
  487. unsigned short *len1 = lens_ptr(db, max_ent);
  488. unsigned short *len2 = lens_ptr(db, ent);
  489. *len1 = *len2 + 1;
  490. }
  491. }
  492. ent = c;
  493. }
  494. OUTPUT(ent); /* output the last code */
  495. if (skb_out)
  496. db->bytes_out += skb_out->len; /* Do not count bytes from here */
  497. db->uncomp_bytes += isize;
  498. db->in_count += isize;
  499. ++db->uncomp_count;
  500. ++db->seqno;
  501. if (bitno < 32)
  502. ++db->bytes_out; /* must be set before calling bsd_check */
  503. /*
  504. * Generate the clear command if needed
  505. */
  506. if (bsd_check(db))
  507. OUTPUT(CLEAR);
  508. /*
  509. * Pad dribble bits of last code with ones.
  510. * Do not emit a completely useless byte of ones.
  511. */
  512. if (bitno < 32 && skb_out && skb_tailroom(skb_out) > 0)
  513. skb_put_u8(skb_out,
  514. (unsigned char)((accm | (0xff << (bitno - 8))) >> 24));
  515. /*
  516. * Increase code size if we would have without the packet
  517. * boundary because the decompressor will do so.
  518. */
  519. if (max_ent >= mxcode && max_ent < db->maxmaxcode)
  520. db->n_bits++;
  521. /* If output length is too large then this is an incompressible frame. */
  522. if (!skb_out || skb_out->len >= skb_in->len) {
  523. ++db->incomp_count;
  524. db->incomp_bytes += isize;
  525. return 0;
  526. }
  527. /* Count the number of compressed frames */
  528. ++db->comp_count;
  529. db->comp_bytes += skb_out->len;
  530. return skb_out->len;
  531. #undef OUTPUT
  532. }
  533. /*
  534. * Update the "BSD Compress" dictionary on the receiver for
  535. * incompressible data by pretending to compress the incoming data.
  536. */
  537. static void bsd_incomp(void *state, struct sk_buff *skb_in, int proto)
  538. {
  539. bsd_compress(state, skb_in, NULL, proto);
  540. }
  541. /*
  542. * Decompress "BSD Compress".
  543. */
  544. static int bsd_decompress(void *state, struct sk_buff *skb_in, struct sk_buff *skb_out,
  545. struct isdn_ppp_resetparams *rsparm)
  546. {
  547. struct bsd_db *db;
  548. unsigned int max_ent;
  549. unsigned long accm;
  550. unsigned int bitno; /* 1st valid bit in accm */
  551. unsigned int n_bits;
  552. unsigned int tgtbitno; /* bitno when we have a code */
  553. struct bsd_dict *dictp;
  554. int seq;
  555. unsigned int incode;
  556. unsigned int oldcode;
  557. unsigned int finchar;
  558. unsigned char *p, *ibuf;
  559. int ilen;
  560. int codelen;
  561. int extra;
  562. db = (struct bsd_db *) state;
  563. max_ent = db->max_ent;
  564. accm = 0;
  565. bitno = 32; /* 1st valid bit in accm */
  566. n_bits = db->n_bits;
  567. tgtbitno = 32 - n_bits; /* bitno when we have a code */
  568. printk(KERN_DEBUG "bsd_decompress called\n");
  569. if (!skb_in || !skb_out) {
  570. printk(KERN_ERR "bsd_decompress called with NULL parameter\n");
  571. return DECOMP_ERROR;
  572. }
  573. /*
  574. * Get the sequence number.
  575. */
  576. if ((p = skb_pull(skb_in, 2)) == NULL) {
  577. return DECOMP_ERROR;
  578. }
  579. p -= 2;
  580. seq = (p[0] << 8) + p[1];
  581. ilen = skb_in->len;
  582. ibuf = skb_in->data;
  583. /*
  584. * Check the sequence number and give up if it differs from
  585. * the value we're expecting.
  586. */
  587. if (seq != db->seqno) {
  588. if (db->debug) {
  589. printk(KERN_DEBUG "bsd_decomp%d: bad sequence # %d, expected %d\n",
  590. db->unit, seq, db->seqno - 1);
  591. }
  592. return DECOMP_ERROR;
  593. }
  594. ++db->seqno;
  595. db->bytes_out += ilen;
  596. if (skb_tailroom(skb_out) > 0)
  597. skb_put_u8(skb_out, 0);
  598. else
  599. return DECOMP_ERR_NOMEM;
  600. oldcode = CLEAR;
  601. /*
  602. * Keep the checkpoint correctly so that incompressible packets
  603. * clear the dictionary at the proper times.
  604. */
  605. for (;;) {
  606. if (ilen-- <= 0) {
  607. db->in_count += (skb_out->len - 1); /* don't count the header */
  608. break;
  609. }
  610. /*
  611. * Accumulate bytes until we have a complete code.
  612. * Then get the next code, relying on the 32-bit,
  613. * unsigned accm to mask the result.
  614. */
  615. bitno -= 8;
  616. accm |= *ibuf++ << bitno;
  617. if (tgtbitno < bitno)
  618. continue;
  619. incode = accm >> tgtbitno;
  620. accm <<= n_bits;
  621. bitno += n_bits;
  622. /*
  623. * The dictionary must only be cleared at the end of a packet.
  624. */
  625. if (incode == CLEAR) {
  626. if (ilen > 0) {
  627. if (db->debug)
  628. printk(KERN_DEBUG "bsd_decomp%d: bad CLEAR\n", db->unit);
  629. return DECOMP_FATALERROR; /* probably a bug */
  630. }
  631. bsd_clear(db);
  632. break;
  633. }
  634. if ((incode > max_ent + 2) || (incode > db->maxmaxcode)
  635. || (incode > max_ent && oldcode == CLEAR)) {
  636. if (db->debug) {
  637. printk(KERN_DEBUG "bsd_decomp%d: bad code 0x%x oldcode=0x%x ",
  638. db->unit, incode, oldcode);
  639. printk(KERN_DEBUG "max_ent=0x%x skb->Len=%d seqno=%d\n",
  640. max_ent, skb_out->len, db->seqno);
  641. }
  642. return DECOMP_FATALERROR; /* probably a bug */
  643. }
  644. /* Special case for KwKwK string. */
  645. if (incode > max_ent) {
  646. finchar = oldcode;
  647. extra = 1;
  648. } else {
  649. finchar = incode;
  650. extra = 0;
  651. }
  652. codelen = *(lens_ptr(db, finchar));
  653. if (skb_tailroom(skb_out) < codelen + extra) {
  654. if (db->debug) {
  655. printk(KERN_DEBUG "bsd_decomp%d: ran out of mru\n", db->unit);
  656. #ifdef DEBUG
  657. printk(KERN_DEBUG " len=%d, finchar=0x%x, codelen=%d,skblen=%d\n",
  658. ilen, finchar, codelen, skb_out->len);
  659. #endif
  660. }
  661. return DECOMP_FATALERROR;
  662. }
  663. /*
  664. * Decode this code and install it in the decompressed buffer.
  665. */
  666. p = skb_put(skb_out, codelen);
  667. p += codelen;
  668. while (finchar > LAST) {
  669. struct bsd_dict *dictp2 = dict_ptr(db, finchar);
  670. dictp = dict_ptr(db, dictp2->cptr);
  671. #ifdef DEBUG
  672. if (--codelen <= 0 || dictp->codem1 != finchar - 1) {
  673. if (codelen <= 0) {
  674. printk(KERN_ERR "bsd_decomp%d: fell off end of chain ", db->unit);
  675. printk(KERN_ERR "0x%x at 0x%x by 0x%x, max_ent=0x%x\n", incode, finchar, dictp2->cptr, max_ent);
  676. } else {
  677. if (dictp->codem1 != finchar - 1) {
  678. printk(KERN_ERR "bsd_decomp%d: bad code chain 0x%x finchar=0x%x ", db->unit, incode, finchar);
  679. printk(KERN_ERR "oldcode=0x%x cptr=0x%x codem1=0x%x\n", oldcode, dictp2->cptr, dictp->codem1);
  680. }
  681. }
  682. return DECOMP_FATALERROR;
  683. }
  684. #endif
  685. {
  686. u32 fcode = dictp->fcode;
  687. *--p = (fcode >> 16) & 0xff;
  688. finchar = fcode & 0xffff;
  689. }
  690. }
  691. *--p = finchar;
  692. #ifdef DEBUG
  693. if (--codelen != 0)
  694. printk(KERN_ERR "bsd_decomp%d: short by %d after code 0x%x, max_ent=0x%x\n", db->unit, codelen, incode, max_ent);
  695. #endif
  696. if (extra) /* the KwKwK case again */
  697. skb_put_u8(skb_out, finchar);
  698. /*
  699. * If not first code in a packet, and
  700. * if not out of code space, then allocate a new code.
  701. *
  702. * Keep the hash table correct so it can be used
  703. * with uncompressed packets.
  704. */
  705. if (oldcode != CLEAR && max_ent < db->maxmaxcode) {
  706. struct bsd_dict *dictp2, *dictp3;
  707. u16 *lens1, *lens2;
  708. unsigned long fcode;
  709. int hval, disp, indx;
  710. fcode = BSD_KEY(oldcode, finchar);
  711. hval = BSD_HASH(oldcode, finchar, db->hshift);
  712. dictp = dict_ptr(db, hval);
  713. /* look for a free hash table entry */
  714. if (dictp->codem1 < max_ent) {
  715. disp = (hval == 0) ? 1 : hval;
  716. do {
  717. hval += disp;
  718. if (hval >= db->hsize)
  719. hval -= db->hsize;
  720. dictp = dict_ptr(db, hval);
  721. } while (dictp->codem1 < max_ent);
  722. }
  723. /*
  724. * Invalidate previous hash table entry
  725. * assigned this code, and then take it over
  726. */
  727. dictp2 = dict_ptr(db, max_ent + 1);
  728. indx = dictp2->cptr;
  729. dictp3 = dict_ptr(db, indx);
  730. if (dictp3->codem1 == max_ent)
  731. dictp3->codem1 = BADCODEM1;
  732. dictp2->cptr = hval;
  733. dictp->codem1 = max_ent;
  734. dictp->fcode = fcode;
  735. db->max_ent = ++max_ent;
  736. /* Update the length of this string. */
  737. lens1 = lens_ptr(db, max_ent);
  738. lens2 = lens_ptr(db, oldcode);
  739. *lens1 = *lens2 + 1;
  740. /* Expand code size if needed. */
  741. if (max_ent >= MAXCODE(n_bits) && max_ent < db->maxmaxcode) {
  742. db->n_bits = ++n_bits;
  743. tgtbitno = 32-n_bits;
  744. }
  745. }
  746. oldcode = incode;
  747. }
  748. ++db->comp_count;
  749. ++db->uncomp_count;
  750. db->comp_bytes += skb_in->len - BSD_OVHD;
  751. db->uncomp_bytes += skb_out->len;
  752. if (bsd_check(db)) {
  753. if (db->debug)
  754. printk(KERN_DEBUG "bsd_decomp%d: peer should have cleared dictionary on %d\n",
  755. db->unit, db->seqno - 1);
  756. }
  757. return skb_out->len;
  758. }
  759. /*************************************************************
  760. * Table of addresses for the BSD compression module
  761. *************************************************************/
  762. static struct isdn_ppp_compressor ippp_bsd_compress = {
  763. .owner = THIS_MODULE,
  764. .num = CI_BSD_COMPRESS,
  765. .alloc = bsd_alloc,
  766. .free = bsd_free,
  767. .init = bsd_init,
  768. .reset = bsd_reset,
  769. .compress = bsd_compress,
  770. .decompress = bsd_decompress,
  771. .incomp = bsd_incomp,
  772. .stat = bsd_stats,
  773. };
  774. /*************************************************************
  775. * Module support routines
  776. *************************************************************/
  777. static int __init isdn_bsdcomp_init(void)
  778. {
  779. int answer = isdn_ppp_register_compressor(&ippp_bsd_compress);
  780. if (answer == 0)
  781. printk(KERN_INFO "PPP BSD Compression module registered\n");
  782. return answer;
  783. }
  784. static void __exit isdn_bsdcomp_exit(void)
  785. {
  786. isdn_ppp_unregister_compressor(&ippp_bsd_compress);
  787. }
  788. module_init(isdn_bsdcomp_init);
  789. module_exit(isdn_bsdcomp_exit);