File: PerfectHashIndex.hpp

package info (click to toggle)
salmon 0.7.2%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,352 kB
  • ctags: 5,243
  • sloc: cpp: 42,341; ansic: 6,252; python: 228; makefile: 207; sh: 190
file content (174 lines) | stat: -rw-r--r-- 6,008 bytes parent folder | download
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
/**
>HEADER
    Copyright (c) 2013 Rob Patro robp@cs.cmu.edu

    This file is part of Sailfish.

    Sailfish is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Sailfish is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Sailfish.  If not, see <http://www.gnu.org/licenses/>.
<HEADER
**/


#ifndef __PERFECT_HASH_INDEX_HPP__
#define __PERFECT_HASH_INDEX_HPP__

#include <vector>
#include <chrono>
#include <iostream>
#include <cstdio>
#include <memory>
#include <functional>

#include <sys/mman.h>

#include "boost/timer/timer.hpp"
#include "cmph.h"

//template <typename Deleter>
class PerfectHashIndex {
  using Kmer = uint64_t;
  using Count = uint32_t;
  using AtomicKmer = std::atomic<Kmer>;
  using AtomicCount = std::atomic<Count>;
  using Deleter = std::function<void(cmph_t*)>;

  public:
   // We'll return this invalid id if a kmer is not found in our DB
   size_t INVALID = std::numeric_limits<size_t>::max();

   PerfectHashIndex( std::vector<Kmer>& kmers, std::unique_ptr<cmph_t, Deleter>& hash, 
                     uint32_t merSize, bool canonical ) : kmers_(std::move(kmers)), 
                                                          hash_(std::move(hash)), 
                                                          hashRaw_(hash_.get()),
                                                          merSize_(merSize),
                                                          canonical_(canonical) {}

   PerfectHashIndex( PerfectHashIndex&& ph ) {
   	merSize_ = ph.merSize_;
   	hash_ = std::move(ph.hash_);
    hashRaw_ = hash_.get();
   	kmers_ = std::move(ph.kmers_);
    canonical_ = ph.canonical_;
   }

   void dumpToFile(const std::string& fname) {
   	FILE* out = fopen(fname.c_str(), "w");

   	// read the key set
    fwrite( reinterpret_cast<char*>(&merSize_), sizeof(merSize_), 1, out );
    fwrite( reinterpret_cast<char*>(&canonical_), sizeof(canonical_), 1, out);
    size_t numCounts = kmers_.size();
    fwrite( reinterpret_cast<char*>(&numCounts), sizeof(size_t), 1, out );
    fwrite( reinterpret_cast<char*>(&kmers_[0]), sizeof(Kmer), numCounts, out );

    cmph_dump(hash_.get(), out); 
    fclose(out);

   }

   static PerfectHashIndex fromFile( const std::string& fname ) {
   	FILE* in = fopen(fname.c_str(),"r");

   	// read the key set
    uint32_t merSize;
    fread( reinterpret_cast<char*>(&merSize), sizeof(merSize), 1, in );
    bool canonical;
    fread( reinterpret_cast<char*>(&canonical), sizeof(canonical), 1, in );
    size_t numCounts;
    fread( reinterpret_cast<char*>(&numCounts), sizeof(size_t), 1, in );
    std::vector<Kmer> kmers(numCounts, Kmer(0));
    fread( reinterpret_cast<char*>(&kmers[0]), sizeof(Kmer), numCounts, in );

    // read the hash
    std::unique_ptr<cmph_t, Deleter> hash( cmph_load(in), cmph_destroy );
    PerfectHashIndex index(kmers, hash, merSize, canonical);

    fclose(in);

    return index;
   }

   inline size_t getKmerIndex( uint64_t kmer ) {
    return kmer % kmers_.size();
   }

   inline size_t index( uint64_t kmer ) {
   	char *key = reinterpret_cast<char*>(&kmer);
    unsigned int id{cmph_search(hashRaw_, key, sizeof(uint64_t))};
    return (kmers_[id] == kmer) ? id : INVALID;
   }

   inline size_t numKeys() { return kmers_.size(); }

   bool verify() {
   	auto start = std::chrono::steady_clock::now();
   	for ( auto k : kmers_ ) { 
   		if( kmers_[index(k)] != k ) { return false; }
   	}
   	auto end = std::chrono::steady_clock::now();
   	auto ms = std::chrono::duration_cast<std::chrono::microseconds>(end-start);
   	std::cerr << "verified: " << static_cast<double>(ms.count()) / kmers_.size() << " us / key\n";
   	return true;
   }

   void will_need(uint32_t threadIdx, uint32_t numThreads) {
     auto pageSize = sysconf(_SC_PAGESIZE);
     size_t numPages{0};
     
     auto entriesPerPage = pageSize / sizeof(char);
     auto size = cmph_size(hashRaw_);
     numPages = (sizeof(char) * size) / entriesPerPage;
     // number of pages that each thread should touch
     auto numPagesPerThread = numPages / numThreads;
     auto entriesPerThread = entriesPerPage * numPagesPerThread;
     // the page this thread starts touching
     auto start = entriesPerPage * threadIdx;
     // the last page this thread touches
     auto end = start + entriesPerThread;

     for (size_t i = start; i < size; i += numThreads*entriesPerPage) {      
      *(reinterpret_cast<char*>(hashRaw_)+i) = *(reinterpret_cast<char*>(hashRaw_)+i);
     }

     // entries per page
     entriesPerPage = pageSize / sizeof(Kmer);
     // total number of pages
     size = kmers_.size();
     numPages = (sizeof(Kmer) * kmers_.size()) / entriesPerPage;
     // number of pages that each thread should touch
     numPagesPerThread = numPages / numThreads;
     entriesPerThread = entriesPerPage * numPagesPerThread;
     // the page this thread starts touching
     start = entriesPerPage * threadIdx;
     // the last page this thread touches
     end = start + entriesPerThread;
     for (size_t i = start; i < size; i += numThreads*entriesPerPage) {
      //std::cerr << "thread " << threadIdx << " is touching page " << i / entriesPerPage << "\n";
      kmers_[i] = kmers_[i];
     }
   }

   inline bool canonical() { return canonical_; }
   inline uint32_t kmerLength() { return merSize_; }
   const std::vector<Kmer>& kmers() { return kmers_; }

   private:
   	std::vector<Kmer> kmers_;
   	std::unique_ptr<cmph_t, Deleter> hash_;
    cmph_t* hashRaw_;
   	uint32_t merSize_;
    bool canonical_;
};

#endif // __PERFECT_HASH_INDEX_HPP__