1/* 2 * This file has been copied from commit e7ac713d^ in the GNU grep git 3 * repository. A few small changes have been made to adapt the code to 4 * Git. 5 */ 6 7/* kwset.c - search for any of a set of keywords. 8 Copyright 1989, 1998, 2000, 2005 Free Software Foundation, Inc. 9 10 This program is free software; you can redistribute it and/or modify 11 it under the terms of the GNU General Public License as published by 12 the Free Software Foundation; either version 2, or (at your option) 13 any later version. 14 15 This program is distributed in the hope that it will be useful, 16 but WITHOUT ANY WARRANTY; without even the implied warranty of 17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 GNU General Public License for more details. 19 20 You should have received a copy of the GNU General Public License 21 along with this program; if not, write to the Free Software 22 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 23 02110-1301, USA. */ 24 25/* Written August 1989 by Mike Haertel. 26 The author may be reached (Email) at the address mike@ai.mit.edu, 27 or (US mail) as Mike Haertel c/o Free Software Foundation. */ 28 29/* The algorithm implemented by these routines bears a startling resemblence 30 to one discovered by Beate Commentz-Walter, although it is not identical. 31 See "A String Matching Algorithm Fast on the Average," Technical Report, 32 IBM-Germany, Scientific Center Heidelberg, Tiergartenstrasse 15, D-6900 33 Heidelberg, Germany. See also Aho, A.V., and M. Corasick, "Efficient 34 String Matching: An Aid to Bibliographic Search," CACM June 1975, 35 Vol. 18, No. 6, which describes the failure function used below. */ 36 37#include"cache.h" 38 39#include"kwset.h" 40#include"compat/obstack.h" 41 42#define NCHAR (UCHAR_MAX + 1) 43#define obstack_chunk_alloc xmalloc 44#define obstack_chunk_free free 45 46#define U(c) ((unsigned char) (c)) 47 48/* Balanced tree of edges and labels leaving a given trie node. */ 49struct tree 50{ 51struct tree *llink;/* Left link; MUST be first field. */ 52struct tree *rlink;/* Right link (to larger labels). */ 53struct trie *trie;/* Trie node pointed to by this edge. */ 54unsigned char label;/* Label on this edge. */ 55char balance;/* Difference in depths of subtrees. */ 56}; 57 58/* Node of a trie representing a set of reversed keywords. */ 59struct trie 60{ 61unsigned int accepting;/* Word index of accepted word, or zero. */ 62struct tree *links;/* Tree of edges leaving this node. */ 63struct trie *parent;/* Parent of this node. */ 64struct trie *next;/* List of all trie nodes in level order. */ 65struct trie *fail;/* Aho-Corasick failure function. */ 66int depth;/* Depth of this node from the root. */ 67int shift;/* Shift function for search failures. */ 68int maxshift;/* Max shift of self and descendents. */ 69}; 70 71/* Structure returned opaquely to the caller, containing everything. */ 72struct kwset 73{ 74struct obstack obstack;/* Obstack for node allocation. */ 75int words;/* Number of words in the trie. */ 76struct trie *trie;/* The trie itself. */ 77int mind;/* Minimum depth of an accepting node. */ 78int maxd;/* Maximum depth of any node. */ 79unsigned char delta[NCHAR];/* Delta table for rapid search. */ 80struct trie *next[NCHAR];/* Table of children of the root. */ 81char*target;/* Target string if there's only one. */ 82int mind2;/* Used in Boyer-Moore search for one string. */ 83char const*trans;/* Character translation table. */ 84}; 85 86/* Allocate and initialize a keyword set object, returning an opaque 87 pointer to it. Return NULL if memory is not available. */ 88kwset_t 89kwsalloc(char const*trans) 90{ 91struct kwset *kwset; 92 93 kwset = (struct kwset *)xmalloc(sizeof(struct kwset)); 94 95obstack_init(&kwset->obstack); 96 kwset->words =0; 97 kwset->trie 98= (struct trie *)obstack_alloc(&kwset->obstack,sizeof(struct trie)); 99if(!kwset->trie) 100{ 101kwsfree((kwset_t) kwset); 102return NULL; 103} 104 kwset->trie->accepting =0; 105 kwset->trie->links = NULL; 106 kwset->trie->parent = NULL; 107 kwset->trie->next = NULL; 108 kwset->trie->fail = NULL; 109 kwset->trie->depth =0; 110 kwset->trie->shift =0; 111 kwset->mind = INT_MAX; 112 kwset->maxd = -1; 113 kwset->target = NULL; 114 kwset->trans = trans; 115 116return(kwset_t) kwset; 117} 118 119/* This upper bound is valid for CHAR_BIT >= 4 and 120 exact for CHAR_BIT in { 4..11, 13, 15, 17, 19 }. */ 121#define DEPTH_SIZE (CHAR_BIT + CHAR_BIT/2) 122 123/* Add the given string to the contents of the keyword set. Return NULL 124 for success, an error message otherwise. */ 125const char* 126kwsincr(kwset_t kws,char const*text,size_t len) 127{ 128struct kwset *kwset; 129registerstruct trie *trie; 130registerunsigned char label; 131registerstruct tree *link; 132registerint depth; 133struct tree *links[DEPTH_SIZE]; 134enum{ L, R } dirs[DEPTH_SIZE]; 135struct tree *t, *r, *l, *rl, *lr; 136 137 kwset = (struct kwset *) kws; 138 trie = kwset->trie; 139 text += len; 140 141/* Descend the trie (built of reversed keywords) character-by-character, 142 installing new nodes when necessary. */ 143while(len--) 144{ 145 label = kwset->trans ? kwset->trans[U(*--text)] : *--text; 146 147/* Descend the tree of outgoing links for this trie node, 148 looking for the current character and keeping track 149 of the path followed. */ 150 link = trie->links; 151 links[0] = (struct tree *) &trie->links; 152 dirs[0] = L; 153 depth =1; 154 155while(link && label != link->label) 156{ 157 links[depth] = link; 158if(label < link->label) 159 dirs[depth++] = L, link = link->llink; 160else 161 dirs[depth++] = R, link = link->rlink; 162} 163 164/* The current character doesn't have an outgoing link at 165 this trie node, so build a new trie node and install 166 a link in the current trie node's tree. */ 167if(!link) 168{ 169 link = (struct tree *)obstack_alloc(&kwset->obstack, 170sizeof(struct tree)); 171if(!link) 172return"memory exhausted"; 173 link->llink = NULL; 174 link->rlink = NULL; 175 link->trie = (struct trie *)obstack_alloc(&kwset->obstack, 176sizeof(struct trie)); 177if(!link->trie) 178{ 179obstack_free(&kwset->obstack, link); 180return"memory exhausted"; 181} 182 link->trie->accepting =0; 183 link->trie->links = NULL; 184 link->trie->parent = trie; 185 link->trie->next = NULL; 186 link->trie->fail = NULL; 187 link->trie->depth = trie->depth +1; 188 link->trie->shift =0; 189 link->label = label; 190 link->balance =0; 191 192/* Install the new tree node in its parent. */ 193if(dirs[--depth] == L) 194 links[depth]->llink = link; 195else 196 links[depth]->rlink = link; 197 198/* Back up the tree fixing the balance flags. */ 199while(depth && !links[depth]->balance) 200{ 201if(dirs[depth] == L) 202--links[depth]->balance; 203else 204++links[depth]->balance; 205--depth; 206} 207 208/* Rebalance the tree by pointer rotations if necessary. */ 209if(depth && ((dirs[depth] == L && --links[depth]->balance) 210|| (dirs[depth] == R && ++links[depth]->balance))) 211{ 212switch(links[depth]->balance) 213{ 214case(char) -2: 215switch(dirs[depth +1]) 216{ 217case L: 218 r = links[depth], t = r->llink, rl = t->rlink; 219 t->rlink = r, r->llink = rl; 220 t->balance = r->balance =0; 221break; 222case R: 223 r = links[depth], l = r->llink, t = l->rlink; 224 rl = t->rlink, lr = t->llink; 225 t->llink = l, l->rlink = lr, t->rlink = r, r->llink = rl; 226 l->balance = t->balance !=1?0: -1; 227 r->balance = t->balance != (char) -1?0:1; 228 t->balance =0; 229break; 230default: 231abort(); 232} 233break; 234case2: 235switch(dirs[depth +1]) 236{ 237case R: 238 l = links[depth], t = l->rlink, lr = t->llink; 239 t->llink = l, l->rlink = lr; 240 t->balance = l->balance =0; 241break; 242case L: 243 l = links[depth], r = l->rlink, t = r->llink; 244 lr = t->llink, rl = t->rlink; 245 t->llink = l, l->rlink = lr, t->rlink = r, r->llink = rl; 246 l->balance = t->balance !=1?0: -1; 247 r->balance = t->balance != (char) -1?0:1; 248 t->balance =0; 249break; 250default: 251abort(); 252} 253break; 254default: 255abort(); 256} 257 258if(dirs[depth -1] == L) 259 links[depth -1]->llink = t; 260else 261 links[depth -1]->rlink = t; 262} 263} 264 265 trie = link->trie; 266} 267 268/* Mark the node we finally reached as accepting, encoding the 269 index number of this word in the keyword set so far. */ 270if(!trie->accepting) 271 trie->accepting =1+2* kwset->words; 272++kwset->words; 273 274/* Keep track of the longest and shortest string of the keyword set. */ 275if(trie->depth < kwset->mind) 276 kwset->mind = trie->depth; 277if(trie->depth > kwset->maxd) 278 kwset->maxd = trie->depth; 279 280return NULL; 281} 282 283/* Enqueue the trie nodes referenced from the given tree in the 284 given queue. */ 285static void 286enqueue(struct tree *tree,struct trie **last) 287{ 288if(!tree) 289return; 290enqueue(tree->llink, last); 291enqueue(tree->rlink, last); 292(*last) = (*last)->next = tree->trie; 293} 294 295/* Compute the Aho-Corasick failure function for the trie nodes referenced 296 from the given tree, given the failure function for their parent as 297 well as a last resort failure node. */ 298static void 299treefails(registerstruct tree const*tree,struct trie const*fail, 300struct trie *recourse) 301{ 302registerstruct tree *link; 303 304if(!tree) 305return; 306 307treefails(tree->llink, fail, recourse); 308treefails(tree->rlink, fail, recourse); 309 310/* Find, in the chain of fails going back to the root, the first 311 node that has a descendent on the current label. */ 312while(fail) 313{ 314 link = fail->links; 315while(link && tree->label != link->label) 316if(tree->label < link->label) 317 link = link->llink; 318else 319 link = link->rlink; 320if(link) 321{ 322 tree->trie->fail = link->trie; 323return; 324} 325 fail = fail->fail; 326} 327 328 tree->trie->fail = recourse; 329} 330 331/* Set delta entries for the links of the given tree such that 332 the preexisting delta value is larger than the current depth. */ 333static void 334treedelta(registerstruct tree const*tree, 335registerunsigned int depth, 336unsigned char delta[]) 337{ 338if(!tree) 339return; 340treedelta(tree->llink, depth, delta); 341treedelta(tree->rlink, depth, delta); 342if(depth < delta[tree->label]) 343 delta[tree->label] = depth; 344} 345 346/* Return true if A has every label in B. */ 347static int 348hasevery(registerstruct tree const*a,registerstruct tree const*b) 349{ 350if(!b) 351return1; 352if(!hasevery(a, b->llink)) 353return0; 354if(!hasevery(a, b->rlink)) 355return0; 356while(a && b->label != a->label) 357if(b->label < a->label) 358 a = a->llink; 359else 360 a = a->rlink; 361return!!a; 362} 363 364/* Compute a vector, indexed by character code, of the trie nodes 365 referenced from the given tree. */ 366static void 367treenext(struct tree const*tree,struct trie *next[]) 368{ 369if(!tree) 370return; 371treenext(tree->llink, next); 372treenext(tree->rlink, next); 373 next[tree->label] = tree->trie; 374} 375 376/* Compute the shift for each trie node, as well as the delta 377 table and next cache for the given keyword set. */ 378const char* 379kwsprep(kwset_t kws) 380{ 381registerstruct kwset *kwset; 382registerint i; 383registerstruct trie *curr; 384registerchar const*trans; 385unsigned char delta[NCHAR]; 386 387 kwset = (struct kwset *) kws; 388 389/* Initial values for the delta table; will be changed later. The 390 delta entry for a given character is the smallest depth of any 391 node at which an outgoing edge is labeled by that character. */ 392memset(delta, kwset->mind < UCHAR_MAX ? kwset->mind : UCHAR_MAX, NCHAR); 393 394/* Check if we can use the simple boyer-moore algorithm, instead 395 of the hairy commentz-walter algorithm. */ 396if(kwset->words ==1&& kwset->trans == NULL) 397{ 398char c; 399 400/* Looking for just one string. Extract it from the trie. */ 401 kwset->target =obstack_alloc(&kwset->obstack, kwset->mind); 402if(!kwset->target) 403return"memory exhausted"; 404for(i = kwset->mind -1, curr = kwset->trie; i >=0; --i) 405{ 406 kwset->target[i] = curr->links->label; 407 curr = curr->links->trie; 408} 409/* Build the Boyer Moore delta. Boy that's easy compared to CW. */ 410for(i =0; i < kwset->mind; ++i) 411 delta[U(kwset->target[i])] = kwset->mind - (i +1); 412/* Find the minimal delta2 shift that we might make after 413 a backwards match has failed. */ 414 c = kwset->target[kwset->mind -1]; 415for(i = kwset->mind -2; i >=0; --i) 416if(kwset->target[i] == c) 417break; 418 kwset->mind2 = kwset->mind - (i +1); 419} 420else 421{ 422registerstruct trie *fail; 423struct trie *last, *next[NCHAR]; 424 425/* Traverse the nodes of the trie in level order, simultaneously 426 computing the delta table, failure function, and shift function. */ 427for(curr = last = kwset->trie; curr; curr = curr->next) 428{ 429/* Enqueue the immediate descendents in the level order queue. */ 430enqueue(curr->links, &last); 431 432 curr->shift = kwset->mind; 433 curr->maxshift = kwset->mind; 434 435/* Update the delta table for the descendents of this node. */ 436treedelta(curr->links, curr->depth, delta); 437 438/* Compute the failure function for the decendents of this node. */ 439treefails(curr->links, curr->fail, kwset->trie); 440 441/* Update the shifts at each node in the current node's chain 442 of fails back to the root. */ 443for(fail = curr->fail; fail; fail = fail->fail) 444{ 445/* If the current node has some outgoing edge that the fail 446 doesn't, then the shift at the fail should be no larger 447 than the difference of their depths. */ 448if(!hasevery(fail->links, curr->links)) 449if(curr->depth - fail->depth < fail->shift) 450 fail->shift = curr->depth - fail->depth; 451 452/* If the current node is accepting then the shift at the 453 fail and its descendents should be no larger than the 454 difference of their depths. */ 455if(curr->accepting && fail->maxshift > curr->depth - fail->depth) 456 fail->maxshift = curr->depth - fail->depth; 457} 458} 459 460/* Traverse the trie in level order again, fixing up all nodes whose 461 shift exceeds their inherited maxshift. */ 462for(curr = kwset->trie->next; curr; curr = curr->next) 463{ 464if(curr->maxshift > curr->parent->maxshift) 465 curr->maxshift = curr->parent->maxshift; 466if(curr->shift > curr->maxshift) 467 curr->shift = curr->maxshift; 468} 469 470/* Create a vector, indexed by character code, of the outgoing links 471 from the root node. */ 472for(i =0; i < NCHAR; ++i) 473 next[i] = NULL; 474treenext(kwset->trie->links, next); 475 476if((trans = kwset->trans) != NULL) 477for(i =0; i < NCHAR; ++i) 478 kwset->next[i] = next[U(trans[i])]; 479else 480memcpy(kwset->next, next, NCHAR *sizeof(struct trie *)); 481} 482 483/* Fix things up for any translation table. */ 484if((trans = kwset->trans) != NULL) 485for(i =0; i < NCHAR; ++i) 486 kwset->delta[i] = delta[U(trans[i])]; 487else 488memcpy(kwset->delta, delta, NCHAR); 489 490return NULL; 491} 492 493/* Fast boyer-moore search. */ 494static size_t 495bmexec(kwset_t kws,char const*text,size_t size) 496{ 497struct kwset const*kwset; 498registerunsigned char const*d1; 499registerchar const*ep, *sp, *tp; 500registerint d, gc, i, len, md2; 501 502 kwset = (struct kwset const*) kws; 503 len = kwset->mind; 504 505if(len ==0) 506return0; 507if(len > size) 508return-1; 509if(len ==1) 510{ 511 tp =memchr(text, kwset->target[0], size); 512return tp ? tp - text : -1; 513} 514 515 d1 = kwset->delta; 516 sp = kwset->target + len; 517 gc =U(sp[-2]); 518 md2 = kwset->mind2; 519 tp = text + len; 520 521/* Significance of 12: 1 (initial offset) + 10 (skip loop) + 1 (md2). */ 522if(size >12* len) 523/* 11 is not a bug, the initial offset happens only once. */ 524for(ep = text + size -11* len;;) 525{ 526while(tp <= ep) 527{ 528 d = d1[U(tp[-1])], tp += d; 529 d = d1[U(tp[-1])], tp += d; 530if(d ==0) 531goto found; 532 d = d1[U(tp[-1])], tp += d; 533 d = d1[U(tp[-1])], tp += d; 534 d = d1[U(tp[-1])], tp += d; 535if(d ==0) 536goto found; 537 d = d1[U(tp[-1])], tp += d; 538 d = d1[U(tp[-1])], tp += d; 539 d = d1[U(tp[-1])], tp += d; 540if(d ==0) 541goto found; 542 d = d1[U(tp[-1])], tp += d; 543 d = d1[U(tp[-1])], tp += d; 544} 545break; 546 found: 547if(U(tp[-2]) == gc) 548{ 549for(i =3; i <= len &&U(tp[-i]) ==U(sp[-i]); ++i) 550; 551if(i > len) 552return tp - len - text; 553} 554 tp += md2; 555} 556 557/* Now we have only a few characters left to search. We 558 carefully avoid ever producing an out-of-bounds pointer. */ 559 ep = text + size; 560 d = d1[U(tp[-1])]; 561while(d <= ep - tp) 562{ 563 d = d1[U((tp += d)[-1])]; 564if(d !=0) 565continue; 566if(U(tp[-2]) == gc) 567{ 568for(i =3; i <= len &&U(tp[-i]) ==U(sp[-i]); ++i) 569; 570if(i > len) 571return tp - len - text; 572} 573 d = md2; 574} 575 576return-1; 577} 578 579/* Hairy multiple string search. */ 580static size_t 581cwexec(kwset_t kws,char const*text,size_t len,struct kwsmatch *kwsmatch) 582{ 583struct kwset const*kwset; 584struct trie *const*next; 585struct trie const*trie; 586struct trie const*accept; 587char const*beg, *lim, *mch, *lmch; 588registerunsigned char c; 589registerunsigned char const*delta; 590registerint d; 591registerchar const*end, *qlim; 592registerstruct tree const*tree; 593registerchar const*trans; 594 595 accept = NULL; 596 597/* Initialize register copies and look for easy ways out. */ 598 kwset = (struct kwset *) kws; 599if(len < kwset->mind) 600return-1; 601 next = kwset->next; 602 delta = kwset->delta; 603 trans = kwset->trans; 604 lim = text + len; 605 end = text; 606if((d = kwset->mind) !=0) 607 mch = NULL; 608else 609{ 610 mch = text, accept = kwset->trie; 611goto match; 612} 613 614if(len >=4* kwset->mind) 615 qlim = lim -4* kwset->mind; 616else 617 qlim = NULL; 618 619while(lim - end >= d) 620{ 621if(qlim && end <= qlim) 622{ 623 end += d -1; 624while((d = delta[c = *end]) && end < qlim) 625{ 626 end += d; 627 end += delta[U(*end)]; 628 end += delta[U(*end)]; 629} 630++end; 631} 632else 633 d = delta[c = (end += d)[-1]]; 634if(d) 635continue; 636 beg = end -1; 637 trie = next[c]; 638if(trie->accepting) 639{ 640 mch = beg; 641 accept = trie; 642} 643 d = trie->shift; 644while(beg > text) 645{ 646 c = trans ? trans[U(*--beg)] : *--beg; 647 tree = trie->links; 648while(tree && c != tree->label) 649if(c < tree->label) 650 tree = tree->llink; 651else 652 tree = tree->rlink; 653if(tree) 654{ 655 trie = tree->trie; 656if(trie->accepting) 657{ 658 mch = beg; 659 accept = trie; 660} 661} 662else 663break; 664 d = trie->shift; 665} 666if(mch) 667goto match; 668} 669return-1; 670 671 match: 672/* Given a known match, find the longest possible match anchored 673 at or before its starting point. This is nearly a verbatim 674 copy of the preceding main search loops. */ 675if(lim - mch > kwset->maxd) 676 lim = mch + kwset->maxd; 677 lmch =0; 678 d =1; 679while(lim - end >= d) 680{ 681if((d = delta[c = (end += d)[-1]]) !=0) 682continue; 683 beg = end -1; 684if(!(trie = next[c])) 685{ 686 d =1; 687continue; 688} 689if(trie->accepting && beg <= mch) 690{ 691 lmch = beg; 692 accept = trie; 693} 694 d = trie->shift; 695while(beg > text) 696{ 697 c = trans ? trans[U(*--beg)] : *--beg; 698 tree = trie->links; 699while(tree && c != tree->label) 700if(c < tree->label) 701 tree = tree->llink; 702else 703 tree = tree->rlink; 704if(tree) 705{ 706 trie = tree->trie; 707if(trie->accepting && beg <= mch) 708{ 709 lmch = beg; 710 accept = trie; 711} 712} 713else 714break; 715 d = trie->shift; 716} 717if(lmch) 718{ 719 mch = lmch; 720goto match; 721} 722if(!d) 723 d =1; 724} 725 726if(kwsmatch) 727{ 728 kwsmatch->index = accept->accepting /2; 729 kwsmatch->offset[0] = mch - text; 730 kwsmatch->size[0] = accept->depth; 731} 732return mch - text; 733} 734 735/* Search through the given text for a match of any member of the 736 given keyword set. Return a pointer to the first character of 737 the matching substring, or NULL if no match is found. If FOUNDLEN 738 is non-NULL store in the referenced location the length of the 739 matching substring. Similarly, if FOUNDIDX is non-NULL, store 740 in the referenced location the index number of the particular 741 keyword matched. */ 742size_t 743kwsexec(kwset_t kws,char const*text,size_t size, 744struct kwsmatch *kwsmatch) 745{ 746struct kwset const*kwset = (struct kwset *) kws; 747if(kwset->words ==1&& kwset->trans == NULL) 748{ 749size_t ret =bmexec(kws, text, size); 750if(kwsmatch != NULL && ret != (size_t) -1) 751{ 752 kwsmatch->index =0; 753 kwsmatch->offset[0] = ret; 754 kwsmatch->size[0] = kwset->mind; 755} 756return ret; 757} 758else 759returncwexec(kws, text, size, kwsmatch); 760} 761 762/* Free the components of the given keyword set. */ 763void 764kwsfree(kwset_t kws) 765{ 766struct kwset *kwset; 767 768 kwset = (struct kwset *) kws; 769obstack_free(&kwset->obstack, NULL); 770free(kws); 771}