psshfs.h revision 1.2
1 /* $NetBSD: psshfs.h,v 1.2 2007/01/06 18:25:19 pooka Exp $ */ 2 3 /* 4 * Copyright (c) 2006 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 10 51 52 PUFFSOP_PROTOS(psshfs); 53 54 #define NEXTREQ(pctx) ((pctx->nextreq)++) 55 #define PSSHFSAUTOVAR(pcc) \ 56 struct puffs_usermount *pu = puffs_cc_getusermount(pcc); \ 57 struct psshfs_ctx *pctx = pu->pu_privdata; \ 58 uint32_t reqid = NEXTREQ(pctx); \ 59 struct psbuf *pb = psbuf_make(PSB_OUT); \ 60 int rv = 0 61 62 #define PSSHFSRETURN(rv) \ 63 psbuf_destroy(pb); \ 64 return (rv) 65 66 struct psshfs_dir { 67 int valid; 68 struct puffs_node *entry; 69 70 char *entryname; 71 struct vattr va; 72 }; 73 74 struct psshfs_node { 75 struct puffs_node *parent; 76 77 struct psshfs_dir *dir; /* only valid if we're of type VDIR */ 78 size_t denttot; 79 size_t dentnext; 80 time_t dentread; 81 int hasvattr; 82 83 int childcount; 84 }; 85 86 /* 87 * XXX: urgh 88 * 89 * This is slightly messy / abusatory structure. It is used for multiple 90 * things. Typical life cycle: create output buffer, append to output 91 * queue (pcc included) . Once the buffer has been sent, the buffer is 92 * freed and the structure is appended to reqqueue as psreq. It is kept 93 * there until matching network data is read. Once this happens, the 94 * data from the received buffer is copied to buffer stored on the queue. 95 * This should be rewritten, clearly. 96 */ 97 #define PSDEFALLOC 0x2000 98 #define PSBUFMAX 0x40000 99 #define PSB_OUT 0 100 #define PSB_IN 1 101 struct psbuf { 102 struct psreq { 103 struct puffs_cc *pcc; 104 uint32_t reqid; 105 TAILQ_ENTRY(psbuf) entries; 106 } psr; 107 108 /* in / out */ 109 uint32_t len; 110 uint32_t remain; 111 uint32_t offset; 112 uint8_t *buf; 113 114 int state; 115 116 /* helpers for in */ 117 uint8_t type; /* buf[0] */ 118 uint32_t reqid; /* buf[1-4] */ 119 }; 120 #define PSBUF_PUT 0 121 #define PSBUF_PUTDONE 1 122 #define PSBUF_GETLEN 2 123 #define PSBUF_GETDATA 3 124 #define PSBUF_GETREADY 4 125 126 struct psshfs_ctx { 127 int sshfd; 128 pid_t sshpid; 129 const char *mountpath; 130 131 int protover; 132 uint32_t nextreq; 133 134 struct psbuf *curpb; 135 136 struct psshfs_node psn_root; 137 ino_t nextino; 138 139 TAILQ_HEAD(, psbuf) outbufq; 140 TAILQ_HEAD(, psbuf) req_queue; 141 }; 142 143 int psshfs_domount(struct puffs_usermount *); 144 145 struct psbuf *psbuf_make(int); 146 void psbuf_destroy(struct psbuf *); 147 void psbuf_recycle(struct psbuf *, int); 148 149 int psbuf_read(struct psshfs_ctx *, struct psbuf *); 150 int psbuf_write(struct psshfs_ctx *, struct psbuf *); 151 152 void pssh_outbuf_enqueue(struct psshfs_ctx *, struct psbuf *, 153 struct puffs_cc *, uint32_t); 154 void psshreq_put(struct psshfs_ctx *, struct psbuf *); 155 struct psbuf *psshreq_get(struct psshfs_ctx *, uint32_t); 156 157 158 int psbuf_put_1(struct psbuf *, uint8_t); 159 int psbuf_put_2(struct psbuf *, uint16_t); 160 int psbuf_put_4(struct psbuf *, uint32_t); 161 int psbuf_put_8(struct psbuf *, uint64_t); 162 int psbuf_put_str(struct psbuf *, const char *); 163 int psbuf_put_data(struct psbuf *, const void *, uint32_t); 164 int psbuf_put_vattr(struct psbuf *, const struct vattr *); 165 166 int psbuf_get_1(struct psbuf *, uint8_t *); 167 int psbuf_get_2(struct psbuf *, uint16_t *); 168 int psbuf_get_4(struct psbuf *, uint32_t *); 169 int psbuf_get_8(struct psbuf *, uint64_t *); 170 int psbuf_get_str(struct psbuf *, char **, uint32_t *); 171 int psbuf_get_vattr(struct psbuf *, struct vattr *); 172 173 int psbuf_expect_status(struct psbuf *); 174 int psbuf_expect_handle(struct psbuf *, char **, size_t *); 175 int psbuf_expect_name(struct psbuf *, uint32_t *); 176 int psbuf_expect_attrs(struct psbuf *, struct vattr *); 177 178 int psbuf_do_data(struct psbuf *, uint8_t *, size_t *); 179 180 int psbuf_req_data(struct psbuf *, int, uint32_t, const void *, size_t); 181 int psbuf_req_str(struct psbuf *, int, uint32_t, const char *); 182 183 184 int sftp_readdir(struct puffs_cc *, struct psshfs_ctx *, 185 struct puffs_node *); 186 187 struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *); 188 struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *, 189 struct psshfs_dir *, const struct vattr *); 190 struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *, 191 const char *, const struct vattr *); 192 struct psshfs_dir *direnter(struct puffs_node *, const char *); 193 void nukenode(struct puffs_node *, const char *); 194 195 #endif /* PSSHFS_H_ */ 196
Indexes created Fri Sep 26 20:09:58 GMT 2025