1 /* 2 * Base types used by various other types. 3 * 4 * Copyright (C) 2019, 2021, 2022, 2023, 2024 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 <l4/sys/compiler.h> 25 #include <l4/sys/types.h> 26 27 28 29 EXTERN_C_BEGIN 30 31 /* Types for file access (access flags, offsets) and IPC operations. */ 32 33 typedef l4_uint64_t flags_t; /* see systypes/fcntl.h */ 34 typedef l4_uint64_t offset_t; 35 typedef l4_addr_t address_t; /* unsigned long */ 36 37 /* Region mapper types. 38 See: pkg/l4re-core/l4re_c/include/rm.h */ 39 40 typedef l4_uint32_t rm_flags_t; 41 typedef l4_uint64_t rm_offset_t; 42 43 /* Dataspace mapping flags. 44 See: pkg/l4re-core/l4re_c/include/dataspace.h */ 45 46 typedef l4_uint64_t map_address_t; 47 typedef unsigned long map_flags_t; 48 49 /* Conversions. */ 50 51 map_flags_t map_flags_for_fault(l4_umword_t flags); 52 53 /* Types and values for notification. */ 54 55 typedef l4_uint64_t notify_flags_t; 56 57 typedef struct 58 { 59 unsigned long sig; /* signal number */ 60 long val; /* signal-specific value */ 61 62 } notify_values_t; 63 64 #define NOTIFY_VALUES_NULL ((notify_values_t) {0, 0}) 65 66 enum notify_flags 67 { 68 NOTIFY_CONTENT_AVAILABLE = 0x001, /* reading files and pipes */ 69 NOTIFY_SPACE_AVAILABLE = 0x002, /* writing pipes */ 70 NOTIFY_PEER_CLOSED = 0x004, /* closing files and pipes */ 71 NOTIFY_FILE_OPENED = 0x008, /* opening files in directories */ 72 NOTIFY_TASK_SIGNAL = 0x100, /* signal from task */ 73 NOTIFY_TASK_ERROR = 0x200, /* error when creating task */ 74 75 /* Combinations of flags. */ 76 77 NOTIFY_TASK_ALL = 0x300, 78 }; 79 80 /* Notifiable object types. */ 81 82 /* Forward reference. */ 83 84 typedef struct notifiable_base notifiable_base_t; 85 86 /* Structure maintaining notification state for a specific object. */ 87 88 typedef struct notifiable 89 { 90 notifiable_base_t *base; /* access to the specific object */ 91 notify_flags_t notifications; /* essential notifications */ 92 notify_flags_t pending_notifications; 93 notify_values_t values; /* signal-specific values */ 94 notify_values_t pending_values; 95 void *handler; /* associated notification handler */ 96 97 } notifiable_t; 98 99 /* A base structure extended by notifiable object structures like files and 100 processes. */ 101 102 typedef struct notifiable_base 103 { 104 l4_cap_idx_t ref; 105 notifiable_t notifiable; 106 107 } notifiable_base_t; 108 109 /* Filesystem object properties. */ 110 111 typedef unsigned long object_flags_t; 112 113 enum object_flags 114 { 115 OBJECT_SUPPORTS_MMAP = 1, 116 OBJECT_HAS_SIZE = 2 117 }; 118 119 /* Memory mapping protection flags compatible with sys/mman.h (and incompatible 120 with comparable L4Re flags). */ 121 122 typedef unsigned long prot_t; 123 124 enum prot_flags 125 { 126 PROT_NONE = 0, 127 PROT_READ = 1, 128 PROT_WRITE = 2, 129 PROT_EXEC = 4 130 }; 131 132 /* Equivalent types are defined in sys/types.h typically. In newlib, they are 133 defined in sys/_types.h if not defined elsewhere (such as in 134 machine/_types.h). In uclibc, the following file is informative: 135 136 pkg/l4re-core/uclibc/lib/contrib/uclibc/libc/sysdeps/linux/common/bits/types.h 137 138 These types are intended for IPC, permitting different parties to employ 139 different library implementations where these types may be different. 140 */ 141 142 typedef l4_uint64_t sys_dev_t; /* device number */ 143 typedef unsigned long int sys_ino_t; /* inode number */ 144 typedef unsigned int sys_mode_t; /* file permissions */ 145 typedef unsigned long int sys_nlink_t; /* link count */ 146 typedef unsigned int sys_uid_t; /* user identifier */ 147 typedef unsigned int sys_gid_t; /* group identifier */ 148 typedef long sys_off_t; /* file offset/position */ 149 typedef long sys_blksize_t; /* input/output block size */ 150 typedef long sys_blkcnt_t; /* number of 512-byte blocks */ 151 152 /* Conversions. */ 153 154 #define systypes_from_sys_mode(mode) \ 155 ((mode_t) mode) 156 157 #define systypes_to_sys_mode(mode) \ 158 ((sys_mode_t) mode) 159 160 EXTERN_C_END 161 162 // vim: tabstop=2 expandtab shiftwidth=2