psshfs.h revision 1.24
1 /* $NetBSD: psshfs.h,v 1.24 2007/09/06 16:09:10 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 /* 36 * Later protocol versions would have some advantages (such as link count 37 * supported directly as a part of stat), but since proto version 3 seems 38 * to be the only widely available version, let's not try to jump through 39 * too many hoops to be compatible with all versions. 40 */ 41 #define SFTP_PROTOVERSION 3 42 43 /* 44 * Refresh directories every n seconds as indicated by the following macro. 45 * Note that local changes will still be visible immediately. 46 */ 47 #define PSSHFS_REFRESHIVAL 30 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_dirwait { 103 struct puffs_cc *dw_cc; 104 LIST_ENTRY(psshfs_dirwait) dw_entries; 105 }; 106 107 struct psshfs_node { 108 struct puffs_node *parent; 109 110 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 111 struct delayattr { 112 struct puffs_framebuf *pufbuf; 113 struct readdirattr *rda; 114 } *da; 115 size_t nextda; 116 117 size_t denttot; 118 size_t dentnext; 119 time_t dentread; 120 int childcount; 121 122 int stat; 123 int opencount; 124 125 time_t attrread; 126 struct puffs_framebuf *getattr_pb; 127 128 char *fhand_r; 129 char *fhand_w; 130 uint32_t fhand_r_len; 131 uint32_t fhand_w_len; 132 133 LIST_HEAD(, psshfs_dirwait) dw; 134 }; 135 #define PSN_RECLAIMED 0x01 136 #define PSN_HASFH 0x02 137 #define PSN_READMAP 0x04 138 #define PSN_WRITEMAP 0x08 139 #define PSN_READDIR 0x10 140 141 struct psshfs_ctx { 142 int sshfd; 143 pid_t sshpid; 144 const char *mountpath; 145 146 int protover; 147 uint32_t nextreq; 148 149 struct puffs_framebuf *curpb; 150 151 struct psshfs_node psn_root; 152 ino_t nextino; 153 154 int canexport; 155 time_t mounttime; 156 }; 157 158 int psshfs_domount(struct puffs_usermount *); 159 160 int psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 161 int psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 162 int psbuf_cmp(struct puffs_usermount *, 163 struct puffs_framebuf *, struct puffs_framebuf *, int *); 164 165 struct puffs_framebuf *psbuf_makeout(void); 166 void psbuf_recycleout(struct puffs_framebuf *); 167 168 void psbuf_put_1(struct puffs_framebuf *, uint8_t); 169 void psbuf_put_2(struct puffs_framebuf *, uint16_t); 170 void psbuf_put_4(struct puffs_framebuf *, uint32_t); 171 void psbuf_put_8(struct puffs_framebuf *, uint64_t); 172 void psbuf_put_str(struct puffs_framebuf *, const char *); 173 void psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t); 174 void psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *); 175 176 uint8_t psbuf_get_type(struct puffs_framebuf *); 177 uint32_t psbuf_get_len(struct puffs_framebuf *); 178 uint32_t psbuf_get_reqid(struct puffs_framebuf *); 179 180 int psbuf_get_1(struct puffs_framebuf *, uint8_t *); 181 int psbuf_get_2(struct puffs_framebuf *, uint16_t *); 182 int psbuf_get_4(struct puffs_framebuf *, uint32_t *); 183 int psbuf_get_8(struct puffs_framebuf *, uint64_t *); 184 int psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *); 185 int psbuf_get_vattr(struct puffs_framebuf *, struct vattr *); 186 187 int psbuf_expect_status(struct puffs_framebuf *); 188 int psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *); 189 int psbuf_expect_name(struct puffs_framebuf *, uint32_t *); 190 int psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *); 191 192 int psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *); 193 194 void psbuf_req_data(struct puffs_framebuf *, int, uint32_t, 195 const void *, uint32_t); 196 void psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *); 197 198 int sftp_readdir(struct puffs_cc *, struct psshfs_ctx *, 199 struct puffs_node *); 200 201 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 202 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 203 struct psshfs_dir *, const struct vattr *); 204 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 205 const char *, const struct vattr *); 206 struct psshfs_dir *direnter(struct puffs_node *, const char *); 207 void nukenode(struct puffs_node *, const char *, int); 208 void doreclaim(struct puffs_node *); 209 int getpathattr(struct puffs_cc *, const char *, struct vattr *); 210 int getnodeattr(struct puffs_cc *, struct puffs_node *); 211 212 #endif /* PSSHFS_H_ */ 213
Indexes created Mon Sep 29 21:09:56 GMT 2025