Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 1 | // Copyright 2021 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
| 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
| 14 | |
| 15 | #define PW_LOG_MODULE_NAME "FS" |
| 16 | |
| 17 | #include "pw_file/flat_file_system.h" |
| 18 | |
| 19 | #include <cstddef> |
| 20 | #include <cstdint> |
| 21 | #include <span> |
| 22 | #include <string_view> |
| 23 | |
| 24 | #include "pw_assert/check.h" |
| 25 | #include "pw_bytes/span.h" |
| 26 | #include "pw_file/file.pwpb.h" |
| 27 | #include "pw_log/log.h" |
| 28 | #include "pw_protobuf/decoder.h" |
| 29 | #include "pw_protobuf/encoder.h" |
| 30 | #include "pw_protobuf/serialized_size.h" |
| 31 | #include "pw_rpc/raw/server_reader_writer.h" |
| 32 | #include "pw_status/status.h" |
| 33 | #include "pw_status/status_with_size.h" |
| 34 | |
| 35 | namespace pw::file { |
| 36 | |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 37 | using Entry = FlatFileSystemService::Entry; |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 38 | |
| 39 | Status FlatFileSystemService::EnumerateFile( |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 40 | Entry& entry, pw::file::ListResponse::StreamEncoder& output_encoder) { |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 41 | StatusWithSize sws = entry.Name(file_name_buffer_); |
| 42 | if (!sws.ok()) { |
| 43 | return sws.status(); |
| 44 | } |
| 45 | { |
| 46 | pw::file::Path::StreamEncoder encoder = output_encoder.GetPathsEncoder(); |
| 47 | |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 48 | encoder |
| 49 | .WritePath(reinterpret_cast<const char*>(file_name_buffer_.data()), |
| 50 | sws.size()) |
| 51 | .IgnoreError(); |
| 52 | encoder.WriteSizeBytes(entry.SizeBytes()).IgnoreError(); |
| 53 | encoder.WritePermissions(entry.Permissions()).IgnoreError(); |
| 54 | encoder.WriteFileId(entry.FileId()).IgnoreError(); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 55 | } |
| 56 | return output_encoder.status(); |
| 57 | } |
| 58 | |
| 59 | void FlatFileSystemService::EnumerateAllFiles(RawServerWriter& writer) { |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 60 | for (Entry* entry : entries_) { |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 61 | PW_DCHECK_NOTNULL(entry); |
| 62 | // For now, don't try to pack entries. |
Wyatt Hepler | f5216e4 | 2022-01-26 17:13:07 -0800 | [diff] [blame] | 63 | pw::file::ListResponse::MemoryEncoder encoder(encoding_buffer_); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 64 | if (Status status = EnumerateFile(*entry, encoder); !status.ok()) { |
Armando Montanez | e2e2328 | 2021-11-10 18:00:27 -0800 | [diff] [blame] | 65 | if (status != Status::NotFound()) { |
| 66 | PW_LOG_ERROR("Failed to enumerate file (id: %u) with status %d", |
| 67 | static_cast<unsigned>(entry->FileId()), |
| 68 | static_cast<int>(status.code())); |
| 69 | } |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 70 | continue; |
| 71 | } |
| 72 | |
| 73 | Status write_status = writer.Write(encoder); |
| 74 | if (!write_status.ok()) { |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 75 | writer.Finish(write_status) |
| 76 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 77 | return; |
| 78 | } |
| 79 | } |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 80 | writer.Finish(OkStatus()) |
| 81 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 82 | } |
| 83 | |
Wyatt Hepler | 8e756e3 | 2021-11-18 09:59:27 -0800 | [diff] [blame] | 84 | void FlatFileSystemService::List(ConstByteSpan request, |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 85 | RawServerWriter& writer) { |
| 86 | protobuf::Decoder decoder(request); |
| 87 | // If a file name was provided, try and find and enumerate the file. |
| 88 | while (decoder.Next().ok()) { |
| 89 | if (decoder.FieldNumber() != |
| 90 | static_cast<uint32_t>(pw::file::ListRequest::Fields::PATH)) { |
| 91 | continue; |
| 92 | } |
| 93 | |
| 94 | std::string_view file_name_view; |
| 95 | if (!decoder.ReadString(&file_name_view).ok() || |
| 96 | file_name_view.length() == 0) { |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 97 | writer.Finish(Status::DataLoss()) |
| 98 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 99 | return; |
| 100 | } |
| 101 | |
| 102 | // Find and enumerate the file requested. |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 103 | Result<Entry*> result = FindFile(file_name_view); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 104 | if (!result.ok()) { |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 105 | writer.Finish(result.status()) |
| 106 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 107 | return; |
| 108 | } |
| 109 | |
Wyatt Hepler | f5216e4 | 2022-01-26 17:13:07 -0800 | [diff] [blame] | 110 | pw::file::ListResponse::MemoryEncoder encoder(encoding_buffer_); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 111 | Status proto_encode_status = EnumerateFile(*result.value(), encoder); |
| 112 | if (!proto_encode_status.ok()) { |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 113 | writer.Finish(proto_encode_status) |
| 114 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 115 | return; |
| 116 | } |
| 117 | |
Wyatt Hepler | bad6d27 | 2022-02-16 07:15:07 -0800 | [diff] [blame] | 118 | writer.Finish(writer.Write(encoder)) |
| 119 | .IgnoreError(); // TODO(pwbug/387): Handle Status properly |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 120 | return; |
| 121 | } |
| 122 | |
| 123 | // If no path was provided in the ListRequest, just enumerate everything. |
| 124 | EnumerateAllFiles(writer); |
| 125 | } |
| 126 | |
Wyatt Hepler | b15c55b | 2022-02-11 09:26:05 -0800 | [diff] [blame] | 127 | void FlatFileSystemService::Delete(ConstByteSpan request, |
| 128 | rpc::RawUnaryResponder& responder) { |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 129 | protobuf::Decoder decoder(request); |
| 130 | while (decoder.Next().ok()) { |
| 131 | if (decoder.FieldNumber() != |
| 132 | static_cast<uint32_t>(pw::file::DeleteRequest::Fields::PATH)) { |
| 133 | continue; |
| 134 | } |
| 135 | |
| 136 | std::string_view file_name_view; |
| 137 | if (!decoder.ReadString(&file_name_view).ok()) { |
Wyatt Hepler | b15c55b | 2022-02-11 09:26:05 -0800 | [diff] [blame] | 138 | responder.Finish({}, Status::DataLoss()).IgnoreError(); |
| 139 | return; |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 140 | } |
Wyatt Hepler | b15c55b | 2022-02-11 09:26:05 -0800 | [diff] [blame] | 141 | responder.Finish({}, FindAndDeleteFile(file_name_view)).IgnoreError(); |
| 142 | return; |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 143 | } |
Wyatt Hepler | b15c55b | 2022-02-11 09:26:05 -0800 | [diff] [blame] | 144 | responder.Finish({}, Status::InvalidArgument()).IgnoreError(); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 145 | } |
| 146 | |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 147 | Result<Entry*> FlatFileSystemService::FindFile(std::string_view file_name) { |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 148 | Status search_status; |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 149 | for (Entry* entry : entries_) { |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 150 | PW_DCHECK_NOTNULL(entry); |
| 151 | StatusWithSize sws = entry->Name(file_name_buffer_); |
| 152 | |
| 153 | // If there not an exact file name length match, don't try and check against |
| 154 | // a prefix. |
| 155 | if (!sws.ok() || file_name.length() != sws.size()) { |
| 156 | if (sws.status() != Status::NotFound()) { |
| 157 | PW_LOG_ERROR("Failed to read file name (id: %u) with status %d", |
| 158 | static_cast<unsigned>(entry->FileId()), |
| 159 | static_cast<int>(sws.status().code())); |
| 160 | } |
| 161 | continue; |
| 162 | } |
| 163 | |
| 164 | if (memcmp(file_name.data(), file_name_buffer_.data(), file_name.size()) == |
| 165 | 0) { |
| 166 | return entry; |
| 167 | } |
| 168 | } |
| 169 | |
| 170 | search_status.Update(Status::NotFound()); |
| 171 | return search_status; |
| 172 | } |
| 173 | |
| 174 | Status FlatFileSystemService::FindAndDeleteFile(std::string_view file_name) { |
Armando Montanez | c1d7920 | 2021-09-30 15:25:49 -0700 | [diff] [blame] | 175 | Result<Entry*> result = FindFile(file_name); |
Armando Montanez | 5be5458 | 2021-09-02 13:58:52 -0700 | [diff] [blame] | 176 | if (!result.ok()) { |
| 177 | return result.status(); |
| 178 | } |
| 179 | |
| 180 | return result.value()->Delete(); |
| 181 | } |
| 182 | |
| 183 | } // namespace pw::file |