xref: /src/usr.sbin/puffs/mount_psshfs/psshfs.h

/*	$NetBSD: psshfs.h,v 1.13 2007/05/11 16:23:01 pooka Exp $	*/

/*
 * Copyright (c) 2006, 2007  Antti Kantee.  All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the company nor the name of the author may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef PSSHFS_H_
#define PSSHFS_H_

#include <sys/queue.h>

#include <puffs.h>

/*
 * Later protocol versions would have some advantages (such as link count
 * supported directly as a part of stat), but since proto version 3 seems
 * to be the only widely available version, let's not try to jump through
 * too many hoops to be compatible with all versions.
 */
#define SFTP_PROTOVERSION 3

/*
 * Refresh directories every n seconds as indicated by the following macro.
 * Note that local changes will still be visible immediately.
 */
#define PSSHFS_REFRESHIVAL 30

/* warm getattr cache in readdir */
#define SUPERREADDIR

PUFFSOP_PROTOS(psshfs);

#define NEXTREQ(pctx) ((pctx->nextreq)++)
#define PSSHFSAUTOVAR(pcc)						\
	struct psshfs_ctx *pctx = puffs_cc_getspecific(pcc);		\
	uint32_t reqid = NEXTREQ(pctx);					\
	struct puffs_framebuf *pb = psbuf_makeout();			\
	int rv = 0

#define PSSHFSRETURN(rv)						\
	puffs_framebuf_destroy(pb);					\
	return (rv)

#define GETRESPONSE(pb) puffs_framebuf_enqueue_cc(pcc, pctx->sshfd, pb)
#define JUSTSEND(pb) puffs_framebuf_enqueue_justsend(pu, pctx->sshfd, pb, 1)
#define SENDCB(pb, f, a) puffs_framebuf_enqueue_cb(pu, pctx->sshfd, pb, f,a)

struct psshfs_dir {
	int valid;
	struct puffs_node *entry;

	char *entryname;
	struct vattr va;
	time_t attrread;
};

struct psshfs_fid {
	time_t mounttime;
	struct puffs_node *node;
};

struct psshfs_node {
	struct puffs_node *parent;

	struct psshfs_dir *dir;	/* only valid if we're of type VDIR */
	size_t denttot;
	size_t dentnext;
	time_t dentread;
	int childcount;
	int reclaimed;
	int hasfh;

	time_t attrread;

	char *fhand_r;
	char *fhand_w;
	size_t fhand_r_len;
	size_t fhand_w_len;
};

struct psshfs_ctx {
	int sshfd;
	pid_t sshpid;
	const char *mountpath;

	int protover;
	uint32_t nextreq;

	struct puffs_framebuf *curpb;

	struct psshfs_node psn_root;
	ino_t nextino;

	int canexport;
	time_t mounttime;
};

int	psshfs_domount(struct puffs_usermount *);

int	psbuf_read(struct puffs_usermount *, struct puffs_framebuf *,int,int*);
int	psbuf_write(struct puffs_usermount *, struct puffs_framebuf *,int,int*);
int	psbuf_cmp(struct puffs_usermount *,
		  struct puffs_framebuf *, struct puffs_framebuf *);

struct puffs_framebuf	*psbuf_makeout(void);
void			psbuf_recycleout(struct puffs_framebuf *);

void	psbuf_put_1(struct puffs_framebuf *, uint8_t);
void	psbuf_put_2(struct puffs_framebuf *, uint16_t);
void	psbuf_put_4(struct puffs_framebuf *, uint32_t);
void	psbuf_put_8(struct puffs_framebuf *, uint64_t);
void	psbuf_put_str(struct puffs_framebuf *, const char *);
void	psbuf_put_data(struct puffs_framebuf *, const void *, uint32_t);
void	psbuf_put_vattr(struct puffs_framebuf *, const struct vattr *);

uint8_t		psbuf_get_type(struct puffs_framebuf *);
uint32_t	psbuf_get_len(struct puffs_framebuf *);
uint32_t	psbuf_get_reqid(struct puffs_framebuf *);

int	psbuf_get_1(struct puffs_framebuf *, uint8_t *);
int	psbuf_get_2(struct puffs_framebuf *, uint16_t *);
int	psbuf_get_4(struct puffs_framebuf *, uint32_t *);
int	psbuf_get_8(struct puffs_framebuf *, uint64_t *);
int	psbuf_get_str(struct puffs_framebuf *, char **, uint32_t *);
int	psbuf_get_vattr(struct puffs_framebuf *, struct vattr *);

int	psbuf_expect_status(struct puffs_framebuf *);
int	psbuf_expect_handle(struct puffs_framebuf *, char **, uint32_t *);
int	psbuf_expect_name(struct puffs_framebuf *, uint32_t *);
int	psbuf_expect_attrs(struct puffs_framebuf *, struct vattr *);

int	psbuf_do_data(struct puffs_framebuf *, uint8_t *, uint32_t *);

void	psbuf_req_data(struct puffs_framebuf *, int, uint32_t,
		       const void *, uint32_t);
void	psbuf_req_str(struct puffs_framebuf *, int, uint32_t, const char *);

int	sftp_readdir(struct puffs_cc *, struct psshfs_ctx *,
		     struct puffs_node *);

struct psshfs_dir *lookup(struct psshfs_dir *, size_t, const char *);
struct puffs_node *makenode(struct puffs_usermount *, struct puffs_node *,
			    struct psshfs_dir *, const struct vattr *);
struct puffs_node *allocnode(struct puffs_usermount *, struct puffs_node *,
			    const char *, const struct vattr *);
struct psshfs_dir *direnter(struct puffs_node *, const char *);
void nukenode(struct puffs_node *, const char *, int);
void doreclaim(struct puffs_node *);
int getpathattr(struct puffs_cc *, const char *, struct vattr *);
int getnodeattr(struct puffs_cc *, struct puffs_node *);

#endif /* PSSHFS_H_ */