freebsd-skq/sys/nfsclient/nfsm_subs.h
iedowse 6e9f1df98f Avoid passing the variable `tl' to functions that just use it for
temporary storage. In the old NFS code it wasn't at all clear if
the value of `tl' was used across or after macro calls, but I'm
fairly confident that the convention was to keep its use local.
Each ex-macro function now uses a local version of this variable,
so all of the double-indirection goes away.

The only exception to the `local use' rule for `tl' is nfsm_clget(),
which is left unchanged by this commit.

Reviewed by:	peter
2001-12-18 01:22:09 +00:00

204 lines
6.2 KiB
C

/*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 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.
*
* @(#)nfsm_subs.h 8.2 (Berkeley) 3/30/95
* $FreeBSD$
*/
#ifndef _NFSCLIENT_NFSM_SUBS_H_
#define _NFSCLIENT_NFSM_SUBS_H_
#include <nfs/nfs_common.h>
#define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
struct ucred;
struct vnode;
/*
* These macros do strange and peculiar things to mbuf chains for
* the assistance of the nfs code. To attempt to use them for any
* other purpose will be dangerous. (they make weird assumptions)
*/
/*
* First define what the actual subs. return
*/
struct mbuf *nfsm_reqhead(struct vnode *vp, u_long procid, int hsiz);
struct mbuf *nfsm_rpchead(struct ucred *cr, int nmflag, int procid,
int auth_type, int auth_len,
struct mbuf *mrest, int mrest_len,
struct mbuf **mbp, u_int32_t *xidp);
#define M_HASCL(m) ((m)->m_flags & M_EXT)
#define NFSMINOFF(m) \
do { \
if (M_HASCL(m)) \
(m)->m_data = (m)->m_ext.ext_buf; \
else if ((m)->m_flags & M_PKTHDR) \
(m)->m_data = (m)->m_pktdat; \
else \
(m)->m_data = (m)->m_dat; \
} while (0)
#define NFSMSIZ(m) ((M_HASCL(m))?MCLBYTES: \
(((m)->m_flags & M_PKTHDR)?MHLEN:MLEN))
/*
* Now for the macros that do the simple stuff and call the functions
* for the hard stuff.
* These macros use several vars. declared in nfsm_reqhead and these
* vars. must not be used elsewhere unless you are careful not to corrupt
* them. The vars. starting with pN and tN (N=1,2,3,..) are temporaries
* that may be used so long as the value is not expected to retained
* after a macro.
* I know, this is kind of dorkey, but it makes the actual op functions
* fairly clean and deals with the mess caused by the xdr discriminating
* unions.
*/
/* *********************************** */
/* Request generation phase macros */
int nfsm_fhtom_xx(struct vnode *v, int v3, struct mbuf **mb,
caddr_t *bpos);
void nfsm_v3attrbuild_xx(struct vattr *va, int full, struct mbuf **mb,
caddr_t *bpos);
int nfsm_strtom_xx(const char *a, int s, int m, struct mbuf **mb,
caddr_t *bpos);
#define nfsm_bcheck(t1, mreq) \
do { \
if (t1) { \
error = t1; \
m_freem(mreq); \
goto nfsmout; \
} \
} while (0)
#define nfsm_fhtom(v, v3) \
do { \
int32_t t1; \
t1 = nfsm_fhtom_xx((v), (v3), &mb, &bpos); \
nfsm_bcheck(t1, mreq); \
} while (0)
/* If full is true, set all fields, otherwise just set mode and time fields */
#define nfsm_v3attrbuild(a, full) \
nfsm_v3attrbuild_xx(a, full, &mb, &bpos)
#define nfsm_uiotom(p, s) \
do { \
int t1; \
t1 = nfsm_uiotombuf((p), &mb, (s), &bpos); \
nfsm_bcheck(t1, mreq); \
} while (0)
#define nfsm_strtom(a, s, m) \
do { \
int t1; \
t1 = nfsm_strtom_xx((a), (s), (m), &mb, &bpos); \
nfsm_bcheck(t1, mreq); \
} while (0)
/* *********************************** */
/* Send the request */
#define nfsm_request(v, t, p, c) \
do { \
error = nfs_request((v), mreq, (t), (p), (c), &mrep, &md, &dpos); \
if (error != 0) { \
if (error & NFSERR_RETERR) \
error &= ~NFSERR_RETERR; \
else \
goto nfsmout; \
} \
} while (0)
/* *********************************** */
/* Reply interpretation phase macros */
int nfsm_mtofh_xx(struct vnode *d, struct vnode **v, int v3, int *f,
struct mbuf **md, caddr_t *dpos);
int nfsm_getfh_xx(nfsfh_t **f, int *s, int v3, struct mbuf **md,
caddr_t *dpos);
int nfsm_loadattr_xx(struct vnode **v, struct vattr *va, struct mbuf **md,
caddr_t *dpos);
int nfsm_postop_attr_xx(struct vnode **v, int *f, struct mbuf **md,
caddr_t *dpos);
int nfsm_wcc_data_xx(struct vnode **v, int *f, struct mbuf **md,
caddr_t *dpos);
#define nfsm_mtofh(d, v, v3, f) \
do { \
int32_t t1; \
t1 = nfsm_mtofh_xx((d), &(v), (v3), &(f), &md, &dpos); \
nfsm_dcheck(t1, mrep); \
} while (0)
#define nfsm_getfh(f, s, v3) \
do { \
int32_t t1; \
t1 = nfsm_getfh_xx(&(f), &(s), (v3), &md, &dpos); \
nfsm_dcheck(t1, mrep); \
} while (0)
#define nfsm_loadattr(v, a) \
do { \
int32_t t1; \
t1 = nfsm_loadattr_xx(&v, a, &md, &dpos); \
nfsm_dcheck(t1, mrep); \
} while (0)
#define nfsm_postop_attr(v, f) \
do { \
int32_t t1; \
t1 = nfsm_postop_attr_xx(&v, &f, &md, &dpos); \
nfsm_dcheck(t1, mrep); \
} while (0)
/* Used as (f) for nfsm_wcc_data() */
#define NFSV3_WCCRATTR 0
#define NFSV3_WCCCHK 1
#define nfsm_wcc_data(v, f) \
do { \
int32_t t1; \
t1 = nfsm_wcc_data_xx(&v, &f, &md, &dpos); \
nfsm_dcheck(t1, mrep); \
} while (0)
#endif