Initial checkin

1 files changed, 225 insertions, 0 deletions

diff --git a/ftpfs/ftpfs.h b/ftpfs/ftpfs.h
new file mode 100644
index 00000000..3cf2c0e0
--- /dev/null
+++ b/ftpfs/ftpfs.h
@@ -0,0 +1,225 @@
+/* Ftp filesystem
+
+   Copyright (C) 1997 Free Software Foundation, Inc.
+   Written by Miles Bader <miles@gnu.ai.mit.edu>
+   This file is part of the GNU Hurd.
+
+   The GNU Hurd is free software; you can redistribute it and/or
+   modify it under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2, or (at
+   your option) any later version.
+
+   The GNU Hurd is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA. */
+
+#ifndef __FTPFS_H__
+#define __FTPFS_H__
+
+#include <stdlib.h>
+#include <cthreads.h>
+#include <ftpconn.h>
+#include <maptime.h>
+
+/* Anonymous types.  */
+struct ccache;
+struct ftpfs_conn;
+
+/* A single entry in a directory.  */
+struct ftpfs_dir_entry
+{
+  char *name;			/* Name of this entry */
+  size_t hv;			/* Hash value of NAME (before mod'ing) */
+
+  /* The active node referred to by this name (may be 0).
+     NETFS_NODE_REFCNT_LOCK should be held while frobbing this.  */
+  struct node *node;
+
+  struct stat stat;
+  char *symlink_target;
+  time_t stat_timestamp;
+
+  /* The directory to which this entry belongs.  */
+  struct ftpfs_dir *dir;
+
+  /* Link to next entry in hash bucket, and address of previous entry's (or
+     hash table's) pointer to this entry.  If the SELF_P field is 0, then
+     this is a deleted entry, awaiting final disposal.  */
+  struct ftpfs_dir_entry *next, **self_p;
+
+  /* Next entry in `directory order', or 0 if none known.  */
+  struct ftpfs_dir_entry *ordered_next, **ordered_self_p;
+
+  /* When the presence/absence of this file was last checked.  */
+  time_t dirent_timestamp;
+
+  void **inode_locp;		/* Used for removing this entry */
+
+  int noent : 1;		/* A negative lookup result.  */
+  int valid : 1;		/* Marker for GC'ing.  */
+};
+
+/* A directory.  */
+struct ftpfs_dir
+{
+  /* Number of entries in HTABLE.  */
+  size_t num_entries;
+
+  /* The number of entries that have nodes attached.  We keep an additional
+     reference to our node if there are any, to prevent it from going away.  */
+  size_t num_live_entries;
+
+  /* Hash table of entries.  */
+  struct ftpfs_dir_entry **htable;
+  size_t htable_len;		/* # of elements in HTABLE (not bytes).  */
+
+  /* List of dir entries in `directory order', in a linked list using the
+     ORDERED_NEXT and ORDERED_SELF_P fields in each entry.  Not all entries
+     in HTABLE need be in this list.  */
+  struct ftpfs_dir_entry *ordered;
+
+  /* The filesystem node that this is the directory for.  */
+  struct node *node;
+
+  /* The filesystem this directory is in.  */
+  struct ftpfs *fs;
+
+  /* The path to this directory on the server.  */
+  const char *rmt_path;
+
+  time_t timestamp;
+
+  /* Stuff for detecting bulk stats.  */
+
+  /* The timestamp of the first sample in bulk_stat_count1, rounded to
+     BULK_STAT_PERIOD seconds.  */
+  time_t bulk_stat_base_stamp;
+
+  /* The number of stats done in the period [bulk_stat_base_stamp,
+     bulk_stat_base_stamp+BULK_STAT_PERIOD).  */
+  unsigned bulk_stat_count_first_half;
+  /* The number of stats done in the period
+     [bulk_stat_base_stamp+BULK_STAT_PERIOD,
+     bulk_stat_base_stamp+BULK_STAT_PERIOD*2).  */
+  unsigned bulk_stat_count_second_half;
+};
+
+/* libnetfs node structure. */
+struct netnode
+{
+  /* The remote filesystem.  */
+  struct ftpfs *fs;
+
+  /* The directory entry for this node.  */
+  struct ftpfs_dir_entry *dir_entry;
+
+  /* The path in FS that this file corresponds to.  */
+  const char *rmt_path;
+
+  /* If this is a regular file, an optional cache of the contents.  This may
+     be 0, if no cache has yet been created, but once created, it only goes
+     away when the node is destroyed.  */
+  struct ccache *contents;
+
+  /* If this is a directory, the contents, or 0 if not fetched.  */
+  struct ftpfs_dir *dir;
+
+  /* Position in the node cache.  */
+  struct node *ncache_next, *ncache_prev;
+};
+
+/* Various parameters that can be used to change the behavior of an ftpfs.  */
+struct ftpfs_params 
+{
+  time_t dir_timeout;
+  time_t dirent_timeout;
+  time_t stat_timeout;
+
+  time_t bulk_stat_period;
+  unsigned bulk_stat_limit;
+
+  size_t node_cache_max;
+};
+
+/* A particular filesystem.  */
+struct ftpfs 
+{
+  /* Root of filesystem.  */
+  struct node *root;
+
+  struct ftpfs_conn *free_conns;
+  struct ftpfs_conn *conns;
+  spin_lock_t conn_lock;
+
+  struct ftp_conn_params *ftp_params;
+  struct ftp_conn_hooks *ftp_hooks;
+
+  /* A hash table mapping inode numbers to directory entries.  */
+  struct ihash *inode_mappings;
+  spin_lock_t inode_mappings_lock;
+
+  struct ftpfs_params params;
+
+  /* A cache that holds a reference to recently used nodes.  */
+  struct node *node_cache_mru, *node_cache_lru;
+  size_t node_cache_len;	/* Number of entries in it.  */
+  struct mutex node_cache_lock;
+};
+
+extern volatile struct mapped_time_value *ftpfs_maptime;
+
+/* The current time.  */
+#define NOW \
+  ({ struct timeval tv; maptime_read (ftpfs_maptime, &tv); tv.tv_sec; })
+
+/* Create a new ftp filesystem with the given parameters.  */
+error_t ftpfs_create (char *rmt_root,
+		      struct ftp_conn_params *ftp_params,
+		      struct ftp_conn_hooks *ftp_hooks,
+		      struct ftpfs_params *params,
+		      struct ftpfs **fs);
+
+/* Refresh stat information for NODE.  This may actually refresh the whole
+   directory if that is deemed desirable.  */
+error_t ftpfs_refresh_node (struct node *node);
+
+/* Remove NODE from its entry (if the entry is still valid, it will remain
+   without a node).  NODE should be locked.  */
+error_t ftpfs_detach_node (struct node *node);
+
+/* Return a new node in NODE, with a name NAME, and return the new node
+   with a single reference in NODE.  E may be 0, if this is the root node.  */
+error_t ftpfs_create_node (struct ftpfs_dir_entry *e, const char *rmt_path,
+			   struct node **node);
+
+/* Add NODE to the recently-used-node cache, which adds a reference to
+   prevent it from going away.  NODE should be locked.  */
+void ftpfs_cache_node (struct node *node);
+
+/* Get an ftp connection to use for an operation. */
+error_t ftpfs_get_ftp_conn (struct ftpfs *fs, struct ftp_conn **conn);
+
+/* Return CONN to the pool of free connections in FS.  */
+void ftpfs_release_ftp_conn (struct ftpfs *fs, struct ftp_conn *conn);
+
+/* Return in DIR a new ftpfs directory, in the filesystem FS, with node NODE
+   and remote path RMT_PATH.  RMT_PATH is *not copied*, so it shouldn't ever
+   change while this directory is active.  */
+error_t ftpfs_dir_create (struct ftpfs *fs, struct node *node,
+			  const char *rmt_path, struct ftpfs_dir **dir);
+
+void ftpfs_dir_free (struct ftpfs_dir *dir);
+
+/* Refresh DIR.  */
+error_t ftpfs_dir_refresh (struct ftpfs_dir *dir);
+
+/* Lookup NAME in DIR, returning its entry, or an error.  */
+error_t ftpfs_dir_lookup (struct ftpfs_dir *dir, const char *name,
+			  struct node **node);
+
+#endif /* __FTPFS_H__ */