1 /* 2 * A resource offering support for creating contexts and opening files. 3 * 4 * Copyright (C) 2021 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 * Boston, MA 02110-1301, USA 20 */ 21 22 #pragma once 23 24 #include <fsserver/file_object_registry.h> 25 #include <fsserver/file_opening.h> 26 #include <fsserver/opener_context_resource.h> 27 #include <fsserver/opener_interface.h> 28 #include <fsserver/resource.h> 29 30 31 32 /* Support for providing access to files. */ 33 34 class OpenerResource : public Resource, public FileOpening, public Opener 35 { 36 protected: 37 FileObjectRegistry *_registry; 38 39 /* Convenience methods determining different object types. */ 40 41 virtual bool accessing_directory(const char *path, flags_t flags, fileid_t fileid) = 0; 42 43 virtual bool accessing_file(const char *path, flags_t flags, fileid_t fileid) = 0; 44 45 /* Convenience methods obtaining different resource types. */ 46 47 virtual long get_directory(const char *path, flags_t flags, fileid_t fileid, 48 offset_t *size, l4_cap_idx_t *cap, 49 object_flags_t *object_flags); 50 51 virtual long get_file(const char *path, flags_t flags, fileid_t fileid, 52 offset_t *size, l4_cap_idx_t *cap, 53 object_flags_t *object_flags); 54 55 /* Retrieval methods. */ 56 57 virtual long get_parent(const char *path, fileid_t *fileid); 58 59 /* Notification methods. */ 60 61 virtual long notify_parent(const char *path); 62 63 public: 64 explicit OpenerResource(FileObjectRegistry *registry); 65 66 virtual ~OpenerResource(); 67 68 /* Server details. */ 69 70 int expected_items(); 71 72 ipc_server_handler_type handler(); 73 74 void *interface() 75 { return static_cast<Opener *>(this); } 76 77 /* Direct access methods. */ 78 79 long open(const char *path, flags_t flags, offset_t *size, 80 l4_cap_idx_t *cap, object_flags_t *object_flags); 81 82 /* Opener interface methods. */ 83 84 long context(l4_cap_idx_t *context); 85 }; 86 87 // vim: tabstop=4 expandtab shiftwidth=4