psshfs.h revision 1.16
1 /* $NetBSD: psshfs.h,v 1.16 2007/05/18 16:13:47 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 /* warm getattr cache in readdir */ 53 #define SUPERREADDIR 54 55 PUFFSOP_PROTOS(psshfs); 56 57 #define NEXTREQ(pctx) ((pctx->nextreq)++) 58 #define PSSHFSAUTOVAR(pcc) \ 59 struct psshfs_ctx *pctx = puffs_cc_getspecific(pcc); \ 60 uint32_t reqid = NEXTREQ(pctx); \ 61 struct puffs_framebuf *pb = psbuf_makeout(); \ 62 int rv = 0 63 64 #define PSSHFSRETURN(rv) \ 65 puffs_framebuf_destroy(pb); \ 66 return (rv) 67 68 #define GETRESPONSE(pb) \ 69 do { \ 70 if (puffs_framev_enqueue_cc(pcc, pctx->sshfd, pb) == -1) { \ 71 rv = errno; \ 72 goto out; \ 73 } \ 74 } while (/*CONSTCOND*/0) 75 76 #define JUSTSEND(pb) \ 77 do { \ 78 if (puffs_framev_enqueue_justsend(pu,pctx->sshfd,pb,1) == -1) { \ 79 rv = errno; \ 80 goto out; \ 81 } \ 82 } while (/*CONSTCOND*/0) 83 84 #define SENDCB(pb, f, a) \ 85 do { \ 86 if (puffs_framev_enqueue_cb(pu, pctx->sshfd, pb, f,a) == -1) { \ 87 rv = errno; \ 88 goto out; \ 89 } \ 90 } while (/*CONSTCOND*/0) 91 92 struct psshfs_dir { 93 int valid; 94 struct puffs_node *entry; 95 96 char *entryname; 97 struct vattr va; 98 time_t attrread; 99 }; 100 101 struct psshfs_fid { 102 time_t mounttime; 103 struct puffs_node *node; 104 }; 105 106 struct psshfs_node { 107 struct puffs_node *parent; 108 109 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 110 size_t denttot; 111 size_t dentnext; 112 time_t dentread; 113 int childcount; 114 115 int stat; 116 117 time_t attrread; 118 119 char *fhand_r; 120 char *fhand_w; 121 uint32_t fhand_r_len; 122 uint32_t fhand_w_len; 123 }; 124 #define PSN_RECLAIMED 0x01 125 #define PSN_HASFH 0x02 126 #define PSN_NUKED 0x04 127 128 struct psshfs_ctx { 129 int sshfd; 130 pid_t sshpid; 131 const char *mountpath; 132 133 int protover; 134 uint32_t nextreq; 135 136 struct puffs_framebuf *curpb; 137 138 struct psshfs_node psn_root; 139 ino_t nextino; 140 141 int canexport; 142 time_t mounttime; 143 }; 144 145 int psshfs_domount(struct puffs_usermount *); 146 147 int psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 148 int psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*); 149 int psbuf_cmp(struct puffs_usermount *, 150 struct puffs_framebuf *, struct puffs_framebuf *); 151 152 struct puffs_framebuf *psbuf_makeout(void); 153 void psbuf_recycleout(struct puffs_framebuf *); 154 155 void psbuf_put_1(struct puffs_framebuf *, uint8_t); 156 void psbuf_put_2(struct puffs_framebuf *, uint16_t); 157 void psbuf_put_4(struct puffs_framebuf *, uint32_t); 158 void psbuf_put_8(struct puffs_framebuf *, uint64_t); 159 void psbuf_put_str(struct puffs_framebuf *, const char *); 160 void psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t); 161 void psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *); 162 163 uint8_t psbuf_get_type(struct puffs_framebuf *); 164 uint32_t psbuf_get_len(struct puffs_framebuf *); 165 uint32_t psbuf_get_reqid(struct puffs_framebuf *); 166 167 int psbuf_get_1(struct puffs_framebuf *, uint8_t *); 168 int psbuf_get_2(struct puffs_framebuf *, uint16_t *); 169 int psbuf_get_4(struct puffs_framebuf *, uint32_t *); 170 int psbuf_get_8(struct puffs_framebuf *, uint64_t *); 171 int psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *); 172 int psbuf_get_vattr(struct puffs_framebuf *, struct vattr *); 173 174 int psbuf_expect_status(struct puffs_framebuf *); 175 int psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *); 176 int psbuf_expect_name(struct puffs_framebuf *, uint32_t *); 177 int psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *); 178 179 int psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *); 180 181 void psbuf_req_data(struct puffs_framebuf *, int, uint32_t, 182 const void *, uint32_t); 183 void psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *); 184 185 int sftp_readdir(struct puffs_cc *, struct psshfs_ctx *, 186 struct puffs_node *); 187 188 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 189 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 190 struct psshfs_dir *, const struct vattr *); 191 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 192 const char *, const struct vattr *); 193 struct psshfs_dir *direnter(struct puffs_node *, const char *); 194 void nukenode(struct puffs_node *, const char *, int); 195 void doreclaim(struct puffs_node *); 196 int getpathattr(struct puffs_cc *, const char *, struct vattr *); 197 int getnodeattr(struct puffs_cc *, struct puffs_node *); 198 199 #endif /* PSSHFS_H_ */ 200
Indexes created Sun Sep 28 16:09:52 GMT 2025