Documentation
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
use std::mem;
use std::path::PathBuf;

use clap;

use futures;
use futures::BoxFuture;
use futures::Future;

use futures_cpupool::CpuPool;

use num_cpus;

use output::Output;
use output::OutputJob;

use ::convert::utils::*;
use ::misc::*;
use ::zbackup::data::*;
use ::zbackup::disk_format::*;
use ::zbackup::repository_core::*;

enum TaskResult {

	ReadBundle {
		output_job: OutputJob,
		bundle_id: BundleId,
		bundle_info: DiskBundleInfo,
	},

	WriteIndex {
		output_job: OutputJob,
	},

}

type TaskFuture =
	BoxFuture <TaskResult, String>;

struct IndexRebuilder <'a> {
	arguments: & 'a RebuildIndexesArguments,
	repository_core: RepositoryCore,
	max_tasks: usize,
	cpu_pool: CpuPool,
}

impl <'a> IndexRebuilder <'a> {

	fn new (
		output: & Output,
		arguments: & 'a RebuildIndexesArguments,
	) -> Result <IndexRebuilder <'a>, String> {

		// open repository

		let repository_core =
			string_result_with_prefix (
				|| format! (
					"Error opening repository {}: ",
					arguments.repository_path.to_string_lossy ()),
				RepositoryCore::open (
					& output,
					& arguments.repository_path,
					arguments.password_file_path.clone ()),
			) ?;

		// create thread pool

		let num_threads =
			num_cpus::get ();

		let cpu_pool =
			CpuPool::new (
				num_threads);

		// return

		Ok (IndexRebuilder {
			arguments: arguments,
			repository_core: repository_core,
			max_tasks: num_threads,
			cpu_pool: cpu_pool,
		})

	}

	fn rebuild_indexes (
		& mut self,
		output: & Output,
	) -> Result <bool, String> {

		// begin transaction

		let atomic_file_writer =
			AtomicFileWriter::new (
				output,
				& self.arguments.repository_path,
				None,
			) ?;

		// get list of bundle files

		let bundle_ids =
			scan_bundle_files (
				output,
				& self.arguments.repository_path,
			) ?;

		output.message_format (
			format_args! (
				"Found {} bundle files",
				bundle_ids.len ()));

		// rebuild indexes

		let mut entries_buffer: Vec <RawIndexEntry> =
			Vec::new ();

		let mut bundle_count: u64 = 0;
		let bundle_total = bundle_ids.len () as u64;

		let output_job_main =
			output_job_start! (
				output,
				"Rebuilding indexes");

		let mut task_futures: Vec <TaskFuture> =
			Vec::new ();

		let mut bundle_ids_iter =
			bundle_ids.into_iter ();

		output.pause ();

		loop {

			// start bundle load tasks

			while task_futures.len () < self.max_tasks {

				if let Some (bundle_id) =
					bundle_ids_iter.next () {

					let repository_core =
						self.repository_core.clone ();

					let output_job_bundle =
						output_job_start! (
							output,
							"Reading bundle {}",
							bundle_id);

					task_futures.push (
						self.cpu_pool.spawn_fn (move || {

							let bundle_info =
								bundle_info_read_path (
									repository_core.bundle_path (
										bundle_id),
									repository_core.encryption_key (),
								) ?;

							Ok (TaskResult::ReadBundle {
								output_job: output_job_bundle,
								bundle_id: bundle_id,
								bundle_info: bundle_info,
							})

						}).boxed ()
					);

				} else {
					break;
				}

			}

			// handle next bundle load

			if task_futures.is_empty () {
				break;
			}

			output.unpause ();

			let (task_result, _index, remaining_task_futures) =
				futures::select_all (
					task_futures,
				).wait ().map_err (
					|(error, _index, _remaining_task_futures)|
					error,
				) ?;

			output.pause ();

			task_futures = remaining_task_futures;

			match task_result {

				TaskResult::ReadBundle {
					output_job: output_job_bundle,
					bundle_id,
					bundle_info,
				} => {

					output_job_bundle.remove ();

					output_job_main.progress (
						bundle_count,
						bundle_total);

					entries_buffer.push (
						RawIndexEntry {

							index_bundle_header:
								DiskIndexBundleHeader::new (
									bundle_id),

							bundle_info:
								bundle_info,

						}
					);

					// write out a new index

					if entries_buffer.len () as u64
						== self.arguments.bundles_per_index {

						let output =
							output.clone ();

						let repository_core =
							self.repository_core.clone ();

						let atomic_file_writer =
							atomic_file_writer.clone ();

						let index_entries =
							mem::replace (
								& mut entries_buffer,
								Vec::new ());

						let index_id =
							IndexId::random ();

						let output_job_write_index =
							output_job_start! (
								output,
								"Writing index {}",
								index_id);

						task_futures.push (
							self.cpu_pool.spawn_fn (move || {

								index_write_with_id (
									& repository_core,
									& atomic_file_writer,
									index_id,
									& index_entries,
								) ?;

								Ok (TaskResult::WriteIndex {
									output_job: output_job_write_index,
								})

							}).boxed ()
						);

					}

					bundle_count += 1;

				},

				TaskResult::WriteIndex {
					output_job: output_job_write_index,
				} => {

					output_job_write_index.remove ();

				},

			};

		}

		output.unpause ();

		// write out final index

		if ! entries_buffer.is_empty () {

			flush_index_entries (
				output,
				& self.repository_core,
				& atomic_file_writer,
				& mut entries_buffer,
			) ?;

		}

		// remove old indexes

		let output_job_remove_indexes =
			output_job_start! (
				output,
				"Scanning old index files");

		let old_index_ids =
			scan_index_files (
				& self.arguments.repository_path,
			) ?;

		output_job_update! (
			output_job_remove_indexes,
			"Removing {} old index files",
			old_index_ids.len ());

		for old_index_id in old_index_ids {

			atomic_file_writer.delete (
				self.repository_core.index_path (
					old_index_id));

		}

		output_job_remove_indexes.complete ();

		// commit changes

		let output_job_commit =
			output_job_start! (
				output,
				"Committing changes");

		atomic_file_writer.commit () ?;

		output_job_commit.remove ();

		// clean up and return

		output_job_main.complete ();

		// TODO not sure how to do this

		//self.repository.close (
		//	output);

		Ok (true)

	}

}

