HardenedBSD src tree
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

216 lines
7.5KB

  1. /*-
  2. * SPDX-License-Identifier: BSD-3-Clause
  3. *
  4. * Copyright (c) 1989, 1993
  5. * The Regents of the University of California. All rights reserved.
  6. *
  7. * This code is derived from software contributed to Berkeley by
  8. * Rick Macklem at The University of Guelph.
  9. *
  10. * Redistribution and use in source and binary forms, with or without
  11. * modification, are permitted provided that the following conditions
  12. * are met:
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in the
  17. * documentation and/or other materials provided with the distribution.
  18. * 3. Neither the name of the University nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25. * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32. * SUCH DAMAGE.
  33. *
  34. * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
  35. * $FreeBSD$
  36. */
  37. #ifndef _NFSCLIENT_NFSNODE_H_
  38. #define _NFSCLIENT_NFSNODE_H_
  39. #include <sys/_task.h>
  40. #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
  41. #include <nfs/nfs.h>
  42. #endif
  43. /*
  44. * Silly rename structure that hangs off the nfsnode until the name
  45. * can be removed by nfs_inactive()
  46. */
  47. struct sillyrename {
  48. struct task s_task;
  49. struct ucred *s_cred;
  50. struct vnode *s_dvp;
  51. int (*s_removeit)(struct sillyrename *sp);
  52. long s_namlen;
  53. char s_name[32];
  54. };
  55. /*
  56. * This structure is used to save the logical directory offset to
  57. * NFS cookie mappings.
  58. * The mappings are stored in a list headed
  59. * by n_cookies, as required.
  60. * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
  61. * stored in increasing logical offset byte order.
  62. */
  63. #define NFSNUMCOOKIES 31
  64. struct nfsdmap {
  65. LIST_ENTRY(nfsdmap) ndm_list;
  66. int ndm_eocookie;
  67. union {
  68. nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
  69. uint64_t ndmu4_cookies[NFSNUMCOOKIES];
  70. } ndm_un1;
  71. };
  72. #define ndm_cookies ndm_un1.ndmu3_cookies
  73. #define ndm4_cookies ndm_un1.ndmu4_cookies
  74. struct nfs_accesscache {
  75. u_int32_t mode; /* ACCESS mode cache */
  76. uid_t uid; /* credentials having mode */
  77. time_t stamp; /* mode cache timestamp */
  78. };
  79. /*
  80. * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
  81. * is purely coincidental.
  82. * There is a unique nfsnode allocated for each active file,
  83. * each current directory, each mounted-on file, text file, and the root.
  84. * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
  85. * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
  86. * type definitions), file handles of > 32 bytes should probably be split out
  87. * into a separate malloc()'d data structure. (Reduce the size of nfsfh_t by
  88. * changing the definition in nfsproto.h of NFS_SMALLFH.)
  89. * NB: Hopefully the current order of the fields is such that everything will
  90. * be well aligned and, therefore, tightly packed.
  91. */
  92. struct nfsnode {
  93. struct mtx n_mtx; /* Protects all of these members */
  94. u_quad_t n_size; /* Current size of file */
  95. u_quad_t n_brev; /* Modify rev when cached */
  96. u_quad_t n_lrev; /* Modify rev for lease */
  97. struct vattr n_vattr; /* Vnode attribute cache */
  98. time_t n_attrstamp; /* Attr. cache timestamp */
  99. struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
  100. struct timespec n_mtime; /* Prev modify time. */
  101. nfsfh_t *n_fhp; /* NFS File Handle */
  102. struct vnode *n_vnode; /* associated vnode */
  103. struct vnode *n_dvp; /* parent vnode */
  104. int n_error; /* Save write error value */
  105. union {
  106. struct timespec nf_atim; /* Special file times */
  107. nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
  108. u_char nd4_cookieverf[NFSX_V4VERF];
  109. } n_un1;
  110. union {
  111. struct timespec nf_mtim;
  112. off_t nd_direof; /* Dir. EOF offset cache */
  113. } n_un2;
  114. union {
  115. struct sillyrename *nf_silly; /* Ptr to silly rename struct */
  116. LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
  117. } n_un3;
  118. short n_fhsize; /* size in bytes, of fh */
  119. short n_flag; /* Flag for locking.. */
  120. nfsfh_t n_fh; /* Small File Handle */
  121. u_char *n_name; /* leaf name, for v4 OPEN op */
  122. uint32_t n_namelen;
  123. int n_directio_opens;
  124. int n_directio_asyncwr;
  125. struct ucred *n_writecred; /* Cred. for putpages */
  126. };
  127. #define n_atim n_un1.nf_atim
  128. #define n_mtim n_un2.nf_mtim
  129. #define n_sillyrename n_un3.nf_silly
  130. #define n_cookieverf n_un1.nd_cookieverf
  131. #define n4_cookieverf n_un1.nd4_cookieverf
  132. #define n_direofoffset n_un2.nd_direof
  133. #define n_cookies n_un3.nd_cook
  134. /*
  135. * Flags for n_flag
  136. */
  137. #define NFSYNCWAIT 0x0002 /* fsync waiting for all directio async writes
  138. to drain */
  139. #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
  140. #define NWRITEERR 0x0008 /* Flag write errors so close will know */
  141. /* 0x20, 0x40, 0x80 free */
  142. #define NACC 0x0100 /* Special file accessed */
  143. #define NUPD 0x0200 /* Special file updated */
  144. #define NCHG 0x0400 /* Special file times changed */
  145. #define NCREATED 0x0800 /* Opened by nfs_create() */
  146. #define NTRUNCATE 0x1000 /* Opened by nfs_setattr() */
  147. #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */
  148. #define NNONCACHE 0x4000 /* Node marked as noncacheable */
  149. #define NDIRCOOKIELK 0x8000 /* Lock to serialize access to directory cookies */
  150. /*
  151. * Convert between nfsnode pointers and vnode pointers
  152. */
  153. #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
  154. #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
  155. #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
  156. /*
  157. * NFS iod threads can be in one of these two states once spawned.
  158. * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time.
  159. * NFSIOD_AVAILABLE - Available to be assigned an I/O operation.
  160. */
  161. enum nfsiod_state {
  162. NFSIOD_NOT_AVAILABLE = 0,
  163. NFSIOD_AVAILABLE = 1,
  164. };
  165. /*
  166. * Queue head for nfsiod's
  167. */
  168. extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
  169. extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON];
  170. extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
  171. #if defined(_KERNEL)
  172. extern struct vop_vector nfs_fifoops;
  173. extern struct vop_vector nfs_vnodeops;
  174. extern struct buf_ops buf_ops_nfs;
  175. /*
  176. * Prototypes for NFS vnode operations
  177. */
  178. int nfs_getpages(struct vop_getpages_args *);
  179. int nfs_putpages(struct vop_putpages_args *);
  180. int nfs_write(struct vop_write_args *);
  181. int nfs_inactive(struct vop_inactive_args *);
  182. int nfs_reclaim(struct vop_reclaim_args *);
  183. /* other stuff */
  184. int nfs_removeit(struct sillyrename *);
  185. int nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
  186. nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
  187. void nfs_invaldir(struct vnode *);
  188. int nfs_upgrade_vnlock(struct vnode *vp);
  189. void nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
  190. void nfs_printf(const char *fmt, ...);
  191. void nfs_dircookie_lock(struct nfsnode *np);
  192. void nfs_dircookie_unlock(struct nfsnode *np);
  193. #endif /* _KERNEL */
  194. #endif