Home | History | Annotate | Line # | Download | only in mount_9p
ninepuffs.h revision 1.8
      1 /*	$NetBSD: ninepuffs.h,v 1.8 2007/05/16 09:57:21 pooka Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2007  Antti Kantee.  All Rights Reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
     16  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     18  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     25  * SUCH DAMAGE.
     26  */
     27 
     28 #ifndef PUFFS9P_H_
     29 #define PUFFS9P_H_
     30 
     31 #include <sys/queue.h>
     32 
     33 #include <puffs.h>
     34 
     35 PUFFSOP_PROTOS(puffs9p);
     36 
     37 /* Qid structure.  optimized for in-mem.  different order on-wire */
     38 struct qid9p {
     39 	uint64_t	qidpath;
     40 	uint32_t	qidvers;
     41 	uint8_t		qidtype;
     42 };
     43 
     44 typedef uint16_t p9ptag_t;
     45 typedef uint32_t p9pfid_t;
     46 
     47 /*
     48  * refuse (no, not *that* refuse) to play if the server doesn't
     49  * support requests of at least the following size.  It would only
     50  * make life difficult
     51  */
     52 #define P9P_MINREQLEN	512
     53 
     54 #define P9P_DEFREQLEN	(16*1024)
     55 #define P9P_INVALFID	0
     56 #define P9P_ROOTFID	1
     57 
     58 #define NEXTTAG(p9p)	\
     59     ((++(p9p->nexttag)) == P9PROTO_NOTAG ? p9p->nexttag = 0 : p9p->nexttag)
     60 
     61 #define NEXTFID(p9p)	\
     62     ((++(p9p->nextfid)) == P9P_INVALFID ? p9p->nextfid = 2 : p9p->nextfid)
     63 
     64 #define AUTOVAR(pcc)							\
     65 	struct puffs9p *p9p = puffs_cc_getspecific(pcc);		\
     66 	uint16_t tag = NEXTTAG(p9p);					\
     67 	struct puffs_framebuf *pb = p9pbuf_makeout();			\
     68 	int rv = 0
     69 
     70 #define RETURN(rv)							\
     71 	puffs_framebuf_destroy(pb);					\
     72 	return (rv)
     73 
     74 #define GETRESPONSE(pb)							\
     75 do {									\
     76 	if (puffs_framev_enqueue_cc(pcc, p9p->servsock, pb) == -1) {	\
     77 		rv = errno;						\
     78 		goto out;						\
     79 	}								\
     80 } while (/*CONSTCOND*/0)
     81 
     82 #define JUSTSEND(pb)							\
     83 do {									\
     84 	if (puffs_framev_enqueue_justsend(pu,p9p->servsock,pb,1) == -1){\
     85 		rv = errno;						\
     86 		goto out;						\
     87 	}								\
     88 } while (/*CONSTCOND*/0)
     89 
     90 #define SENDCB(pb, f, a)						\
     91 do {									\
     92 	if (puffs_framev_enqueue_cb(pu, p9p->servsock, pb, f,a) == -1) {\
     93 		rv = errno;						\
     94 		goto out;						\
     95 	}								\
     96 } while (/*CONSTCOND*/0)
     97 
     98 struct puffs9p {
     99 	int servsock;
    100 
    101 	p9ptag_t nexttag;
    102 	p9pfid_t nextfid;
    103 
    104 	size_t maxreq;		/* negotiated with server */
    105 };
    106 
    107 struct dirfid {
    108 	p9pfid_t	fid;
    109 	off_t		seekoff;
    110 	LIST_ENTRY(dirfid) entries;
    111 };
    112 
    113 struct p9pnode {
    114 	p9pfid_t	fid_base;
    115 	p9pfid_t	fid_read;
    116 	p9pfid_t	fid_write;
    117 
    118 	LIST_HEAD(,dirfid) dir_openlist;
    119 };
    120 
    121 struct puffs_framebuf	*p9pbuf_makeout(void);
    122 void			p9pbuf_recycleout(struct puffs_framebuf *);
    123 
    124 int	p9pbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*);
    125 int	p9pbuf_write(struct puffs_usermount *, struct puffs_framebuf*,int,int*);
    126 int	p9pbuf_cmp(struct puffs_usermount *,
    127 		   struct puffs_framebuf *, struct puffs_framebuf *);
    128 
    129 void	p9pbuf_put_1(struct puffs_framebuf *, uint8_t);
    130 void	p9pbuf_put_2(struct puffs_framebuf *, uint16_t);
    131 void	p9pbuf_put_4(struct puffs_framebuf *, uint32_t);
    132 void	p9pbuf_put_8(struct puffs_framebuf *, uint64_t);
    133 void	p9pbuf_put_str(struct puffs_framebuf *, const char *);
    134 void	p9pbuf_put_data(struct puffs_framebuf *, const void *, uint16_t);
    135 void	p9pbuf_write_data(struct puffs_framebuf *, uint8_t *, uint32_t);
    136 
    137 int	p9pbuf_get_1(struct puffs_framebuf *, uint8_t *);
    138 int	p9pbuf_get_2(struct puffs_framebuf *, uint16_t *);
    139 int	p9pbuf_get_4(struct puffs_framebuf *, uint32_t *);
    140 int	p9pbuf_get_8(struct puffs_framebuf *, uint64_t *);
    141 int	p9pbuf_get_str(struct puffs_framebuf *, char **, uint16_t *);
    142 int	p9pbuf_get_data(struct puffs_framebuf *, uint8_t **, uint16_t *);
    143 int	p9pbuf_read_data(struct puffs_framebuf *, uint8_t *, uint32_t);
    144 
    145 uint8_t		p9pbuf_get_type(struct puffs_framebuf *);
    146 uint16_t	p9pbuf_get_tag(struct puffs_framebuf *);
    147 
    148 int	proto_getqid(struct puffs_framebuf *, struct qid9p *);
    149 int	proto_getstat(struct puffs_framebuf *, struct vattr *,
    150 		      char **, uint16_t *);
    151 int	proto_expect_walk_nqids(struct puffs_framebuf *, uint16_t *);
    152 int	proto_expect_stat(struct puffs_framebuf *, struct vattr *);
    153 int	proto_expect_qid(struct puffs_framebuf *, uint8_t, struct qid9p *);
    154 
    155 int	proto_cc_dupfid(struct puffs_cc *, p9pfid_t, p9pfid_t);
    156 int	proto_cc_clunkfid(struct puffs_cc *, p9pfid_t, int);
    157 int	proto_cc_open(struct puffs_cc *, p9pfid_t, p9pfid_t, int);
    158 
    159 void	proto_make_stat(struct puffs_framebuf *, const struct vattr *,
    160 			const char *, enum vtype);
    161 
    162 struct puffs_node	*p9p_handshake(struct puffs_usermount *, const char *);
    163 
    164 void			qid2vattr(struct vattr *, const struct qid9p *);
    165 struct puffs_node	*newp9pnode_va(struct puffs_usermount *,
    166 				       const struct vattr *, p9pfid_t);
    167 struct puffs_node	*newp9pnode_qid(struct puffs_usermount *,
    168 					const struct qid9p *, p9pfid_t);
    169 
    170 int	getdfwithoffset(struct puffs_cc *, struct p9pnode *, off_t,
    171 			 struct dirfid **);
    172 void	storedf(struct p9pnode *, struct dirfid *);
    173 void	releasedf(struct puffs_cc *, struct dirfid *);
    174 void	nukealldf(struct puffs_cc *, struct p9pnode *);
    175 
    176 #endif /* PUFFS9P_H_ */
    177