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
 ****************************************************************************/

#include "nfs_proto.h"
#include <sys/socket.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* 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
{
  uint32_t nm_flag;           /* Flags for soft/hard... */
  uint32_t nm_state;          /* Internal state flags */
  struct nfsnode *nm_head;    /* A list to all files opened on this mountpoint */
  bool nm_mounted;            /* true: The file system is ready */
  sem_t nm_sem;               /* Used to assume thread-safe access */
  uint32_t nm_numgrps;        /* Max. size of groupslist */
  nfsfh_t nm_fh;              /* File handle of root dir */
  char nm_path[90];           /* server's path of the directory being mount */
  uint32_t nm_fhsize;         /* Size of root file handle */
  struct nfs_fattr nm_fattr;  /* nfs file attribute cache */
  struct rpcclnt *nm_rpcclnt; /* rpc state */
  struct socket *nm_so;       /* Rpc socket */
  uint8_t nm_sotype;          /* Type of socket */
  uint8_t nm_soproto;         /* and protocol */
  uint8_t nm_soflags;         /* pr_flags for socket protocol */
  struct sockaddr nm_nam;     /* Addr of server */
  uint32_t nm_timeo;          /* Init timer for NFSMNT_DUMBTIMR */
  uint32_t nm_retry;          /* Max retries */
  uint32_t nm_srtt[4];        /* Timers for rpcs */
  uint32_t nm_sdrtt[4];
  uint32_t nm_sent;           /* Request send count */
  uint32_t nm_cwnd;           /* Request send window */
  uint32_t nm_timeouts;       /* Request timeouts */
  uint32_t nm_deadthresh;     /* Threshold of timeouts-->dead server */
  uint32_t nm_rsize;          /* Max size of read rpc */
  uint32_t nm_wsize;          /* Max size of write rpc */
  uint32_t nm_readdirsize;    /* Size of a readdir rpc */
  uint32_t nm_readahead;      /* Num. of blocks to readahead */
  uint32_t nm_acdirmin;       /* Directory attr cache min lifetime */
  uint32_t nm_acdirmax;       /* Directory attr cache max lifetime */
  uint32_t nm_acregmin;       /* Reg file attr cache min lifetime */
  uint32_t nm_acregmax;       /* Reg file attr cache max lifetime */
  unsigned char nm_verf[NFSX_V3WRITEVERF];     /* V3 write verifier */
};

#endif