RASCSI/cpp/scsictl/scsictl_display.cpp

//---------------------------------------------------------------------------
//
// SCSI Target Emulator PiSCSI
// for Raspberry Pi
//
// Copyright (C) 2021-2023 Uwe Seimet
//
//---------------------------------------------------------------------------

#include "shared/piscsi_util.h"
#include "shared/protobuf_util.h"
#include "scsictl_display.h"
#include <sstream>
#include <vector>
#include <set>
#include <map>
#include <iomanip>

using namespace std;
using namespace piscsi_interface;
using namespace piscsi_util;
using namespace protobuf_util;

string ScsictlDisplay::DisplayDevicesInfo(const PbDevicesInfo& devices_info) const
{
	ostringstream s;

	const vector<PbDevice> devices(devices_info.devices().begin(), devices_info.devices().end());

	s << ListDevices(devices);

	return s.str();
}

string ScsictlDisplay::DisplayDeviceInfo(const PbDevice& pb_device) const
{
	ostringstream s;

	s << "  " << pb_device.id() << ":" << pb_device.unit() << "  " << PbDeviceType_Name(pb_device.type())
			<< "  " << pb_device.vendor() << ":" << pb_device.product() << ":" << pb_device.revision();

	if (pb_device.block_size()) {
		s << "  " << pb_device.block_size() << " bytes per sector";

		if (pb_device.block_count()) {
			s << "  " << pb_device.block_size() * pb_device.block_count() << " bytes capacity";
		}
	}

	if (pb_device.properties().supports_file() && !pb_device.file().name().empty()) {
		s << "  " << pb_device.file().name();
	}

	s << "  ";

	vector<string> properties;

	if (pb_device.properties().read_only()) {
		properties.emplace_back("read-only");
	}

	if (pb_device.properties().protectable() && pb_device.status().protected_()) {
		properties.emplace_back("protected");
	}

	if (pb_device.properties().stoppable() && pb_device.status().stopped()) {
		properties.emplace_back("stopped");
	}

	if (pb_device.properties().removable() && pb_device.status().removed()) {
		properties.emplace_back("removed");
	}

	if (pb_device.properties().lockable() && pb_device.status().locked()) {
		properties.emplace_back("locked");
	}

	if (!properties.empty()) {
		s << Join(properties) << "  ";
	}

	s << DisplayParams(pb_device) << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayVersionInfo(const PbVersionInfo& version_info) const
{
	ostringstream s;

	s << "piscsi server version: " << setfill('0') << setw(2) << version_info.major_version() << "."
			<< setw(2) << version_info.minor_version();

	if (version_info.patch_version() > 0) {
		s << "." << version_info.patch_version();
	}
	else if (version_info.patch_version() < 0) {
		s << " (development version)";
	}

	s << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayLogLevelInfo(const PbLogLevelInfo& log_level_info) const
{
	ostringstream s;

	if (!log_level_info.log_levels_size()) {
		s << "  No log level settings available\n";
	}
	else {
		s << "piscsi log levels, sorted by severity:\n";

		for (const auto& log_level : log_level_info.log_levels()) {
			s << "  " << log_level << '\n';
		}
	}

	s << "Current piscsi log level: " << log_level_info.current_log_level() << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayDeviceTypesInfo(const PbDeviceTypesInfo& device_types_info) const
{
	ostringstream s;

	s << "Supported device types and their properties:";

	for (const auto& device_type_info : device_types_info.properties()) {
		s << "\n  " << PbDeviceType_Name(device_type_info.type()) << "  ";

		const PbDeviceProperties& properties = device_type_info.properties();

		s << DisplayAttributes(properties);

		if (properties.supports_file()) {
			s << "Image file support\n        ";
		}

		if (properties.supports_params()) {
			s << "Parameter support\n        ";
		}

		s << DisplayDefaultParameters(properties);

		s << DisplayBlockSizes(properties);
	}

	s << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayReservedIdsInfo(const PbReservedIdsInfo& reserved_ids_info) const
{
	ostringstream s;

	if (reserved_ids_info.ids_size()) {
		const set<int32_t> sorted_ids(reserved_ids_info.ids().begin(), reserved_ids_info.ids().end());
		s << "Reserved device IDs: " << Join(sorted_ids) << '\n';
	}

	return s.str();
}

string ScsictlDisplay::DisplayImageFile(const PbImageFile& image_file_info) const
{
	ostringstream s;

	s << image_file_info.name() << "  " << image_file_info.size() << " bytes";

	if (image_file_info.read_only()) {
		s << "  read-only";
	}

	if (image_file_info.type() != UNDEFINED) {
		s << "  " << PbDeviceType_Name(image_file_info.type());
	}

	s << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayImageFilesInfo(const PbImageFilesInfo& image_files_info) const
{
	ostringstream s;

	s << "Default image file folder: " << image_files_info.default_image_folder() << '\n';
	s << "Supported folder depth: " << image_files_info.depth() << '\n';

	if (!image_files_info.image_files().empty()) {
		vector<PbImageFile> image_files(image_files_info.image_files().begin(), image_files_info.image_files().end());
		ranges::sort(image_files, [](const auto& a, const auto& b) { return a.name() < b.name(); });

		s << "Available image files:\n";
		for (const auto& image_file : image_files) {
			s << "  ";

			s << DisplayImageFile(image_file);
		}
	}

	return s.str();
}

string ScsictlDisplay::DisplayNetworkInterfaces(const PbNetworkInterfacesInfo& network_interfaces_info) const
{
	ostringstream s;

	const set<string, less<>> sorted_interfaces(network_interfaces_info.name().begin(), network_interfaces_info.name().end());
	s << "Available (up) network interfaces: " << Join(sorted_interfaces) << '\n';

	return s.str();
}

string ScsictlDisplay::DisplayMappingInfo(const PbMappingInfo& mapping_info) const
{
	ostringstream s;

	s << "Supported image file extension to device type mappings:\n";

	for (const map<string, PbDeviceType, less<>> sorted_mappings(mapping_info.mapping().begin(), mapping_info.mapping().end());
			const auto& [extension, type] : sorted_mappings) {
		s << "  " << extension << "->" << PbDeviceType_Name(type) << '\n';
	}

	return s.str();
}

string ScsictlDisplay::DisplayStatisticsInfo(const PbStatisticsInfo& statistics_info) const
{
	ostringstream s;

	s << "Statistics:\n";

	// Sort by ascending ID, LUN and key and by descending category
	vector<PbStatistics> sorted_statistics = { statistics_info.statistics().begin(), statistics_info.statistics().end() };
	ranges::sort(sorted_statistics, [] (const PbStatistics& a, const PbStatistics& b) {
		if (a.category() > b.category()) return true;
		if (a.category() < b.category()) return false;
		if (a.id() < b.id()) return true;
		if (a.id() > b.id()) return false;
		if (a.unit() < b.unit()) return true;
		if (a.unit() > b.unit()) return false;
		return a.key() < b.key();
	});

	PbStatisticsCategory prev_category = PbStatisticsCategory::CATEGORY_NONE;
	for (const auto& statistics : sorted_statistics) {
		if (statistics.category() != prev_category) {
			// Strip leading "CATEGORY_"
			s << "  " << PbStatisticsCategory_Name(statistics.category()).substr(9) << '\n';
			prev_category = statistics.category();
		}

		s << "    " << statistics.id() << ":" << statistics.unit() << "  " << statistics.key() << ": " << statistics.value() << '\n';
	}

	return s.str();
}

string ScsictlDisplay::DisplayOperationInfo(const PbOperationInfo& operation_info) const
{
	ostringstream s;

	const map<int, PbOperationMetaData, less<>> operations(operation_info.operations().begin(), operation_info.operations().end());

	// Copies result into a map sorted by operation name
	auto unknown_operation = make_unique<PbOperationMetaData>();
	map<string, PbOperationMetaData, less<>> sorted_operations;

	for (const auto& [ordinal, meta_data] : operations) {
		if (PbOperation_IsValid(static_cast<PbOperation>(ordinal))) {
			sorted_operations[PbOperation_Name(static_cast<PbOperation>(ordinal))] = meta_data;
		}
		else {
			// If the server-side operation is unknown for the client use the server-provided operation name
			// No further operation information is available in this case
			sorted_operations[meta_data.server_side_name()] = *unknown_operation;
		}
	}

	s << "Operations supported by piscsi server and their parameters:\n";
	for (const auto& [name, meta_data] : sorted_operations) {
		if (!meta_data.server_side_name().empty()) {
			s << "  " << name;
			if (!meta_data.description().empty()) {
				s << " (" << meta_data.description() << ")";
			}
			s << '\n';

			s << DisplayParameters(meta_data);
		}
		else {
			s << "  " << name << " (Unknown server-side operation)\n";
		}
	}

	return s.str();
}

string ScsictlDisplay::DisplayParams(const PbDevice& pb_device) const
{
	ostringstream s;

	set<string, less<>> params;
	for (const auto& [key, value] : pb_device.params()) {
		params.insert(key + "=" + value);
	}

	s << Join(params, ":");

	return s.str();
}

string ScsictlDisplay::DisplayAttributes(const PbDeviceProperties& props) const
{
	ostringstream s;

	vector<string> properties;
	if (props.read_only()) {
		properties.emplace_back("read-only");
	}
	if (props.protectable()) {
		properties.emplace_back("protectable");
	}
	if (props.stoppable()) {
		properties.emplace_back("stoppable");
	}
	if (props.removable()) {
		properties.emplace_back("removable");
	}
	if (props.lockable()) {
		properties.emplace_back("lockable");
	}

	if (!properties.empty()) {
		s << "Properties: " << Join(properties) << "\n        ";
	}

	return s.str();
}

string ScsictlDisplay::DisplayDefaultParameters(const PbDeviceProperties& properties) const
{
	ostringstream s;

	if (!properties.default_params().empty()) {
		set<string, less<>> params;
		for (const auto& [key, value] : properties.default_params()) {
			params.insert(key + "=" + value);
		}

		s << "Default parameters: " << Join(params, "\n                            ");
	}

	return s.str();
}

string ScsictlDisplay::DisplayBlockSizes(const PbDeviceProperties& properties) const
{
	ostringstream s;

	if (properties.block_sizes_size()) {
		const set<uint32_t> sorted_sizes(properties.block_sizes().begin(), properties.block_sizes().end());
		s << "Configurable block sizes in bytes: " << Join(sorted_sizes);
	}

	return s.str();
}

string ScsictlDisplay::DisplayParameters(const PbOperationMetaData& meta_data) const
{
	vector<PbOperationParameter> sorted_parameters(meta_data.parameters().begin(), meta_data.parameters().end());
	ranges::sort(sorted_parameters, [](const auto& a, const auto& b) { return a.name() < b.name(); });

	ostringstream s;

	for (const auto& parameter : sorted_parameters) {
		s << "    " << parameter.name() << ": "
			<< (parameter.is_mandatory() ? "mandatory" : "optional");

		if (!parameter.description().empty()) {
			s << " (" << parameter.description() << ")";
		}
		s << '\n';

		s << DisplayPermittedValues(parameter);

		if (!parameter.default_value().empty()) {
			s << "      Default value: " << parameter.default_value() << '\n';
		}
	}

	return s.str();
}

string ScsictlDisplay::DisplayPermittedValues(const PbOperationParameter& parameter) const
{
	ostringstream s;
	if (parameter.permitted_values_size()) {
		const set<string, less<>> sorted_values(parameter.permitted_values().begin(), parameter.permitted_values().end());
		s << "      Permitted values: " << Join(parameter.permitted_values()) << '\n';
	}

	return s.str();
}