psshfs.h revision 1.19
1 /* $NetBSD: psshfs.h,v 1.19 2007/05/20 20:06:23 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2006, 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 * 3. The name of the company nor the name of the author may be used to 15 * endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS 19 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 21 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 #ifndef PSSHFS_H_ 32 #define PSSHFS_H_ 33 34 #include <sys/queue.h> 35 36 #include <puffs.h> 37 38 /* 39 * Later protocol versions would have some advantages (such as link count 40 * supported directly as a part of stat), but since proto version 3 seems 41 * to be the only widely available version, let's not try to jump through 42 * too many hoops to be compatible with all versions. 43 */ 44 #define SFTP_PROTOVERSION 3 45 46 /* 47 * Refresh directories every n seconds as indicated by the following macro. 48 * Note that local changes will still be visible immediately. 49 */ 50 #define PSSHFS_REFRESHIVAL 30 51 52 PUFFSOP_PROTOS(psshfs); 53 54 #define NEXTREQ(pctx) ((pctx->nextreq)++) 55 #define PSSHFSAUTOVAR(pcc) \ 56 struct psshfs_ctx *pctx = puffs_cc_getspecific(pcc); \ 57 uint32_t reqid = NEXTREQ(pctx); \ 58 struct puffs_framebuf *pb = psbuf_makeout(); \ 59 int rv = 0 60 61 #define PSSHFSRETURN(rv) \ 62 puffs_framebuf_destroy(pb); \ 63 return (rv) 64 65 #define GETRESPONSE(pb) \ 66 do { \ 67 if (puffs_framev_enqueue_cc(pcc, pctx->sshfd, pb) == -1) { \ 68 rv = errno; \ 69 goto out; \ 70 } \ 71 } while (/*CONSTCOND*/0) 72 73 #define JUSTSEND(pb) \ 74 do { \ 75 if (puffs_framev_enqueue_justsend(pu,pctx->sshfd,pb,1) == -1) { \ 76 rv = errno; \ 77 goto out; \ 78 } \ 79 } while (/*CONSTCOND*/0) 80 81 #define SENDCB(pb, f, a) \ 82 do { \ 83 if (puffs_framev_enqueue_cb(pu, pctx->sshfd, pb, f,a) == -1) { \ 84 rv = errno; \ 85 goto out; \ 86 } \ 87 } while (/*CONSTCOND*/0) 88 89 struct psshfs_dir { 90 int valid; 91 struct puffs_node *entry; 92 93 char *entryname; 94 struct vattr va; 95 time_t attrread; 96 97 struct puffs_framebuf *getattr_pb; 98 }; 99 100 struct psshfs_fid { 101 time_t mounttime; 102 struct puffs_node *node; 103 }; 104 105 struct psshfs_node { 106 struct puffs_node *parent; 107 108 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 109 struct delayattr { 110 struct puffs_framebuf *pufbuf; 111 struct readdirattr *rda; 112 } *da; 113 size_t nextda; 114 115 size_t denttot; 116 size_t dentnext; 117 time_t dentread; 118 int childcount; 119 120 int stat; 121 122 time_t attrread; 123 struct puffs_framebuf *getattr_pb; 124 125 char *fhand_r; 126 char *fhand_w; 127 uint32_t fhand_r_len; 128 uint32_t fhand_w_len; 129 }; 130 #define PSN_RECLAIMED 0x01 131 #define PSN_HASFH 0x02 132 133 struct psshfs_ctx { 134 int sshfd; 135 pid_t sshpid; 136 const char *mountpath; 137 138 int protover; 139 uint32_t nextreq; 140 141 struct puffs_framebuf *curpb; 142 143 struct psshfs_node psn_root; 144 ino_t nextino; 145 146 int canexport; 147 time_t mounttime; 148 }; 149 150 int psshfs_domount(struct puffs_usermount *); 151 152 int psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 153 int psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 154 int psbuf_cmp(struct puffs_usermount *, 155 struct puffs_framebuf *, struct puffs_framebuf *); 156 157 struct puffs_framebuf *psbuf_makeout(void); 158 void psbuf_recycleout(struct puffs_framebuf *); 159 160 void psbuf_put_1(struct puffs_framebuf *, uint8_t); 161 void psbuf_put_2(struct puffs_framebuf *, uint16_t); 162 void psbuf_put_4(struct puffs_framebuf *, uint32_t); 163 void psbuf_put_8(struct puffs_framebuf *, uint64_t); 164 void psbuf_put_str(struct puffs_framebuf *, const char *); 165 void psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t); 166 void psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *); 167 168 uint8_t psbuf_get_type(struct puffs_framebuf *); 169 uint32_t psbuf_get_len(struct puffs_framebuf *); 170 uint32_t psbuf_get_reqid(struct puffs_framebuf *); 171 172 int psbuf_get_1(struct puffs_framebuf *, uint8_t *); 173 int psbuf_get_2(struct puffs_framebuf *, uint16_t *); 174 int psbuf_get_4(struct puffs_framebuf *, uint32_t *); 175 int psbuf_get_8(struct puffs_framebuf *, uint64_t *); 176 int psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *); 177 int psbuf_get_vattr(struct puffs_framebuf *, struct vattr *); 178 179 int psbuf_expect_status(struct puffs_framebuf *); 180 int psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *); 181 int psbuf_expect_name(struct puffs_framebuf *, uint32_t *); 182 int psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *); 183 184 int psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *); 185 186 void psbuf_req_data(struct puffs_framebuf *, int, uint32_t, 187 const void *, uint32_t); 188 void psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *); 189 190 int sftp_readdir(struct puffs_cc *, struct psshfs_ctx *, 191 struct puffs_node *); 192 193 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 194 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 195 struct psshfs_dir *, const struct vattr *); 196 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 197 const char *, const struct vattr *); 198 struct psshfs_dir *direnter(struct puffs_node *, const char *); 199 void nukenode(struct puffs_node *, const char *, int); 200 void doreclaim(struct puffs_node *); 201 int getpathattr(struct puffs_cc *, const char *, struct vattr *); 202 int getnodeattr(struct puffs_cc *, struct puffs_node *); 203 204 #endif /* PSSHFS_H_ */ 205
Indexes created Sun Sep 28 16:09:52 GMT 2025