-
Notifications
You must be signed in to change notification settings - Fork 443
/
faidx.c
1066 lines (868 loc) · 30.3 KB
/
faidx.c
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
/* faidx.c -- FASTA and FASTQ random access.
Copyright (C) 2008, 2009, 2013-2020, 2022, 2024 Genome Research Ltd.
Portions copyright (C) 2011 Broad Institute.
Author: Heng Li <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE. */
#define HTS_BUILDING_LIBRARY // Enables HTSLIB_EXPORT, see htslib/hts_defs.h
#include <config.h>
#include <ctype.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <inttypes.h>
#include <errno.h>
#include <limits.h>
#include <unistd.h>
#include <assert.h>
#include "htslib/bgzf.h"
#include "htslib/faidx.h"
#include "htslib/hfile.h"
#include "htslib/khash.h"
#include "htslib/kstring.h"
#include "hts_internal.h"
// Faster isgraph; assumes ASCII
static inline int isgraph_(unsigned char c) {
return c > ' ' && c <= '~';
}
#ifdef isgraph
# undef isgraph
#endif
#define isgraph isgraph_
// An optimised bgzf_getc.
// We could consider moving this to bgzf.h, but our own code uses it here only.
static inline int bgzf_getc_(BGZF *fp) {
if (fp->block_offset+1 < fp->block_length) {
int c = ((unsigned char*)fp->uncompressed_block)[fp->block_offset++];
fp->uncompressed_address++;
return c;
}
return bgzf_getc(fp);
}
#define bgzf_getc bgzf_getc_
typedef struct {
int id; // faidx_t->name[id] is for this struct.
uint32_t line_len, line_blen;
uint64_t len;
uint64_t seq_offset;
uint64_t qual_offset;
} faidx1_t;
KHASH_MAP_INIT_STR(s, faidx1_t)
struct faidx_t {
BGZF *bgzf;
int n, m;
char **name;
khash_t(s) *hash;
enum fai_format_options format;
};
static int fai_name2id(void *v, const char *ref)
{
faidx_t *fai = (faidx_t *)v;
khint_t k = kh_get(s, fai->hash, ref);
return k == kh_end(fai->hash) ? -1 : kh_val(fai->hash, k).id;
}
static inline int fai_insert_index(faidx_t *idx, const char *name, uint64_t len, uint32_t line_len, uint32_t line_blen, uint64_t seq_offset, uint64_t qual_offset)
{
if (!name) {
hts_log_error("Malformed line");
return -1;
}
char *name_key = strdup(name);
int absent;
khint_t k = kh_put(s, idx->hash, name_key, &absent);
faidx1_t *v = &kh_value(idx->hash, k);
if (! absent) {
hts_log_warning("Ignoring duplicate sequence \"%s\" at byte offset %" PRIu64, name, seq_offset);
free(name_key);
return 0;
}
if (idx->n == idx->m) {
char **tmp;
idx->m = idx->m? idx->m<<1 : 16;
if (!(tmp = (char**)realloc(idx->name, sizeof(char*) * idx->m))) {
hts_log_error("Out of memory");
return -1;
}
idx->name = tmp;
}
v->id = idx->n;
idx->name[idx->n++] = name_key;
v->len = len;
v->line_len = line_len;
v->line_blen = line_blen;
v->seq_offset = seq_offset;
v->qual_offset = qual_offset;
return 0;
}
static faidx_t *fai_build_core(BGZF *bgzf) {
kstring_t name = { 0, 0, NULL };
int c, read_done, line_num;
faidx_t *idx;
uint64_t seq_offset, qual_offset;
uint64_t seq_len, qual_len;
uint64_t char_len, cl, line_len, ll;
enum read_state {OUT_READ, IN_NAME, IN_SEQ, SEQ_END, IN_QUAL} state;
idx = (faidx_t*)calloc(1, sizeof(faidx_t));
idx->hash = kh_init(s);
idx->format = FAI_NONE;
state = OUT_READ, read_done = 0, line_num = 1;
seq_offset = qual_offset = seq_len = qual_len = char_len = cl = line_len = ll = 0;
while ((c = bgzf_getc(bgzf)) >= 0) {
switch (state) {
case OUT_READ:
switch (c) {
case '>':
if (idx->format == FAI_FASTQ) {
hts_log_error("Found '>' in a FASTQ file, error at line %d", line_num);
goto fail;
}
idx->format = FAI_FASTA;
state = IN_NAME;
break;
case '@':
if (idx->format == FAI_FASTA) {
hts_log_error("Found '@' in a FASTA file, error at line %d", line_num);
goto fail;
}
idx->format = FAI_FASTQ;
state = IN_NAME;
break;
case '\r':
// Blank line with cr-lf ending?
if ((c = bgzf_getc(bgzf)) == '\n') {
line_num++;
} else {
hts_log_error("Format error, carriage return not followed by new line at line %d", line_num);
goto fail;
}
break;
case '\n':
// just move onto the next line
line_num++;
break;
default: {
char s[4] = { '"', c, '"', '\0' };
hts_log_error("Format error, unexpected %s at line %d", isprint(c) ? s : "character", line_num);
goto fail;
}
}
break;
case IN_NAME:
if (read_done) {
if (fai_insert_index(idx, name.s, seq_len, line_len, char_len, seq_offset, qual_offset) != 0)
goto fail;
read_done = 0;
}
name.l = 0;
do {
if (!isspace(c)) {
kputc(c, &name);
} else if (name.l > 0 || c == '\n') {
break;
}
} while ((c = bgzf_getc(bgzf)) >= 0);
kputsn("", 0, &name);
if (c < 0) {
hts_log_error("The last entry '%s' has no sequence at line %d", name.s, line_num);
goto fail;
}
// read the rest of the line if necessary
if (c != '\n') while ((c = bgzf_getc(bgzf)) >= 0 && c != '\n');
state = IN_SEQ; seq_len = qual_len = char_len = line_len = 0;
seq_offset = bgzf_utell(bgzf);
line_num++;
break;
case IN_SEQ:
if (idx->format == FAI_FASTA) {
if (c == '\n') {
state = OUT_READ;
line_num++;
continue;
} else if (c == '>') {
state = IN_NAME;
continue;
}
} else if (idx->format == FAI_FASTQ) {
if (c == '+') {
state = IN_QUAL;
if (c != '\n') while ((c = bgzf_getc(bgzf)) >= 0 && c != '\n');
qual_offset = bgzf_utell(bgzf);
line_num++;
continue;
} else if (c == '\n') {
hts_log_error("Inlined empty line is not allowed in sequence '%s' at line %d", name.s, line_num);
goto fail;
}
}
ll = cl = 0;
if (idx->format == FAI_FASTA) read_done = 1;
do {
ll++;
if (isgraph(c)) cl++;
} while ((c = bgzf_getc(bgzf)) >= 0 && c != '\n');
ll++; seq_len += cl;
if (line_len == 0) {
line_len = ll;
char_len = cl;
} else if (line_len > ll) {
if (idx->format == FAI_FASTA)
state = OUT_READ;
else
state = SEQ_END;
} else if (line_len < ll) {
hts_log_error("Different line length in sequence '%s' at line %d", name.s, line_num);
goto fail;
}
line_num++;
break;
case SEQ_END:
if (c == '+') {
state = IN_QUAL;
while ((c = bgzf_getc(bgzf)) >= 0 && c != '\n');
qual_offset = bgzf_utell(bgzf);
line_num++;
} else {
hts_log_error("Format error, expecting '+', got '%c' at line %d", c, line_num);
goto fail;
}
break;
case IN_QUAL:
if (c == '\n') {
if (!read_done) {
hts_log_error("Inlined empty line is not allowed in quality of sequence '%s' at line %d", name.s, line_num);
goto fail;
}
state = OUT_READ;
line_num++;
continue;
} else if (c == '@' && read_done) {
state = IN_NAME;
continue;
}
ll = cl = 0;
do {
ll++;
if (isgraph(c)) cl++;
} while ((c = bgzf_getc(bgzf)) >= 0 && c != '\n');
ll++; qual_len += cl;
if (line_len < ll) {
hts_log_error("Quality line length too long in '%s' at line %d", name.s, line_num);
goto fail;
} else if (qual_len == seq_len) {
read_done = 1;
} else if (qual_len > seq_len) {
hts_log_error("Quality length longer than sequence in '%s' at line %d", name.s, line_num);
goto fail;
} else if (line_len > ll) {
hts_log_error("Quality line length too short in '%s' at line %d", name.s, line_num);
goto fail;
}
line_num++;
break;
}
}
if (read_done) {
if (fai_insert_index(idx, name.s, seq_len, line_len, char_len, seq_offset, qual_offset) != 0)
goto fail;
} else {
hts_log_error("File truncated at line %d", line_num);
goto fail;
}
free(name.s);
return idx;
fail:
free(name.s);
fai_destroy(idx);
return NULL;
}
static int fai_save(const faidx_t *fai, hFILE *fp) {
khint_t k;
int i;
char buf[96]; // Must be big enough for format below.
for (i = 0; i < fai->n; ++i) {
faidx1_t x;
k = kh_get(s, fai->hash, fai->name[i]);
assert(k < kh_end(fai->hash));
x = kh_value(fai->hash, k);
if (fai->format == FAI_FASTA) {
snprintf(buf, sizeof(buf),
"\t%"PRIu64"\t%"PRIu64"\t%"PRIu32"\t%"PRIu32"\n",
x.len, x.seq_offset, x.line_blen, x.line_len);
} else {
snprintf(buf, sizeof(buf),
"\t%"PRIu64"\t%"PRIu64"\t%"PRIu32"\t%"PRIu32"\t%"PRIu64"\n",
x.len, x.seq_offset, x.line_blen, x.line_len, x.qual_offset);
}
if (hputs(fai->name[i], fp) != 0) return -1;
if (hputs(buf, fp) != 0) return -1;
}
return 0;
}
static faidx_t *fai_read(hFILE *fp, const char *fname, int format)
{
faidx_t *fai;
char *buf = NULL, *p;
ssize_t l, lnum = 1;
fai = (faidx_t*)calloc(1, sizeof(faidx_t));
if (!fai) return NULL;
fai->hash = kh_init(s);
if (!fai->hash) goto fail;
buf = (char*)calloc(0x10000, 1);
if (!buf) goto fail;
while ((l = hgetln(buf, 0x10000, fp)) > 0) {
uint32_t line_len, line_blen, n;
uint64_t len;
uint64_t seq_offset;
uint64_t qual_offset = 0;
for (p = buf; *p && !isspace_c(*p); ++p);
if (p - buf < l) {
*p = 0; ++p;
}
if (format == FAI_FASTA) {
n = sscanf(p, "%"SCNu64"%"SCNu64"%"SCNu32"%"SCNu32, &len, &seq_offset, &line_blen, &line_len);
if (n != 4) {
hts_log_error("Could not understand FASTA index %s line %zd", fname, lnum);
goto fail;
}
} else {
n = sscanf(p, "%"SCNu64"%"SCNu64"%"SCNu32"%"SCNu32"%"SCNu64, &len, &seq_offset, &line_blen, &line_len, &qual_offset);
if (n != 5) {
if (n == 4) {
hts_log_error("Possibly this is a FASTA index, try using faidx. Problem in %s line %zd", fname, lnum);
} else {
hts_log_error("Could not understand FASTQ index %s line %zd", fname, lnum);
}
goto fail;
}
}
if (fai_insert_index(fai, buf, len, line_len, line_blen, seq_offset, qual_offset) != 0) {
goto fail;
}
if (buf[l - 1] == '\n') ++lnum;
}
if (l < 0) {
hts_log_error("Error while reading %s: %s", fname, strerror(errno));
goto fail;
}
free(buf);
return fai;
fail:
free(buf);
fai_destroy(fai);
return NULL;
}
void fai_destroy(faidx_t *fai)
{
int i;
if (!fai) return;
for (i = 0; i < fai->n; ++i) free(fai->name[i]);
free(fai->name);
kh_destroy(s, fai->hash);
if (fai->bgzf) bgzf_close(fai->bgzf);
free(fai);
}
static int fai_build3_core(const char *fn, const char *fnfai, const char *fngzi)
{
kstring_t fai_kstr = { 0, 0, NULL };
kstring_t gzi_kstr = { 0, 0, NULL };
BGZF *bgzf = NULL;
hFILE *fp = NULL;
faidx_t *fai = NULL;
int save_errno, res;
char *file_type;
bgzf = bgzf_open(fn, "r");
if ( !bgzf ) {
hts_log_error("Failed to open the file %s : %s", fn, strerror(errno));
goto fail;
}
if ( bgzf->is_compressed ) {
if (bgzf_index_build_init(bgzf) != 0) {
hts_log_error("Failed to allocate bgzf index");
goto fail;
}
}
fai = fai_build_core(bgzf);
if ( !fai ) {
if (bgzf->is_compressed && bgzf->is_gzip) {
hts_log_error("Cannot index files compressed with gzip, please use bgzip");
}
goto fail;
}
if (fai->format == FAI_FASTA) {
file_type = "FASTA";
} else {
file_type = "FASTQ";
}
if (!fnfai) {
if (ksprintf(&fai_kstr, "%s.fai", fn) < 0) goto fail;
fnfai = fai_kstr.s;
}
if (!fngzi) {
if (ksprintf(&gzi_kstr, "%s.gzi", fn) < 0) goto fail;
fngzi = gzi_kstr.s;
}
if ( bgzf->is_compressed ) {
if (bgzf_index_dump(bgzf, fngzi, NULL) < 0) {
hts_log_error("Failed to make bgzf index %s", fngzi);
goto fail;
}
}
res = bgzf_close(bgzf);
bgzf = NULL;
if (res < 0) {
hts_log_error("Error on closing %s : %s", fn, strerror(errno));
goto fail;
}
fp = hopen(fnfai, "wb");
if ( !fp ) {
hts_log_error("Failed to open %s index %s : %s", file_type, fnfai, strerror(errno));
goto fail;
}
if (fai_save(fai, fp) != 0) {
hts_log_error("Failed to write %s index %s : %s", file_type, fnfai, strerror(errno));
goto fail;
}
if (hclose(fp) != 0) {
hts_log_error("Failed on closing %s index %s : %s", file_type, fnfai, strerror(errno));
goto fail;
}
free(fai_kstr.s);
free(gzi_kstr.s);
fai_destroy(fai);
return 0;
fail:
save_errno = errno;
free(fai_kstr.s);
free(gzi_kstr.s);
bgzf_close(bgzf);
fai_destroy(fai);
errno = save_errno;
return -1;
}
int fai_build3(const char *fn, const char *fnfai, const char *fngzi) {
return fai_build3_core(fn, fnfai, fngzi);
}
int fai_build(const char *fn) {
return fai_build3(fn, NULL, NULL);
}
static faidx_t *fai_load3_core(const char *fn, const char *fnfai, const char *fngzi,
int flags, int format)
{
kstring_t fai_kstr = { 0, 0, NULL };
kstring_t gzi_kstr = { 0, 0, NULL };
hFILE *fp = NULL;
faidx_t *fai = NULL;
int res, gzi_index_needed = 0;
char *file_type;
if (format == FAI_FASTA) {
file_type = "FASTA";
} else {
file_type = "FASTQ";
}
if (fn == NULL)
return NULL;
if (fnfai == NULL) {
if (ksprintf(&fai_kstr, "%s.fai", fn) < 0) goto fail;
fnfai = fai_kstr.s;
}
if (fngzi == NULL) {
if (ksprintf(&gzi_kstr, "%s.gzi", fn) < 0) goto fail;
fngzi = gzi_kstr.s;
}
fp = hopen(fnfai, "rb");
if (fp) {
// index file present, check if a compressed index is needed
hFILE *gz = NULL;
BGZF *bgzf = bgzf_open(fn, "rb");
if (bgzf == 0) {
hts_log_error("Failed to open %s file %s", file_type, fn);
goto fail;
}
if (bgzf_compression(bgzf) == 2) { // BGZF compression
if ((gz = hopen(fngzi, "rb")) == 0) {
if (!(flags & FAI_CREATE) || errno != ENOENT) {
hts_log_error("Failed to open %s index %s: %s", file_type, fngzi, strerror(errno));
bgzf_close(bgzf);
goto fail;
}
gzi_index_needed = 1;
res = hclose(fp); // closed as going to be re-indexed
if (res < 0) {
hts_log_error("Failed on closing %s index %s : %s", file_type, fnfai, strerror(errno));
goto fail;
}
} else {
res = hclose(gz);
if (res < 0) {
hts_log_error("Failed on closing %s index %s : %s", file_type, fngzi, strerror(errno));
goto fail;
}
}
}
bgzf_close(bgzf);
}
if (fp == 0 || gzi_index_needed) {
if (!(flags & FAI_CREATE) || errno != ENOENT) {
hts_log_error("Failed to open %s index %s: %s", file_type, fnfai, strerror(errno));
goto fail;
}
hts_log_info("Build %s index", file_type);
if (fai_build3_core(fn, fnfai, fngzi) < 0) {
goto fail;
}
fp = hopen(fnfai, "rb");
if (fp == 0) {
hts_log_error("Failed to open %s index %s: %s", file_type, fnfai, strerror(errno));
goto fail;
}
}
fai = fai_read(fp, fnfai, format);
if (fai == NULL) {
hts_log_error("Failed to read %s index %s", file_type, fnfai);
goto fail;
}
res = hclose(fp);
fp = NULL;
if (res < 0) {
hts_log_error("Failed on closing %s index %s : %s", file_type, fnfai, strerror(errno));
goto fail;
}
fai->bgzf = bgzf_open(fn, "rb");
if (fai->bgzf == 0) {
hts_log_error("Failed to open %s file %s", file_type, fn);
goto fail;
}
if ( fai->bgzf->is_compressed==1 ) {
if ( bgzf_index_load(fai->bgzf, fngzi, NULL) < 0 ) {
hts_log_error("Failed to load .gzi index: %s", fngzi);
goto fail;
}
}
free(fai_kstr.s);
free(gzi_kstr.s);
return fai;
fail:
if (fai) fai_destroy(fai);
if (fp) hclose_abruptly(fp);
free(fai_kstr.s);
free(gzi_kstr.s);
return NULL;
}
faidx_t *fai_load3(const char *fn, const char *fnfai, const char *fngzi,
int flags) {
return fai_load3_core(fn, fnfai, fngzi, flags, FAI_FASTA);
}
faidx_t *fai_load(const char *fn)
{
return fai_load3(fn, NULL, NULL, FAI_CREATE);
}
faidx_t *fai_load3_format(const char *fn, const char *fnfai, const char *fngzi,
int flags, enum fai_format_options format) {
return fai_load3_core(fn, fnfai, fngzi, flags, format);
}
faidx_t *fai_load_format(const char *fn, enum fai_format_options format) {
return fai_load3_format(fn, NULL, NULL, FAI_CREATE, format);
}
static char *fai_retrieve(const faidx_t *fai, const faidx1_t *val,
uint64_t offset, hts_pos_t beg, hts_pos_t end, hts_pos_t *len) {
char *buffer, *s;
ssize_t nread, remaining, firstline_len, firstline_blen;
int ret;
if ((uint64_t) end - (uint64_t) beg >= SIZE_MAX - 2) {
hts_log_error("Range %"PRId64"..%"PRId64" too big", beg, end);
*len = -1;
return NULL;
}
if (val->line_blen <= 0) {
hts_log_error("Invalid line length in index: %d", val->line_blen);
*len = -1;
return NULL;
}
ret = bgzf_useek(fai->bgzf,
offset
+ beg / val->line_blen * val->line_len
+ beg % val->line_blen, SEEK_SET);
if (ret < 0) {
*len = -1;
hts_log_error("Failed to retrieve block. (Seeking in a compressed, .gzi unindexed, file?)");
return NULL;
}
// Over-allocate so there is extra space for one end-of-line sequence
buffer = (char*)malloc((size_t) end - beg + val->line_len - val->line_blen + 1);
if (!buffer) {
*len = -1;
return NULL;
}
remaining = *len = end - beg;
firstline_blen = val->line_blen - beg % val->line_blen;
// Special case when the entire interval requested is within a single FASTA/Q line
if (remaining <= firstline_blen) {
nread = bgzf_read_small(fai->bgzf, buffer, remaining);
if (nread < remaining) goto error;
buffer[nread] = '\0';
return buffer;
}
s = buffer;
firstline_len = val->line_len - beg % val->line_blen;
// Read the (partial) first line and its line terminator, but increment s past the
// line contents only, so the terminator characters will be overwritten by the next line.
nread = bgzf_read_small(fai->bgzf, s, firstline_len);
if (nread < firstline_len) goto error;
s += firstline_blen;
remaining -= firstline_blen;
// Similarly read complete lines and their line terminator characters, but overwrite the latter.
while (remaining > val->line_blen) {
nread = bgzf_read_small(fai->bgzf, s, val->line_len);
if (nread < (ssize_t) val->line_len) goto error;
s += val->line_blen;
remaining -= val->line_blen;
}
if (remaining > 0) {
nread = bgzf_read_small(fai->bgzf, s, remaining);
if (nread < remaining) goto error;
s += remaining;
}
*s = '\0';
return buffer;
error:
hts_log_error("Failed to retrieve block: %s",
(nread == 0)? "unexpected end of file" : "error reading file");
free(buffer);
*len = -1;
return NULL;
}
static int fai_get_val(const faidx_t *fai, const char *str,
hts_pos_t *len, faidx1_t *val, hts_pos_t *fbeg, hts_pos_t *fend) {
khiter_t iter;
khash_t(s) *h;
int id;
hts_pos_t beg, end;
if (!fai_parse_region(fai, str, &id, &beg, &end, 0)) {
hts_log_warning("Reference %s not found in FASTA file, returning empty sequence", str);
*len = -2;
return 1;
}
h = fai->hash;
iter = kh_get(s, h, faidx_iseq(fai, id));
if (iter >= kh_end(h)) {
// should have already been caught above
abort();
}
*val = kh_value(h, iter);
if (beg >= val->len) beg = val->len;
if (end >= val->len) end = val->len;
if (beg > end) beg = end;
*fbeg = beg;
*fend = end;
return 0;
}
/*
* The internal still has line_blen as uint32_t, but our references
* can be longer, so for future proofing we use hts_pos_t. We also needed
* a signed value so we can return negatives as an error.
*/
hts_pos_t fai_line_length(const faidx_t *fai, const char *str)
{
faidx1_t val;
int64_t beg, end;
hts_pos_t len;
if (fai_get_val(fai, str, &len, &val, &beg, &end))
return -1;
else
return val.line_blen;
}
char *fai_fetch64(const faidx_t *fai, const char *str, hts_pos_t *len)
{
faidx1_t val;
int64_t beg, end;
if (fai_get_val(fai, str, len, &val, &beg, &end)) {
return NULL;
}
// now retrieve the sequence
return fai_retrieve(fai, &val, val.seq_offset, beg, end, len);
}
char *fai_fetch(const faidx_t *fai, const char *str, int *len)
{
hts_pos_t len64;
char *ret = fai_fetch64(fai, str, &len64);
*len = len64 < INT_MAX ? len64 : INT_MAX; // trunc
return ret;
}
char *fai_fetchqual64(const faidx_t *fai, const char *str, hts_pos_t *len) {
faidx1_t val;
int64_t beg, end;
if (fai_get_val(fai, str, len, &val, &beg, &end)) {
return NULL;
}
// now retrieve the sequence
return fai_retrieve(fai, &val, val.qual_offset, beg, end, len);
}
char *fai_fetchqual(const faidx_t *fai, const char *str, int *len) {
hts_pos_t len64;
char *ret = fai_fetchqual64(fai, str, &len64);
*len = len64 < INT_MAX ? len64 : INT_MAX; // trunc
return ret;
}
int faidx_fetch_nseq(const faidx_t *fai)
{
return fai->n;
}
int faidx_nseq(const faidx_t *fai)
{
return fai->n;
}
const char *faidx_iseq(const faidx_t *fai, int i)
{
return fai->name[i];
}
hts_pos_t faidx_seq_len64(const faidx_t *fai, const char *seq)
{
khint_t k = kh_get(s, fai->hash, seq);
if ( k == kh_end(fai->hash) ) return -1;
return kh_val(fai->hash, k).len;
}
int faidx_seq_len(const faidx_t *fai, const char *seq)
{
hts_pos_t len = faidx_seq_len64(fai, seq);
return len < INT_MAX ? len : INT_MAX;
}
static int faidx_adjust_position(const faidx_t *fai, int end_adjust,
faidx1_t *val_out, const char *c_name,
hts_pos_t *p_beg_i, hts_pos_t *p_end_i,
hts_pos_t *len) {
khiter_t iter;
faidx1_t *val;
// Adjust position
iter = kh_get(s, fai->hash, c_name);
if (iter == kh_end(fai->hash)) {
if (len)
*len = -2;
hts_log_error("The sequence \"%s\" was not found", c_name);
return 1;
}
val = &kh_value(fai->hash, iter);
if (val_out)
*val_out = *val;
if(*p_end_i < *p_beg_i)
*p_beg_i = *p_end_i;
if(*p_beg_i < 0)
*p_beg_i = 0;
else if(val->len <= *p_beg_i)
*p_beg_i = val->len;
if(*p_end_i < 0)
*p_end_i = 0;
else if(val->len <= *p_end_i)
*p_end_i = val->len - end_adjust;
return 0;
}
int fai_adjust_region(const faidx_t *fai, int tid,
hts_pos_t *beg, hts_pos_t *end)
{
hts_pos_t orig_beg, orig_end;
if (!fai || !beg || !end || tid < 0 || tid >= fai->n)
return -1;
orig_beg = *beg;
orig_end = *end;
if (faidx_adjust_position(fai, 0, NULL, fai->name[tid], beg, end, NULL) != 0) {
hts_log_error("Inconsistent faidx internal state - couldn't find \"%s\"",
fai->name[tid]);
return -1;
}
return ((orig_beg != *beg ? 1 : 0) |
(orig_end != *end && orig_end < HTS_POS_MAX ? 2 : 0));
}
char *faidx_fetch_seq64(const faidx_t *fai, const char *c_name, hts_pos_t p_beg_i, hts_pos_t p_end_i, hts_pos_t *len)
{
faidx1_t val;
// Adjust position
if (faidx_adjust_position(fai, 1, &val, c_name, &p_beg_i, &p_end_i, len)) {
return NULL;
}
// Now retrieve the sequence
return fai_retrieve(fai, &val, val.seq_offset, p_beg_i, p_end_i + 1, len);
}
char *faidx_fetch_seq(const faidx_t *fai, const char *c_name, int p_beg_i, int p_end_i, int *len)
{
hts_pos_t len64;
char *ret = faidx_fetch_seq64(fai, c_name, p_beg_i, p_end_i, &len64);
*len = len64 < INT_MAX ? len64 : INT_MAX; // trunc
return ret;
}
char *faidx_fetch_qual64(const faidx_t *fai, const char *c_name, hts_pos_t p_beg_i, hts_pos_t p_end_i, hts_pos_t *len)
{
faidx1_t val;
// Adjust position
if (faidx_adjust_position(fai, 1, &val, c_name, &p_beg_i, &p_end_i, len)) {
return NULL;
}