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