PageRenderTime 41ms CodeModel.GetById 12ms RepoModel.GetById 1ms app.codeStats 0ms

/headers/private/kernel/fs/fd.h

https://bitbucket.org/ddevine/haiku
C Header | 119 lines | 87 code | 23 blank | 9 comment | 1 complexity | 3473efab0bafda7b26f0a5b5d2d0cdc7 MD5 | raw file
Possible License(s): Apache-2.0, LGPL-2.0, LGPL-2.1, MPL-2.0-no-copyleft-exception, MIT, ISC, BSD-3-Clause, AGPL-1.0, GPL-2.0, GPL-3.0, LGPL-3.0 
    

  1. /*
    2. 

  2.  * Copyright 2002-2006, Axel Dörfler, axeld@pinc-software.de.
    3. 

  3.  * Distributed under the terms of the MIT License.
    4. 

  4.  */
    5. 

  5. #ifndef _FD_H
    6. 

  6. #define _FD_H
    7. 

  7. 

  8. 

  9. #include <vfs.h>
    10. 

  10. #include <team.h>
    11. 

  11. #include <thread.h>
    12. 

  12. 

  13. 

  14. #ifdef __cplusplus
    15. 

  15. extern "C" {
    16. 

  16. #endif
    17. 

  17. 

  18. struct file_descriptor;
    19. 

  19. struct io_context;
    20. 

  20. struct net_socket;
    21. 

  21. struct selectsync;
    22. 

  22. struct select_info;
    23. 

  23. 

  24. struct fd_ops {
    25. 

  25. 	status_t	(*fd_read)(struct file_descriptor *, off_t pos, void *buffer, size_t *length);
    26. 

  26. 	status_t	(*fd_write)(struct file_descriptor *, off_t pos, const void *buffer, size_t *length);
    27. 

  27. 	off_t		(*fd_seek)(struct file_descriptor *, off_t pos, int seekType);
    28. 

  28. 	status_t	(*fd_ioctl)(struct file_descriptor *, ulong op, void *buffer, size_t length);
    29. 

  29. 	status_t	(*fd_set_flags)(struct file_descriptor *, int flags);
    30. 

  30. 	status_t	(*fd_select)(struct file_descriptor *, uint8 event,
    31. 

  31. 						struct selectsync *sync);
    32. 

  32. 	status_t	(*fd_deselect)(struct file_descriptor *, uint8 event,
    33. 

  33. 						struct selectsync *sync);
    34. 

  34. 	status_t	(*fd_read_dir)(struct io_context* ioContext,
    35. 

  35. 						struct file_descriptor *, struct dirent *buffer,
    36. 

  36. 						size_t bufferSize, uint32 *_count);
    37. 

  37. 	status_t	(*fd_rewind_dir)(struct file_descriptor *);
    38. 

  38. 	status_t	(*fd_read_stat)(struct file_descriptor *, struct stat *);
    39. 

  39. 	status_t	(*fd_write_stat)(struct file_descriptor *, const struct stat *, int statMask);
    40. 

  40. 	status_t	(*fd_close)(struct file_descriptor *);
    41. 

  41. 	void		(*fd_free)(struct file_descriptor *);
    42. 

  42. };
    43. 

  43. 

  44. struct file_descriptor {
    45. 

  45. 	int32	type;               /* descriptor type */
    46. 

  46. 	int32	ref_count;
    47. 

  47. 	int32	open_count;
    48. 

  48. 	struct fd_ops *ops;
    49. 

  49. 	union {
    50. 

  50. 		struct vnode *vnode;
    51. 

  51. 		struct fs_mount *mount;
    52. 

  52. 		struct net_socket *socket;
    53. 

  53. 	} u;
    54. 

  54. 	void	*cookie;
    55. 

  55. 	int32	open_mode;
    56. 

  56. 	off_t	pos;
    57. 

  57. };
    58. 

  58. 

  59. 

  60. /* Types of file descriptors we can create */
    61. 

  61. 

  62. enum fd_types {
    63. 

  63. 	FDTYPE_FILE	= 1,
    64. 

  64. 	FDTYPE_ATTR,
    65. 

  65. 	FDTYPE_DIR,
    66. 

  66. 	FDTYPE_ATTR_DIR,
    67. 

  67. 	FDTYPE_INDEX,
    68. 

  68. 	FDTYPE_INDEX_DIR,
    69. 

  69. 	FDTYPE_QUERY,
    70. 

  70. 	FDTYPE_SOCKET
    71. 

  71. };
    72. 

  72. 

  73. // additional open mode - kernel special
    74. 

  74. #define O_DISCONNECTED 0x80000000
    75. 

  75. 

  76. /* Prototypes */
    77. 

  77. 

  78. extern struct file_descriptor *alloc_fd(void);
    79. 

  79. extern int new_fd_etc(struct io_context *, struct file_descriptor *, int firstIndex);
    80. 

  80. extern int new_fd(struct io_context *, struct file_descriptor *);
    81. 

  81. extern struct file_descriptor *get_fd(struct io_context *, int);
    82. 

  82. extern struct file_descriptor *get_open_fd(struct io_context *, int);
    83. 

  83. extern void close_fd(struct file_descriptor *descriptor);
    84. 

  84. extern status_t close_fd_index(struct io_context *context, int fd);
    85. 

  85. extern void put_fd(struct file_descriptor *descriptor);
    86. 

  86. extern void disconnect_fd(struct file_descriptor *descriptor);
    87. 

  87. extern void inc_fd_ref_count(struct file_descriptor *descriptor);
    88. 

  88. extern int dup_foreign_fd(team_id fromTeam, int fd, bool kernel);
    89. 

  89. extern status_t select_fd(int32 fd, struct select_info *info, bool kernel);
    90. 

  90. extern status_t deselect_fd(int32 fd, struct select_info *info, bool kernel);
    91. 

  91. extern bool fd_is_valid(int fd, bool kernel);
    92. 

  92. extern struct vnode *fd_vnode(struct file_descriptor *descriptor);
    93. 

  93. 

  94. extern bool fd_close_on_exec(struct io_context *context, int fd);
    95. 

  95. extern void fd_set_close_on_exec(struct io_context *context, int fd, bool closeFD);
    96. 

  96. 

  97. static struct io_context *get_current_io_context(bool kernel);
    98. 

  98. 

  99. extern status_t user_fd_kernel_ioctl(int fd, ulong op, void *buffer, size_t length);
    100. 

  100. 

  101. /* The prototypes of the (sys|user)_ functions are currently defined in vfs.h */
    102. 

  102. 

  103. 

  104. /* Inlines */
    105. 

  105. 

  106. static inline struct io_context *
    107. 

  107. get_current_io_context(bool kernel)
    108. 

  108. {
    109. 

  109. 	if (kernel)
    110. 

  110. 		return (struct io_context *)team_get_kernel_team()->io_context;
    111. 

  111. 

  112. 	return (struct io_context *)thread_get_current_thread()->team->io_context;
    113. 

  113. }
    114. 

  114. 

  115. #ifdef __cplusplus
    116. 

  116. }
    117. 

  117. #endif
    118. 

  118. 

  119. #endif /* _FD_H */
    120. 

  120.