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/xprt.h>
  19 #include <linux/sunrpc/sched.h>
  20
  21 #ifdef RPC_DEBUG
  22 # define RPCDBG_FACILITY        RPCDBG_PMAP
  23 #endif
  24
  25 #define PMAP_SET                1
  26 #define PMAP_UNSET              2
  27 #define PMAP_GETPORT            3
  28
  29 struct portmap_args {
  30         u32                     pm_prog;
  31         u32                     pm_vers;
  32         u32                     pm_prot;
  33         unsigned short          pm_port;
  34         struct rpc_task *       pm_task;
  35 };
  36
  37 static struct rpc_procinfo      pmap_procedures[];
  38 static struct rpc_clnt *        pmap_create(char *, struct sockaddr_in *, int, int);
  39 static void                     pmap_getport_done(struct rpc_task *, void *);
  40 static struct rpc_program       pmap_program;
  41
  42 static void pmap_getport_prepare(struct rpc_task *task, void *calldata)
  43 {
  44         struct portmap_args *map = calldata;
  45         struct rpc_message msg = {
  46                 .rpc_proc       = &pmap_procedures[PMAP_GETPORT],
  47                 .rpc_argp       = map,
  48                 .rpc_resp       = &map->pm_port,
  49         };
  50
  51         rpc_call_setup(task, &msg, 0);
  52 }
  53
  54 static inline struct portmap_args *pmap_map_alloc(void)
  55 {
  56         return kmalloc(sizeof(struct portmap_args), GFP_NOFS);
  57 }
  58
  59 static inline void pmap_map_free(struct portmap_args *map)
  60 {
  61         kfree(map);
  62 }
  63
  64 static void pmap_map_release(void *data)
  65 {
  66         pmap_map_free(data);
  67 }
  68
  69 static const struct rpc_call_ops pmap_getport_ops = {
  70         .rpc_call_prepare       = pmap_getport_prepare,
  71         .rpc_call_done          = pmap_getport_done,
  72         .rpc_release            = pmap_map_release,
  73 };
  74
  75 static inline void pmap_wake_portmap_waiters(struct rpc_xprt *xprt)
  76 {
  77         xprt_clear_binding(xprt);
  78         rpc_wake_up(&xprt->binding);
  79 }
  80
  81 /**
  82  * rpc_getport - obtain the port for a given RPC service on a given host
  83  * @task: task that is waiting for portmapper request
  84  *
  85  * This one can be called for an ongoing RPC request, and can be used in
  86  * an async (rpciod) context.
  87  */
  88 void rpc_getport(struct rpc_task *task)
  89 {
  90         struct rpc_clnt *clnt = task->tk_client;
  91         struct rpc_xprt *xprt = task->tk_xprt;
  92         struct sockaddr_in *sap = &xprt->addr;
  93         struct portmap_args *map;
  94         struct rpc_clnt *pmap_clnt;
  95         struct rpc_task *child;
  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         if (xprt_test_and_set_binding(xprt)) {
 105                 task->tk_status = -EACCES;      /* tell caller to check again */
 106                 rpc_sleep_on(&xprt->binding, task, NULL, NULL);
 107                 return;
 108         }
 109
 110         /* Someone else may have bound if we slept */
 111         if (xprt_bound(xprt)) {
 112                 task->tk_status = 0;
 113                 goto bailout_nofree;
 114         }
 115
 116         map = pmap_map_alloc();
 117         if (!map) {
 118                 task->tk_status = -ENOMEM;
 119                 goto bailout_nofree;
 120         }
 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_task = task;
 126
 127         pmap_clnt = pmap_create(clnt->cl_server, sap, map->pm_prot, 0);
 128         if (IS_ERR(pmap_clnt)) {
 129                 task->tk_status = PTR_ERR(pmap_clnt);
 130                 goto bailout;
 131         }
 132
 133         child = rpc_run_task(pmap_clnt, RPC_TASK_ASYNC, &pmap_getport_ops, map);
 134         if (IS_ERR(child)) {
 135                 task->tk_status = -EIO;
 136                 goto bailout;
 137         }
 138         rpc_release_task(child);
 139
 140         rpc_sleep_on(&xprt->binding, task, NULL, NULL);
 141
 142         task->tk_xprt->stat.bind_count++;
 143         return;
 144
 145 bailout:
 146         pmap_map_free(map);
 147 bailout_nofree:
 148         pmap_wake_portmap_waiters(xprt);
 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_task *task = map->pm_task;
 205         struct rpc_xprt *xprt = task->tk_xprt;
 206         int status = child->tk_status;
 207
 208         if (status < 0) {
 209                 /* Portmapper not available */
 210                 xprt->ops->set_port(xprt, 0);
 211                 task->tk_status = status;
 212         } else if (map->pm_port == 0) {
 213                 /* Requested RPC service wasn't registered */
 214                 xprt->ops->set_port(xprt, 0);
 215                 task->tk_status = -EACCES;
 216         } else {
 217                 /* Succeeded */
 218                 xprt->ops->set_port(xprt, map->pm_port);
 219                 xprt_set_bound(xprt);
 220                 task->tk_status = 0;
 221         }
 222
 223         dprintk("RPC: %4d pmap_getport_done(status %d, port %u)\n",
 224                         child->tk_pid, child->tk_status, map->pm_port);
 225
 226         pmap_wake_portmap_waiters(xprt);
 227 }
 228
 229 /**
 230  * rpc_register - set or unset a port registration with the local portmapper
 231  * @prog: RPC program number to bind
 232  * @vers: RPC version number to bind
 233  * @prot: transport protocol to use to make this request
 234  * @port: port value to register
 235  * @okay: result code
 236  *
 237  * port == 0 means unregister, port != 0 means register.
 238  */
 239 int rpc_register(u32 prog, u32 vers, int prot, unsigned short port, int *okay)
 240 {
 241         struct sockaddr_in      sin = {
 242                 .sin_family     = AF_INET,
 243                 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
 244         };
 245         struct portmap_args     map = {
 246                 .pm_prog        = prog,
 247                 .pm_vers        = vers,
 248                 .pm_prot        = prot,
 249                 .pm_port        = port,
 250         };
 251         struct rpc_message msg = {
 252                 .rpc_proc       = &pmap_procedures[port ? PMAP_SET : PMAP_UNSET],
 253                 .rpc_argp       = &map,
 254                 .rpc_resp       = okay,
 255         };
 256         struct rpc_clnt         *pmap_clnt;
 257         int error = 0;
 258
 259         dprintk("RPC: registering (%u, %u, %d, %u) with portmapper.\n",
 260                         prog, vers, prot, port);
 261
 262         pmap_clnt = pmap_create("localhost", &sin, IPPROTO_UDP, 1);
 263         if (IS_ERR(pmap_clnt)) {
 264                 error = PTR_ERR(pmap_clnt);
 265                 dprintk("RPC: couldn't create pmap client. Error = %d\n", error);
 266                 return error;
 267         }
 268
 269         error = rpc_call_sync(pmap_clnt, &msg, 0);
 270
 271         if (error < 0) {
 272                 printk(KERN_WARNING
 273                         "RPC: failed to contact portmap (errno %d).\n",
 274                         error);
 275         }
 276         dprintk("RPC: registration status %d/%d\n", error, *okay);
 277
 278         /* Client deleted automatically because cl_oneshot == 1 */
 279         return error;
 280 }
 281
 282 static struct rpc_clnt *pmap_create(char *hostname, struct sockaddr_in *srvaddr, int proto, int privileged)
 283 {
 284         struct rpc_xprt *xprt;
 285         struct rpc_clnt *clnt;
 286
 287         xprt = xprt_create_proto(proto, srvaddr, NULL);
 288         if (IS_ERR(xprt))
 289                 return (struct rpc_clnt *)xprt;
 290         xprt->ops->set_port(xprt, RPC_PMAP_PORT);
 291         xprt_set_bound(xprt);
 292         if (!privileged)
 293                 xprt->resvport = 0;
 294
 295         clnt = rpc_new_client(xprt, hostname,
 296                                 &pmap_program, RPC_PMAP_VERSION,
 297                                 RPC_AUTH_UNIX);
 298         if (!IS_ERR(clnt)) {
 299                 clnt->cl_softrtry = 1;
 300                 clnt->cl_oneshot  = 1;
 301         }
 302         return clnt;
 303 }
 304
 305 /*
 306  * XDR encode/decode functions for PMAP
 307  */
 308 static int xdr_encode_mapping(struct rpc_rqst *req, u32 *p, struct portmap_args *map)
 309 {
 310         dprintk("RPC: xdr_encode_mapping(%u, %u, %u, %u)\n",
 311                 map->pm_prog, map->pm_vers, map->pm_prot, map->pm_port);
 312         *p++ = htonl(map->pm_prog);
 313         *p++ = htonl(map->pm_vers);
 314         *p++ = htonl(map->pm_prot);
 315         *p++ = htonl(map->pm_port);
 316
 317         req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
 318         return 0;
 319 }
 320
 321 static int xdr_decode_port(struct rpc_rqst *req, u32 *p, unsigned short *portp)
 322 {
 323         *portp = (unsigned short) ntohl(*p++);
 324         return 0;
 325 }
 326
 327 static int xdr_decode_bool(struct rpc_rqst *req, u32 *p, unsigned int *boolp)
 328 {
 329         *boolp = (unsigned int) ntohl(*p++);
 330         return 0;
 331 }
 332
 333 static struct rpc_procinfo      pmap_procedures[] = {
 334 [PMAP_SET] = {
 335           .p_proc               = PMAP_SET,
 336           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 337           .p_decode             = (kxdrproc_t) xdr_decode_bool,
 338           .p_bufsiz             = 4,
 339           .p_count              = 1,
 340           .p_statidx            = PMAP_SET,
 341           .p_name               = "SET",
 342         },
 343 [PMAP_UNSET] = {
 344           .p_proc               = PMAP_UNSET,
 345           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 346           .p_decode             = (kxdrproc_t) xdr_decode_bool,
 347           .p_bufsiz             = 4,
 348           .p_count              = 1,
 349           .p_statidx            = PMAP_UNSET,
 350           .p_name               = "UNSET",
 351         },
 352 [PMAP_GETPORT] = {
 353           .p_proc               = PMAP_GETPORT,
 354           .p_encode             = (kxdrproc_t) xdr_encode_mapping,
 355           .p_decode             = (kxdrproc_t) xdr_decode_port,
 356           .p_bufsiz             = 4,
 357           .p_count              = 1,
 358           .p_statidx            = PMAP_GETPORT,
 359           .p_name               = "GETPORT",
 360         },
 361 };
 362
 363 static struct rpc_version       pmap_version2 = {
 364         .number         = 2,
 365         .nrprocs        = 4,
 366         .procs          = pmap_procedures
 367 };
 368
 369 static struct rpc_version *     pmap_version[] = {
 370         NULL,
 371         NULL,
 372         &pmap_version2
 373 };
 374
 375 static struct rpc_stat          pmap_stats;
 376
 377 static struct rpc_program       pmap_program = {
 378         .name           = "portmap",
 379         .number         = RPC_PMAP_PROGRAM,
 380         .nrvers         = ARRAY_SIZE(pmap_version),
 381         .version        = pmap_version,
 382         .stats          = &pmap_stats,
 383 };