-
-
Notifications
You must be signed in to change notification settings - Fork 252
/
workers.go
663 lines (565 loc) · 18.9 KB
/
workers.go
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
package processor
import (
"bytes"
"fmt"
"github.com/minio/blake2b-simd"
"hash"
"io/ioutil"
"sort"
"strings"
"sync"
"sync/atomic"
)
// The below are used as identifiers for the code state machine
const (
SBlank int64 = 1
SCode int64 = 2
SComment int64 = 3
SCommentCode int64 = 4 // Indicates comment after code
SMulticomment int64 = 5
SMulticommentCode int64 = 6 // Indicates multi comment after code
SMulticommentBlank int64 = 7 // Indicates multi comment ended with blank afterwards
SString int64 = 8
)
// LineType what type of line are are processing
type LineType int32
// These are not meant to be CAMEL_CASE but as it us used by an external project we cannot change it
const (
LINE_BLANK LineType = iota
LINE_CODE
LINE_COMMENT
)
// Taken from https://en.wikipedia.org/wiki/Byte_order_mark#Byte_order_marks_by_encoding
// These indicate that we cannot count the file correctly so we can at least warn the user
var ByteOrderMarks = [][]byte{
{254, 255}, // UTF-16 BE
{255, 254}, // UTF-16 LE
{0, 0, 254, 255}, // UTF-32 BE
{255, 254, 0, 0}, // UTF-32 LE
{43, 47, 118, 56}, // UTF-7
{43, 47, 118, 57}, // UTF-7
{43, 47, 118, 43}, // UTF-7
{43, 47, 118, 47}, // UTF-7
{43, 47, 118, 56, 45}, // UTF-7
{247, 100, 76}, // UTF-1
{221, 115, 102, 115}, // UTF-EBCDIC
{14, 254, 255}, // SCSU
{251, 238, 40}, // BOCU-1
{132, 49, 149, 51}, // GB-18030
}
func checkForMatchSingle(currentByte byte, index int, endPoint int, matches []byte, fileJob *FileJob) bool {
potentialMatch := true
if currentByte == matches[0] {
for j := 0; j < len(matches); j++ {
if index+j >= endPoint || matches[j] != fileJob.Content[index+j] {
potentialMatch = false
break
}
}
if potentialMatch {
return true
}
}
return false
}
func isWhitespace(currentByte byte) bool {
if currentByte != ' ' && currentByte != '\t' && currentByte != '\n' && currentByte != '\r' {
return false
}
return true
}
// Check if this file is binary by checking for nul byte and if so bail out
// this is how GNU Grep, git and ripgrep check for binary files
func isBinary(index int, currentByte byte) bool {
if index < 10000 && !DisableCheckBinary && currentByte == 0 {
return true
}
return false
}
func shouldProcess(currentByte, processBytesMask byte) bool {
if currentByte&processBytesMask != currentByte {
return false
}
return true
}
func resetState(currentState int64) int64 {
if currentState == SMulticomment || currentState == SMulticommentCode {
currentState = SMulticomment
} else if currentState == SString {
currentState = SString
} else {
currentState = SBlank
}
return currentState
}
func stringState(fileJob *FileJob, index int, endPoint int, stringTrie *Trie, endString []byte, currentState int64, ignoreEscape bool) (int, int64) {
// Its not possible to enter this state without checking at least 1 byte so it is safe to check -1 here
// without checking if it is out of bounds first
for i := index; i < endPoint; i++ {
index = i
// If we hit a newline, return because we want to count the stats but keep
// the current state so we end up back in this loop when the outer
// one calls again
if fileJob.Content[i] == '\n' {
return i, currentState
}
// If we are in a literal string we want to ignore the \ check OR we aren't checking for special ones
if ignoreEscape || fileJob.Content[i-1] != '\\' {
if ok, _, _ := stringTrie.Match(fileJob.Content[i:]); ok != 0 {
return i, SCode
}
}
}
return index, currentState
}
func codeState(
fileJob *FileJob,
index int,
endPoint int,
currentState int64,
endString []byte,
endComments [][]byte,
langFeatures LanguageFeature,
digest *hash.Hash,
) (int, int64, []byte, [][]byte, bool) {
for i := index; i < endPoint; i++ {
curByte := fileJob.Content[i]
index = i
if curByte == '\n' {
return i, currentState, endString, endComments, false
}
if isBinary(i, curByte) {
fileJob.Binary = true
return i, currentState, endString, endComments, false
}
if shouldProcess(curByte, langFeatures.ProcessMask) {
if Duplicates {
// Technically this is wrong because we skip bytes so this is not a true
// hash of the file contents, but for duplicate files it shouldn't matter
// as both will skip the same way
digestible := []byte{fileJob.Content[index]}
(*digest).Write(digestible)
}
switch tokenType, offsetJump, endString := langFeatures.Tokens.Match(fileJob.Content[i:]); tokenType {
case TString:
// If we are in string state then check what sort of string so we know if docstring OR ignoreescape string
i, ignoreEscape := verifyIgnoreEscape(langFeatures, fileJob, index)
// It is safe to -1 here as to enter the code state we need to have
// transitioned from blank to here hence i should always be >= 1
// This check is to ensure we aren't in a character declaration
// TODO this should use language features
if fileJob.Content[i-1] != '\\' {
currentState = SString
}
return i, currentState, endString, endComments, ignoreEscape
case TSlcomment:
currentState = SCommentCode
return i, currentState, endString, endComments, false
case TMlcomment:
if langFeatures.Nested || len(endComments) == 0 {
endComments = append(endComments, endString)
currentState = SMulticommentCode
i += offsetJump - 1
return i, currentState, endString, endComments, false
}
case TComplexity:
if index == 0 || isWhitespace(fileJob.Content[index-1]) {
fileJob.Complexity++
}
}
}
}
return index, currentState, endString, endComments, false
}
func commentState(fileJob *FileJob, index int, endPoint int, currentState int64, endComments [][]byte, endString []byte, langFeatures LanguageFeature) (int, int64, []byte, [][]byte) {
for i := index; i < endPoint; i++ {
curByte := fileJob.Content[i]
index = i
if curByte == '\n' {
return i, currentState, endString, endComments
}
if checkForMatchSingle(curByte, index, endPoint, endComments[len(endComments)-1], fileJob) {
// set offset jump here
offsetJump := len(endComments[len(endComments)-1])
endComments = endComments[:len(endComments)-1]
if len(endComments) == 0 {
// If we started as multiline code switch back to code so we count correctly
// IE i := 1 /* for the lols */
// TODO is that required? Might still be required to count correctly
if currentState == SMulticommentCode {
currentState = SCode // TODO pointless to change here, just set S_MULTICOMMENT_BLANK
} else {
currentState = SMulticommentBlank
}
}
i += offsetJump - 1
return i, currentState, endString, endComments
}
// Check if we are entering another multiline comment
// This should come below check for match single as it speeds up processing
if langFeatures.Nested || len(endComments) == 0 {
if ok, offsetJump, endString := langFeatures.MultiLineComments.Match(fileJob.Content[i:]); ok != 0 {
endComments = append(endComments, endString)
i += offsetJump - 1
return i, currentState, endString, endComments
}
}
}
return index, currentState, endString, endComments
}
func blankState(
fileJob *FileJob,
index int,
endPoint int,
currentState int64,
endComments [][]byte,
endString []byte,
langFeatures LanguageFeature,
) (int, int64, []byte, [][]byte, bool) {
switch tokenType, offsetJump, endString := langFeatures.Tokens.Match(fileJob.Content[index:]); tokenType {
case TMlcomment:
if langFeatures.Nested || len(endComments) == 0 {
endComments = append(endComments, endString)
currentState = SMulticomment
index += offsetJump - 1
return index, currentState, endString, endComments, false
}
case TSlcomment:
currentState = SComment
return index, currentState, endString, endComments, false
case TString:
index, ignoreEscape := verifyIgnoreEscape(langFeatures, fileJob, index)
currentState = SString
return index, currentState, endString, endComments, ignoreEscape
case TComplexity:
currentState = SCode
if index == 0 || isWhitespace(fileJob.Content[index-1]) {
fileJob.Complexity++
}
default:
currentState = SCode
}
return index, currentState, endString, endComments, false
}
// Some languages such as C# have quoted strings like @"\" where no escape character is required
// this checks if there is one so we can cater for these cases
func verifyIgnoreEscape(langFeatures LanguageFeature, fileJob *FileJob, index int) (int, bool) {
ignoreEscape := false
// loop over the string states and if we have the special flag match, and if so we need to ensure we can handle them
for i := 0; i < len(langFeatures.Quotes); i++ {
if langFeatures.Quotes[i].DocString || langFeatures.Quotes[i].IgnoreEscape {
// If so we need to check if where we are falls into these conditions
isMatch := true
for j := 0; j < len(langFeatures.Quotes[i].Start); j++ {
if fileJob.Content[index+j] != langFeatures.Quotes[i].Start[j] {
isMatch = false
break
}
}
// If we have a match then jump ahead enough so we don't pick it up again for cases like @"
if isMatch {
ignoreEscape = true
index = index + len(langFeatures.Quotes[i].Start)
}
}
}
return index, ignoreEscape
}
// CountStats will process the fileJob
// If the file contains anything even just a newline its line count should be >= 1.
// If the file has a size of 0 its line count should be 0.
// Newlines belong to the line they started on so a file of \n means only 1 line
// This is the 'hot' path for the application and needs to be as fast as possible
func CountStats(fileJob *FileJob) {
// Needs to always run to ensure the language is set
determineLanguage(fileJob)
// If the file has a length of 0 it is is empty then we say it has no lines
fileJob.Bytes = int64(len(fileJob.Content))
if fileJob.Bytes == 0 {
fileJob.Lines = 0
return
}
LanguageFeaturesMutex.Lock()
langFeatures := LanguageFeatures[fileJob.Language]
LanguageFeaturesMutex.Unlock()
if langFeatures.Complexity == nil {
langFeatures.Complexity = &Trie{}
}
if langFeatures.SingleLineComments == nil {
langFeatures.SingleLineComments = &Trie{}
}
if langFeatures.MultiLineComments == nil {
langFeatures.MultiLineComments = &Trie{}
}
if langFeatures.Strings == nil {
langFeatures.Strings = &Trie{}
}
if langFeatures.Tokens == nil {
langFeatures.Tokens = &Trie{}
}
endPoint := int(fileJob.Bytes - 1)
currentState := SBlank
endComments := [][]byte{}
endString := []byte{}
// TODO needs to be set via langFeatures.Quotes[0].IgnoreEscape for the matching feature
ignoreEscape := false
// For determining duplicates we need the below. The reason for creating
// the byte array here is to avoid GC pressure. MD5 is in the standard library
// and is fast enough to not warrant murmur3 hashing. No need to be
// crypto secure here either so no need to eat the performance cost of a better
// hash method
var digest hash.Hash
if Duplicates {
digest = blake2b.New256()
}
for index := checkBomSkip(fileJob); index < len(fileJob.Content); index++ {
// Based on our current state determine if the state should change by checking
// what the character is. The below is very CPU bound so need to be careful if
// changing anything in here and profile/measure afterwards!
// NB that the order of the if statements matters and has been set to what in benchmarks is most efficient
if !isWhitespace(fileJob.Content[index]) {
switch currentState {
case SCode:
index, currentState, endString, endComments, ignoreEscape = codeState(
fileJob,
index,
endPoint,
currentState,
endString,
endComments,
langFeatures,
&digest,
)
case SString:
index, currentState = stringState(fileJob, index, endPoint, langFeatures.Strings, endString, currentState, ignoreEscape)
case SMulticomment, SMulticommentCode:
index, currentState, endString, endComments = commentState(
fileJob,
index,
endPoint,
currentState,
endComments,
endString,
langFeatures,
)
case SBlank, SMulticommentBlank:
// From blank we can move into comment, move into a multiline comment
// or move into code but we can only do one.
index, currentState, endString, endComments, ignoreEscape = blankState(
fileJob,
index,
endPoint,
currentState,
endComments,
endString,
langFeatures,
)
}
}
// Only check the first 10000 characters for null bytes indicating a binary file
// and if we find it then we return otherwise carry on and ignore binary markers
if index < 10000 && fileJob.Binary {
return
}
// This means the end of processing the line so calculate the stats according to what state
// we are currently in
if fileJob.Content[index] == '\n' || index >= endPoint {
fileJob.Lines++
switch currentState {
case SCode, SString, SCommentCode, SMulticommentCode:
fileJob.Code++
currentState = resetState(currentState)
if fileJob.Callback != nil {
if !fileJob.Callback.ProcessLine(fileJob, fileJob.Lines, LINE_CODE) {
return
}
}
if Trace {
printTrace(fmt.Sprintf("%s line %d ended with state: %d: counted as code", fileJob.Location, fileJob.Lines, currentState))
}
case SComment, SMulticomment, SMulticommentBlank:
fileJob.Comment++
currentState = resetState(currentState)
if fileJob.Callback != nil {
if !fileJob.Callback.ProcessLine(fileJob, fileJob.Lines, LINE_COMMENT) {
return
}
}
if Trace {
printTrace(fmt.Sprintf("%s line %d ended with state: %d: counted as comment", fileJob.Location, fileJob.Lines, currentState))
}
case SBlank:
fileJob.Blank++
if fileJob.Callback != nil {
if !fileJob.Callback.ProcessLine(fileJob, fileJob.Lines, LINE_BLANK) {
return
}
}
if Trace {
printTrace(fmt.Sprintf("%s line %d ended with state: %d: counted as blank", fileJob.Location, fileJob.Lines, currentState))
}
}
}
}
if Duplicates {
fileJob.Hash = digest.Sum(nil)
}
// Save memory by unsetting the content as we no longer require it
fileJob.Content = nil
}
// Check if we have any Byte Order Marks (BOM) in front of the file
func checkBomSkip(fileJob *FileJob) int {
// UTF-8 BOM which if detected we should skip the BOM as we can then count correctly
// []byte is UTF-8 BOM taken from https://en.wikipedia.org/wiki/Byte_order_mark#Byte_order_marks_by_encoding
if bytes.HasPrefix(fileJob.Content, []byte{239, 187, 191}) {
if Verbose {
printWarn(fmt.Sprintf("UTF-8 BOM found for file %s skipping 3 bytes", fileJob.Filename))
}
return 3
}
// If we have one of the other BOM then we might not be able to count correctly so if verbose let the user know
if Verbose {
for _, v := range ByteOrderMarks {
if bytes.HasPrefix(fileJob.Content, v) {
printWarn(fmt.Sprintf("BOM found for file %s indicating it is not ASCII/UTF-8 and may be counted incorrectly or ignored as a binary file", fileJob.Filename))
}
}
}
return 0
}
type languageGuess struct {
Name string
Count int
}
// Given a filejob which could have multiple language types make a guess to the type
// based on keywords supplied, which is similar to how https://github.com/vmchale/polyglot does it
// If however there is only a single language we
func determineLanguage(fileJob *FileJob) {
// If being called through an API its possible nothing is set here and as
// such should just return as the Language value should have already been set
if len(fileJob.PossibleLanguages) == 0 {
return
}
// There should only be two possibilities now, either we have a single language
// in which case we set it and return
// or we have multiple in which case we try to determine it heuristically
if len(fileJob.PossibleLanguages) == 1 {
fileJob.Language = fileJob.PossibleLanguages[0]
return
}
startTime := makeTimestampNano()
var toCheck string
if len(fileJob.Content) > 2000 {
toCheck = string(fileJob.Content)[:2000]
} else {
toCheck = string(fileJob.Content)
}
toSort := []languageGuess{}
for _, lan := range fileJob.PossibleLanguages {
LanguageFeaturesMutex.Lock()
langFeatures := LanguageFeatures[lan]
LanguageFeaturesMutex.Unlock()
count := 0
for _, key := range langFeatures.Keywords {
if strings.Contains(toCheck, key) {
fileJob.Language = lan
count++
}
}
toSort = append(toSort, languageGuess{Name: lan, Count: count})
}
sort.Slice(toSort, func(i, j int) bool {
return toSort[i].Count > toSort[j].Count
})
if Verbose {
printWarn(fmt.Sprintf("guessing language %s for file %s", toSort[0].Name, fileJob.Filename))
}
if Trace {
printTrace(fmt.Sprintf("nanoseconds to guess language: %s: %d", fileJob.Filename, makeTimestampNano()-startTime))
}
if len(toSort) != 0 {
fileJob.Language = toSort[0].Name
}
}
// Reads entire file into memory and then pushes it onto the next queue
func fileReaderWorker(input chan *FileJob, output chan *FileJob) {
var startTime int64
var wg sync.WaitGroup
for i := 0; i < FileReadJobWorkers; i++ {
wg.Add(1)
go func() {
for res := range input {
atomic.CompareAndSwapInt64(&startTime, 0, makeTimestampMilli())
fileStartTime := makeTimestampNano()
content, err := ioutil.ReadFile(res.Location)
if Trace {
printTrace(fmt.Sprintf("nanoseconds read into memory: %s: %d", res.Location, makeTimestampNano()-fileStartTime))
}
if err == nil {
res.Content = content
output <- res
} else {
if Verbose {
printWarn(fmt.Sprintf("error reading: %s %s", res.Location, err))
}
}
}
wg.Done()
}()
}
go func() {
wg.Wait()
close(output)
if Debug {
printDebug(fmt.Sprintf("milliseconds reading files into memory: %d", makeTimestampMilli()-startTime))
}
}()
}
var duplicates = CheckDuplicates{
hashes: make(map[int64][][]byte),
}
// Does the actual processing of stats and as such contains the hot path CPU call
func fileProcessorWorker(input chan *FileJob, output chan *FileJob) {
var startTime int64
var wg sync.WaitGroup
for i := 0; i < FileProcessJobWorkers; i++ {
wg.Add(1)
go func() {
for res := range input {
atomic.CompareAndSwapInt64(&startTime, 0, makeTimestampMilli())
fileStartTime := makeTimestampNano()
CountStats(res)
if Duplicates {
duplicates.mux.Lock()
if duplicates.Check(res.Bytes, res.Hash) {
if Verbose {
printWarn(fmt.Sprintf("skipping duplicate file: %s", res.Location))
}
duplicates.mux.Unlock()
continue
}
duplicates.Add(res.Bytes, res.Hash)
duplicates.mux.Unlock()
}
if Trace {
printTrace(fmt.Sprintf("nanoseconds process: %s: %d", res.Location, makeTimestampNano()-fileStartTime))
}
if !res.Binary {
output <- res
} else {
if Verbose {
printWarn(fmt.Sprintf("skipping file identified as binary: %s", res.Location))
}
}
}
wg.Done()
}()
}
go func() {
wg.Wait()
close(output)
}()
if Debug {
printDebug(fmt.Sprintf("milliseconds processing files: %d", makeTimestampMilli()-startTime))
}
}