Plan9FileSystem.cpp 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  1. /*
  2. * Copyright (c) 2020, Sergey Bugaev <bugaevc@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <Kernel/FileSystem/Plan9FileSystem.h>
  7. #include <Kernel/Process.h>
  8. namespace Kernel {
  9. KResultOr<NonnullRefPtr<Plan9FS>> Plan9FS::try_create(FileDescription& file_description)
  10. {
  11. return adopt_nonnull_ref_or_enomem(new (nothrow) Plan9FS(file_description));
  12. }
  13. Plan9FS::Plan9FS(FileDescription& file_description)
  14. : FileBackedFileSystem(file_description)
  15. , m_completion_blocker(*this)
  16. {
  17. }
  18. Plan9FS::~Plan9FS()
  19. {
  20. // Make sure to destroy the root inode before the FS gets destroyed.
  21. if (m_root_inode) {
  22. VERIFY(m_root_inode->ref_count() == 1);
  23. m_root_inode = nullptr;
  24. }
  25. }
  26. class Plan9FS::Message {
  27. public:
  28. enum class Type : u8 {
  29. // 9P2000.L
  30. Tlerror = 6,
  31. Rlerror = 7,
  32. Tstatfs = 8,
  33. Rstatfs = 9,
  34. Tlopen = 12,
  35. Rlopen = 13,
  36. Tlcreate = 14,
  37. Rlcreate = 15,
  38. Tsymlink = 16,
  39. Rsymlink = 17,
  40. Tmknod = 18,
  41. Rmknod = 19,
  42. Trename = 20,
  43. Rrename = 21,
  44. Treadlink = 22,
  45. Rreadlink = 23,
  46. Tgetattr = 24,
  47. Rgetattr = 25,
  48. Tsetattr = 26,
  49. Rsetattr = 27,
  50. Txattrwalk = 30,
  51. Rxattrwalk = 31,
  52. Txattrcreate = 32,
  53. Rxattrcreate = 33,
  54. Treaddir = 40,
  55. Rreaddir = 41,
  56. Tfsync = 50,
  57. Rfsync = 51,
  58. Tlock = 52,
  59. Rlock = 53,
  60. Tgetlock = 54,
  61. Rgetlock = 55,
  62. Tlink = 70,
  63. Rlink = 71,
  64. Tmkdir = 72,
  65. Rmkdir = 73,
  66. Trenameat = 74,
  67. Rrenameat = 75,
  68. Tunlinkat = 76,
  69. Runlinkat = 77,
  70. // 9P2000
  71. Tversion = 100,
  72. Rversion = 101,
  73. Tauth = 102,
  74. Rauth = 103,
  75. Tattach = 104,
  76. Rattach = 105,
  77. Terror = 106,
  78. Rerror = 107,
  79. Tflush = 108,
  80. Rflush = 109,
  81. Twalk = 110,
  82. Rwalk = 111,
  83. Topen = 112,
  84. Ropen = 113,
  85. Tcreate = 114,
  86. Rcreate = 115,
  87. Tread = 116,
  88. Rread = 117,
  89. Twrite = 118,
  90. Rwrite = 119,
  91. Tclunk = 120,
  92. Rclunk = 121,
  93. Tremove = 122,
  94. Rremove = 123,
  95. Tstat = 124,
  96. Rstat = 125,
  97. Twstat = 126,
  98. Rwstat = 127
  99. };
  100. class Decoder {
  101. public:
  102. explicit Decoder(const StringView& data)
  103. : m_data(data)
  104. {
  105. }
  106. Decoder& operator>>(u8&);
  107. Decoder& operator>>(u16&);
  108. Decoder& operator>>(u32&);
  109. Decoder& operator>>(u64&);
  110. Decoder& operator>>(StringView&);
  111. Decoder& operator>>(qid&);
  112. StringView read_data();
  113. bool has_more_data() const { return !m_data.is_empty(); }
  114. private:
  115. StringView m_data;
  116. template<typename N>
  117. Decoder& read_number(N& number)
  118. {
  119. VERIFY(sizeof(number) <= m_data.length());
  120. memcpy(&number, m_data.characters_without_null_termination(), sizeof(number));
  121. m_data = m_data.substring_view(sizeof(number), m_data.length() - sizeof(number));
  122. return *this;
  123. }
  124. };
  125. Message& operator<<(u8);
  126. Message& operator<<(u16);
  127. Message& operator<<(u32);
  128. Message& operator<<(u64);
  129. Message& operator<<(const StringView&);
  130. void append_data(const StringView&);
  131. template<typename T>
  132. Message& operator>>(T& t)
  133. {
  134. VERIFY(m_have_been_built);
  135. m_built.decoder >> t;
  136. return *this;
  137. }
  138. StringView read_data()
  139. {
  140. VERIFY(m_have_been_built);
  141. return m_built.decoder.read_data();
  142. }
  143. Type type() const { return m_type; }
  144. u16 tag() const { return m_tag; }
  145. Message(Plan9FS&, Type);
  146. Message(NonnullOwnPtr<KBuffer>&&);
  147. ~Message();
  148. Message& operator=(Message&&);
  149. const KBuffer& build();
  150. static constexpr size_t max_header_size = 24;
  151. private:
  152. template<typename N>
  153. Message& append_number(N number)
  154. {
  155. VERIFY(!m_have_been_built);
  156. m_builder.append(reinterpret_cast<const char*>(&number), sizeof(number));
  157. return *this;
  158. }
  159. union {
  160. KBufferBuilder m_builder;
  161. struct {
  162. NonnullOwnPtr<KBuffer> buffer;
  163. Decoder decoder;
  164. } m_built;
  165. };
  166. u16 m_tag { 0 };
  167. Type m_type { 0 };
  168. bool m_have_been_built { false };
  169. };
  170. KResult Plan9FS::initialize()
  171. {
  172. ensure_thread();
  173. Message version_message { *this, Message::Type::Tversion };
  174. version_message << (u32)m_max_message_size << "9P2000.L";
  175. TRY(post_message_and_wait_for_a_reply(version_message));
  176. u32 msize;
  177. StringView remote_protocol_version;
  178. version_message >> msize >> remote_protocol_version;
  179. dbgln("Remote supports msize={} and protocol version {}", msize, remote_protocol_version);
  180. m_remote_protocol_version = parse_protocol_version(remote_protocol_version);
  181. m_max_message_size = min(m_max_message_size, (size_t)msize);
  182. // TODO: auth
  183. u32 root_fid = allocate_fid();
  184. Message attach_message { *this, Message::Type::Tattach };
  185. // FIXME: This needs a user name and an "export" name; but how do we get them?
  186. // Perhaps initialize() should accept a string of FS-specific options...
  187. attach_message << root_fid << (u32)-1 << "sergey"
  188. << "/";
  189. if (m_remote_protocol_version >= ProtocolVersion::v9P2000u)
  190. attach_message << (u32)-1;
  191. TRY(post_message_and_wait_for_a_reply(attach_message));
  192. m_root_inode = TRY(Plan9FSInode::try_create(*this, root_fid));
  193. return KSuccess;
  194. }
  195. Plan9FS::ProtocolVersion Plan9FS::parse_protocol_version(const StringView& s) const
  196. {
  197. if (s == "9P2000.L")
  198. return ProtocolVersion::v9P2000L;
  199. if (s == "9P2000.u")
  200. return ProtocolVersion::v9P2000u;
  201. return ProtocolVersion::v9P2000;
  202. }
  203. Inode& Plan9FS::root_inode()
  204. {
  205. return *m_root_inode;
  206. }
  207. Plan9FS::Message& Plan9FS::Message::operator<<(u8 number)
  208. {
  209. return append_number(number);
  210. }
  211. Plan9FS::Message& Plan9FS::Message::operator<<(u16 number)
  212. {
  213. return append_number(number);
  214. }
  215. Plan9FS::Message& Plan9FS::Message::operator<<(u32 number)
  216. {
  217. return append_number(number);
  218. }
  219. Plan9FS::Message& Plan9FS::Message::operator<<(u64 number)
  220. {
  221. return append_number(number);
  222. }
  223. Plan9FS::Message& Plan9FS::Message::operator<<(const StringView& string)
  224. {
  225. *this << static_cast<u16>(string.length());
  226. m_builder.append(string);
  227. return *this;
  228. }
  229. void Plan9FS::Message::append_data(const StringView& data)
  230. {
  231. *this << static_cast<u32>(data.length());
  232. m_builder.append(data);
  233. }
  234. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(u8& number)
  235. {
  236. return read_number(number);
  237. }
  238. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(u16& number)
  239. {
  240. return read_number(number);
  241. }
  242. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(u32& number)
  243. {
  244. return read_number(number);
  245. }
  246. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(u64& number)
  247. {
  248. return read_number(number);
  249. }
  250. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(qid& qid)
  251. {
  252. return *this >> qid.type >> qid.version >> qid.path;
  253. }
  254. Plan9FS::Message::Decoder& Plan9FS::Message::Decoder::operator>>(StringView& string)
  255. {
  256. u16 length;
  257. *this >> length;
  258. VERIFY(length <= m_data.length());
  259. string = m_data.substring_view(0, length);
  260. m_data = m_data.substring_view_starting_after_substring(string);
  261. return *this;
  262. }
  263. StringView Plan9FS::Message::Decoder::read_data()
  264. {
  265. u32 length;
  266. *this >> length;
  267. VERIFY(length <= m_data.length());
  268. auto data = m_data.substring_view(0, length);
  269. m_data = m_data.substring_view_starting_after_substring(data);
  270. return data;
  271. }
  272. Plan9FS::Message::Message(Plan9FS& fs, Type type)
  273. : m_builder()
  274. , m_tag(fs.allocate_tag())
  275. , m_type(type)
  276. , m_have_been_built(false)
  277. {
  278. u32 size_placeholder = 0;
  279. *this << size_placeholder << (u8)type << m_tag;
  280. }
  281. Plan9FS::Message::Message(NonnullOwnPtr<KBuffer>&& buffer)
  282. : m_built { move(buffer), Decoder({ buffer->data(), buffer->size() }) }
  283. , m_have_been_built(true)
  284. {
  285. u32 size;
  286. u8 raw_type;
  287. *this >> size >> raw_type >> m_tag;
  288. m_type = (Type)raw_type;
  289. }
  290. Plan9FS::Message::~Message()
  291. {
  292. if (m_have_been_built) {
  293. m_built.buffer.~NonnullOwnPtr<KBuffer>();
  294. m_built.decoder.~Decoder();
  295. } else {
  296. m_builder.~KBufferBuilder();
  297. }
  298. }
  299. Plan9FS::Message& Plan9FS::Message::operator=(Message&& message)
  300. {
  301. m_tag = message.m_tag;
  302. m_type = message.m_type;
  303. if (m_have_been_built) {
  304. m_built.buffer.~NonnullOwnPtr<KBuffer>();
  305. m_built.decoder.~Decoder();
  306. } else {
  307. m_builder.~KBufferBuilder();
  308. }
  309. m_have_been_built = message.m_have_been_built;
  310. if (m_have_been_built) {
  311. new (&m_built.buffer) NonnullOwnPtr<KBuffer>(move(message.m_built.buffer));
  312. new (&m_built.decoder) Decoder(move(message.m_built.decoder));
  313. } else {
  314. new (&m_builder) KBufferBuilder(move(message.m_builder));
  315. }
  316. return *this;
  317. }
  318. const KBuffer& Plan9FS::Message::build()
  319. {
  320. VERIFY(!m_have_been_built);
  321. auto tmp_buffer = m_builder.build();
  322. // FIXME: We should not assume success here.
  323. VERIFY(tmp_buffer);
  324. m_have_been_built = true;
  325. m_builder.~KBufferBuilder();
  326. new (&m_built.buffer) NonnullOwnPtr<KBuffer>(tmp_buffer.release_nonnull());
  327. new (&m_built.decoder) Decoder({ m_built.buffer->data(), m_built.buffer->size() });
  328. u32* size = reinterpret_cast<u32*>(m_built.buffer->data());
  329. *size = m_built.buffer->size();
  330. return *m_built.buffer;
  331. }
  332. Plan9FS::ReceiveCompletion::ReceiveCompletion(u16 tag)
  333. : tag(tag)
  334. {
  335. }
  336. Plan9FS::ReceiveCompletion::~ReceiveCompletion()
  337. {
  338. }
  339. bool Plan9FS::Blocker::unblock(u16 tag)
  340. {
  341. {
  342. SpinlockLocker lock(m_lock);
  343. if (m_did_unblock)
  344. return false;
  345. m_did_unblock = true;
  346. if (m_completion->tag != tag)
  347. return false;
  348. if (!m_completion->result.is_error())
  349. m_message = move(*m_completion->message);
  350. }
  351. return unblock();
  352. }
  353. bool Plan9FS::Blocker::setup_blocker()
  354. {
  355. return add_to_blocker_set(m_fs.m_completion_blocker);
  356. }
  357. void Plan9FS::Blocker::will_unblock_immediately_without_blocking(UnblockImmediatelyReason)
  358. {
  359. {
  360. SpinlockLocker lock(m_lock);
  361. if (m_did_unblock)
  362. return;
  363. }
  364. m_fs.m_completion_blocker.try_unblock(*this);
  365. }
  366. bool Plan9FS::Blocker::is_completed() const
  367. {
  368. SpinlockLocker lock(m_completion->lock);
  369. return m_completion->completed;
  370. }
  371. bool Plan9FS::Plan9FSBlockerSet::should_add_blocker(Thread::Blocker& b, void*)
  372. {
  373. // NOTE: m_lock is held already!
  374. auto& blocker = static_cast<Blocker&>(b);
  375. return !blocker.is_completed();
  376. }
  377. void Plan9FS::Plan9FSBlockerSet::unblock_completed(u16 tag)
  378. {
  379. unblock_all_blockers_whose_conditions_are_met([&](Thread::Blocker& b, void*, bool&) {
  380. VERIFY(b.blocker_type() == Thread::Blocker::Type::Plan9FS);
  381. auto& blocker = static_cast<Blocker&>(b);
  382. return blocker.unblock(tag);
  383. });
  384. }
  385. void Plan9FS::Plan9FSBlockerSet::unblock_all()
  386. {
  387. unblock_all_blockers_whose_conditions_are_met([&](Thread::Blocker& b, void*, bool&) {
  388. VERIFY(b.blocker_type() == Thread::Blocker::Type::Plan9FS);
  389. auto& blocker = static_cast<Blocker&>(b);
  390. return blocker.unblock();
  391. });
  392. }
  393. void Plan9FS::Plan9FSBlockerSet::try_unblock(Plan9FS::Blocker& blocker)
  394. {
  395. if (m_fs.is_complete(*blocker.completion())) {
  396. SpinlockLocker lock(m_lock);
  397. blocker.unblock(blocker.completion()->tag);
  398. }
  399. }
  400. bool Plan9FS::is_complete(const ReceiveCompletion& completion)
  401. {
  402. MutexLocker locker(m_lock);
  403. if (m_completions.contains(completion.tag)) {
  404. // If it's still in the map then it can't be complete
  405. VERIFY(!completion.completed);
  406. return false;
  407. }
  408. // if it's not in the map anymore, it must be complete. But we MUST
  409. // hold m_lock to be able to check completion.completed!
  410. VERIFY(completion.completed);
  411. return true;
  412. }
  413. KResult Plan9FS::post_message(Message& message, RefPtr<ReceiveCompletion> completion)
  414. {
  415. auto& buffer = message.build();
  416. const u8* data = buffer.data();
  417. size_t size = buffer.size();
  418. auto& description = file_description();
  419. MutexLocker locker(m_send_lock);
  420. if (completion) {
  421. // Save the completion record *before* we send the message. This
  422. // ensures that it exists when the thread reads the response
  423. MutexLocker locker(m_lock);
  424. auto tag = completion->tag;
  425. m_completions.set(tag, completion.release_nonnull());
  426. // TODO: What if there is a collision? Do we need to wait until
  427. // the existing record with the tag completes before queueing
  428. // this one?
  429. }
  430. while (size > 0) {
  431. if (!description.can_write()) {
  432. auto unblock_flags = Thread::FileBlocker::BlockFlags::None;
  433. if (Thread::current()->block<Thread::WriteBlocker>({}, description, unblock_flags).was_interrupted())
  434. return EINTR;
  435. }
  436. auto data_buffer = UserOrKernelBuffer::for_kernel_buffer(const_cast<u8*>(data));
  437. auto nwritten = TRY(description.write(data_buffer, size));
  438. data += nwritten;
  439. size -= nwritten;
  440. }
  441. return KSuccess;
  442. }
  443. KResult Plan9FS::do_read(u8* data, size_t size)
  444. {
  445. auto& description = file_description();
  446. while (size > 0) {
  447. if (!description.can_read()) {
  448. auto unblock_flags = Thread::FileBlocker::BlockFlags::None;
  449. if (Thread::current()->block<Thread::ReadBlocker>({}, description, unblock_flags).was_interrupted())
  450. return EINTR;
  451. }
  452. auto data_buffer = UserOrKernelBuffer::for_kernel_buffer(data);
  453. auto nread = TRY(description.read(data_buffer, size));
  454. if (nread == 0)
  455. return EIO;
  456. data += nread;
  457. size -= nread;
  458. }
  459. return KSuccess;
  460. }
  461. KResult Plan9FS::read_and_dispatch_one_message()
  462. {
  463. struct [[gnu::packed]] Header {
  464. u32 size;
  465. u8 type;
  466. u16 tag;
  467. };
  468. Header header;
  469. TRY(do_read(reinterpret_cast<u8*>(&header), sizeof(header)));
  470. auto buffer = KBuffer::try_create_with_size(header.size, Memory::Region::Access::ReadWrite);
  471. if (!buffer)
  472. return ENOMEM;
  473. // Copy the already read header into the buffer.
  474. memcpy(buffer->data(), &header, sizeof(header));
  475. TRY(do_read(buffer->data() + sizeof(header), header.size - sizeof(header)));
  476. MutexLocker locker(m_lock);
  477. auto optional_completion = m_completions.get(header.tag);
  478. if (optional_completion.has_value()) {
  479. auto completion = optional_completion.value();
  480. SpinlockLocker lock(completion->lock);
  481. completion->result = KSuccess;
  482. completion->message = adopt_own_if_nonnull(new (nothrow) Message { buffer.release_nonnull() });
  483. completion->completed = true;
  484. m_completions.remove(header.tag);
  485. m_completion_blocker.unblock_completed(header.tag);
  486. } else {
  487. dbgln("Received a 9p message of type {} with an unexpected tag {}, dropping", header.type, header.tag);
  488. }
  489. return KSuccess;
  490. }
  491. KResult Plan9FS::post_message_and_explicitly_ignore_reply(Message& message)
  492. {
  493. return post_message(message, {});
  494. }
  495. KResult Plan9FS::post_message_and_wait_for_a_reply(Message& message)
  496. {
  497. auto request_type = message.type();
  498. auto tag = message.tag();
  499. auto completion = adopt_ref(*new ReceiveCompletion(tag));
  500. TRY(post_message(message, completion));
  501. if (Thread::current()->block<Plan9FS::Blocker>({}, *this, message, completion).was_interrupted())
  502. return EINTR;
  503. if (completion->result.is_error()) {
  504. dbgln("Plan9FS: Message was aborted with error {}", completion->result.error());
  505. return EIO;
  506. }
  507. auto reply_type = message.type();
  508. if (reply_type == Message::Type::Rlerror) {
  509. // Contains a numerical Linux errno; hopefully our errno numbers match.
  510. u32 error_code;
  511. message >> error_code;
  512. return KResult((ErrnoCode)error_code);
  513. } else if (reply_type == Message::Type::Rerror) {
  514. // Contains an error message. We could attempt to parse it, but for now
  515. // we simply return EIO instead. In 9P200.u, it can also contain a
  516. // numerical errno in an unspecified encoding; we ignore those too.
  517. StringView error_name;
  518. message >> error_name;
  519. dbgln("Plan9FS: Received error name {}", error_name);
  520. return EIO;
  521. } else if ((u8)reply_type != (u8)request_type + 1) {
  522. // Other than those error messages. we only expect the matching reply
  523. // message type.
  524. dbgln("Plan9FS: Received unexpected message type {} in response to {}", (u8)reply_type, (u8)request_type);
  525. return EIO;
  526. } else {
  527. return KSuccess;
  528. }
  529. }
  530. size_t Plan9FS::adjust_buffer_size(size_t size) const
  531. {
  532. size_t max_size = m_max_message_size - Message::max_header_size;
  533. return min(size, max_size);
  534. }
  535. void Plan9FS::thread_main()
  536. {
  537. dbgln("Plan9FS: Thread running");
  538. do {
  539. auto result = read_and_dispatch_one_message();
  540. if (result.is_error()) {
  541. // If we fail to read, wake up everyone with an error.
  542. MutexLocker locker(m_lock);
  543. for (auto& it : m_completions) {
  544. it.value->result = result;
  545. it.value->completed = true;
  546. }
  547. m_completions.clear();
  548. m_completion_blocker.unblock_all();
  549. dbgln("Plan9FS: Thread terminating, error reading");
  550. return;
  551. }
  552. } while (!m_thread_shutdown);
  553. dbgln("Plan9FS: Thread terminating");
  554. }
  555. void Plan9FS::ensure_thread()
  556. {
  557. SpinlockLocker lock(m_thread_lock);
  558. if (!m_thread_running.exchange(true, AK::MemoryOrder::memory_order_acq_rel)) {
  559. Process::create_kernel_process(m_thread, "Plan9FS", [&]() {
  560. thread_main();
  561. m_thread_running.store(false, AK::MemoryOrder::memory_order_release);
  562. });
  563. }
  564. }
  565. Plan9FSInode::Plan9FSInode(Plan9FS& fs, u32 fid)
  566. : Inode(fs, fid)
  567. {
  568. }
  569. KResultOr<NonnullRefPtr<Plan9FSInode>> Plan9FSInode::try_create(Plan9FS& fs, u32 fid)
  570. {
  571. return adopt_nonnull_ref_or_enomem(new (nothrow) Plan9FSInode(fs, fid));
  572. }
  573. Plan9FSInode::~Plan9FSInode()
  574. {
  575. Plan9FS::Message clunk_request { fs(), Plan9FS::Message::Type::Tclunk };
  576. clunk_request << fid();
  577. // FIXME: Should we observe this error somehow?
  578. [[maybe_unused]] auto rc = fs().post_message_and_explicitly_ignore_reply(clunk_request);
  579. }
  580. KResult Plan9FSInode::ensure_open_for_mode(int mode)
  581. {
  582. bool use_lopen = fs().m_remote_protocol_version >= Plan9FS::ProtocolVersion::v9P2000L;
  583. u32 l_mode = 0;
  584. u8 p9_mode = 0;
  585. {
  586. MutexLocker locker(m_inode_lock);
  587. // If it's already open in this mode, we're done.
  588. if ((m_open_mode & mode) == mode)
  589. return KSuccess;
  590. m_open_mode |= mode;
  591. if ((m_open_mode & O_RDWR) == O_RDWR) {
  592. l_mode |= 2;
  593. p9_mode |= 2;
  594. } else if (m_open_mode & O_WRONLY) {
  595. l_mode |= 1;
  596. p9_mode |= 1;
  597. } else if (m_open_mode & O_RDONLY) {
  598. // Leave the values at 0.
  599. }
  600. }
  601. if (use_lopen) {
  602. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Tlopen };
  603. message << fid() << l_mode;
  604. return fs().post_message_and_wait_for_a_reply(message);
  605. } else {
  606. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Topen };
  607. message << fid() << p9_mode;
  608. return fs().post_message_and_wait_for_a_reply(message);
  609. }
  610. }
  611. KResultOr<size_t> Plan9FSInode::read_bytes(off_t offset, size_t size, UserOrKernelBuffer& buffer, FileDescription*) const
  612. {
  613. TRY(const_cast<Plan9FSInode&>(*this).ensure_open_for_mode(O_RDONLY));
  614. size = fs().adjust_buffer_size(size);
  615. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Treadlink };
  616. StringView data;
  617. // Try readlink first.
  618. bool readlink_succeded = false;
  619. if (fs().m_remote_protocol_version >= Plan9FS::ProtocolVersion::v9P2000L && offset == 0) {
  620. message << fid();
  621. if (auto result = fs().post_message_and_wait_for_a_reply(message); result.is_success()) {
  622. readlink_succeded = true;
  623. message >> data;
  624. }
  625. }
  626. if (!readlink_succeded) {
  627. message = Plan9FS::Message { fs(), Plan9FS::Message::Type::Tread };
  628. message << fid() << (u64)offset << (u32)size;
  629. TRY(fs().post_message_and_wait_for_a_reply(message));
  630. data = message.read_data();
  631. }
  632. // Guard against the server returning more data than requested.
  633. size_t nread = min(data.length(), size);
  634. if (!buffer.write(data.characters_without_null_termination(), nread))
  635. return EFAULT;
  636. return nread;
  637. }
  638. KResultOr<size_t> Plan9FSInode::write_bytes(off_t offset, size_t size, const UserOrKernelBuffer& data, FileDescription*)
  639. {
  640. TRY(ensure_open_for_mode(O_WRONLY));
  641. size = fs().adjust_buffer_size(size);
  642. auto data_copy = TRY(data.try_copy_into_kstring(size)); // FIXME: this seems ugly
  643. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Twrite };
  644. message << fid() << (u64)offset;
  645. message.append_data(data_copy->view());
  646. TRY(fs().post_message_and_wait_for_a_reply(message));
  647. u32 nwritten;
  648. message >> nwritten;
  649. return nwritten;
  650. }
  651. InodeMetadata Plan9FSInode::metadata() const
  652. {
  653. InodeMetadata metadata;
  654. metadata.inode = identifier();
  655. // 9P2000.L; TODO: 9P2000 & 9P2000.u
  656. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Tgetattr };
  657. message << fid() << (u64)GetAttrMask::Basic;
  658. auto result = fs().post_message_and_wait_for_a_reply(message);
  659. if (result.is_error()) {
  660. // Just return blank metadata; hopefully that's enough to result in an
  661. // error at some upper layer. Ideally, there would be a way for
  662. // Inode::metadata() to return failure.
  663. return metadata;
  664. }
  665. u64 valid;
  666. Plan9FS::qid qid;
  667. u32 mode;
  668. u32 uid;
  669. u32 gid;
  670. u64 nlink;
  671. u64 rdev;
  672. u64 size;
  673. u64 blksize;
  674. u64 blocks;
  675. message >> valid >> qid >> mode >> uid >> gid >> nlink >> rdev >> size >> blksize >> blocks;
  676. // TODO: times...
  677. if (valid & (u64)GetAttrMask::Mode)
  678. metadata.mode = mode;
  679. if (valid & (u64)GetAttrMask::NLink)
  680. metadata.link_count = nlink;
  681. #if 0
  682. // FIXME: Map UID/GID somehow? Or what do we do?
  683. if (valid & (u64)GetAttrMask::UID)
  684. metadata.uid = uid;
  685. if (valid & (u64)GetAttrMask::GID)
  686. metadata.uid = gid;
  687. // FIXME: What about device nodes?
  688. if (valid & (u64)GetAttrMask::RDev)
  689. metadata.encoded_device = 0; // TODO
  690. #endif
  691. if (valid & (u64)GetAttrMask::Size)
  692. metadata.size = size;
  693. if (valid & (u64)GetAttrMask::Blocks) {
  694. metadata.block_size = blksize;
  695. metadata.block_count = blocks;
  696. }
  697. return metadata;
  698. }
  699. void Plan9FSInode::flush_metadata()
  700. {
  701. // Do nothing.
  702. }
  703. KResult Plan9FSInode::traverse_as_directory(Function<bool(FileSystem::DirectoryEntryView const&)> callback) const
  704. {
  705. // TODO: Should we synthesize "." and ".." here?
  706. if (fs().m_remote_protocol_version >= Plan9FS::ProtocolVersion::v9P2000L) {
  707. // Start by cloning the fid and opening it.
  708. auto clone_fid = fs().allocate_fid();
  709. {
  710. Plan9FS::Message clone_message { fs(), Plan9FS::Message::Type::Twalk };
  711. clone_message << fid() << clone_fid << (u16)0;
  712. TRY(fs().post_message_and_wait_for_a_reply(clone_message));
  713. Plan9FS::Message open_message { fs(), Plan9FS::Message::Type::Tlopen };
  714. open_message << clone_fid << (u32)0;
  715. auto result = fs().post_message_and_wait_for_a_reply(open_message);
  716. if (result.is_error()) {
  717. Plan9FS::Message close_message { fs(), Plan9FS::Message::Type::Tclunk };
  718. close_message << clone_fid;
  719. // FIXME: Should we observe this error?
  720. [[maybe_unused]] auto rc = fs().post_message_and_explicitly_ignore_reply(close_message);
  721. return result;
  722. }
  723. }
  724. u64 offset = 0;
  725. u32 count = fs().adjust_buffer_size(8 * MiB);
  726. KResult result = KSuccess;
  727. while (true) {
  728. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Treaddir };
  729. message << clone_fid << offset << count;
  730. result = fs().post_message_and_wait_for_a_reply(message);
  731. if (result.is_error())
  732. break;
  733. StringView data = message.read_data();
  734. if (data.is_empty()) {
  735. // We've reached the end.
  736. break;
  737. }
  738. for (Plan9FS::Message::Decoder decoder { data }; decoder.has_more_data();) {
  739. Plan9FS::qid qid;
  740. u8 type;
  741. StringView name;
  742. decoder >> qid >> offset >> type >> name;
  743. callback({ name, { fsid(), fs().allocate_fid() }, 0 });
  744. }
  745. }
  746. Plan9FS::Message close_message { fs(), Plan9FS::Message::Type::Tclunk };
  747. close_message << clone_fid;
  748. // FIXME: Should we observe this error?
  749. [[maybe_unused]] auto rc = fs().post_message_and_explicitly_ignore_reply(close_message);
  750. return result;
  751. } else {
  752. // TODO
  753. return ENOTIMPL;
  754. }
  755. }
  756. KResultOr<NonnullRefPtr<Inode>> Plan9FSInode::lookup(StringView name)
  757. {
  758. u32 newfid = fs().allocate_fid();
  759. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Twalk };
  760. message << fid() << newfid << (u16)1 << name;
  761. TRY(fs().post_message_and_wait_for_a_reply(message));
  762. return TRY(Plan9FSInode::try_create(fs(), newfid));
  763. }
  764. KResultOr<NonnullRefPtr<Inode>> Plan9FSInode::create_child(StringView, mode_t, dev_t, UserID, GroupID)
  765. {
  766. // TODO
  767. return ENOTIMPL;
  768. }
  769. KResult Plan9FSInode::add_child(Inode&, const StringView&, mode_t)
  770. {
  771. // TODO
  772. return ENOTIMPL;
  773. }
  774. KResult Plan9FSInode::remove_child(const StringView&)
  775. {
  776. // TODO
  777. return ENOTIMPL;
  778. }
  779. KResult Plan9FSInode::chmod(mode_t)
  780. {
  781. // TODO
  782. return ENOTIMPL;
  783. }
  784. KResult Plan9FSInode::chown(UserID, GroupID)
  785. {
  786. // TODO
  787. return ENOTIMPL;
  788. }
  789. KResult Plan9FSInode::truncate(u64 new_size)
  790. {
  791. if (fs().m_remote_protocol_version >= Plan9FS::ProtocolVersion::v9P2000L) {
  792. Plan9FS::Message message { fs(), Plan9FS::Message::Type::Tsetattr };
  793. SetAttrMask valid = SetAttrMask::Size;
  794. u32 mode = 0;
  795. u32 uid = 0;
  796. u32 gid = 0;
  797. u64 atime_sec = 0;
  798. u64 atime_nsec = 0;
  799. u64 mtime_sec = 0;
  800. u64 mtime_nsec = 0;
  801. message << fid() << (u64)valid << mode << uid << gid << new_size << atime_sec << atime_nsec << mtime_sec << mtime_nsec;
  802. return fs().post_message_and_wait_for_a_reply(message);
  803. } else {
  804. // TODO: wstat version
  805. return KSuccess;
  806. }
  807. }
  808. }