snapraid/cmdline/status.c

// SPDX-License-Identifier: GPL-3.0-or-later
// Copyright (C) 2013 Andrea Mazzoleni

#include "os/portable.h"

#include "support.h"
#include "elem.h"
#include "state.h"
#include "parity.h"
#include "handle.h"
#include "raid/raid.h"

/****************************************************************************/
/* status */

unsigned day_ago(time_t ref, time_t now)
{
	/* in case some dates is in the future */
	if (now < ref)
		return 0;

	now -= ref;

	return (unsigned)(now / (24 * 3600));
}

#define GRAPH_COLUMN 70
#define GRAPH_ROW 15

/**
 * Bit used to mark unscrubbed time info.
 */
#define TIME_NEW 1

int state_status(struct snapraid_state* state)
{
	block_off_t blockmax;
	block_off_t i;
	time_t now;
	block_off_t count;
	unsigned l;
	unsigned dayoldest, daymedian, daynewest;
	unsigned bar_scrubbed[GRAPH_COLUMN];
	unsigned bar_new[GRAPH_COLUMN];
	unsigned barmax;
	time_t oldest, newest, median;
	unsigned x, y;
	tommy_node* node_disk;
	unsigned file_count;
	unsigned file_fragmented;
	unsigned extra_fragment;
	unsigned file_zerosubsecond;
	uint64_t file_size;
	uint64_t file_block_count;
	uint64_t file_block_free;
	unsigned dealloc_count;
	block_off_t parity_block_free;
	uint64_t all_wasted;
	int free_not_zero;

	/* get the present time */
	now = time(0);

	/* keep track if at least a free info is available */
	free_not_zero = 0;

	blockmax = parity_allocated_size(state);

	log_tag("summary:block_size:%u\n", state->block_size);
	log_tag("summary:parity_block_count:%" PRIu64 "\n", blockmax);

	/* get the minimum parity free space */
	parity_block_free = state->parity[0].free_blocks;
	for (l = 0; l < state->level; ++l) {
		log_tag("summary:parity_block_total:%s:%" PRIu64 "\n", lev_config_name(l), state->parity[l].total_blocks);
		log_tag("summary:parity_block_free:%s:%" PRIu64 "\n", lev_config_name(l), state->parity[l].free_blocks);
		if (state->parity[l].free_blocks < parity_block_free)
			parity_block_free = state->parity[l].free_blocks;
		if (state->parity[l].free_blocks != 0)
			free_not_zero = 1;
	}
	log_tag("summary:parity_block_free_min:%" PRIu64 "\n", parity_block_free);

	printf("SnapRAID status report:\n");
	printf("\n");
	printf("   Files Fragmented Excess  Wasted  Used    Free  Use Name\n");
	printf("            Files  Fragments  GB      GB      GB\n");

	/* count fragments */
	dealloc_count = 0;
	file_count = 0;
	file_size = 0;
	file_block_count = 0;
	file_block_free = 0;
	file_fragmented = 0;
	extra_fragment = 0;
	file_zerosubsecond = 0;
	all_wasted = 0;
	for (node_disk = state->disklist; node_disk != 0; node_disk = node_disk->next) {
		struct snapraid_disk* disk = node_disk->data;
		tommy_node* node;
		block_off_t j;
		unsigned disk_file_count = 0;
		unsigned disk_file_fragmented = 0;
		unsigned disk_extra_fragment = 0;
		unsigned disk_file_zerosubsecond = 0;
		block_off_t disk_block_count = 0;
		uint64_t disk_file_size = 0;
		block_off_t disk_block_latest_used = 0;
		block_off_t disk_block_max_by_space;
		block_off_t disk_block_max_by_parity;
		block_off_t disk_block_max;
		uint64_t disk_used_bytes;
		uint64_t disk_free_bytes;
		int64_t wasted;

		dealloc_count += tommy_list_count(&disk->dealloclist);

		/* for each file in the disk */
		node = disk->filelist;
		while (node) {
			struct snapraid_file* file;

			file = node->data;
			node = node->next; /* next node */

			if (file->mtime_nsec == STAT_NSEC_INVALID
				|| file->mtime_nsec == 0
			) {
				++file_zerosubsecond;
				++disk_file_zerosubsecond;
				if (disk_file_zerosubsecond < 50)
					log_tag("zerosubsecond:%s:%s: \n", disk->name, file->sub);
				if (disk_file_zerosubsecond == 50)
					log_tag("zerosubsecond:%s:%s: (more follow)\n", disk->name, file->sub);
			}

			/* check fragmentation */
			if (file->blockmax != 0) {
				block_off_t prev_pos;
				block_off_t last_pos;
				int fragmented;

				fragmented = 0;
				prev_pos = fs_file2par_get(disk, file, 0);
				for (j = 1; j < file->blockmax; ++j) {
					block_off_t parity_pos = fs_file2par_get(disk, file, j);
					if (prev_pos + 1 != parity_pos) {
						fragmented = 1;
						++extra_fragment;
						++disk_extra_fragment;
					}
					prev_pos = parity_pos;
				}

				/* keep track of latest block used */
				last_pos = fs_file2par_get(disk, file, file->blockmax - 1);
				if (last_pos > disk_block_latest_used) {
					disk_block_latest_used = last_pos;
				}

				if (fragmented) {
					++file_fragmented;
					++disk_file_fragmented;
				}

				disk_block_count += file->blockmax;
			}

			/* count files */
			++file_count;
			++disk_file_count;
			file_size += file->size;
			file_block_count += file->blockmax;
			disk_file_size += file->size;
		}

		if (disk->free_blocks != 0)
			free_not_zero = 1;

		/* get the free block info */
		disk_block_max_by_space = disk_block_count + disk->free_blocks;
		disk_block_max_by_parity = blockmax + parity_block_free;

		/*
		 * The maximum usable space in a disk is limited by the smallest
		 * of the disk size and the parity size
		 * the wasted space is the space that we have to leave
		 * free on the data disk, when the parity is filled up
		 */
		if (disk_block_max_by_space < disk_block_max_by_parity) {
			disk_block_max = disk_block_max_by_space;
		} else {
			disk_block_max = disk_block_max_by_parity;
		}

		/*
		 * Wasted space is the difference of the two maximum size
		 * if negative, it's extra space available in parity
		 */
		wasted = (int64_t)disk_block_max_by_space - (int64_t)disk_block_max_by_parity;
		wasted *= state->block_size;

		if (wasted > 0)
			all_wasted += wasted;
		file_block_free += disk_block_max - disk_block_count;

		printf("%8u", disk_file_count);
		printf("%8u", disk_file_fragmented);
		printf("%8u", disk_extra_fragment);
		if (wasted < -100LL * GIGA) {
			printf("       -");
		} else {
			printf("%8.1f", (double)wasted / GIGA);
		}
		printf("%8" PRIu64, disk_file_size / GIGA);

		if (disk_block_max == 0 && disk_block_count == 0) {
			/* if the disk is empty and we don't have the free space info */
			printf("       -");
			printf("   - ");
		} else {
			printf("%8" PRIu64, (disk_block_max - disk_block_count) * (uint64_t)state->block_size / GIGA);
			printf(" %3u%%", muldiv(disk_block_count, 100, disk_block_max));
		}
		printf(" %s\n", disk->name);

		log_tag("summary:disk_file_count:%s:%u\n", disk->name, disk_file_count);
		log_tag("summary:disk_block_count:%s:%" PRIu64 "\n", disk->name, disk_block_count);
		log_tag("summary:disk_fragmented_file_count:%s:%u\n", disk->name, disk_file_fragmented);
		log_tag("summary:disk_excess_fragment_count:%s:%u\n", disk->name, disk_extra_fragment);
		log_tag("summary:disk_zerosubsecond_file_count:%s:%u\n", disk->name, disk_file_zerosubsecond);
		log_tag("summary:disk_file_size:%s:%" PRIu64 "\n", disk->name, disk_file_size);
		log_tag("summary:disk_block_allocated:%s:%" PRIu64 "\n", disk->name, disk_block_latest_used + 1);
		log_tag("summary:disk_block_total:%s:%" PRIu64 "\n", disk->name, disk->total_blocks);
		log_tag("summary:disk_block_free:%s:%" PRIu64 "\n", disk->name, disk->free_blocks);
		log_tag("summary:disk_block_max_by_space:%s:%" PRIu64 "\n", disk->name, disk_block_max_by_space);
		log_tag("summary:disk_block_max_by_parity:%s:%" PRIu64 "\n", disk->name, disk_block_max_by_parity);
		log_tag("summary:disk_block_max:%s:%" PRIu64 "\n", disk->name, disk_block_max);
		log_tag("summary:disk_space_wasted:%s:%" PRId64 "\n", disk->name, wasted);

		disk_used_bytes = disk_block_count * (uint64_t)state->block_size;
		disk_free_bytes = (disk_block_max - disk_block_count) * (uint64_t)state->block_size;
		log_tag("summary:disk_used:%s:%" PRIu64 "\n", disk->name, disk_used_bytes);
		log_tag("summary:disk_free:%s:%" PRIu64 "\n", disk->name, disk_free_bytes);
		log_tag("summary:disk_use_percent:%s:%u\n", disk->name, muldiv(disk_block_count, 100, disk_block_max));
	}

	/* totals */
	printf(" --------------------------------------------------------------------------\n");
	printf("%8u", file_count);
	printf("%8u", file_fragmented);
	printf("%8u", extra_fragment);
	printf("%8.1f", (double)all_wasted / GIGA);
	printf("%8" PRIu64, file_size / GIGA);
	printf("%8" PRIu64, file_block_free * state->block_size / GIGA);
	printf(" %3u%%", muldiv(file_block_count, 100, file_block_count + file_block_free));
	printf("\n");

	/* warn about invalid data free info */
	if (!free_not_zero)
		printf("\nWARNING! Free space info will be valid after the first sync.\n");

	log_tag("summary:file_count:%u\n", file_count);
	log_tag("summary:file_block_count:%" PRIu64 "\n", file_block_count);
	log_tag("summary:fragmented_file_count:%u\n", file_fragmented);
	log_tag("summary:excess_fragment_count:%u\n", extra_fragment);
	log_tag("summary:zerosubsecond_file_count:%u\n", file_zerosubsecond);
	log_tag("summary:file_size:%" PRIu64 "\n", file_size);
	log_tag("summary:parity_size:%" PRIu64 "\n", blockmax * (uint64_t)state->block_size);
	log_tag("summary:parity_size_max:%" PRIu64 "\n", (blockmax + parity_block_free) * (uint64_t)state->block_size);
	log_tag("summary:hash:%s\n", hash_config_name(state->hash));
	log_tag("summary:prev_hash:%s\n", hash_config_name(state->prevhash));
	log_tag("summary:best_hash:%s\n", hash_config_name(state->besthash));
	log_tag("summary:total_wasted:%" PRIu64 "\n", all_wasted);
	log_tag("summary:total_used:%" PRIu64 "\n", file_size);
	log_tag("summary:total_free:%" PRIu64 "\n", file_block_free * state->block_size);
	log_tag("summary:total_use_percent:%u\n", muldiv(file_block_count, 100, file_block_count + file_block_free));
	log_flush();

	oldest = 0;
	median = 0;
	newest = 0;
	count = 0;
	for (tommy_node* j = tommy_list_head(&state->bucketlist); j != 0; j = j->next) {
		struct snapraid_bucket* bucket = j->data;
		block_off_t bucket_count = bucket->count_scrubbed + bucket->count_justsynced;

		if (count == 0)
			oldest = bucket->time_at;
		if (count < state->bucketcount / 2)
			median = bucket->time_at;
		newest = bucket->time_at;

		count += bucket_count;
	}

	if (!count) {
		printf("The array is empty.\n");
		return 0;
	}

	dayoldest = day_ago(oldest, now);
	daymedian = day_ago(median, now);
	daynewest = day_ago(newest, now);

	log_tag("summary:scrub_oldest_days:%u\n", dayoldest);
	log_tag("summary:scrub_median_days:%u\n", daymedian);
	log_tag("summary:scrub_newest_days:%u\n", daynewest);

	/* compute graph limits */
	barmax = 0;
	memset(bar_scrubbed, 0, sizeof(bar_scrubbed));
	memset(bar_new, 0, sizeof(bar_new));
	for (tommy_node* j = tommy_list_head(&state->bucketlist); j != 0; j = j->next) {
		struct snapraid_bucket* bucket = j->data;

		unsigned column = muldiv(bucket->time_at - oldest, GRAPH_COLUMN, newest - oldest + 1);

		bar_scrubbed[column] += bucket->count_scrubbed;
		bar_new[column] += bucket->count_justsynced;

		if (bar_scrubbed[column] + bar_new[column] > barmax)
			barmax = bar_scrubbed[column] + bar_new[column];
	}

	/* output scrub history as structured data */
	log_tag("scrub_graph_range:%u:%u\n", GRAPH_COLUMN, barmax);
	for (l = 0; l < GRAPH_COLUMN; ++l) {
		unsigned days_ago = dayoldest - (dayoldest - daynewest) * l / (GRAPH_COLUMN - 1);
		log_tag("scrub_graph_bar:%u:%u:%u:%u\n", l, days_ago, bar_scrubbed[l], bar_new[l]);
	}

	printf("\n\n");

	/* print the graph */
	for (y = 0; y < GRAPH_ROW; ++y) {
		if (y == 0)
			printf("%3" PRIu64 "%%|", barmax * 100 / count);
		else if (y == GRAPH_ROW - 1)
			printf("  0%%|");
		else if (y == GRAPH_ROW / 2)
			printf("%3" PRIu64 "%%|", barmax * 50 / count);
		else
			printf("    |");
		for (x = 0; x < GRAPH_COLUMN; ++x) {
			unsigned pivot_upper = barmax * (GRAPH_ROW - y) / GRAPH_ROW;
			unsigned pivot_lower = barmax * (GRAPH_ROW - 1 - y) / GRAPH_ROW;
			unsigned both = bar_scrubbed[x] + bar_new[x];
			unsigned scrubbed = bar_scrubbed[x];

			if (both > pivot_upper) {
				if (scrubbed > pivot_lower)
					printf("*");
				else
					printf("o");
			} else if (both > pivot_lower) {
				if (scrubbed == both)
					printf("*");
				else
					printf("o");
			} else {
				if (y == GRAPH_ROW - 1)
					printf("_");
				else
					printf(" ");
			}
		}
		printf("\n");
	}
	printf("   %3u                    days ago of the last scrub/sync               %3u\n", dayoldest, daynewest);

	printf("\n");

	printf("The oldest block was scrubbed %u days ago, the median %u, the newest %u.\n", dayoldest, daymedian, daynewest);

	printf("\n");

	if (newest > now) {
		printf("WARNING! You have scrub dates in the future! The next sync/scrub will truncate them!\n");
	}

	if (state->unsynced_blocks) {
		printf("WARNING! The array is NOT fully synced.\n");
		printf("You have a sync in progress at %u%%.\n", muldiv(blockmax - state->unsynced_blocks, 100, blockmax));
		if (dealloc_count) {
			printf("WARNING! There are %u files updated or deleted from the array that may reduce the recovery probability until the next sync.\n", dealloc_count);
			for (node_disk = state->disklist; node_disk != 0; node_disk = node_disk->next) {
				struct snapraid_disk* disk = node_disk->data;
				for (tommy_node* node = tommy_list_head(&disk->dealloclist); node != 0; node = node->next) {
					struct snapraid_dealloc* dealloc = node->data;
					msg_verbose("\t%s\n", fmt_term(disk, dealloc->sub));
				}
			}
		}
	} else {
		printf("No sync is in progress.\n");
	}

	if (state->unscrubbed_blocks) {
		printf("%u%% of the array is not scrubbed.\n", muldiv_upper(state->unscrubbed_blocks, 100, blockmax));
	} else {
		printf("The full array was scrubbed at least one time.\n");
	}

	if (file_zerosubsecond) {
		printf("You have %u files with a zero sub-second timestamp.\n", file_zerosubsecond);
		printf("Run 'snapraid touch' to set their sub-second timestamps to a non-zero value.\n");
	} else {
		printf("No file has a zero sub-second timestamp.\n");
	}

	if (state->rehash_blocks) {
		printf("You have a rehash in progress at %u%%.\n", muldiv(count - state->rehash_blocks, 100, count));
	} else {
		if (state->besthash != state->hash) {
			printf("No rehash is in progress, but for optimal performance one is recommended.\n");
		} else {
			printf("No rehash is in progress or needed.\n");
		}
	}

	if (state->bad_blocks) {
		printf("DANGER! In the array there are %" PRIu64 " errors!\n\n", state->bad_blocks);

		block_off_t bad_range;
		block_off_t bad_count;
		block_off_t range_start;
		block_off_t range_count;

		printf("They are at blocks:");

		/* print some of the errors */
		bad_range = 0;
		bad_count = 0;
		range_start = 0;
		range_count = 0;
		for (i = 0; i <= blockmax; ++i) { /* one extra iteration to print the final range */
			snapraid_info info = 0;
			int is_bad = 0;

			if (i < blockmax) {
				info = info_get(&state->infoarr, i);
				if (info != 0) /* unused blocks are never bad */
					is_bad = info_get_bad(info);
			}
			if (is_bad) {
				/* create or extend the range */
				if (!range_count)
					range_start = i;
				++range_count;
			} else {
				/* break the range */
				if (range_count) {
					if (range_count == 1) {
						printf(" %" PRIu64 "", range_start);
					} else {
						printf(" %" PRIu64 "-%" PRIu64 "", range_start, range_start + range_count - 1);
					}
					bad_count += range_count;
					++bad_range;
					range_count = 0;
				}
			}

			if (bad_range > 100) {
				printf(" and %" PRIu64 " more...", state->bad_blocks - bad_count);
				break;
			}
		}

		printf("\n");

		printf("To fix them use the command 'snapraid -e fix'.\n");
		printf("The errors will disappear from the 'status' at the next 'scrub' command.\n");
	} else {
		printf("No error detected.\n");
	}

	if (state->bad_blocks)
		log_tag("summary:exit:bad\n");
	else if (state->unsynced_blocks != 0)
		log_tag("summary:exit:unsynced\n");
	else
		log_tag("summary:exit:ok\n");

	return 0;
}