2020-08-28 14:18:02 +00:00
|
|
|
|
//---------------------------------------------------------------------------
|
|
|
|
|
|
//
|
2022-12-05 17:58:23 +00:00
|
|
|
|
// SCSI Target Emulator PiSCSI
|
2020-08-28 14:18:02 +00:00
|
|
|
|
// for Raspberry Pi
|
|
|
|
|
|
//
|
|
|
|
|
|
// Copyright (C) 2001-2006 ＰＩ．(ytanaka@ipc-tokai.or.jp)
|
|
|
|
|
|
// Copyright (C) 2014-2020 GIMONS
|
2023-10-15 06:38:15 +00:00
|
|
|
|
// Copyright (C) 2022-2023 Uwe Seimet
|
2022-10-01 15:56:06 +00:00
|
|
|
|
// Copyright (C) akuker
|
2020-08-28 14:18:02 +00:00
|
|
|
|
//
|
2022-10-01 15:56:06 +00:00
|
|
|
|
// Licensed under the BSD 3-Clause License.
|
|
|
|
|
|
// See LICENSE file in the project root folder.
|
2020-08-28 14:18:02 +00:00
|
|
|
|
//
|
|
|
|
|
|
//---------------------------------------------------------------------------
|
SASI code removal, error handling update, bug fixes, code cleanup (#806)
Summary ov most important changes triggered by the SASI code removal:
- Removed the SASI controller code
- New controller management. There is a new controller base class AbstractController and a class ControllerManager managing the controller lifecycle. The lifecycle management was removed from rasci.cpp and is covered by unit tests.
- New device management. The DeviceFactory manages the device lifecycle instead of rascsi.cpp. The new code is covered by unit tests.
- The lifecycle managment uses C++ collections with variable size instead of arrays with hard-coded sizes.
- The ScsiController method contains most of what was previously contained in scsidev_ctrl.cpp plus the code from sasidev_ctrl.cpp that was relevant for SCSI.
- scsi_command_util contains helper methods used for identical SCSI command implementations of more than one device
- Devices know their controllers, so that the controller instance does not need to be passed to each SCSI command. This change helps to decouple the devices from the controller. The phase_handler interface is also part of this decoupling.
- Use scsi_command_exception for propagating SCSI command execution errors, This resolves issues with the previous error handling, which was based on return values and often on magic numbers.
- Removed legacy SCSI error codes, all errors are now encoded by sense_key::, asc:: and status::.
- Fixed various warnings reported with -Wextra, -Weffc++ and -Wpedantic.
- Use constructor member initialization lists (recommended for ISO C++)
- Consistently use new/delete instead of malloc/free (recommended for ISO C++), resulting in better type safety and error handling
- Replaced variable sized arrays on the stack (violates ISO C++ and can cause a stack overflow)
- Replaced NULL by nullptr (recommended for C++), resulting in better type safety
- Use more const member functions in order to avoid side effects
- The format device page can now also be changed for hard disk drives (Fujitsu M2624S supports this, for instance), not just for MOs.
- Better encapsulation, updated access specifiers in many places
- Removed unused methods and method arguments
- Fixed a number of TODOs
- Added/updated unit tests for a lot of non-legacy classes
- Makefile support for creating HTML coverage reports with lcov/genhtml
2022-09-03 14:53:53 +00:00
|
|
|
|
|
2020-08-28 14:18:02 +00:00
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
|
|
#include "disk.h"
|
2023-10-15 06:38:15 +00:00
|
|
|
|
#include <span>
|
2022-10-25 08:29:57 +00:00
|
|
|
|
#include <vector>
|
|
|
|
|
|
#include <map>
|
2020-08-28 14:18:02 +00:00
|
|
|
|
|
2022-10-01 15:56:06 +00:00
|
|
|
|
using Geometry = pair<uint32_t, uint32_t>;
|
|
|
|
|
|
|
2022-10-08 17:26:04 +00:00
|
|
|
|
class SCSIMO : public Disk
|
2020-08-28 14:18:02 +00:00
|
|
|
|
{
|
|
|
|
|
|
public:
|
SASI code removal, error handling update, bug fixes, code cleanup (#806)
Summary ov most important changes triggered by the SASI code removal:
- Removed the SASI controller code
- New controller management. There is a new controller base class AbstractController and a class ControllerManager managing the controller lifecycle. The lifecycle management was removed from rasci.cpp and is covered by unit tests.
- New device management. The DeviceFactory manages the device lifecycle instead of rascsi.cpp. The new code is covered by unit tests.
- The lifecycle managment uses C++ collections with variable size instead of arrays with hard-coded sizes.
- The ScsiController method contains most of what was previously contained in scsidev_ctrl.cpp plus the code from sasidev_ctrl.cpp that was relevant for SCSI.
- scsi_command_util contains helper methods used for identical SCSI command implementations of more than one device
- Devices know their controllers, so that the controller instance does not need to be passed to each SCSI command. This change helps to decouple the devices from the controller. The phase_handler interface is also part of this decoupling.
- Use scsi_command_exception for propagating SCSI command execution errors, This resolves issues with the previous error handling, which was based on return values and often on magic numbers.
- Removed legacy SCSI error codes, all errors are now encoded by sense_key::, asc:: and status::.
- Fixed various warnings reported with -Wextra, -Weffc++ and -Wpedantic.
- Use constructor member initialization lists (recommended for ISO C++)
- Consistently use new/delete instead of malloc/free (recommended for ISO C++), resulting in better type safety and error handling
- Replaced variable sized arrays on the stack (violates ISO C++ and can cause a stack overflow)
- Replaced NULL by nullptr (recommended for C++), resulting in better type safety
- Use more const member functions in order to avoid side effects
- The format device page can now also be changed for hard disk drives (Fujitsu M2624S supports this, for instance), not just for MOs.
- Better encapsulation, updated access specifiers in many places
- Removed unused methods and method arguments
- Fixed a number of TODOs
- Added/updated unit tests for a lot of non-legacy classes
- Makefile support for creating HTML coverage reports with lcov/genhtml
2022-09-03 14:53:53 +00:00
|
|
|
|
|
2023-11-14 14:32:46 +00:00
|
|
|
|
explicit SCSIMO(int);
|
2022-09-07 14:38:42 +00:00
|
|
|
|
~SCSIMO() override = default;
|
Configurable block size, controller/device cleanup, dispatchers per device, bridge setup (#203)
* Use foreach
* Renaming
* Revert "Renaming"
This reverts commit b0554b9c0a052e282625a4565d429313af2b3cc7.
* Manpage updates
* Removed obsolete assertions
* Replaced QWORD by uint64_t and removed respective typedef
* Removed LPCSTR typedef
* Removed LPCTSTR typedef
* Removed LPTSTR typedef
* Renamed SCSI command interface classes
* Renamed xm6.h to rascsi.h
* Moved interface classes to new interfaces subfolder
* Added include
* Fixed compilation issues of 64 bit Ubuntu
* Renaming
* Sort block sizes
* protobuf interface description update
* Fixed handling for sector size for non-disk devices
* Fixed typo
* Fixed comment
* Translate code commends into English, removing redundant ones (#214)
* Comment update
* For other bridge interfaces than eth0 IP address and netmask can be provided
* Added special rule for testing on x86 PCs
* Translated code comments into English, removing some redundant ones in the process, plus fixing typos (#215)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* Comment update
* Removed unused typedefs
* Added special rule for testing on x86 PCs
* Comment update
* Comment update
* Updated capacity calculation
* Updated protobuf interface to signal parameter support
* Simplified protobuf interface
* Updated rasctl server info output
* Updated logging
* protobuf interface has to return block only if it is configurable
* Updated block size handling
* Improved error message if ID is already in use
* Removed typedef
* Renamed protobuf interface method
* Renaming
* Use protobuf::Messsge instead of protobuf::MessageLite
* default_image_folder cannot be an empty string, removed obsolete check
* Logging update
* Made some error messages more concise
* Removed magic constant
* Updated error message
* Comment update
* Names of removable media drives must be constant and not contain the capacity
* Improved DeviceFactory error handling
* More error handing improvements
* Interface comment update
* Pass interface list to ctapdriver when creating bridge
* Moved initialization code
* Updated rasctl server information output
* Improved handling of MO capacities
* Renaming
* Comment update
* Reject inserting a medium when there is already a medium present (eject first)
* Save list of files in use before dry-run
* Updated rasctl server info message
* Comment update
* Fixed typo
* Cleaned list handling
* Sort devices list by ID *and unit*
* Improved block size check
* Fixed issue with missing method in old Raspberry Pi OS protobuf implementation
* Updated error message
* Improve and fix bugs with saving&loading configuration files for rascsi-web (#218)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* - Store only file path and name to configuration csv
- Strip known non-file path strings when reading configuration csv (backwards compatibility)
- Validate SCSI ID before attempting to attach a device
* Add comment and TODO
* Partial translation of cfilesystem.h
* Move csv read/write logic into file_cmd.py
* Load default.csv on rascsi-web startup
* Add rudimentary error handling to config loading/saving
* Implement a delete configuration csv file feature. Also rename the delete_image method to delete_file and made it take the full file patch as argument to be consistent with other file operation methods.
* Catch the exception when attempting to exclude SCSI id that is already in use from a list of valid SCSI ids
* Fix error handling when failing to open a csv file for read or write
* Removed unused structures, code and type cleanup
* Use unscoped enums for commands
* SASI Format opcode is 0x06, not 0x04 (see comment in code)
* Removed duplicate command
* Code review, data type updates
* Data type updated, use #pragma once
* Logging update
* Renaming
* Renaming
* Removed duplicate code
* Renaming
* Refactoring
* Removed TODO
* Updated logging
* Comment update
* Comment update
* Updated GetEventStatusNotification
* Removed goto
* Options -h and -v do not require to be the root user (fixes issue #166)
* Updated error messages and exception handling
* Added number of supported LUNs to protobuf interface
* Updated list handling of protobuf interface
* Comment update
* Improved error handling
* Added missing return statement
* Allow empty device list
* Fixed unnecessary detach_all() when config file isn't read (#221)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* - Store only file path and name to configuration csv
- Strip known non-file path strings when reading configuration csv (backwards compatibility)
- Validate SCSI ID before attempting to attach a device
* Add comment and TODO
* Partial translation of cfilesystem.h
* Move csv read/write logic into file_cmd.py
* Load default.csv on rascsi-web startup
* Add rudimentary error handling to config loading/saving
* Implement a delete configuration csv file feature. Also rename the delete_image method to delete_file and made it take the full file patch as argument to be consistent with other file operation methods.
* Catch the exception when attempting to exclude SCSI id that is already in use from a list of valid SCSI ids
* Fix error handling when failing to open a csv file for read or write
* Run detach_all() only after succeeding to open a file for reading
* Protecting/unprotecing a non-ready medium is considered not possible
* Updated error message
* Extract detaching all devices, add parameter list support
* Comment update
* Fixed typos
* Restore files in use if dry-run fails
* Feature configurable reserved id for rascsi-web (#223)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* - Store only file path and name to configuration csv
- Strip known non-file path strings when reading configuration csv (backwards compatibility)
- Validate SCSI ID before attempting to attach a device
* Add comment and TODO
* Partial translation of cfilesystem.h
* Move csv read/write logic into file_cmd.py
* Load default.csv on rascsi-web startup
* Add rudimentary error handling to config loading/saving
* Implement a delete configuration csv file feature. Also rename the delete_image method to delete_file and made it take the full file patch as argument to be consistent with other file operation methods.
* Catch the exception when attempting to exclude SCSI id that is already in use from a list of valid SCSI ids
* Fix error handling when failing to open a csv file for read or write
* Run detach_all() only after succeeding to open a file for reading
* Make the reserved SCSI id configurable through an argument to start.sh; make the rascsi-web service reserve 7 by default to maintain current behavior.
* Make it possible to reserve multiple scsi ids in the web ui
* Added support for reserved IDs
* rasctl output update
* Re-ordered logging
* Logging update
* Make use of the newly introduced 'rasctl -r' to have the webui reserve ids on the backend side upon startup (#224)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* - Store only file path and name to configuration csv
- Strip known non-file path strings when reading configuration csv (backwards compatibility)
- Validate SCSI ID before attempting to attach a device
* Add comment and TODO
* Partial translation of cfilesystem.h
* Move csv read/write logic into file_cmd.py
* Load default.csv on rascsi-web startup
* Add rudimentary error handling to config loading/saving
* Implement a delete configuration csv file feature. Also rename the delete_image method to delete_file and made it take the full file patch as argument to be consistent with other file operation methods.
* Catch the exception when attempting to exclude SCSI id that is already in use from a list of valid SCSI ids
* Fix error handling when failing to open a csv file for read or write
* Run detach_all() only after succeeding to open a file for reading
* Make use of the new 'rasctl -r' command to reserve IDs on the backend side as well.
* Updated string to integer conversions
* Improved string to integer conversion
* Move string to integer conversion to rasutil
* Removed unused variable
* Fixed detach, which did not remove the filename from the filenames set
* Re-added folder to gitignore
* Set/Display patch version
* Fix issue where reserved ids were not reserved again when restarting rascsi-service from within the web ui (#226)
* Translate code commends into English, removing redundant ones
* - Translated all remaining Japanese code comments in src/raspberrypi/ to English, with the exception of cfilesystem.cpp|h
- Removed some redundant comments where the context is obvious from the
code
- Fixed a few typos and mistakes
* - Store only file path and name to configuration csv
- Strip known non-file path strings when reading configuration csv (backwards compatibility)
- Validate SCSI ID before attempting to attach a device
* Add comment and TODO
* Partial translation of cfilesystem.h
* Move csv read/write logic into file_cmd.py
* Load default.csv on rascsi-web startup
* Add rudimentary error handling to config loading/saving
* Implement a delete configuration csv file feature. Also rename the delete_image method to delete_file and made it take the full file patch as argument to be consistent with other file operation methods.
* Catch the exception when attempting to exclude SCSI id that is already in use from a list of valid SCSI ids
* Fix error handling when failing to open a csv file for read or write
* Run detach_all() only after succeeding to open a file for reading
* Make use of the new 'rasctl -r' command to reserve IDs on the backend side as well.
* Make sure reserved SCSI IDs gets reserved again when restarting rascsi-service from within the web ui
* Updated interface comment
* Accept daynaport as legacy type
* Fixed typo
* Remove file from the list of files in use when ejected with a SCSI command
* Check for attached device for INSERT, EJECT, PROTECT, UNPROTECT
* Fixed error handling
* Fixed filepath handling
* Added more device shortcuts to rasctl
* Fixed function declaration
* Extraced ATTACH and DETACH
* Extracted INSERT
* Simplified ProcessCmd
* Comment update
* Fixed memory leak
* Log information on whether a new device is protected or read-only
* Updated errro message
* Updated error message
* Initialize private fields
* Updated rasctl help message
* Added DEVICE_INFO to protobuf interface
* Improved error handling
* DEVICE_INFO supports device list
* Updated server info handling
* Unified result handling with oneof, all commands now return PbResult
* A result can always return a message string
* Fixed typo
* Simplified sending of commands
* Improved error handling
* Removed unused code
* Updated error handling
* Code cleanup
* Comment update
* Updated logging
* Updated error handling
* Updated handling of removed status for devices without image file support
* Comment update
* Fixed typo
* Updated logging
* Updated parameter handling
* Updated setting default interfaces
* Revert "Updated setting default interfaces"
This reverts commit 210abc775d9a79dd0c631cf3877966a2923f4d5b.
* Revert "Updated parameter handling"
This reverts commit 35302addd59f5f5e1cc032888ba32dcbb426a846.
* rascsi supports reserving IDs
* Updated help message
* Replaced BOOL by bool
* Logging update
* Logging update
* Added default parameters to device properties
* Return parameters a device was set up with
* Improved device initialization
* Updated default parameter handling
* Updated default parameter handling
* Fixed typo
* Comment updates
* Comment update
* Manage default parameters in the respective device
* Do not pass empty parameter string
* Added supports_params flag
* Made comparisons more consistent
* Updated error handling
* Updated exception handling
* Renaming
* Comment update
* NEC sectors size must be 512 bytes
* Updated logging
* Updated vendor name handling
* Updated handling of media loading/unloading
* Added stoppable property and stopped status
* Made MO stoppable
* Removed duplicate code
* Removed duplicate code
* Copy read-only property
* Renaming
* Removed duplicate code, added START/STOP
* Improved default parameter handling
* Updated load/eject handling
* Logging update
* Fixed typo
* Verified START/STOP UNIT
* Updated logging
* Updated status handling
* Updated status handling
* More status handling updates
* Logging update
* Made instance fields local variables
* Made disk_t private
* Made some data structures private
* Fixed ARM compile issue
* Fixed ctapdriver initialization issue
* Reset read-only status when opening an image file
* Made logging more consistent
* Updated log level
* Log load/eject on error level for testing
* Revert "Log load/eject on error level for testing"
This reverts commit d35a15ea8e520517d25e1e1054ad1aeda9f85f2e.
* Assume drive is not ready after having been stopped
* Updated status handling
* Fixed typo
* Rebuild manpage
* Fixed issue #234 (MODE SENSE (10) returns wrong mode parameter header)
* Removed unused code
* Enum data type update
* Removed duplicate range check
* Removed duplicate code
* Removed more duplicate code
* Logging update
* SCCD sector size was not meant to be configurable
* Updated configurable sector size properties
* Removed assertion
* Improved error handling
* Updated error handling
* Re-added special error handling only relevant for SASI
* Added TODOs
* Comment update
* Added override modifier
* Removed obsolete debug flag (related code was not called)
* Comment and logging updates
* Removed obsolete try/catch
* Revert "Removed obsolete try/catch"
This reverts commit 39ca12d8b153c706316ce79f4fec65c9abc60024.
* Comment update
* Removed duplicate code
* Updated error messages, use more foreach loops
* Updated logging
* Logging update
* README update
* Added block_count
* Evaluate block size when inserting a media
* rasctl display capacity if available
* Info message update
* Added missing product name to NEC vital product data
* MO block size depends on capacity only
* Extended property/status display
* Property display update
* Updated error handling
* (Doc only changes) Fix typos and add clarification that SASI is used on Unix workstations
Co-authored-by: Daniel Markstedt <markstedt@gmail.com>
Co-authored-by: Tony Kuker <akuker@gmail.com>
2021-09-15 01:23:04 +00:00
|
|
|
|
|
2022-10-23 19:51:39 +00:00
|
|
|
|
void Open() override;
|
2020-08-28 14:18:02 +00:00
|
|
|
|
|
2022-11-02 14:36:19 +00:00
|
|
|
|
vector<uint8_t> InquiryInternal() const override;
|
2024-01-09 21:36:24 +00:00
|
|
|
|
void ModeSelect(scsi_defs::scsi_command, cdb_t, span<const uint8_t>, int) override;
|
2020-08-28 14:18:02 +00:00
|
|
|
|
|
2022-02-27 21:58:01 +00:00
|
|
|
|
protected:
|
|
|
|
|
|
|
2022-09-25 21:49:24 +00:00
|
|
|
|
void SetUpModePages(map<int, vector<byte>>&, int, bool) const override;
|
2022-09-21 06:27:51 +00:00
|
|
|
|
void AddFormatPage(map<int, vector<byte>>&, bool) const override;
|
|
|
|
|
|
void AddVendorPage(map<int, vector<byte>>&, int, bool) const override;
|
2022-02-27 21:58:01 +00:00
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
2022-09-21 06:27:51 +00:00
|
|
|
|
void AddOptionPage(map<int, vector<byte>>&, bool) const;
|
SASI code removal, error handling update, bug fixes, code cleanup (#806)
Summary ov most important changes triggered by the SASI code removal:
- Removed the SASI controller code
- New controller management. There is a new controller base class AbstractController and a class ControllerManager managing the controller lifecycle. The lifecycle management was removed from rasci.cpp and is covered by unit tests.
- New device management. The DeviceFactory manages the device lifecycle instead of rascsi.cpp. The new code is covered by unit tests.
- The lifecycle managment uses C++ collections with variable size instead of arrays with hard-coded sizes.
- The ScsiController method contains most of what was previously contained in scsidev_ctrl.cpp plus the code from sasidev_ctrl.cpp that was relevant for SCSI.
- scsi_command_util contains helper methods used for identical SCSI command implementations of more than one device
- Devices know their controllers, so that the controller instance does not need to be passed to each SCSI command. This change helps to decouple the devices from the controller. The phase_handler interface is also part of this decoupling.
- Use scsi_command_exception for propagating SCSI command execution errors, This resolves issues with the previous error handling, which was based on return values and often on magic numbers.
- Removed legacy SCSI error codes, all errors are now encoded by sense_key::, asc:: and status::.
- Fixed various warnings reported with -Wextra, -Weffc++ and -Wpedantic.
- Use constructor member initialization lists (recommended for ISO C++)
- Consistently use new/delete instead of malloc/free (recommended for ISO C++), resulting in better type safety and error handling
- Replaced variable sized arrays on the stack (violates ISO C++ and can cause a stack overflow)
- Replaced NULL by nullptr (recommended for C++), resulting in better type safety
- Use more const member functions in order to avoid side effects
- The format device page can now also be changed for hard disk drives (Fujitsu M2624S supports this, for instance), not just for MOs.
- Better encapsulation, updated access specifiers in many places
- Removed unused methods and method arguments
- Fixed a number of TODOs
- Added/updated unit tests for a lot of non-legacy classes
- Makefile support for creating HTML coverage reports with lcov/genhtml
2022-09-03 14:53:53 +00:00
|
|
|
|
|
|
|
|
|
|
bool SetGeometryForCapacity(uint64_t);
|
|
|
|
|
|
|
|
|
|
|
|
// The mapping of supported capacities to block sizes and block counts, empty if there is no capacity restriction
|
|
|
|
|
|
unordered_map<uint64_t, Geometry> geometries;
|
2021-07-20 13:32:44 +00:00
|
|
|
|
};
|
