forked from sphinxsearch/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsphinxsearch.cpp
9837 lines (8402 loc) · 271 KB
/
sphinxsearch.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// $Id$
//
//
// Copyright (c) 2001-2016, Andrew Aksyonoff
// Copyright (c) 2008-2016, Sphinx Technologies Inc
// All rights reserved
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License. You should have
// received a copy of the GPL license along with this program; if you
// did not, you can find it at http://www.gnu.org/
//
#include "sphinx.h"
#include "sphinxsearch.h"
#include "sphinxquery.h"
#include "sphinxint.h"
#include "sphinxplugin.h"
#include "sphinxqcache.h"
#include <math.h>
//////////////////////////////////////////////////////////////////////////
/// query debugging printouts
#define QDEBUG 0
#if QDEBUG
#define QDEBUGARG(_arg) _arg
#else
#define QDEBUGARG(_arg)
#endif
//////////////////////////////////////////////////////////////////////////
/// costs for max_predicted_time estimations, in nanoseconds
/// YMMV, defaults were estimated in a very specific environment, and then rounded off
int g_iPredictorCostDoc = 64;
int g_iPredictorCostHit = 48;
int g_iPredictorCostSkip = 2048;
int g_iPredictorCostMatch = 64;
//////////////////////////////////////////////////////////////////////////
// EXTENDED MATCHING V2
//////////////////////////////////////////////////////////////////////////
#define SPH_TREE_DUMP 0
#define SPH_BM25_K1 1.2f
#define SPH_BM25_SCALE 1000
struct QwordsHash_fn
{
static inline int Hash ( const CSphString & sKey )
{
return sphCRC32 ( sKey.cstr() );
}
};
void ISphQword::CollectHitMask()
{
if ( m_bAllFieldsKnown )
return;
SeekHitlist ( m_iHitlistPos );
for ( Hitpos_t uHit = GetNextHit(); uHit!=EMPTY_HIT; uHit = GetNextHit() )
m_dQwordFields.Set ( HITMAN::GetField ( uHit ) );
m_bAllFieldsKnown = true;
}
/// match in the stream
struct ExtDoc_t
{
SphDocID_t m_uDocid;
CSphRowitem * m_pDocinfo; ///< for inline storage only
SphOffset_t m_uHitlistOffset;
DWORD m_uDocFields;
float m_fTFIDF;
};
/// word in the query
struct ExtQword_t
{
CSphString m_sWord; ///< word
CSphString m_sDictWord; ///< word as processed by dict
int m_iDocs; ///< matching documents
int m_iHits; ///< matching hits
float m_fIDF; ///< IDF value
float m_fBoost; ///< IDF multiplier
int m_iQueryPos; ///< position in the query
bool m_bExpanded; ///< added by prefix expansion
bool m_bExcluded; ///< excluded by the query (eg. bb in (aa AND NOT bb))
};
/// query words set
typedef CSphOrderedHash < ExtQword_t, CSphString, QwordsHash_fn, 256 > ExtQwordsHash_t;
struct ZoneHits_t
{
CSphVector<Hitpos_t> m_dStarts;
CSphVector<Hitpos_t> m_dEnds;
};
/// per-document zone information (span start/end positions)
struct ZoneInfo_t
{
SphDocID_t m_uDocid;
ZoneHits_t * m_pHits;
};
// FindSpan vector operators
static bool operator < ( const ZoneInfo_t & tZone, SphDocID_t uDocid )
{
return tZone.m_uDocid<uDocid;
}
static bool operator == ( const ZoneInfo_t & tZone, SphDocID_t uDocid )
{
return tZone.m_uDocid==uDocid;
}
static bool operator < ( SphDocID_t uDocid, const ZoneInfo_t & tZone )
{
return uDocid<tZone.m_uDocid;
}
static void PrintDocsChunk ( int QDEBUGARG(iCount), int QDEBUGARG(iAtomPos), const ExtDoc_t * QDEBUGARG(pDocs), const char * QDEBUGARG(sNode), void * QDEBUGARG(pNode) )
{
#if QDEBUG
CSphStringBuilder tRes;
tRes.Appendf ( "node %s 0x%x:%p getdocs (%d) = [", sNode ? sNode : "???", iAtomPos, pNode, iCount );
for ( int i=0; i<iCount; i++ )
tRes.Appendf ( i ? ", 0x%x" : "0x%x", DWORD ( pDocs[i].m_uDocid ) );
tRes.Appendf ( "]" );
printf ( "%s", tRes.cstr() );
#endif
}
static void PrintHitsChunk ( int QDEBUGARG(iCount), int QDEBUGARG(iAtomPos), const ExtHit_t * QDEBUGARG(pHits), const char * QDEBUGARG(sNode), void * QDEBUGARG(pNode) )
{
#if QDEBUG
CSphStringBuilder tRes;
tRes.Appendf ( "node %s 0x%x:%p gethits (%d) = [", sNode ? sNode : "???", iAtomPos, pNode, iCount );
for ( int i=0; i<iCount; i++ )
tRes.Appendf ( i ? ", 0x%x:0x%x" : "0x%x:0x%x", DWORD ( pHits[i].m_uDocid ), DWORD ( pHits[i].m_uHitpos ) );
tRes.Appendf ( "]" );
printf ( "%s", tRes.cstr() );
#endif
}
struct TermPos_t
{
WORD m_uQueryPos;
WORD m_uAtomPos;
};
/// generic match streamer
class ExtNode_i
{
public:
ExtNode_i ();
virtual ~ExtNode_i () { SafeDeleteArray ( m_pDocinfo ); }
static ExtNode_i * Create ( const XQNode_t * pNode, const ISphQwordSetup & tSetup );
static ExtNode_i * Create ( const XQKeyword_t & tWord, const XQNode_t * pNode, const ISphQwordSetup & tSetup );
static ExtNode_i * Create ( ISphQword * pQword, const XQNode_t * pNode, const ISphQwordSetup & tSetup );
virtual void Reset ( const ISphQwordSetup & tSetup ) = 0;
virtual void HintDocid ( SphDocID_t uMinID ) = 0;
virtual const ExtDoc_t * GetDocsChunk() = 0;
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs ) = 0;
virtual int GetQwords ( ExtQwordsHash_t & hQwords ) = 0;
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords ) = 0;
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const = 0;
virtual bool GotHitless () = 0;
virtual int GetDocsCount () { return INT_MAX; }
virtual int GetHitsCount () { return 0; }
virtual uint64_t GetWordID () const = 0; ///< for now, only used for duplicate keyword checks in quorum operator
void DebugIndent ( int iLevel )
{
while ( iLevel-- )
printf ( " " );
}
virtual void DebugDump ( int iLevel )
{
DebugIndent ( iLevel );
printf ( "ExtNode\n" );
}
// return specific extra data may be associated with the node
// intended to be used a bit similar to QueryInterface() in COM technology
// but simpler due to enum instead of 128-bit GUID, and no ref. counting
inline bool GetExtraData ( ExtraData_e eNode, void** ppData )
{
return ExtraDataImpl ( eNode, ppData );
}
private:
virtual bool ExtraDataImpl ( ExtraData_e, void** )
{
return false;
}
public:
static const int MAX_DOCS = 512;
static const int MAX_HITS = 512;
int m_iAtomPos; ///< we now need it on this level for tricks like expanded keywords within phrases
protected:
ExtDoc_t m_dDocs[MAX_DOCS];
ExtHit_t m_dHits[MAX_HITS];
public:
int m_iStride; ///< docinfo stride (for inline mode only)
protected:
CSphRowitem * m_pDocinfo; ///< docinfo storage (for inline mode only)
void AllocDocinfo ( const ISphQwordSetup & tSetup )
{
if ( tSetup.m_iInlineRowitems )
{
m_iStride = tSetup.m_iInlineRowitems;
m_pDocinfo = new CSphRowitem [ MAX_DOCS*m_iStride ];
}
}
protected:
inline const ExtDoc_t * ReturnDocsChunk ( int iCount, const char * sNode )
{
assert ( iCount>=0 && iCount<MAX_DOCS );
m_dDocs[iCount].m_uDocid = DOCID_MAX;
PrintDocsChunk ( iCount, m_iAtomPos, m_dDocs, sNode, this );
return iCount ? m_dDocs : NULL;
}
inline const ExtHit_t * ReturnHitsChunk ( int iCount, const char * sNode, bool bReverse )
{
assert ( iCount>=0 && iCount<MAX_HITS );
m_dHits[iCount].m_uDocid = DOCID_MAX;
#ifndef NDEBUG
for ( int i=1; i<iCount; i++ )
{
bool bQPosPassed = ( ( bReverse && m_dHits[i-1].m_uQuerypos>=m_dHits[i].m_uQuerypos ) || ( !bReverse && m_dHits[i-1].m_uQuerypos<=m_dHits[i].m_uQuerypos ) );
assert ( m_dHits[i-1].m_uDocid!=m_dHits[i].m_uDocid ||
( m_dHits[i-1].m_uHitpos<m_dHits[i].m_uHitpos || ( m_dHits[i-1].m_uHitpos==m_dHits[i].m_uHitpos && bQPosPassed ) ) );
}
#endif
PrintHitsChunk ( iCount, m_iAtomPos, m_dHits, sNode, this );
return iCount ? m_dHits : NULL;
}
};
//////////////////////////////////////////////////////////////////////////
/// single keyword streamer
class ExtTerm_c : public ExtNode_i, ISphNoncopyable
{
public:
ExtTerm_c ( ISphQword * pQword, const FieldMask_t& uFields, const ISphQwordSetup & tSetup, bool bNotWeighted );
ExtTerm_c ( ISphQword * pQword, const ISphQwordSetup & tSetup );
ExtTerm_c () {} ///< to be used in pair with Init()
~ExtTerm_c ()
{
SafeDelete ( m_pQword );
}
void Init ( ISphQword * pQword, const FieldMask_t& uFields, const ISphQwordSetup & tSetup, bool bNotWeighted );
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual int GetQwords ( ExtQwordsHash_t & hQwords );
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords );
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const;
virtual bool GotHitless () { return false; }
virtual int GetDocsCount () { return m_pQword->m_iDocs; }
virtual int GetHitsCount () { return m_pQword->m_iHits; }
virtual uint64_t GetWordID () const
{
if ( m_pQword->m_uWordID )
return m_pQword->m_uWordID;
else
return sphFNV64 ( m_pQword->m_sDictWord.cstr() );
}
virtual void HintDocid ( SphDocID_t uMinID )
{
m_pQword->HintDocid ( uMinID );
if ( m_pStats )
m_pStats->m_iSkips++;
if ( m_pNanoBudget )
*m_pNanoBudget -= g_iPredictorCostSkip;
}
virtual void DebugDump ( int iLevel )
{
DebugIndent ( iLevel );
printf ( "ExtTerm: %s at: %d ", m_pQword->m_sWord.cstr(), m_pQword->m_iAtomPos );
if ( m_dQueriedFields.TestAll(true) )
{
printf ( "(all)\n" );
} else
{
bool bFirst = true;
printf ( "in: " );
for ( int iField=0; iField<SPH_MAX_FIELDS; iField++ )
{
if ( m_dQueriedFields.Test ( iField ) )
{
if ( !bFirst )
printf ( ", " );
printf ( "%d", iField );
bFirst = false;
}
}
printf ( "\n" );
}
}
protected:
ISphQword * m_pQword;
FieldMask_t m_dQueriedFields; ///< accepted fields mask
bool m_bHasWideFields; ///< whether fields mask for this term refer to fields 32+
float m_fIDF; ///< IDF for this term (might be 0.0f for non-1st occurences in query)
int64_t m_iMaxTimer; ///< work until this timestamp
CSphString * m_pWarning;
bool m_bNotWeighted;
CSphQueryStats * m_pStats;
int64_t * m_pNanoBudget;
ExtDoc_t * m_pLastChecked; ///< points to entry in m_dDocs which GetHitsChunk() currently emits hits for
SphDocID_t m_uMatchChecked; ///< there are no more hits for matches block starting with this ID
bool m_bTail; ///< should we emit more hits for current docid or proceed furthwer
public:
static volatile bool m_bInterruptNow; ///< may be set from outside to indicate the globally received sigterm
};
/// Immediately interrupt current operation
void sphInterruptNow()
{
ExtTerm_c::m_bInterruptNow = true;
}
bool sphInterrupted()
{
return ExtTerm_c::m_bInterruptNow;
}
volatile bool ExtTerm_c::m_bInterruptNow = false;
/// single keyword streamer with artificial hitlist
class ExtTermHitless_c : public ExtTerm_c
{
public:
ExtTermHitless_c ( ISphQword * pQword, const FieldMask_t& uFields, const ISphQwordSetup & tSetup, bool bNotWeighted )
: ExtTerm_c ( pQword, uFields, tSetup, bNotWeighted )
, m_uFieldPos ( 0 )
{}
virtual void Reset ( const ISphQwordSetup & ) { m_uFieldPos = 0; }
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual bool GotHitless () { return true; }
protected:
DWORD m_uFieldPos;
};
//////////////////////////////////////////////////////////////////////////
/// position filter policy
template < TermPosFilter_e T >
class TermAcceptor_c
{
public:
TermAcceptor_c ( ISphQword *, const XQNode_t *, const ISphQwordSetup & ) {}
protected:
inline bool IsAcceptableHit ( const ExtHit_t * ) const { return true; }
inline void Reset() {}
};
template<>
class TermAcceptor_c<TERM_POS_FIELD_LIMIT> : public ISphNoncopyable
{
public:
TermAcceptor_c ( ISphQword *, const XQNode_t * pNode, const ISphQwordSetup & )
: m_iMaxFieldPos ( pNode->m_dSpec.m_iFieldMaxPos )
{}
protected:
inline bool IsAcceptableHit ( const ExtHit_t * ) const;
inline void Reset() {}
private:
const int m_iMaxFieldPos;
};
template<>
class TermAcceptor_c<TERM_POS_ZONES> : public ISphNoncopyable
{
public:
TermAcceptor_c ( ISphQword *, const XQNode_t * pNode, const ISphQwordSetup & tSetup )
: m_pZoneChecker ( tSetup.m_pZoneChecker )
, m_dZones ( pNode->m_dSpec.m_dZones )
, m_uLastZonedId ( 0 )
, m_iCheckFrom ( 0 )
{}
protected:
inline bool IsAcceptableHit ( const ExtHit_t * pHit ) const;
inline void Reset()
{
m_uLastZonedId = 0;
m_iCheckFrom = 0;
}
protected:
ISphZoneCheck * m_pZoneChecker; ///< zone-limited searches query ranker about zones
mutable CSphVector<int> m_dZones; ///< zone ids for this particular term
mutable SphDocID_t m_uLastZonedId;
mutable int m_iCheckFrom;
};
///
class BufferedNode_c
{
protected:
BufferedNode_c ()
: m_pRawDocs ( NULL )
, m_pRawDoc ( NULL )
, m_pRawHit ( NULL )
, m_uLastID ( 0 )
, m_eState ( COPY_DONE )
, m_uDoneFor ( 0 )
, m_uHitStartDocid ( 0 )
{
m_dMyDocs[0].m_uDocid = DOCID_MAX;
m_dMyHits[0].m_uDocid = DOCID_MAX;
m_dFilteredHits[0].m_uDocid = DOCID_MAX;
}
void Reset ()
{
m_pRawDocs = NULL;
m_pRawDoc = NULL;
m_pRawHit = NULL;
m_uLastID = 0;
m_eState = COPY_DONE;
m_uDoneFor = 0;
m_uHitStartDocid = 0;
m_dMyDocs[0].m_uDocid = DOCID_MAX;
m_dMyHits[0].m_uDocid = DOCID_MAX;
m_dFilteredHits[0].m_uDocid = DOCID_MAX;
}
protected:
const ExtDoc_t * m_pRawDocs; ///< chunk start as returned by raw GetDocsChunk() (need to store it for raw GetHitsChunk() calls)
const ExtDoc_t * m_pRawDoc; ///< current position in raw docs chunk
const ExtHit_t * m_pRawHit; ///< current position in raw hits chunk
SphDocID_t m_uLastID;
enum
{
COPY_FILTERED,
COPY_TRAILING,
COPY_DONE
} m_eState; ///< internal GetHitsChunk() state (are we copying from my hits, or passing trailing raw hits, or done)
ExtDoc_t m_dMyDocs[ExtNode_i::MAX_DOCS]; ///< all documents within the required pos range
ExtHit_t m_dMyHits[ExtNode_i::MAX_HITS]; ///< all hits within the required pos range
ExtHit_t m_dFilteredHits[ExtNode_i::MAX_HITS]; ///< hits from requested subset of the documents (for GetHitsChunk())
SphDocID_t m_uDoneFor;
SphDocID_t m_uHitStartDocid;
};
/// single keyword streamer, with term position filtering
template < TermPosFilter_e T, class ExtBase=ExtTerm_c >
class ExtConditional : public BufferedNode_c, public ExtBase, protected TermAcceptor_c<T>
{
typedef TermAcceptor_c<T> t_Acceptor;
protected:
ExtConditional ( ISphQword * pQword, const XQNode_t * pNode, const ISphQwordSetup & tSetup );
public:
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual bool GotHitless () { return false; }
private:
virtual bool ExtraDataImpl ( ExtraData_e eData, void ** ppResult );
};
/// single keyword streamer, with term position filtering
template < TermPosFilter_e T >
class ExtTermPos_c : public ExtConditional<T,ExtTerm_c>
{
public:
ExtTermPos_c ( ISphQword * pQword, const XQNode_t * pNode, const ISphQwordSetup & tSetup )
: ExtConditional<T,ExtTerm_c> ( pQword, pNode, tSetup )
{
ExtTerm_c::Init ( pQword, pNode->m_dSpec.m_dFieldMask, tSetup, pNode->m_bNotWeighted );
}
};
template<TermPosFilter_e T, class ExtBase>
bool ExtConditional<T,ExtBase>::ExtraDataImpl ( ExtraData_e, void ** )
{
return false;
}
/// multi-node binary-operation streamer traits
class ExtTwofer_c : public ExtNode_i
{
public:
ExtTwofer_c ( ExtNode_i * pLeft, ExtNode_i * pRight, const ISphQwordSetup & tSetup );
ExtTwofer_c () {} ///< to be used in pair with Init();
~ExtTwofer_c ();
void Init ( ExtNode_i * pFirst, ExtNode_i * pSecond, const ISphQwordSetup & tSetup );
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual int GetQwords ( ExtQwordsHash_t & hQwords );
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords );
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const;
virtual bool GotHitless () { return m_pLeft->GotHitless() || m_pRight->GotHitless(); }
void DebugDumpT ( const char * sName, int iLevel )
{
DebugIndent ( iLevel );
printf ( "%s:\n", sName );
m_pLeft->DebugDump ( iLevel+1 );
m_pRight->DebugDump ( iLevel+1 );
}
void SetNodePos ( WORD uPosLeft, WORD uPosRight )
{
m_uNodePosL = uPosLeft;
m_uNodePosR = uPosRight;
}
virtual void HintDocid ( SphDocID_t uMinID )
{
m_pLeft->HintDocid ( uMinID );
m_pRight->HintDocid ( uMinID );
}
virtual uint64_t GetWordID () const
{
uint64_t dHash[2];
dHash[0] = m_pLeft->GetWordID();
dHash[1] = m_pRight->GetWordID();
return sphFNV64 ( dHash, sizeof(dHash) );
}
protected:
ExtNode_i * m_pLeft;
ExtNode_i * m_pRight;
const ExtDoc_t * m_pCurDocL;
const ExtDoc_t * m_pCurDocR;
const ExtHit_t * m_pCurHitL;
const ExtHit_t * m_pCurHitR;
WORD m_uNodePosL;
WORD m_uNodePosR;
SphDocID_t m_uMatchedDocid;
};
/// A-and-B streamer
class ExtAnd_c : public ExtTwofer_c
{
public:
ExtAnd_c ( ExtNode_i * pLeft, ExtNode_i * pRight, const ISphQwordSetup & tSetup ) : ExtTwofer_c ( pLeft, pRight, tSetup ), m_bQPosReverse ( false ) {}
ExtAnd_c() : m_bQPosReverse ( false ) {} ///< to be used with Init()
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
void DebugDump ( int iLevel ) { DebugDumpT ( "ExtAnd", iLevel ); }
void SetQPosReverse ()
{
m_bQPosReverse = true;
}
protected:
bool m_bQPosReverse;
};
class ExtAndZonespanned_c : public ExtAnd_c
{
public:
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
void DebugDump ( int iLevel ) { DebugDumpT ( "ExtAndZonespan", iLevel ); }
protected:
bool IsSameZonespan ( const ExtHit_t * pHit1, const ExtHit_t * pHit2 ) const;
ISphZoneCheck * m_pZoneChecker;
CSphVector<int> m_dZones;
};
class ExtAndZonespan_c : public ExtConditional < TERM_POS_NONE, ExtAndZonespanned_c >
{
public:
ExtAndZonespan_c ( ExtNode_i * pFirst, ExtNode_i * pSecond, const ISphQwordSetup & tSetup, const XQNode_t * pNode )
: ExtConditional<TERM_POS_NONE,ExtAndZonespanned_c> ( NULL, pNode, tSetup )
{
Init ( pFirst, pSecond, tSetup );
m_pZoneChecker = tSetup.m_pZoneChecker;
m_dZones = pNode->m_dSpec.m_dZones;
}
};
/// A-or-B streamer
class ExtOr_c : public ExtTwofer_c
{
public:
ExtOr_c ( ExtNode_i * pLeft, ExtNode_i * pRight, const ISphQwordSetup & tSetup ) : ExtTwofer_c ( pLeft, pRight, tSetup ) {}
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
void DebugDump ( int iLevel ) { DebugDumpT ( "ExtOr", iLevel ); }
};
/// A-maybe-B streamer
class ExtMaybe_c : public ExtOr_c
{
public:
ExtMaybe_c ( ExtNode_i * pLeft, ExtNode_i * pRight, const ISphQwordSetup & tSetup ) : ExtOr_c ( pLeft, pRight, tSetup ) {}
virtual const ExtDoc_t * GetDocsChunk();
void DebugDump ( int iLevel ) { DebugDumpT ( "ExtMaybe", iLevel ); }
};
/// A-and-not-B streamer
class ExtAndNot_c : public ExtTwofer_c
{
public:
ExtAndNot_c ( ExtNode_i * pLeft, ExtNode_i * pRight, const ISphQwordSetup & tSetup );
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual void Reset ( const ISphQwordSetup & tSetup );
void DebugDump ( int iLevel ) { DebugDumpT ( "ExtAndNot", iLevel ); }
protected:
bool m_bPassthrough;
};
/// generic operator over N nodes
class ExtNWayT : public ExtNode_i
{
public:
ExtNWayT ( const CSphVector<ExtNode_i *> & dNodes, const ISphQwordSetup & tSetup );
~ExtNWayT ();
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual int GetQwords ( ExtQwordsHash_t & hQwords );
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords );
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const;
virtual bool GotHitless () { return false; }
virtual void HintDocid ( SphDocID_t uMinID ) { m_pNode->HintDocid ( uMinID ); }
virtual uint64_t GetWordID () const;
protected:
ExtNode_i * m_pNode; ///< my and-node for all the terms
const ExtDoc_t * m_pDocs; ///< current docs chunk from and-node
const ExtHit_t * m_pHits; ///< current hits chunk from and-node
const ExtDoc_t * m_pDoc; ///< current doc from and-node
const ExtHit_t * m_pHit; ///< current hit from and-node
const ExtDoc_t * m_pMyDoc; ///< current doc for hits getter
const ExtHit_t * m_pMyHit; ///< current hit for hits getter
SphDocID_t m_uLastDocID; ///< last emitted hit
ExtHit_t m_dMyHits[MAX_HITS]; ///< buffer for all my phrase hits; inherited m_dHits will receive filtered results
SphDocID_t m_uMatchedDocid; ///< doc currently in process
SphDocID_t m_uHitsOverFor; ///< there are no more hits for matches block starting with this ID
protected:
inline void ConstructNode ( const CSphVector<ExtNode_i *> & dNodes, const CSphVector<WORD> & dPositions, const ISphQwordSetup & tSetup )
{
assert ( m_pNode==NULL );
WORD uLPos = dPositions[0];
ExtNode_i * pCur = dNodes[uLPos++]; // ++ for zero-based to 1-based
ExtAnd_c * pCurEx = NULL;
DWORD uLeaves = dNodes.GetLength();
WORD uRPos;
for ( DWORD i=1; i<uLeaves; i++ )
{
uRPos = dPositions[i];
pCur = pCurEx = new ExtAnd_c ( pCur, dNodes[uRPos++], tSetup ); // ++ for zero-based to 1-based
pCurEx->SetNodePos ( uLPos, uRPos );
uLPos = 0;
}
if ( pCurEx )
pCurEx->SetQPosReverse();
m_pNode = pCur;
}
};
struct ExtNodeTF_fn
{
bool IsLess ( ExtNode_i * pA, ExtNode_i * pB ) const
{
return pA->GetDocsCount() < pB->GetDocsCount();
}
};
struct ExtNodeTFExt_fn
{
const CSphVector<ExtNode_i *> & m_dNodes;
explicit ExtNodeTFExt_fn ( const CSphVector<ExtNode_i *> & dNodes )
: m_dNodes ( dNodes )
{}
ExtNodeTFExt_fn ( const ExtNodeTFExt_fn & rhs )
: m_dNodes ( rhs.m_dNodes )
{}
bool IsLess ( WORD uA, WORD uB ) const
{
return m_dNodes[uA]->GetDocsCount() < m_dNodes[uB]->GetDocsCount();
}
private:
const ExtNodeTFExt_fn & operator = ( const ExtNodeTFExt_fn & )
{
return *this;
}
};
/// FSM is Finite State Machine
template < class FSM >
class ExtNWay_c : public ExtNWayT, private FSM
{
public:
ExtNWay_c ( const CSphVector<ExtNode_i *> & dNodes, const XQNode_t & tNode, const ISphQwordSetup & tSetup )
: ExtNWayT ( dNodes, tSetup )
, FSM ( dNodes, tNode, tSetup )
{
CSphVector<WORD> dPositions ( dNodes.GetLength() );
ARRAY_FOREACH ( i, dPositions )
dPositions[i] = (WORD) i;
dPositions.Sort ( ExtNodeTFExt_fn ( dNodes ) );
ConstructNode ( dNodes, dPositions, tSetup );
}
public:
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual void DebugDump ( int iLevel )
{
DebugIndent ( iLevel );
printf ( "%s\n", FSM::GetName() );
m_pNode->DebugDump ( iLevel+1 );
}
private:
bool EmitTail ( int & iHit ); ///< the "trickiest part" extracted in order to process the proximity also
};
class FSMphrase
{
protected:
struct State_t
{
int m_iTagQword;
DWORD m_uExpHitposWithField;
};
protected:
FSMphrase ( const CSphVector<ExtNode_i *> & dQwords, const XQNode_t & tNode, const ISphQwordSetup & tSetup );
bool HitFSM ( const ExtHit_t* pHit, ExtHit_t* dTarget );
inline static const char * GetName() { return "ExtPhrase"; }
inline void ResetFSM()
{
m_dStates.Resize(0);
}
protected:
CSphVector<int> m_dQposDelta; ///< next expected qpos delta for each existing qpos (for skipped stopwords case)
CSphVector<int> m_dAtomPos; ///< lets use it as finite automata states and keep references on it
CSphVector<State_t> m_dStates; ///< pointers to states of finite automata
DWORD m_uQposMask;
};
/// exact phrase streamer
typedef ExtNWay_c < FSMphrase > ExtPhrase_c;
/// proximity streamer
class FSMproximity
{
protected:
FSMproximity ( const CSphVector<ExtNode_i *> & dQwords, const XQNode_t & tNode, const ISphQwordSetup & tSetup );
bool HitFSM ( const ExtHit_t* pHit, ExtHit_t* dTarget );
inline static const char * GetName() { return "ExtProximity"; }
inline void ResetFSM()
{
m_uExpPos = 0;
m_uWords = 0;
m_iMinQindex = -1;
ARRAY_FOREACH ( i, m_dProx )
m_dProx[i] = UINT_MAX;
}
protected:
int m_iMaxDistance;
DWORD m_uWordsExpected;
DWORD m_uMinQpos;
DWORD m_uQLen;
DWORD m_uExpPos;
CSphVector<DWORD> m_dProx; // proximity hit position for i-th word
CSphVector<int> m_dDeltas; // used for weight calculation
DWORD m_uWords;
int m_iMinQindex;
DWORD m_uQposMask;
};
/// exact phrase streamer
typedef ExtNWay_c<FSMproximity> ExtProximity_c;
/// proximity streamer
class FSMmultinear
{
protected:
FSMmultinear ( const CSphVector<ExtNode_i *> & dNodes, const XQNode_t & tNode, const ISphQwordSetup & tSetup );
bool HitFSM ( const ExtHit_t * pHit, ExtHit_t * dTarget );
inline static const char * GetName() { return "ExtMultinear"; }
inline void ResetFSM()
{
m_iRing = m_uLastP = m_uPrelastP = 0;
}
protected:
int m_iNear; ///< the NEAR distance
DWORD m_uPrelastP;
DWORD m_uPrelastML;
DWORD m_uPrelastSL;
DWORD m_uPrelastW;
DWORD m_uLastP; ///< position of the last hit
DWORD m_uLastML; ///< the length of the previous hit
DWORD m_uLastSL; ///< the length of the previous hit in Query
DWORD m_uLastW; ///< last weight
DWORD m_uWordsExpected; ///< now many hits we're expect
DWORD m_uWeight; ///< weight accum
DWORD m_uFirstHit; ///< hitpos of the beginning of the match chain
WORD m_uFirstNpos; ///< N-position of the head of the chain
WORD m_uFirstQpos; ///< Q-position of the head of the chain (for twofers)
CSphVector<WORD> m_dNpos; ///< query positions for multinear
CSphVector<ExtHit_t> m_dRing; ///< ring buffer for multihit data
int m_iRing; ///< the head of the ring
bool m_bTwofer; ///< if we have 2- or N-way NEAR
bool m_bQposMask;
private:
inline int RingTail() const
{
return ( m_iRing + m_dNpos.GetLength() - 1 ) % m_uWordsExpected;
}
inline void Add2Ring ( const ExtHit_t* pHit )
{
if ( !m_bTwofer )
m_dRing [ RingTail() ] = *pHit;
}
inline void ShiftRing()
{
if ( ++m_iRing==(int)m_uWordsExpected )
m_iRing=0;
}
};
/// exact phrase streamer
typedef ExtNWay_c<FSMmultinear> ExtMultinear_c;
/// quorum streamer
class ExtQuorum_c : public ExtNode_i
{
public:
ExtQuorum_c ( CSphVector<ExtNode_i*> & dQwords, const XQNode_t & tNode, const ISphQwordSetup & tSetup );
virtual ~ExtQuorum_c ();
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual int GetQwords ( ExtQwordsHash_t & hQwords );
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords );
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const;
virtual uint64_t GetWordID () const;
virtual bool GotHitless () { return false; }
virtual void HintDocid ( SphDocID_t uMinID )
{
ARRAY_FOREACH ( i, m_dChildren )
if ( m_dChildren[i].m_pTerm )
m_dChildren[i].m_pTerm->HintDocid ( uMinID );
}
static int GetThreshold ( const XQNode_t & tNode, int iQwords );
struct TermTuple_t
{
ExtNode_i * m_pTerm; ///< my children nodes (simply ExtTerm_c for now, not true anymore)
const ExtDoc_t * m_pCurDoc; ///< current positions into children doclists
const ExtHit_t * m_pCurHit; ///< current positions into children hitlists
int m_iCount; ///< terms count in case of dupes
bool m_bStandStill; ///< should we emit hits to proceed further
};
private:
ExtHit_t m_dQuorumHits[MAX_HITS]; ///< buffer for all my quorum hits; inherited m_dHits will receive filtered results
int m_iMyHitCount; ///< hits collected so far
int m_iMyLast; ///< hits processed so far
CSphVector<TermTuple_t> m_dInitialChildren; ///< my children nodes (simply ExtTerm_c for now)
CSphVector<TermTuple_t> m_dChildren;
SphDocID_t m_uMatchedDocid; ///< tail docid for hitlist emission
int m_iThresh; ///< keyword count threshold
// FIXME!!! also skip hits processing for children w\o constrains ( zones or field limit )
bool m_bHasDupes; ///< should we analyze hits on docs collecting
// check for hits that matches and return flag that docs might be advanced
bool CollectMatchingHits ( SphDocID_t uDocid, int iQuorum );
const ExtHit_t * GetHitsChunkDupes ( const ExtDoc_t * pDocs );
const ExtHit_t * GetHitsChunkDupesTail ();
const ExtHit_t * GetHitsChunkSimple ( const ExtDoc_t * pDocs );
int CountQuorum ( bool bFixDupes )
{
if ( !m_bHasDupes )
return m_dChildren.GetLength();
int iSum = 0;
bool bHasDupes = false;
ARRAY_FOREACH ( i, m_dChildren )
{
iSum += m_dChildren[i].m_iCount;
bHasDupes |= ( m_dChildren[i].m_iCount>1 );
}
#if QDEBUG
if ( bFixDupes && bHasDupes!=m_bHasDupes )
printf ( "quorum dupes %d -> %d\n", m_bHasDupes, bHasDupes );
#endif
m_bHasDupes = bFixDupes ? bHasDupes : m_bHasDupes;
return iSum;
}
};
/// A-B-C-in-this-order streamer
class ExtOrder_c : public ExtNode_i
{
public:
ExtOrder_c ( const CSphVector<ExtNode_i *> & dChildren, const ISphQwordSetup & tSetup );
~ExtOrder_c ();
virtual void Reset ( const ISphQwordSetup & tSetup );
virtual const ExtDoc_t * GetDocsChunk();
virtual const ExtHit_t * GetHitsChunk ( const ExtDoc_t * pDocs );
virtual int GetQwords ( ExtQwordsHash_t & hQwords );
virtual void SetQwordsIDF ( const ExtQwordsHash_t & hQwords );
virtual void GetTerms ( const ExtQwordsHash_t & hQwords, CSphVector<TermPos_t> & dTermDupes ) const;
virtual bool GotHitless () { return false; }
virtual uint64_t GetWordID () const;
virtual void HintDocid ( SphDocID_t uMinID )
{
ARRAY_FOREACH ( i, m_dChildren )
m_dChildren[i]->HintDocid ( uMinID );
}
protected:
CSphVector<ExtNode_i *> m_dChildren;
CSphVector<const ExtDoc_t*> m_pDocsChunk; ///< last document chunk (for hit fetching)
CSphVector<const ExtDoc_t*> m_pDocs; ///< current position in document chunk
CSphVector<const ExtHit_t*> m_pHits; ///< current position in hits chunk
ExtHit_t m_dMyHits[MAX_HITS]; ///< buffer for all my phrase hits; inherited m_dHits will receive filtered results
bool m_bDone;
SphDocID_t m_uHitsOverFor;
protected:
int GetChildIdWithNextHit ( SphDocID_t uDocid ); ///< get next hit within given document, and return its child-id
int GetMatchingHits ( SphDocID_t uDocid, ExtHit_t * pHitbuf, int iLimit ); ///< process candidate hits and stores actual matches while we can
};
/// same-text-unit streamer
/// (aka, A and B within same sentence, or same paragraph)
class ExtUnit_c : public ExtNode_i
{