px4-firmware/nuttx/fs/nfs/nfs_mount.h

/****************************************************************************
 * fs/nfs/nfs_mount.h
 *
 *   Copyright (C) 2012 Gregory Nutt. All rights reserved.
 *   Copyright (C) 2012 Jose Pablo Rojas Vargas. All rights reserved.
 *   Author: Jose Pablo Rojas Vargas <jrojas@nx-engineering.com>
 *
 * Leveraged from OpenBSD:
 *
 *  Copyright (c) 1989, 1993
 *  The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Rick Macklem at The University of Guelph.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 ****************************************************************************/

#ifndef __FS_NFS_NFS_MOUNT_H
#define __FS_NFS_NFS_MOUNT_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

#define NFSOP(nmp, op)    (*nmp->nm_nfsops->nn_##op)
#define NFSHASOP(nmp, op) (nmp->nm_nfsops->nn_##op != NULL)
#define NFSDAT(nmp, nam)  (nmp->nm_nfsops->nn_##nam)

/* Convert mount ptr to nfsmount ptr. */

#define VFSTONFS(mp)      ((struct nfsmount *)((mp)->i_private))

/****************************************************************************
 * Public Types
 ****************************************************************************/

/* Mount structure.
 * One allocated on every NFS mount.
 * Holds NFS specific information for mount.
 */

struct nfsmount
{
  int nm_flag;                /* Flags for soft/hard... */
  int nm_state;               /* Internal state flags */
  struct inode *nm_mountp;    /* Vfs structure for this filesystem */
  struct nfsnode *nfs_head;   /* A list to all files opened on this mountpoint */
  bool nfs_mounted;           /* true: The file system is ready */
  int nm_numgrps;             /* Max. size of groupslist */
  nfsfh_t nm_fh;              /* File handle of root dir */
  int nm_fhsize;              /* Size of root file handle */
  struct rpcclnt nm_rpcclnt;  /* rpc state */
  struct socket *nm_so;       /* Rpc socket */
  int nm_sotype;              /* Type of socket */
  int nm_soproto;             /* and protocol */
  int nm_soflags;             /* pr_flags for socket protocol */
  struct sockaddr *nm_nam;    /* Addr of server */
  int nm_timeo;               /* Init timer for NFSMNT_DUMBTIMR */
  int nm_retry;               /* Max retries */
  int nm_srtt[4];             /* Timers for rpcs */
  int nm_sdrtt[4];
  int nm_sent;                /* Request send count */
  int nm_cwnd;                /* Request send window */
  int nm_timeouts;            /* Request timeouts */
  int nm_deadthresh;          /* Threshold of timeouts-->dead server */
  int nm_rsize;               /* Max size of read rpc */
  int nm_wsize;               /* Max size of write rpc */
  int nm_readdirsize;         /* Size of a readdir rpc */
  int nm_readahead;           /* Num. of blocks to readahead */
  int nm_acdirmin;            /* Directory attr cache min lifetime */
  int nm_acdirmax;            /* Directory attr cache max lifetime */
  int nm_acregmin;            /* Reg file attr cache min lifetime */
  int nm_acregmax;            /* Reg file attr cache max lifetime */
  unsigned char nm_verf[NFSX_V3WRITEVERF];    /* V3 write verifier */
};

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

/* Prototypes for NFS mount operations: */

int nfs_mount(struct mount *, const char *, void *, struct nameidata *,
              struct proc *);
int mountnfs(struct nfs_args *, struct mount *, struct mbuf *, char *, char *);
void nfs_decode_args(struct nfsmount *, struct nfs_args *, struct nfs_args *);
int nfs_start(struct mount *, int, struct proc *);
int nfs_unmount(struct mount *, int, struct proc *);
int nfs_root(struct mount *, struct vnode **);
int nfs_statfs(struct mount *, struct statfs *, struct proc *);
int nfs_sync(struct mount *, int, struct ucred *, struct proc *);
int nfs_vget(struct mount *, ino_t, struct vnode **);
int nfs_fhtovp(struct mount *, struct fid *, struct vnode **);
int nfs_vptofh(struct vnode *, struct fid *);
int nfs_fsinfo(struct nfsmount *, struct vnode *, struct ucred *,
               struct proc *);
void nfs_init(void);

#endif