File: wavefront.h

package info (click to toggle)
libwfa2 2.3.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,072 kB
  • sloc: ansic: 13,812; python: 540; cpp: 500; makefile: 268; sh: 176; lisp: 41
file content (145 lines) | stat: -rw-r--r-- 4,823 bytes parent folder | download | duplicates (3)
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
/*
 *                             The MIT License
 *
 * Wavefront Alignment Algorithms
 * Copyright (c) 2017 by Santiago Marco-Sola  <santiagomsola@gmail.com>
 *
 * This file is part of Wavefront Alignment Algorithms.
 *
 * 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.
 *
 * PROJECT: Wavefront Alignment Algorithms
 * AUTHOR(S): Santiago Marco-Sola <santiagomsola@gmail.com>
 * DESCRIPTION: Individual WaveFront data structure
 */

#ifndef WAVEFRONT_H_
#define WAVEFRONT_H_

#include "system/mm_allocator.h"
#include "wavefront_offset.h"
#include "wavefront_backtrace_buffer.h"

/*
 * Alignment position
 */
typedef struct {
  int score;          // Score
  int k;              // Diagonal
  wf_offset_t offset; // Offset
} wavefront_pos_t;

/*
 * Wavefront
 */
typedef enum {
  wavefront_status_free,
  wavefront_status_busy,
  wavefront_status_deallocated,
} wavefront_status_type;
typedef struct {
  // Dimensions
  bool null;                           // Is null interval?
  int lo;                              // Lowest diagonal (inclusive)
  int hi;                              // Highest diagonal (inclusive)
  // Wavefront elements
  wf_offset_t* offsets;                // Offsets (k-centered)
  wf_offset_t* offsets_mem;            // Offsets base memory (Internal)
  // Piggyback backtrace
  int bt_occupancy_max;                // Maximum number of pcigar-ops stored on the Backtrace-block
  pcigar_t* bt_pcigar;                 // Backtrace-block pcigar (k-centered)
  bt_block_idx_t* bt_prev;             // Backtrace-block previous-index (k-centered)
  pcigar_t* bt_pcigar_mem;             // Backtrace-block (base memory - Internal)
  bt_block_idx_t* bt_prev_mem;         // Backtrace-block previous-index (base memory - Internal)
  // Slab internals
  wavefront_status_type status;        // Wavefront status (memory state)
  int wf_elements_allocated;           // Total wf-elements allocated (max. wf. size)
  int wf_elements_allocated_min;       // Minimum diagonal-element wf-element allocated
  int wf_elements_allocated_max;       // Maximum diagonal-element wf-element allocated
  int wf_elements_init_min;            // Minimum diagonal-element initialized (inclusive)
  int wf_elements_init_max;            // Maximum diagonal-element initialized (inclusive)
} wavefront_t;

/*
 * Wavefront Set
 */
typedef struct {
  /* In Wavefronts*/
  wavefront_t* in_mwavefront_misms;
  wavefront_t* in_mwavefront_open1;
  wavefront_t* in_mwavefront_open2;
  wavefront_t* in_i1wavefront_ext;
  wavefront_t* in_i2wavefront_ext;
  wavefront_t* in_d1wavefront_ext;
  wavefront_t* in_d2wavefront_ext;
  /* Out Wavefronts */
  wavefront_t* out_mwavefront;
  wavefront_t* out_i1wavefront;
  wavefront_t* out_i2wavefront;
  wavefront_t* out_d1wavefront;
  wavefront_t* out_d2wavefront;
} wavefront_set_t;

/*
 * Setup
 */
void wavefront_allocate(
    wavefront_t* const wavefront,
    const int wf_elements_allocated,
    const bool allocate_backtrace,
    mm_allocator_t* const mm_allocator);
void wavefront_resize(
    wavefront_t* const wavefront,
    const int wf_elements_allocated,
    mm_allocator_t* const mm_allocator);
void wavefront_free(
    wavefront_t* const wavefront,
    mm_allocator_t* const mm_allocator);

/*
 * Initialization
 */
void wavefront_init(
    wavefront_t* const wavefront,
    const int min_lo,
    const int max_hi);
void wavefront_init_null(
    wavefront_t* const wavefront,
    const int min_lo,
    const int max_hi);
void wavefront_init_victim(
    wavefront_t* const wavefront,
    const int min_lo,
    const int max_hi);

/*
 * Accessors
 */
void wavefront_set_limits(
    wavefront_t* const wavefront,
    const int lo,
    const int hi);

/*
 * Utils
 */
uint64_t wavefront_get_size(
    wavefront_t* const wavefront);

#endif /* WAVEFRONT_H_ */