1 /* $NetBSD: ninepuffs.h,v 1.16 2020/05/26 22:54:43 uwe 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(pu) \ 65 struct puffs_cc *pcc = puffs_cc_getcc(pu); \ 66 struct puffs9p *p9p = puffs_getspecific(pu); \ 67 p9ptag_t tag; \ 68 struct puffs_framebuf *pb = p9pbuf_makeout(); \ 69 int rv = 0 70 71 #define RETURN(rv) \ 72 puffs_framebuf_destroy(pb); \ 73 return (rv) 74 75 #define GETRESPONSE(pb) \ 76 do { \ 77 if (puffs_framev_enqueue_cc(pcc, p9p->servsock, pb, 0) == -1) { \ 78 rv = errno; \ 79 goto out; \ 80 } \ 81 } while (/*CONSTCOND*/0) 82 83 #define JUSTSEND(pb) \ 84 do { \ 85 if (puffs_framev_enqueue_justsend(pu,p9p->servsock,pb,1,0)==-1){\ 86 rv = errno; \ 87 goto out; \ 88 } \ 89 } while (/*CONSTCOND*/0) 90 91 #define SENDCB(pb, f, a) \ 92 do { \ 93 if (puffs_framev_enqueue_cb(pu, p9p->servsock,pb,f,a,0) == -1) {\ 94 rv = errno; \ 95 goto out; \ 96 } \ 97 } while (/*CONSTCOND*/0) 98 99 struct puffs9p { 100 int servsock; 101 102 p9ptag_t nexttag; 103 p9pfid_t nextfid; 104 105 size_t maxreq; /* negotiated with server */ 106 107 int protover; 108 int server; 109 #define P9P_SERVER_TCP 0 110 #define P9P_SERVER_CDEV 1 111 }; 112 113 struct dirfid { 114 p9pfid_t fid; 115 off_t seekoff; 116 LIST_ENTRY(dirfid) entries; 117 }; 118 119 struct p9pnode { 120 p9pfid_t fid_base; 121 p9pfid_t fid_read; 122 p9pfid_t fid_write; 123 124 LIST_HEAD(,dirfid) dir_openlist; 125 }; 126 127 struct puffs_framebuf *p9pbuf_makeout(void); 128 void p9pbuf_recycleout(struct puffs_framebuf *); 129 130 int p9pbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 131 int p9pbuf_write(struct puffs_usermount *, struct puffs_framebuf*,int,int*); 132 int p9pbuf_cmp(struct puffs_usermount *, 133 struct puffs_framebuf *, struct puffs_framebuf *, int *); 134 135 void p9pbuf_put_1(struct puffs_framebuf *, uint8_t); 136 void p9pbuf_put_2(struct puffs_framebuf *, uint16_t); 137 void p9pbuf_put_4(struct puffs_framebuf *, uint32_t); 138 void p9pbuf_put_8(struct puffs_framebuf *, uint64_t); 139 void p9pbuf_put_str(struct puffs_framebuf *, const char *); 140 void p9pbuf_put_data(struct puffs_framebuf *, const void *, uint16_t); 141 void p9pbuf_write_data(struct puffs_framebuf *, uint8_t *, uint32_t); 142 143 int p9pbuf_get_1(struct puffs_framebuf *, uint8_t *); 144 int p9pbuf_get_2(struct puffs_framebuf *, uint16_t *); 145 int p9pbuf_get_4(struct puffs_framebuf *, uint32_t *); 146 int p9pbuf_get_8(struct puffs_framebuf *, uint64_t *); 147 int p9pbuf_get_str(struct puffs_framebuf *, char **, uint16_t *); 148 int p9pbuf_get_data(struct puffs_framebuf *, uint8_t **, uint16_t *); 149 int p9pbuf_read_data(struct puffs_framebuf *, uint8_t *, uint32_t); 150 151 uint8_t p9pbuf_get_type(struct puffs_framebuf *); 152 uint16_t p9pbuf_get_tag(struct puffs_framebuf *); 153 154 int proto_getqid(struct puffs_framebuf *, struct qid9p *); 155 int proto_getstat(struct puffs_usermount *, struct puffs_framebuf *, struct vattr *, 156 char **, uint16_t *); 157 int proto_expect_walk_nqids(struct puffs_usermount *, 158 struct puffs_framebuf *, uint16_t *); 159 int proto_expect_stat(struct puffs_usermount *, struct puffs_framebuf *, 160 struct vattr *); 161 int proto_expect_qid(struct puffs_usermount *, struct puffs_framebuf *, 162 uint8_t, struct qid9p *); 163 int proto_handle_rerror(struct puffs_usermount *, struct puffs_framebuf *); 164 165 int proto_cc_dupfid(struct puffs_usermount *, p9pfid_t, p9pfid_t); 166 int proto_cc_clunkfid(struct puffs_usermount *, p9pfid_t, int); 167 int proto_cc_open(struct puffs_usermount *, p9pfid_t, p9pfid_t, int); 168 169 void proto_make_stat(struct puffs_usermount *, struct puffs_framebuf *, 170 const struct vattr *, const char *, enum vtype); 171 172 struct puffs_node *p9p_handshake(struct puffs_usermount *, 173 const char *, const char *); 174 175 void qid2vattr(struct vattr *, const struct qid9p *); 176 struct puffs_node *newp9pnode_va(struct puffs_usermount *, 177 const struct vattr *, p9pfid_t); 178 struct puffs_node *newp9pnode_qid(struct puffs_usermount *, 179 const struct qid9p *, p9pfid_t); 180 181 int getdfwithoffset(struct puffs_usermount *, struct p9pnode *, off_t, 182 struct dirfid **); 183 void storedf(struct p9pnode *, struct dirfid *); 184 void releasedf(struct puffs_usermount *, struct dirfid *); 185 void nukealldf(struct puffs_usermount *, struct p9pnode *); 186 187 #endif /* PUFFS9P_H_ */ 188