xref: /openbmc/estoraged/include/pattern.hpp (revision 04c28fad)
1 #pragma once
2 
3 #include "erase.hpp"
4 #include "util.hpp"
5 
6 #include <stdplus/fd/create.hpp>
7 #include <stdplus/fd/managed.hpp>
8 
9 #include <chrono>
10 #include <span>
11 #include <string>
12 
13 namespace estoraged
14 {
15 using stdplus::fd::Fd;
16 
17 class Pattern : public Erase
18 {
19   public:
20     /** @brief Creates a pattern erase object.
21      *
22      *  @param[in] inDevPath - the linux device path for the block device.
23      */
24     Pattern(std::string_view inDevPath) : Erase(inDevPath) {}
25 
26     /** @brief writes an uncompressible random pattern to the drive, using
27      * default parameters. It also throws errors accordingly.
28      */
29     void writePattern()
30     {
31         stdplus::fd::Fd&& fd =
32             stdplus::fd::open(devPath, stdplus::fd::OpenAccess::WriteOnly);
33         writePattern(util::findSizeOfBlockDevice(devPath), fd);
34     }
35 
36     /** @brief writes an uncompressible random pattern to the drive
37      * and throws errors accordingly.
38      *
39      *  @param[in] bytes - Size of the block device
40      *  @param[in] fd - the stdplus file descriptor
41      */
42     void writePattern(uint64_t driveSize, Fd& fd);
43 
44     /** @brief verifies the uncompressible random pattern is on the drive, using
45      * default parameters. It also throws errors accordingly.
46      */
47     void verifyPattern()
48     {
49         stdplus::fd::Fd&& fd =
50             stdplus::fd::open(devPath, stdplus::fd::OpenAccess::ReadOnly);
51         verifyPattern(util::findSizeOfBlockDevice(devPath), fd);
52     }
53 
54     /** @brief verifies the uncompressible random pattern is on the drive
55      * and throws errors accordingly.
56      *
57      *  @param[in] bytes - Size of the block device
58      *  @param[in] fd - the stdplus file descriptor
59      */
60     void verifyPattern(uint64_t driveSize, Fd& fd);
61 
62   private:
63     static constexpr uint32_t seed = 0x6a656272;
64     static constexpr size_t blockSize = 4096;
65     static constexpr size_t blockSizeUsing32 = blockSize / sizeof(uint32_t);
66     static constexpr size_t maxRetry = 32;
67     static constexpr std::chrono::duration delay = std::chrono::milliseconds(1);
68 };
69 
70 } // namespace estoraged
71