LXR linux/include/net/9p/transport.h

   1/*
   2 * include/net/9p/transport.h
   3 *
   4 * Transport Definition
   5 *
   6 *  Copyright (C) 2005 by Latchesar Ionkov <lucho@ionkov.net>
   7 *  Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
   8 *
   9 *  This program is free software; you can redistribute it and/or modify
  10 *  it under the terms of the GNU General Public License version 2
  11 *  as published by the Free Software Foundation.
  12 *
  13 *  This program is distributed in the hope that it will be useful,
  14 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 *  GNU General Public License for more details.
  17 *
  18 *  You should have received a copy of the GNU General Public License
  19 *  along with this program; if not, write to:
  20 *  Free Software Foundation
  21 *  51 Franklin Street, Fifth Floor
  22 *  Boston, MA  02111-1301  USA
  23 *
  24 */
  25
  26#ifndef NET_9P_TRANSPORT_H
  27#define NET_9P_TRANSPORT_H
  28
  29#define P9_DEF_MIN_RESVPORT     (665U)
  30#define P9_DEF_MAX_RESVPORT     (1023U)
  31
  32/**
  33 * struct p9_trans_module - transport module interface
  34 * @list: used to maintain a list of currently available transports
  35 * @name: the human-readable name of the transport
  36 * @maxsize: transport provided maximum packet size
  37 * @def: set if this transport should be considered the default
  38 * @create: member function to create a new connection on this transport
  39 * @close: member function to discard a connection on this transport
  40 * @request: member function to issue a request to the transport
  41 * @cancel: member function to cancel a request (if it hasn't been sent)
  42 * @cancelled: member function to notify that a cancelled request will not
  43 *             not receive a reply
  44 *
  45 * This is the basic API for a transport module which is registered by the
  46 * transport module with the 9P core network module and used by the client
  47 * to instantiate a new connection on a transport.
  48 *
  49 * The transport module list is protected by v9fs_trans_lock.
  50 */
  51
  52struct p9_trans_module {
  53        struct list_head list;
  54        char *name;             /* name of transport */
  55        int maxsize;            /* max message size of transport */
  56        int def;                /* this transport should be default */
  57        struct module *owner;
  58        int (*create)(struct p9_client *, const char *, char *);
  59        void (*close) (struct p9_client *);
  60        int (*request) (struct p9_client *, struct p9_req_t *req);
  61        int (*cancel) (struct p9_client *, struct p9_req_t *req);
  62        int (*cancelled)(struct p9_client *, struct p9_req_t *req);
  63        int (*zc_request)(struct p9_client *, struct p9_req_t *,
  64                          struct iov_iter *, struct iov_iter *, int , int, int);
  65};
  66
  67void v9fs_register_trans(struct p9_trans_module *m);
  68void v9fs_unregister_trans(struct p9_trans_module *m);
  69struct p9_trans_module *v9fs_get_trans_by_name(char *s);
  70struct p9_trans_module *v9fs_get_default_trans(void);
  71void v9fs_put_trans(struct p9_trans_module *m);
  72#endif /* NET_9P_TRANSPORT_H */
  73