net/sunrpc/pmap_clnt.c

   1 /*
   2  * linux/net/sunrpc/pmap_clnt.c
   3  *
   4  * In-kernel RPC portmapper client.
   5  *
   6  * Portmapper supports version 2 of the rpcbind protocol (RFC 1833).
   7  *
   8  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
   9  */
  10
  11 #include <linux/types.h>
  12 #include <linux/socket.h>
  13 #include <linux/kernel.h>
  14 #include <linux/errno.h>
  15 #include <linux/uio.h>
  16 #include <linux/in.h>
  17 #include <linux/sunrpc/clnt.h>
  18 #include <linux/sunrpc/sched.h>
  19
  20 #ifdef RPC_DEBUG
  21 # define RPCDBG_FACILITY        RPCDBG_PMAP
  22 #endif
  23
  24 #define PMAP_SET                1
  25 #define PMAP_UNSET              2
  26 #define PMAP_GETPORT            3
  27
  28 struct portmap_args {
  29         u32                     pm_prog;
  30         u32                     pm_vers;
  31         u32                     pm_prot;
  32         unsigned short          pm_port;
  33         struct rpc_xprt *       pm_xprt;
  34 };
  35
  36 static struct rpc_procinfo      pmap_procedures[];
  37 static struct rpc_clnt *        pmap_create(char *, struct sockaddr_in *, int, int);
  38 static void                     pmap_getport_done(struct rpc_task *, void *);
  39 static struct rpc_program       pmap_program;
  40
  41 static void pmap_getport_prepare(struct rpc_task *task, void *calldata)
  42 {
  43         struct portmap_args *map = calldata;
  44         struct rpc_message msg = {
  45                 .rpc_proc       = &pmap_procedures[PMAP_GETPORT],
  46                 .rpc_argp       = map,
  47                 .rpc_resp       = &map->pm_port,
  48         };
  49
  50         rpc_call_setup(task, &msg, 0);
  51 }
  52
  53 static inline struct portmap_args *pmap_map_alloc(void)
  54 {
  55         return kmalloc(sizeof(struct portmap_args), GFP_NOFS);
  56 }
  57
  58 static inline void pmap_map_free(struct portmap_args *map)
  59 {
  60         kfree(map);
  61 }
  62
  63 static void pmap_map_release(void *data)
  64 {
  65         pmap_map_free(data);
  66 }
  67
  68 static const struct rpc_call_ops pmap_getport_ops = {
  69         .rpc_call_prepare       = pmap_getport_prepare,
  70         .rpc_call_done          = pmap_getport_done,
  71         .rpc_release            = pmap_map_release,
  72 };
  73
  74 static inline void pmap_wake_portmap_waiters(struct rpc_xprt *xprt, int status)
  75 {
  76         xprt_clear_binding(xprt);
  77         rpc_wake_up_status(&xprt->binding, status);
  78 }
  79
  80 /**
  81  * rpc_getport - obtain the port for a given RPC service on a given host
  82  * @task: task that is waiting for portmapper request
  83  *
  84  * This one can be called for an ongoing RPC request, and can be used in
  85  * an async (rpciod) context.
  86  */
  87 void rpc_getport(struct rpc_task *task)
  88 {
  89         struct rpc_clnt *clnt = task->tk_client;
  90         struct rpc_xprt *xprt = task->tk_xprt;
  91         struct sockaddr_in addr;
  92         struct portmap_args *map;
  93         struct rpc_clnt *pmap_clnt;
  94         struct rpc_task *child;
  95         int status;
  96
  97         dprintk("RPC: %4d rpc_getport(%s, %u, %u, %d)\n",
  98                         task->tk_pid, clnt->cl_server,
  99                         clnt->cl_prog, clnt->cl_vers, xprt->prot);
 100
 101         /* Autobind on cloned rpc clients is discouraged */
 102         BUG_ON(clnt->cl_parent != clnt);
 103
 104         status = -EACCES;               /* tell caller to check again */
 105         if (xprt_test_and_set_binding(xprt))
 106                 goto bailout_nowake;
 107
 108         /* Put self on queue before sending rpcbind request, in case
 109          * pmap_getport_done completes before we return from rpc_run_task */
 110         rpc_sleep_on(&xprt->binding, task, NULL, NULL);
 111
 112         /* Someone else may have bound if we slept */
 113         status = 0;
 114         if (xprt_bound(xprt))
 115                 goto bailout_nofree;
 116
 117         status = -ENOMEM;
 118         map = pmap_map_alloc();
 119         if (!map)
 120                 goto bailout_nofree;
 121         map->pm_prog = clnt->cl_prog;
 122         map->pm_vers = clnt->cl_vers;
 123         map->pm_prot = xprt->prot;
 124         map->pm_port = 0;
 125         map->pm_xprt = xprt_get(xprt);
 126
 127         rpc_peeraddr(clnt, (struct sockaddr *) &addr, sizeof(addr));
 128         pmap_clnt = pmap_create(clnt->cl_server, &addr, map->pm_prot, 0);
 129         status = PTR_ERR(pmap_clnt);
 130         if (IS_ERR(pmap_clnt))
 131                 goto bailout;
 132
 133         status = -EIO;
 134         child = rpc_run_task(pmap_clnt, RPC_TASK_ASYNC, &pmap_getport_ops, map);
 135         if (IS_ERR(child))
 136                 goto bailout;
 137         rpc_put_task(child);
 138
 139         task->tk_xprt->stat.bind_count++;
 140         return;
 141
 142 bailout:
 143         pmap_map_free(map);
 144         xprt_put(xprt);
 145 bailout_nofree:
 146         pmap_wake_portmap_waiters(xprt, status);
 147 bailout_nowake:
 148         task->tk_status = status;
 149 }
 150
 151 #ifdef CONFIG_ROOT_NFS
 152 /**
 153  * rpc_getport_external - obtain the port for a given RPC service on a given host
 154  * @sin: address of remote peer
 155  * @prog: RPC program number to bind
 156  * @vers: RPC version number to bind
 157  * @prot: transport protocol to use to make this request
 158  *
 159  * This one is called from outside the RPC client in a synchronous task context.
 160  */
 161 int rpc_getport_external(struct sockaddr_in *sin, __u32 prog, __u32 vers, int prot)
 162 {
 163         struct portmap_args map = {
 164                 .pm_prog        = prog,
 165                 .pm_vers        = vers,
 166                 .pm_prot        = prot,
 167                 .pm_port        = 0
 168         };
 169         struct rpc_message msg = {
 170                 .rpc_proc       = &pmap_procedures[PMAP_GETPORT],
 171                 .rpc_argp       = &map,
 172                 .rpc_resp       = &map.pm_port,
 173         };
 174         struct rpc_clnt *pmap_clnt;
 175         char            hostname[32];
 176         int             status;
 177
 178         dprintk("RPC:      rpc_getport_external(%u.%u.%u.%u, %u, %u, %d)\n",
 179                         NIPQUAD(sin->sin_addr.s_addr), prog, vers, prot);
 180
 181         sprintf(hostname, "%u.%u.%u.%u", NIPQUAD(sin->sin_addr.s_addr));
 182         pmap_clnt = pmap_create(hostname, sin, prot, 0);
 183         if (IS_ERR(pmap_clnt))
 184                 return PTR_ERR(pmap_clnt);
 185
 186         /* Setup the call info struct */
 187         status = rpc_call_sync(pmap_clnt, &msg, 0);
 188
 189         if (status >= 0) {
 190                 if (map.pm_port != 0)
 191                         return map.pm_port;
 192                 status = -EACCES;
 193         }
 194         return status;
 195 }
 196 #endif
 197
 198 /*
 199  * Portmapper child task invokes this callback via tk_exit.
 200  */
 201 static void pmap_getport_done(struct rpc_task *child, void *data)
 202 {
 203         struct portmap_args *map = data;
 204         struct rpc_xprt *xprt = map->pm_xprt;
 205         int status = child->tk_status;
 206
 207         if (status < 0) {
 208                 /* Portmapper not available */
 209                 xprt->ops->set_port(xprt, 0);
 210         } else if (map->pm_port == 0) {
 211                 /* Requested RPC service wasn't registered */
 212                 xprt->ops->set_port(xprt, 0);
 213                 status = -EACCES;
 214         } else {
 215                 /* Succeeded */
 216                 xprt->ops->set_port(xprt, map->pm_port);
 217                 xprt_set_bound(xprt);
 218                 status = 0;
 219         }
 220
 221         dprintk("RPC: %4d pmap_getport_done(status %d, port %u)\n",
 222                         child->tk_pid, status, map->pm_port);
 223
 224         pmap_wake_portmap_waiters(xprt, status);
 225         xprt_put(xprt);
 226 }
 227
 228 /**
 229  * rpc_register - set or unset a port registration with the local portmapper
 230  * @prog: RPC program number to bind
 231  * @vers: RPC version number to bind
 232  * @prot: transport protocol to use to make this request
 233  * @port: port value to register
 234  * @okay: result code
 235  *
 236  * port == 0 means unregister, port != 0 means register.
 237  */
 238 int rpc_register(u32 prog, u32 vers, int prot, unsigned short port, int *okay)
 239 {
 240         struct sockaddr_in      sin = {
 241                 .sin_family     = AF_INET,
 242                 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
 243         };
 244         struct portmap_args     map = {
 245                 .pm_prog        = prog,
 246                 .pm_vers        = vers,
 247                 .pm_prot        = prot,
 248                 .pm_port        = port,
 249         };
 250         struct rpc_message msg = {
 251                 .rpc_proc       = &pmap_procedures[port ? PMAP_SET : PMAP_UNSET],
 252                 .rpc_argp       = &map,
 253                 .rpc_resp       = okay,
 254         };
 255         struct rpc_clnt         *pmap_clnt;
 256         int error = 0;
 257
 258         dprintk("RPC: registering (%u, %u, %d, %u) with portmapper.\n",
 259                         prog, vers, prot, port);
 260
 261         pmap_clnt = pmap_create("localhost", &sin, IPPROTO_UDP, 1);
 262         if (IS_ERR(pmap_clnt)) {
 263                 error = PTR_ERR(pmap_clnt);
 264                 dprintk("RPC: couldn't create pmap client. Error = %d\n", error);
 265                 return error;
 266         }
 267
 268         error = rpc_call_sync(pmap_clnt, &msg, 0);
 269
 270         if (error < 0) {
 271                 printk(KERN_WARNING
 272                         "RPC: failed to contact portmap (errno %d).\n",
 273                         error);
 274         }
 275         dprintk("RPC: registration status %d/%d\n", error, *okay);
 276
 277         /* Client deleted automatically because cl_oneshot == 1 */
 278         return error;
 279 }
 280
 281 static struct rpc_clnt *pmap_create(char *hostname, struct sockaddr_in *srvaddr, int proto, int privileged)
 282 {
 283         struct rpc_create_args args = {
 284                 .protocol       = proto,
 285                 .address        = (struct sockaddr *)srvaddr,
 286                 .addrsize       = sizeof(*srvaddr),
 287                 .servername     = hostname,
 288                 .program        = &pmap_program,
 289                 .version        = RPC_PMAP_VERSION,
 290                 .authflavor     = RPC_AUTH_UNIX,
 291                 .flags          = (RPC_CLNT_CREATE_ONESHOT |
 292                                    RPC_CLNT_CREATE_NOPING),
 293         };
 294
 295         srvaddr->sin_port = htons(RPC_PMAP_PORT);
 296         if (!privileged)
 297                 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
 298         return rpc_create(&args);
 299 }
 300
 301 /*
 302  * XDR encode/decode functions for PMAP
 303  */
 304 static int xdr_encode_mapping(struct rpc_rqst *req, __be32 *p, struct portmap_args *map)
 305 {
 306         dprintk("RPC: xdr_encode_mapping(%u, %u, %u, %u)\n",
 307                 map->pm_prog, map->pm_vers, map->pm_prot, map->pm_port);
 308         *p++ = htonl(map->pm_prog);
 309         *p++ = htonl(map->pm_vers);
 310         *p++ = htonl(map->pm_prot);
 311         *p++ = htonl(map->pm_port);
 312
 313         req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
 314         return 0;
 315 }
 316
 317 static int xdr_decode_port(struct rpc_rqst *req, __be32 *p, unsigned short *portp)
 318 {
 319         *portp = (unsigned short) ntohl(*p++);
 320         return 0;
 321 }
 322
 323 static int xdr_decode_bool(struct rpc_rqst *req, __be32 *p, unsigned int *boolp)
 324 {
 325         *boolp = (unsigned int) ntohl(*p++);
 326         return 0;
 327 }
 328
 329 static struct rpc_procinfo      pmap_procedures[] = {
 330 [PMAP_SET] = {
 331           .p_proc               = PMAP_SET,
 332           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 333           .p_decode             = (kxdrproc_t) xdr_decode_bool,
 334           .p_bufsiz             = 4,
 335           .p_count              = 1,
 336           .p_statidx            = PMAP_SET,
 337           .p_name               = "SET",
 338         },
 339 [PMAP_UNSET] = {
 340           .p_proc               = PMAP_UNSET,
 341           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 342           .p_decode             = (kxdrproc_t) xdr_decode_bool,
 343           .p_bufsiz             = 4,
 344           .p_count              = 1,
 345           .p_statidx            = PMAP_UNSET,
 346           .p_name               = "UNSET",
 347         },
 348 [PMAP_GETPORT] = {
 349           .p_proc               = PMAP_GETPORT,
 350           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 351           .p_decode             = (kxdrproc_t) xdr_decode_port,
 352           .p_bufsiz             = 4,
 353           .p_count              = 1,
 354           .p_statidx            = PMAP_GETPORT,
 355           .p_name               = "GETPORT",
 356         },
 357 };
 358
 359 static struct rpc_version       pmap_version2 = {
 360         .number         = 2,
 361         .nrprocs        = 4,
 362         .procs          = pmap_procedures
 363 };
 364
 365 static struct rpc_version *     pmap_version[] = {
 366         NULL,
 367         NULL,
 368         &pmap_version2
 369 };
 370
 371 static struct rpc_stat          pmap_stats;
 372
 373 static struct rpc_program       pmap_program = {
 374         .name           = "portmap",
 375         .number         = RPC_PMAP_PROGRAM,
 376         .nrvers         = ARRAY_SIZE(pmap_version),
 377         .version        = pmap_version,
 378         .stats          = &pmap_stats,
 379 };