psshfs.h revision 1.30
1 /* $NetBSD: psshfs.h,v 1.30 2007/11/30 16:24:04 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 * 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 PSSHFS_H_ 29 #define PSSHFS_H_ 30 31 #include <sys/queue.h> 32 33 #include <puffs.h> 34 35 extern unsigned int max_reads; 36 37 /* 38 * Later protocol versions would have some advantages (such as link count 39 * supported directly as a part of stat), but since proto version 3 seems 40 * to be the only widely available version, let's not try to jump through 41 * too many hoops to be compatible with all versions. 42 */ 43 #define SFTP_PROTOVERSION 3 44 45 #define DEFAULTREFRESH 30 46 #define REFRESHTIMEOUT(pctx, t) \ 47 (!(pctx)->refreshival || ((pctx->refreshival!=-1) && ((t)>pctx->refreshival))) 48 49 PUFFSOP_PROTOS(psshfs); 50 51 #define NEXTREQ(pctx) ((pctx->nextreq)++) 52 #define PSSHFSAUTOVAR(pcc) \ 53 struct psshfs_ctx *pctx = puffs_cc_getspecific(pcc); \ 54 uint32_t reqid = NEXTREQ(pctx); \ 55 struct puffs_framebuf *pb = psbuf_makeout(); \ 56 int rv = 0 57 58 #define PSSHFSRETURN(rv) \ 59 puffs_framebuf_destroy(pb); \ 60 return (rv) 61 62 #define GETRESPONSE(pb) \ 63 do { \ 64 if (puffs_framev_enqueue_cc(pcc, pctx->sshfd, pb, 0) == -1) { \ 65 rv = errno; \ 66 goto out; \ 67 } \ 68 } while (/*CONSTCOND*/0) 69 70 #define JUSTSEND(pb) \ 71 do { \ 72 if (puffs_framev_enqueue_justsend(pu,pctx->sshfd,pb,1,0) == -1){\ 73 rv = errno; \ 74 goto out; \ 75 } \ 76 } while (/*CONSTCOND*/0) 77 78 #define SENDCB(pb, f, a) \ 79 do { \ 80 if (puffs_framev_enqueue_cb(pu, pctx->sshfd, pb,f,a,0) == -1) { \ 81 rv = errno; \ 82 goto out; \ 83 } \ 84 } while (/*CONSTCOND*/0) 85 86 struct psshfs_dir { 87 int valid; 88 struct puffs_node *entry; 89 90 char *entryname; 91 struct vattr va; 92 time_t attrread; 93 94 struct puffs_framebuf *getattr_pb; 95 }; 96 97 struct psshfs_fid { 98 time_t mounttime; 99 struct puffs_node *node; 100 }; 101 102 struct psshfs_wait { 103 struct puffs_cc *pw_cc; 104 int pw_type; 105 TAILQ_ENTRY(psshfs_wait) pw_entries; 106 }; 107 #define PWTYPE_READDIR 1 108 #define PWTYPE_READ1 2 109 #define PWTYPE_READ2 3 110 #define PWTYPE_WRITE 4 111 112 struct psshfs_node { 113 struct puffs_node *parent; 114 115 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 116 struct delayattr { 117 struct puffs_framebuf *pufbuf; 118 struct readdirattr *rda; 119 } *da; 120 size_t nextda; 121 122 size_t denttot; 123 size_t dentnext; 124 time_t dentread; 125 int childcount; 126 127 int stat; 128 int readcount; 129 130 time_t attrread; 131 char *symlink; 132 time_t slread; 133 struct puffs_framebuf *getattr_pb; 134 135 char *fhand_r; 136 char *fhand_w; 137 uint32_t fhand_r_len; 138 uint32_t fhand_w_len; 139 struct puffs_framebuf *lazyopen_r; 140 struct puffs_framebuf *lazyopen_w; 141 int lazyopen_err_r, lazyopen_err_w; 142 143 TAILQ_HEAD(, psshfs_wait) pw; 144 }; 145 #define PSN_RECLAIMED 0x01 146 #define PSN_HASFH 0x02 147 #define PSN_READDIR 0x04 148 #define PSN_DOLAZY_R 0x08 149 #define PSN_DOLAZY_W 0x10 150 #define PSN_LAZYWAIT_R 0x20 151 #define PSN_LAZYWAIT_W 0x40 152 #define PSN_HANDLECLOSE 0x80 153 154 #define HANDLE_READ 0x1 155 #define HANDLE_WRITE 0x2 156 157 struct psshfs_ctx { 158 int sshfd; 159 pid_t sshpid; 160 const char *mountpath; 161 162 int protover; 163 uint32_t nextreq; 164 165 struct puffs_framebuf *curpb; 166 167 struct psshfs_node psn_root; 168 ino_t nextino; 169 170 int canexport; 171 time_t mounttime; 172 173 int refreshival; 174 }; 175 176 int psshfs_domount(struct puffs_usermount *); 177 178 int psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 179 int psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 180 int psbuf_cmp(struct puffs_usermount *, 181 struct puffs_framebuf *, struct puffs_framebuf *, int *); 182 183 struct puffs_framebuf *psbuf_makeout(void); 184 void psbuf_recycleout(struct puffs_framebuf *); 185 186 void psbuf_put_1(struct puffs_framebuf *, uint8_t); 187 void psbuf_put_2(struct puffs_framebuf *, uint16_t); 188 void psbuf_put_4(struct puffs_framebuf *, uint32_t); 189 void psbuf_put_8(struct puffs_framebuf *, uint64_t); 190 void psbuf_put_str(struct puffs_framebuf *, const char *); 191 void psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t); 192 void psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *); 193 194 uint8_t psbuf_get_type(struct puffs_framebuf *); 195 uint32_t psbuf_get_len(struct puffs_framebuf *); 196 uint32_t psbuf_get_reqid(struct puffs_framebuf *); 197 198 int psbuf_get_1(struct puffs_framebuf *, uint8_t *); 199 int psbuf_get_2(struct puffs_framebuf *, uint16_t *); 200 int psbuf_get_4(struct puffs_framebuf *, uint32_t *); 201 int psbuf_get_8(struct puffs_framebuf *, uint64_t *); 202 int psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *); 203 int psbuf_get_vattr(struct puffs_framebuf *, struct vattr *); 204 205 int psbuf_expect_status(struct puffs_framebuf *); 206 int psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *); 207 int psbuf_expect_name(struct puffs_framebuf *, uint32_t *); 208 int psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *); 209 210 int psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *); 211 212 void psbuf_req_data(struct puffs_framebuf *, int, uint32_t, 213 const void *, uint32_t); 214 void psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *); 215 216 int sftp_readdir(struct puffs_cc *, struct psshfs_ctx *, 217 struct puffs_node *); 218 219 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 220 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 221 struct psshfs_dir *, const struct vattr *); 222 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 223 const char *, const struct vattr *); 224 struct psshfs_dir *direnter(struct puffs_node *, const char *); 225 void nukenode(struct puffs_node *, const char *, int); 226 void doreclaim(struct puffs_node *); 227 int getpathattr(struct puffs_cc *, const char *, struct vattr *); 228 int getnodeattr(struct puffs_cc *, struct puffs_node *); 229 230 void closehandles(struct puffs_usermount *, struct psshfs_node *, int); 231 void lazyopen_rresp(struct puffs_usermount *, struct puffs_framebuf *, 232 void *, int); 233 void lazyopen_wresp(struct puffs_usermount *, struct puffs_framebuf *, 234 void *, int); 235 236 #endif /* PSSHFS_H_ */ 237
Indexes created Tue Sep 30 06:09:59 GMT 2025