shim_handle.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  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 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 Lesser 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 Lesser General Public License for more details.
  13. You should have received a copy of the GNU Lesser 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 <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 atomic_int version;
  59. bool queried;
  60. enum shim_file_type type;
  61. mode_t mode;
  62. struct atomic_int size;
  63. struct shim_qstr host_uri;
  64. unsigned long atime;
  65. unsigned long mtime;
  66. unsigned long ctime;
  67. unsigned long nlink;
  68. };
  69. struct shim_file_handle {
  70. unsigned int version;
  71. struct shim_file_data * data;
  72. enum shim_file_type type;
  73. uint64_t size;
  74. uint64_t marker;
  75. enum { FILEBUF_MAP, FILEBUF_NONE } buf_type;
  76. uint64_t mapsize;
  77. uint64_t mapoffset;
  78. void * mapbuf;
  79. };
  80. #define FILE_HANDLE_DATA(hdl) ((hdl)->info.file.data)
  81. #define FILE_DENTRY_DATA(dent) ((struct shim_file_data *) (dent)->data)
  82. struct shim_dev_ops {
  83. /* open: provide a filename relative to the mount point and flags,
  84. modify the shim handle */
  85. int (*open) (struct shim_handle * hdl, const char * name, int flags);
  86. /* close: clean up the file state inside the handle */
  87. int (*close) (struct shim_handle * hdl);
  88. /* read: the content from the file opened as handle */
  89. int (*read) (struct shim_handle * hdl, void * buf, size_t count);
  90. /* write: the content from the file opened as handle */
  91. int (*write) (struct shim_handle * hdl, const void * buf, size_t count);
  92. /* flush: flush out user buffer */
  93. int (*flush) (struct shim_handle * hdl);
  94. /* seek: the content from the file opened as handle */
  95. int (*seek) (struct shim_handle * hdl, off_t offset, int wence);
  96. int (*truncate) (struct shim_handle * hdl, uint64_t len);
  97. int (*mode) (const char * name, mode_t * mode);
  98. /* stat, hstat: get status of the file */
  99. int (*stat) (const char * name, struct stat * buf);
  100. int (*hstat) (struct shim_handle * hdl, struct stat * buf);
  101. };
  102. struct shim_dev_handle {
  103. struct shim_dev_ops dev_ops;
  104. };
  105. struct shim_pipe_handle {
  106. #if USE_SIMPLE_PIPE == 1
  107. struct shim_handle * pair;
  108. #else
  109. IDTYPE pipeid;
  110. #endif
  111. };
  112. #define SOCK_STREAM 1
  113. #define SOCK_DGRAM 2
  114. #define SOCK_NONBLOCK 04000
  115. #define SOCK_CLOEXEC 02000000
  116. #define SOL_TCP 6
  117. #define PF_LOCAL 1
  118. #define PF_UNIX PF_LOCAL
  119. #define PF_FILE PF_LOCAL
  120. #define PF_INET 2
  121. #define PF_INET6 10
  122. #define AF_UNIX PF_UNIX
  123. #define AF_INET PF_INET
  124. #define AF_INET6 PF_INET6
  125. enum shim_sock_state {
  126. SOCK_CREATED,
  127. SOCK_BOUND,
  128. SOCK_CONNECTED,
  129. SOCK_BOUNDCONNECTED,
  130. SOCK_LISTENED,
  131. SOCK_ACCEPTED,
  132. SOCK_SHUTDOWN,
  133. };
  134. struct shim_unix_data {
  135. unsigned int pipeid;
  136. };
  137. struct shim_sock_handle {
  138. int domain;
  139. int sock_type;
  140. int protocol;
  141. int error;
  142. enum shim_sock_state sock_state;
  143. union shim_sock_addr {
  144. // INET addr
  145. struct {
  146. struct addr_inet {
  147. unsigned short port;
  148. unsigned short ext_port;
  149. union {
  150. struct in_addr v4;
  151. struct in6_addr v6;
  152. } addr;
  153. } bind, conn;
  154. } in;
  155. // UNIX addr
  156. struct addr_unix {
  157. struct shim_dentry * dentry;
  158. unsigned int pipeid;
  159. struct shim_unix_data * data;
  160. } un;
  161. } addr;
  162. struct shim_sock_option {
  163. struct shim_sock_option * next;
  164. int level;
  165. int optname;
  166. int optlen;
  167. char optval[];
  168. } * pending_options;
  169. };
  170. struct shim_dirent {
  171. struct shim_dirent * next;
  172. unsigned long ino; /* Inode number */
  173. unsigned char type;
  174. char name[]; /* File name (null-terminated) */
  175. };
  176. struct shim_dir_handle {
  177. int offset;
  178. struct shim_dentry * dotdot;
  179. struct shim_dentry * dot;
  180. struct shim_dentry ** buf;
  181. struct shim_dentry ** ptr;
  182. };
  183. struct shim_shm_handle {
  184. /* XXX: need to implement */
  185. void * __reserved;
  186. };
  187. struct msg_type;
  188. struct msg_item;
  189. struct msg_client;
  190. #define MAX_SYSV_CLIENTS 32
  191. DEFINE_LIST(shim_msg_handle);
  192. struct shim_msg_handle {
  193. unsigned long msqkey; /* msg queue key from user */
  194. IDTYPE msqid; /* msg queue identifier */
  195. bool owned; /* owned by current process */
  196. struct shim_ipc_info * owner;
  197. LEASETYPE lease;
  198. int perm; /* access permissions */
  199. bool deleted; /* marking the queue deleted */
  200. int nmsgs; /* number of msgs */
  201. int currentsize; /* current size in bytes */
  202. struct msg_qobj * queue;
  203. int queuesize;
  204. int queueused;
  205. struct msg_qobj * freed;
  206. PAL_HANDLE event; /* event for waiting */
  207. int ntypes;
  208. int maxtypes;
  209. struct msg_type * types;
  210. struct sysv_score scores[MAX_SYSV_CLIENTS];
  211. LIST_TYPE(shim_msg_handle) list;
  212. LIST_TYPE(shim_msg_handle) key_hlist;
  213. LIST_TYPE(shim_msg_handle) qid_hlist;
  214. };
  215. struct sem_objs;
  216. DEFINE_LIST(shim_sem_handle);
  217. struct shim_sem_handle {
  218. unsigned long semkey;
  219. IDTYPE semid;
  220. bool owned;
  221. struct shim_ipc_info * owner;
  222. LEASETYPE lease;
  223. int perm;
  224. bool deleted;
  225. PAL_HANDLE event;
  226. int nsems;
  227. struct sem_obj * sems;
  228. int nreqs;
  229. struct sysv_score scores[MAX_SYSV_CLIENTS];
  230. LISTP_TYPE(sem_ops) migrated;
  231. LIST_TYPE(shim_sem_handle) list;
  232. LIST_TYPE(shim_sem_handle) key_hlist;
  233. LIST_TYPE(shim_sem_handle) sid_hlist;
  234. };
  235. DEFINE_LIST(futex_waiter);
  236. DEFINE_LISTP(futex_waiter);
  237. DEFINE_LIST(shim_futex_handle);
  238. struct shim_futex_handle {
  239. unsigned int * uaddr;
  240. LISTP_TYPE(futex_waiter) waiters;
  241. struct shim_vma * vma;
  242. LIST_TYPE(shim_futex_handle) list;
  243. };
  244. struct shim_str_data {
  245. REFTYPE ref_count;
  246. char * str;
  247. size_t len;
  248. size_t buf_size;
  249. bool dirty;
  250. int (*update) (struct shim_handle * hdl);
  251. int (*modify) (struct shim_handle * hdl);
  252. };
  253. struct shim_str_handle {
  254. struct shim_str_data * data; /* inode is stored in dentry, too.
  255. store pointer here for efficiency */
  256. char * ptr;
  257. };
  258. DEFINE_LIST(shim_epoll_fd);
  259. DEFINE_LISTP(shim_epoll_fd);
  260. struct shim_epoll_handle {
  261. int maxfds;
  262. int nfds;
  263. LISTP_TYPE(shim_epoll_fd) fds; /* this list contains all the
  264. * shim_epoll_fd objects in correspondence
  265. * with the registered handles. */
  266. FDTYPE * pal_fds;
  267. PAL_HANDLE * pal_handles;
  268. int npals;
  269. int nread;
  270. int nwaiters;
  271. AEVENTTYPE event;
  272. };
  273. struct shim_mount;
  274. struct shim_qstr;
  275. struct shim_dentry;
  276. /* The epolls list links to the back field of the shim_epoll_fd structure
  277. */
  278. struct shim_handle {
  279. enum shim_handle_type type;
  280. REFTYPE ref_count;
  281. char fs_type[8];
  282. struct shim_mount * fs;
  283. struct shim_qstr path;
  284. struct shim_dentry * dentry;
  285. /* If this handle is registered for any epoll handle, this list contains
  286. * a shim_epoll_fd object in correspondence with the epoll handle. */
  287. LISTP_TYPE(shim_epoll_fd) epolls;
  288. struct shim_qstr uri; /* URI representing this handle, it is not
  289. * necessary to be set. */
  290. PAL_HANDLE pal_handle;
  291. union {
  292. struct shim_file_handle file;
  293. struct shim_dev_handle dev;
  294. struct shim_pipe_handle pipe;
  295. struct shim_sock_handle sock;
  296. struct shim_dir_handle dir;
  297. struct shim_shm_handle shm;
  298. struct shim_msg_handle msg;
  299. struct shim_sem_handle sem;
  300. struct shim_futex_handle futex;
  301. struct shim_str_handle str;
  302. struct shim_epoll_handle epoll;
  303. } info;
  304. int flags;
  305. int acc_mode;
  306. IDTYPE owner;
  307. REFTYPE opened;
  308. LOCKTYPE lock;
  309. };
  310. /* allocating / manage handle */
  311. struct shim_handle * get_new_handle (void);
  312. void flush_handle (struct shim_handle * hdl);
  313. void open_handle (struct shim_handle * hdl);
  314. void close_handle (struct shim_handle * hdl);
  315. void get_handle (struct shim_handle * hdl);
  316. void put_handle (struct shim_handle * hdl);
  317. /* file descriptor table */
  318. struct shim_fd_handle {
  319. FDTYPE vfd; /* virtual file descriptor */
  320. int flags; /* file descriptor flags, only FD_CLOEXEC */
  321. struct shim_handle * handle;
  322. };
  323. #define MAX_MAX_FDS (65536)
  324. #define DEFAULT_MAX_FDS (1024)
  325. extern unsigned int max_fds;
  326. struct shim_handle_map {
  327. /* the top of created file descriptors */
  328. FDTYPE fd_size;
  329. FDTYPE fd_top;
  330. /* refrence count and lock */
  331. REFTYPE ref_count;
  332. LOCKTYPE lock;
  333. /* An array of file descriptor belong to this mapping */
  334. struct shim_fd_handle ** map;
  335. };
  336. /* allocating file descriptors */
  337. #define FD_NULL ((FDTYPE) -1)
  338. #define HANDLE_ALLOCATED(fd_handle) ((fd_handle) && (fd_handle)->vfd != FD_NULL)
  339. struct shim_handle * __get_fd_handle (FDTYPE fd, int * flags,
  340. struct shim_handle_map * map);
  341. struct shim_handle * get_fd_handle (FDTYPE fd, int * flags,
  342. struct shim_handle_map * map);
  343. int set_new_fd_handle (struct shim_handle * hdl, int flags,
  344. struct shim_handle_map * map);
  345. int set_new_fd_handle_by_fd (FDTYPE fd, struct shim_handle * hdl,
  346. int flags, struct shim_handle_map * map);
  347. struct shim_handle *
  348. __detach_fd_handle (struct shim_fd_handle * fd, int * flags,
  349. struct shim_handle_map * map);
  350. struct shim_handle * detach_fd_handle (FDTYPE fd, int * flags,
  351. struct shim_handle_map * map);
  352. /* manage handle mapping */
  353. int dup_handle_map (struct shim_handle_map ** new_map,
  354. struct shim_handle_map * old_map);
  355. int flush_handle_map (struct shim_handle_map * map);
  356. void get_handle_map (struct shim_handle_map * map);
  357. void put_handle_map (struct shim_handle_map * map);
  358. int walk_handle_map (int (*callback) (struct shim_fd_handle *,
  359. struct shim_handle_map *, void *),
  360. struct shim_handle_map * map, void * arg);
  361. int init_handle (void);
  362. int init_important_handles (void);
  363. size_t get_file_size (struct shim_handle * file);
  364. int do_handle_read (struct shim_handle * hdl, void * buf, int count);
  365. int do_handle_write (struct shim_handle * hdl, const void * buf, int count);
  366. #endif /* _SHIM_HANDLE_H_ */