psshfs.h revision 1.34
1 /* $NetBSD: psshfs.h,v 1.34 2008/09/06 12:29:57 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(pu) \ 53 struct puffs_cc *pcc = puffs_cc_getcc(pu); \ 54 struct psshfs_ctx *pctx = puffs_getspecific(pu); \ 55 uint32_t reqid = NEXTREQ(pctx); \ 56 struct puffs_framebuf *pb = psbuf_makeout(); \ 57 int rv = 0 58 59 #define PSSHFSRETURN(rv) \ 60 puffs_framebuf_destroy(pb); \ 61 return (rv) 62 63 #define GETRESPONSE(pb) \ 64 do { \ 65 if (puffs_framev_enqueue_cc(pcc, pctx->sshfd, pb, 0) == -1) { \ 66 rv = errno; \ 67 goto out; \ 68 } \ 69 } while (/*CONSTCOND*/0) 70 71 #define JUSTSEND(pb) \ 72 do { \ 73 if (puffs_framev_enqueue_justsend(pu,pctx->sshfd,pb,1,0) == -1){\ 74 rv = errno; \ 75 goto out; \ 76 } \ 77 } while (/*CONSTCOND*/0) 78 79 #define SENDCB(pb, f, a) \ 80 do { \ 81 if (puffs_framev_enqueue_cb(pu, pctx->sshfd, pb,f,a,0) == -1) { \ 82 rv = errno; \ 83 goto out; \ 84 } \ 85 } while (/*CONSTCOND*/0) 86 87 struct psshfs_dir { 88 int valid; 89 struct puffs_node *entry; 90 91 char *entryname; 92 struct vattr va; 93 time_t attrread; 94 }; 95 96 struct psshfs_fid { 97 time_t mounttime; 98 struct puffs_node *node; 99 }; 100 101 struct psshfs_wait { 102 struct puffs_cc *pw_cc; 103 int pw_type; 104 TAILQ_ENTRY(psshfs_wait) pw_entries; 105 }; 106 #define PWTYPE_READDIR 1 107 #define PWTYPE_READ1 2 108 #define PWTYPE_READ2 3 109 #define PWTYPE_WRITE 4 110 111 struct psshfs_node { 112 struct puffs_node *parent; 113 114 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 115 116 size_t denttot; 117 size_t dentnext; 118 time_t dentread; 119 int childcount; 120 121 int stat; 122 int readcount; 123 124 time_t attrread; 125 char *symlink; 126 time_t slread; 127 128 char *fhand_r; 129 char *fhand_w; 130 uint32_t fhand_r_len; 131 uint32_t fhand_w_len; 132 struct puffs_framebuf *lazyopen_r; 133 struct puffs_framebuf *lazyopen_w; 134 int lazyopen_err_r, lazyopen_err_w; 135 136 TAILQ_HEAD(, psshfs_wait) pw; 137 }; 138 #define PSN_RECLAIMED 0x01 139 #define PSN_HASFH 0x02 140 #define PSN_READDIR 0x04 141 #define PSN_DOLAZY_R 0x08 142 #define PSN_DOLAZY_W 0x10 143 #define PSN_LAZYWAIT_R 0x20 144 #define PSN_LAZYWAIT_W 0x40 145 #define PSN_HANDLECLOSE 0x80 146 147 #define HANDLE_READ 0x1 148 #define HANDLE_WRITE 0x2 149 150 struct psshfs_ctx { 151 int sshfd; 152 pid_t sshpid; 153 const char *mountpath; 154 char **sshargs; 155 156 int protover; 157 uint32_t nextreq; 158 159 struct puffs_framebuf *curpb; 160 161 struct psshfs_node psn_root; 162 ino_t nextino; 163 164 int canexport; 165 time_t mounttime; 166 167 int refreshival; 168 }; 169 170 int psshfs_handshake(struct puffs_usermount *); 171 172 int psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 173 int psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 174 int psbuf_cmp(struct puffs_usermount *, 175 struct puffs_framebuf *, struct puffs_framebuf *, int *); 176 177 struct puffs_framebuf *psbuf_makeout(void); 178 void psbuf_recycleout(struct puffs_framebuf *); 179 180 void psbuf_put_1(struct puffs_framebuf *, uint8_t); 181 void psbuf_put_2(struct puffs_framebuf *, uint16_t); 182 void psbuf_put_4(struct puffs_framebuf *, uint32_t); 183 void psbuf_put_8(struct puffs_framebuf *, uint64_t); 184 void psbuf_put_str(struct puffs_framebuf *, const char *); 185 void psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t); 186 void psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *); 187 188 uint8_t psbuf_get_type(struct puffs_framebuf *); 189 uint32_t psbuf_get_len(struct puffs_framebuf *); 190 uint32_t psbuf_get_reqid(struct puffs_framebuf *); 191 192 int psbuf_get_1(struct puffs_framebuf *, uint8_t *); 193 int psbuf_get_2(struct puffs_framebuf *, uint16_t *); 194 int psbuf_get_4(struct puffs_framebuf *, uint32_t *); 195 int psbuf_get_8(struct puffs_framebuf *, uint64_t *); 196 int psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *); 197 int psbuf_get_vattr(struct puffs_framebuf *, struct vattr *); 198 199 int psbuf_expect_status(struct puffs_framebuf *); 200 int psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *); 201 int psbuf_expect_name(struct puffs_framebuf *, uint32_t *); 202 int psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *); 203 204 int psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *); 205 206 void psbuf_req_data(struct puffs_framebuf *, int, uint32_t, 207 const void *, uint32_t); 208 void psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *); 209 210 int sftp_readdir(struct puffs_usermount *, struct psshfs_ctx *, 211 struct puffs_node *); 212 213 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 214 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 215 struct psshfs_dir *, const struct vattr *); 216 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 217 const char *, const struct vattr *); 218 struct psshfs_dir *direnter(struct puffs_node *, const char *); 219 void nukenode(struct puffs_node *, const char *, int); 220 void doreclaim(struct puffs_node *); 221 int getpathattr(struct puffs_usermount *, const char *, struct vattr *); 222 int getnodeattr(struct puffs_usermount *, struct puffs_node *); 223 224 void closehandles(struct puffs_usermount *, struct psshfs_node *, int); 225 void lazyopen_rresp(struct puffs_usermount *, struct puffs_framebuf *, 226 void *, int); 227 void lazyopen_wresp(struct puffs_usermount *, struct puffs_framebuf *, 228 void *, int); 229 230 #endif /* PSSHFS_H_ */ 231
Indexes created Tue Sep 30 11:09:46 GMT 2025