1 /* 2 * A pipe pager providing access to pipe content and navigation support. 3 * 4 * Copyright (C) 2021, 2022, 2023 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/pipe_accessor.h> 25 #include <fsserver/pipe_object_interface.h> 26 #include <fsserver/pipe_paging.h> 27 #include <fsserver/pager.h> 28 29 30 31 /* A pager abstraction for a pipe. */ 32 33 class PipePager : public Pager, public PipeObject 34 { 35 protected: 36 PipePaging *_paging; 37 bool _writing; 38 l4_cap_idx_t _notifier = L4_INVALID_CAP; 39 40 /* Helper methods. */ 41 42 virtual long next_region_for_reader(offset_t *populated_size, offset_t *size); 43 44 virtual long next_region_for_writer(offset_t *populated_size, offset_t *size); 45 46 virtual long pipe_error(); 47 48 public: 49 explicit PipePager(PipePaging *paging, bool writer); 50 51 virtual void close(); 52 53 /* Server details. */ 54 55 ipc_server_default_config_type config(); 56 57 void *interface() 58 { return static_cast<PipeObject *>(this); } 59 60 /* Pager methods. */ 61 62 virtual long map(offset_t offset, map_address_t hot_spot, map_flags_t flags, l4_snd_fpage_t *region); 63 64 /* Pipe methods. */ 65 66 virtual long closed(int *closed); 67 68 virtual long current_region(offset_t *populated_size, offset_t *size); 69 70 virtual long next_region(offset_t *populated_size, offset_t *size); 71 72 /* Flushing/synchronisation. */ 73 74 virtual long flush(offset_t populated_size, offset_t *size); 75 76 /* Notification methods. */ 77 78 virtual long subscribe(l4_cap_idx_t notifier, notify_flags_t flags); 79 80 virtual long unsubscribe(); 81 }; 82 83 // vim: tabstop=4 expandtab shiftwidth=4