command! (

	name = rebuild_indexes,
	export = rebuild_indexes_command,

	arguments = RebuildIndexesArguments {
		repository_path: PathBuf,
		password_file_path: Option <PathBuf>,
		bundles_per_index: u64,
	},

	clap_subcommand = {

		clap::SubCommand::with_name ("rebuild-indexes")
			.about ("Builds a new set of index files by scanning all bundles")

			.arg (
				clap::Arg::with_name ("repository")

				.long ("repository")
				.value_name ("REPOSITORY")
				.required (true)
				.help ("Path to the repository")

			)

			.arg (
				clap::Arg::with_name ("password-file")

				.long ("password-file")
				.value_name ("PASSWORD-FILE")
				.required (false)
				.help ("Path to the password file")

			)

			.arg (
				clap::Arg::with_name ("bundles-per-index")

				.long ("bundles-per-index")
				.value_name ("BUNDLES-PER-INDEX")
				.default_value ("4096")
				.help ("Bundles per index")

			)

	},

	clap_arguments_parse = |clap_matches| {

		RebuildIndexesArguments {

			repository_path:
				args::path_required (
					& clap_matches,
					"repository"),

			password_file_path:
				args::path_optional (
					& clap_matches,
					"password-file"),

			bundles_per_index:
				args::u64_required (
					& clap_matches,
					"bundles-per-index"),

		}

	},

	action = |output, arguments| {
		IndexRebuilder::new (
			output,
			arguments,
		) ?.rebuild_indexes (
			output,
		)
	},

);

// ex: noet ts=4 filetype=rust