shim_handle.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. /* -*- mode:c; c-file-style:"k&r"; c-basic-offset: 4; tab-width:4; indent-tabs-mode:nil; mode:auto-fill; fill-column:78; -*- */
  2. /* vim: set ts=4 sw=4 et tw=78 fo=cqt wm=0: */
  3. /* Copyright (C) 2014 OSCAR lab, Stony Brook University
  4. This file is part of Graphene Library OS.
  5. Graphene Library OS is free software: you can redistribute it and/or
  6. modify it under the terms of the GNU General Public License
  7. as published by the Free Software Foundation, either version 3 of the
  8. License, or (at your option) any later version.
  9. Graphene Library OS is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with this program. If not, see <http://www.gnu.org/licenses/>. */
  15. /*
  16. * shim_handle.h
  17. *
  18. * Definitions of types and functions for file/handle bookkeeping.
  19. */
  20. #ifndef _SHIM_HANDLE_H_
  21. #define _SHIM_HANDLE_H_
  22. #include <shim_types.h>
  23. #include <shim_defs.h>
  24. #include <shim_sysv.h>
  25. #include <pal.h>
  26. #include <linux_list.h>
  27. #include <linux/shm.h>
  28. #include <linux/in.h>
  29. #include <linux/in6.h>
  30. #include <linux/un.h>
  31. #include <asm/fcntl.h>
  32. /* start definition of shim handle */
  33. enum shim_handle_type {
  34. TYPE_FILE,
  35. TYPE_DEV,
  36. TYPE_PIPE,
  37. TYPE_SOCK,
  38. TYPE_DIR,
  39. TYPE_SHM,
  40. TYPE_SEM,
  41. TYPE_MSG,
  42. TYPE_FUTEX,
  43. TYPE_STR,
  44. TYPE_EPOLL,
  45. };
  46. struct shim_handle;
  47. struct shim_thread;
  48. struct shim_vma;
  49. enum shim_file_type {
  50. FILE_UNKNOWN,
  51. FILE_REGULAR,
  52. FILE_DIR,
  53. FILE_DEV,
  54. FILE_TTY,
  55. };
  56. struct shim_file_data {
  57. LOCKTYPE lock;
  58. struct shim_atomic version;
  59. bool queried;
  60. enum shim_file_type type;
  61. mode_t mode;
  62. struct shim_atomic size;
  63. struct shim_qstr host_uri;
  64. unsigned long atime;
  65. unsigned long mtime;
  66. unsigned long ctime;
  67. };
  68. struct shim_file_handle {
  69. unsigned int version;
  70. struct shim_file_data * data;
  71. enum shim_file_type type;
  72. unsigned long size;
  73. unsigned long marker;
  74. enum { FILEBUF_MAP, FILEBUF_NONE } buf_type;
  75. unsigned long mapsize;
  76. unsigned long mapoffset;
  77. void * mapbuf;
  78. };
  79. #define FILE_HANDLE_DATA(hdl) ((hdl)->info.file.data)
  80. #define FILE_DENTRY_DATA(dent) ((struct shim_file_data *) (dent)->data)
  81. struct shim_dev_ops {
  82. /* open: provide a filename relative to the mount point and flags,
  83. modify the shim handle */
  84. int (*open) (struct shim_handle * hdl, const char * name, int flags);
  85. /* close: clean up the file state inside the handle */
  86. int (*close) (struct shim_handle * hdl);
  87. /* read: the content from the file opened as handle */
  88. int (*read) (struct shim_handle * hdl, void * buf, size_t count);
  89. /* write: the content from the file opened as handle */
  90. int (*write) (struct shim_handle * hdl, const void * buf, size_t count);
  91. /* flush: flush out user buffer */
  92. int (*flush) (struct shim_handle * hdl);
  93. /* seek: the content from the file opened as handle */
  94. int (*seek) (struct shim_handle * hdl, off_t offset, int wence);
  95. int (*truncate) (struct shim_handle * hdl, uint64_t len);
  96. int (*mode) (const char * name, mode_t * mode);
  97. /* stat, hstat: get status of the file */
  98. int (*stat) (const char * name, struct stat * buf);
  99. int (*hstat) (struct shim_handle * hdl, struct stat * buf);
  100. };
  101. struct shim_dev_handle {
  102. struct shim_dev_ops dev_ops;
  103. };
  104. struct shim_pipe_handle {
  105. #if USE_SIMPLE_PIPE == 1
  106. struct shim_handle * pair;
  107. #else
  108. IDTYPE pipeid;
  109. #endif
  110. };
  111. #define SOCK_STREAM 1
  112. #define SOCK_DGRAM 2
  113. #define SOCK_NONBLOCK 04000
  114. #define SOCK_CLOEXEC 02000000
  115. #define SOL_TCP 6
  116. #define PF_LOCAL 1
  117. #define PF_UNIX PF_LOCAL
  118. #define PF_FILE PF_LOCAL
  119. #define PF_INET 2
  120. #define PF_INET6 10
  121. #define AF_UNIX PF_UNIX
  122. #define AF_INET PF_INET
  123. #define AF_INET6 PF_INET6
  124. enum shim_sock_state {
  125. SOCK_CREATED,
  126. SOCK_BOUND,
  127. SOCK_CONNECTED,
  128. SOCK_BOUNDCONNECTED,
  129. SOCK_LISTENED,
  130. SOCK_ACCEPTED,
  131. SOCK_SHUTDOWN,
  132. };
  133. struct shim_unix_data {
  134. unsigned int pipeid;
  135. };
  136. struct shim_sock_handle {
  137. int domain;
  138. int sock_type;
  139. int protocol;
  140. int error;
  141. enum shim_sock_state sock_state;
  142. union shim_sock_addr {
  143. // INET addr
  144. struct {
  145. struct addr_inet {
  146. unsigned short port;
  147. unsigned short ext_port;
  148. union {
  149. struct in_addr v4;
  150. struct in6_addr v6;
  151. } addr;
  152. } bind, conn;
  153. } in;
  154. // UNIX addr
  155. struct addr_unix {
  156. struct shim_dentry * dentry;
  157. unsigned int pipeid;
  158. struct shim_unix_data * data;
  159. } un;
  160. } addr;
  161. struct shim_sock_option {
  162. struct shim_sock_option * next;
  163. int level;
  164. int optname;
  165. int optlen;
  166. char optval[];
  167. } * pending_options;
  168. };
  169. struct shim_dirent {
  170. struct shim_dirent * next;
  171. unsigned long ino; /* Inode number */
  172. unsigned char type;
  173. char name[]; /* File name (null-terminated) */
  174. };
  175. struct shim_dir_handle {
  176. int offset;
  177. struct shim_dentry * dotdot;
  178. struct shim_dentry * dot;
  179. struct shim_dentry ** buf;
  180. struct shim_dentry ** ptr;
  181. };
  182. struct shim_shm_handle {
  183. /* XXX: need to implement */
  184. void * __reserved;
  185. };
  186. struct msg_type;
  187. struct msg_item;
  188. struct msg_client;
  189. #define MAX_SYSV_CLIENTS 32
  190. struct shim_msg_handle {
  191. unsigned long msqkey; /* msg queue key from user */
  192. IDTYPE msqid; /* msg queue identifier */
  193. bool owned; /* owned by current process */
  194. struct shim_ipc_info * owner;
  195. LEASETYPE lease;
  196. int perm; /* access permissions */
  197. bool deleted; /* marking the queue deleted */
  198. int nmsgs; /* number of msgs */
  199. int currentsize; /* current size in bytes */
  200. struct msg_qobj * queue;
  201. int queuesize;
  202. int queueused;
  203. struct msg_qobj * freed;
  204. PAL_HANDLE event; /* event for waiting */
  205. int ntypes;
  206. int maxtypes;
  207. struct msg_type * types;
  208. struct sysv_score scores[MAX_SYSV_CLIENTS];
  209. struct list_head list;
  210. struct hlist_node key_hlist;
  211. struct hlist_node qid_hlist;
  212. };
  213. struct sem_objs;
  214. struct shim_sem_handle {
  215. unsigned long semkey;
  216. IDTYPE semid;
  217. bool owned;
  218. struct shim_ipc_info * owner;
  219. LEASETYPE lease;
  220. int perm;
  221. bool deleted;
  222. PAL_HANDLE event;
  223. int nsems;
  224. struct sem_obj * sems;
  225. int nreqs;
  226. struct sysv_score scores[MAX_SYSV_CLIENTS];
  227. struct list_head migrated;
  228. struct list_head list;
  229. struct hlist_node key_hlist;
  230. struct hlist_node sid_hlist;
  231. };
  232. struct shim_futex_handle {
  233. PAL_HANDLE event;
  234. unsigned int * uaddr;
  235. struct list_head waiters;
  236. struct shim_vma * vma;
  237. struct list_head list;
  238. };
  239. struct shim_str_data {
  240. REFTYPE ref_count;
  241. char * str;
  242. size_t len;
  243. size_t buf_size;
  244. bool dirty;
  245. int (*update) (struct shim_handle * hdl);
  246. int (*modify) (struct shim_handle * hdl);
  247. };
  248. struct shim_str_handle {
  249. struct shim_str_data * data; /* inode is stored in dentry, too.
  250. store pointer here for efficiency */
  251. char * ptr;
  252. };
  253. struct shim_epoll_handle {
  254. int maxfds;
  255. int nfds;
  256. struct list_head fds;
  257. FDTYPE * pal_fds;
  258. PAL_HANDLE * pal_handles;
  259. int npals;
  260. int nread;
  261. int nwaiters;
  262. AEVENTTYPE event;
  263. };
  264. struct shim_mount;
  265. struct shim_qstr;
  266. struct shim_dentry;
  267. struct shim_handle {
  268. enum shim_handle_type type;
  269. REFTYPE ref_count;
  270. char fs_type[8];
  271. struct shim_mount * fs;
  272. struct shim_qstr path;
  273. struct shim_dentry * dentry;
  274. struct shim_qstr uri; /* URI representing this handle, it is not
  275. * necessary to be set. */
  276. PAL_HANDLE pal_handle;
  277. union {
  278. struct shim_file_handle file;
  279. struct shim_dev_handle dev;
  280. struct shim_pipe_handle pipe;
  281. struct shim_sock_handle sock;
  282. struct shim_dir_handle dir;
  283. struct shim_shm_handle shm;
  284. struct shim_msg_handle msg;
  285. struct shim_sem_handle sem;
  286. struct shim_futex_handle futex;
  287. struct shim_str_handle str;
  288. struct shim_epoll_handle epoll;
  289. } info;
  290. int flags;
  291. int acc_mode;
  292. IDTYPE owner;
  293. REFTYPE opened;
  294. LOCKTYPE lock;
  295. };
  296. /* allocating / manage handle */
  297. struct shim_handle * get_new_handle (void);
  298. void flush_handle (struct shim_handle * hdl);
  299. void open_handle (struct shim_handle * hdl);
  300. void close_handle (struct shim_handle * hdl);
  301. void get_handle (struct shim_handle * hdl);
  302. void put_handle (struct shim_handle * hdl);
  303. /* file descriptor table */
  304. struct shim_fd_handle {
  305. FDTYPE vfd; /* virtual file descriptor */
  306. int flags; /* file descriptor flags, only FD_CLOEXEC */
  307. struct shim_handle * handle;
  308. };
  309. #define MAX_FDS 1024
  310. struct shim_handle_map {
  311. /* the top of created file descriptors */
  312. FDTYPE fd_size;
  313. FDTYPE fd_top;
  314. /* refrence count and lock */
  315. REFTYPE ref_count;
  316. LOCKTYPE lock;
  317. /* An array of file descriptor belong to this mapping */
  318. struct shim_fd_handle ** map;
  319. };
  320. /* allocating file descriptors */
  321. #define FD_NULL ((FDTYPE) -1)
  322. #define HANDLE_ALLOCATED(fd_handle) ((fd_handle) && (fd_handle)->vfd != FD_NULL)
  323. struct shim_handle * __get_fd_handle (FDTYPE fd, int * flags,
  324. struct shim_handle_map * map);
  325. struct shim_handle * get_fd_handle (FDTYPE fd, int * flags,
  326. struct shim_handle_map * map);
  327. int set_new_fd_handle (struct shim_handle * hdl, int flags,
  328. struct shim_handle_map * map);
  329. int set_new_fd_handle_by_fd (FDTYPE fd, struct shim_handle * hdl,
  330. int flags, struct shim_handle_map * map);
  331. struct shim_handle *
  332. __detach_fd_handle (struct shim_fd_handle * fd, int * flags,
  333. struct shim_handle_map * map);
  334. struct shim_handle * detach_fd_handle (FDTYPE fd, int * flags,
  335. struct shim_handle_map * map);
  336. /* manage handle mapping */
  337. int dup_handle_map (struct shim_handle_map ** new_map,
  338. struct shim_handle_map * old_map);
  339. int flush_handle_map (struct shim_handle_map * map);
  340. void get_handle_map (struct shim_handle_map * map);
  341. void put_handle_map (struct shim_handle_map * map);
  342. int walk_handle_map (int (*callback) (struct shim_fd_handle *,
  343. struct shim_handle_map *, void *),
  344. struct shim_handle_map * map, void * arg);
  345. int init_handle (void);
  346. int init_important_handles (void);
  347. size_t get_file_size (struct shim_handle * file);
  348. int do_handle_read (struct shim_handle * hdl, void * buf, int count);
  349. int do_handle_write (struct shim_handle * hdl, const void * buf, int count);
  350. #endif /* _SHIM_HANDLE_H_ */