2 * linux/net/sunrpc/svc.c
4 * High-level RPC service routines
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #include <linux/linkage.h>
10 #include <linux/sched.h>
11 #include <linux/errno.h>
12 #include <linux/net.h>
16 #include <linux/sunrpc/types.h>
17 #include <linux/sunrpc/xdr.h>
18 #include <linux/sunrpc/stats.h>
19 #include <linux/sunrpc/svcsock.h>
20 #include <linux/sunrpc/clnt.h>
22 #define RPCDBG_FACILITY RPCDBG_SVCDSP
23 #define RPC_PARANOIA 1
26 * Create an RPC service
29 svc_create(struct svc_program
*prog
, unsigned int bufsize
)
31 struct svc_serv
*serv
;
35 if (!(serv
= kzalloc(sizeof(*serv
), GFP_KERNEL
)))
37 serv
->sv_name
= prog
->pg_name
;
38 serv
->sv_program
= prog
;
39 serv
->sv_nrthreads
= 1;
40 serv
->sv_stats
= prog
->pg_stats
;
41 serv
->sv_bufsz
= bufsize
? bufsize
: 4096;
44 prog
->pg_lovers
= prog
->pg_nvers
-1;
45 for (vers
=0; vers
<prog
->pg_nvers
; vers
++)
46 if (prog
->pg_vers
[vers
]) {
47 prog
->pg_hivers
= vers
;
48 if (prog
->pg_lovers
> vers
)
49 prog
->pg_lovers
= vers
;
50 if (prog
->pg_vers
[vers
]->vs_xdrsize
> xdrsize
)
51 xdrsize
= prog
->pg_vers
[vers
]->vs_xdrsize
;
55 serv
->sv_xdrsize
= xdrsize
;
56 INIT_LIST_HEAD(&serv
->sv_threads
);
57 INIT_LIST_HEAD(&serv
->sv_sockets
);
58 INIT_LIST_HEAD(&serv
->sv_tempsocks
);
59 INIT_LIST_HEAD(&serv
->sv_permsocks
);
60 spin_lock_init(&serv
->sv_lock
);
62 /* Remove any stale portmap registrations */
63 svc_register(serv
, 0, 0);
69 * Destroy an RPC service
72 svc_destroy(struct svc_serv
*serv
)
74 struct svc_sock
*svsk
;
76 dprintk("RPC: svc_destroy(%s, %d)\n",
77 serv
->sv_program
->pg_name
,
80 if (serv
->sv_nrthreads
) {
81 if (--(serv
->sv_nrthreads
) != 0) {
82 svc_sock_update_bufs(serv
);
86 printk("svc_destroy: no threads for serv=%p!\n", serv
);
88 while (!list_empty(&serv
->sv_tempsocks
)) {
89 svsk
= list_entry(serv
->sv_tempsocks
.next
,
92 svc_delete_socket(svsk
);
94 while (!list_empty(&serv
->sv_permsocks
)) {
95 svsk
= list_entry(serv
->sv_permsocks
.next
,
98 svc_delete_socket(svsk
);
101 cache_clean_deferred(serv
);
103 /* Unregister service with the portmapper */
104 svc_register(serv
, 0, 0);
109 * Allocate an RPC server's buffer space.
110 * We allocate pages and place them in rq_argpages.
113 svc_init_buffer(struct svc_rqst
*rqstp
, unsigned int size
)
118 if (size
> RPCSVC_MAXPAYLOAD
)
119 size
= RPCSVC_MAXPAYLOAD
;
120 pages
= 2 + (size
+ PAGE_SIZE
-1) / PAGE_SIZE
;
121 rqstp
->rq_argused
= 0;
122 rqstp
->rq_resused
= 0;
124 BUG_ON(pages
> RPCSVC_MAXPAGES
);
126 struct page
*p
= alloc_page(GFP_KERNEL
);
129 rqstp
->rq_argpages
[arghi
++] = p
;
132 rqstp
->rq_arghi
= arghi
;
137 * Release an RPC server buffer
140 svc_release_buffer(struct svc_rqst
*rqstp
)
142 while (rqstp
->rq_arghi
)
143 put_page(rqstp
->rq_argpages
[--rqstp
->rq_arghi
]);
144 while (rqstp
->rq_resused
) {
145 if (rqstp
->rq_respages
[--rqstp
->rq_resused
] == NULL
)
147 put_page(rqstp
->rq_respages
[rqstp
->rq_resused
]);
149 rqstp
->rq_argused
= 0;
153 * Create a server thread
156 svc_create_thread(svc_thread_fn func
, struct svc_serv
*serv
)
158 struct svc_rqst
*rqstp
;
161 rqstp
= kzalloc(sizeof(*rqstp
), GFP_KERNEL
);
165 init_waitqueue_head(&rqstp
->rq_wait
);
167 if (!(rqstp
->rq_argp
= kmalloc(serv
->sv_xdrsize
, GFP_KERNEL
))
168 || !(rqstp
->rq_resp
= kmalloc(serv
->sv_xdrsize
, GFP_KERNEL
))
169 || !svc_init_buffer(rqstp
, serv
->sv_bufsz
))
172 serv
->sv_nrthreads
++;
173 rqstp
->rq_server
= serv
;
174 error
= kernel_thread((int (*)(void *)) func
, rqstp
, 0);
177 svc_sock_update_bufs(serv
);
183 svc_exit_thread(rqstp
);
188 * Destroy an RPC server thread
191 svc_exit_thread(struct svc_rqst
*rqstp
)
193 struct svc_serv
*serv
= rqstp
->rq_server
;
195 svc_release_buffer(rqstp
);
196 kfree(rqstp
->rq_resp
);
197 kfree(rqstp
->rq_argp
);
198 kfree(rqstp
->rq_auth_data
);
201 /* Release the server */
207 * Register an RPC service with the local portmapper.
208 * To unregister a service, call this routine with
209 * proto and port == 0.
212 svc_register(struct svc_serv
*serv
, int proto
, unsigned short port
)
214 struct svc_program
*progp
;
216 int i
, error
= 0, dummy
;
218 progp
= serv
->sv_program
;
220 dprintk("RPC: svc_register(%s, %s, %d)\n",
221 progp
->pg_name
, proto
== IPPROTO_UDP
? "udp" : "tcp", port
);
224 clear_thread_flag(TIF_SIGPENDING
);
226 for (i
= 0; i
< progp
->pg_nvers
; i
++) {
227 if (progp
->pg_vers
[i
] == NULL
)
229 error
= rpc_register(progp
->pg_prog
, i
, proto
, port
, &dummy
);
232 if (port
&& !dummy
) {
239 spin_lock_irqsave(¤t
->sighand
->siglock
, flags
);
241 spin_unlock_irqrestore(¤t
->sighand
->siglock
, flags
);
248 * Process the RPC request.
251 svc_process(struct svc_serv
*serv
, struct svc_rqst
*rqstp
)
253 struct svc_program
*progp
;
254 struct svc_version
*versp
= NULL
; /* compiler food */
255 struct svc_procedure
*procp
= NULL
;
256 struct kvec
* argv
= &rqstp
->rq_arg
.head
[0];
257 struct kvec
* resv
= &rqstp
->rq_res
.head
[0];
260 u32 dir
, prog
, vers
, proc
;
261 __be32 auth_stat
, rpc_stat
;
263 __be32
*accept_statp
;
265 rpc_stat
= rpc_success
;
267 if (argv
->iov_len
< 6*4)
270 /* setup response xdr_buf.
271 * Initially it has just one page
273 svc_take_page(rqstp
); /* must succeed */
274 resv
->iov_base
= page_address(rqstp
->rq_respages
[0]);
276 rqstp
->rq_res
.pages
= rqstp
->rq_respages
+1;
277 rqstp
->rq_res
.len
= 0;
278 rqstp
->rq_res
.page_base
= 0;
279 rqstp
->rq_res
.page_len
= 0;
280 rqstp
->rq_res
.buflen
= PAGE_SIZE
;
281 rqstp
->rq_res
.tail
[0].iov_base
= NULL
;
282 rqstp
->rq_res
.tail
[0].iov_len
= 0;
283 /* Will be turned off only in gss privacy case: */
284 rqstp
->rq_sendfile_ok
= 1;
285 /* tcp needs a space for the record length... */
286 if (rqstp
->rq_prot
== IPPROTO_TCP
)
289 rqstp
->rq_xid
= svc_getu32(argv
);
290 svc_putu32(resv
, rqstp
->rq_xid
);
292 dir
= svc_getnl(argv
);
293 vers
= svc_getnl(argv
);
295 /* First words of reply: */
296 svc_putnl(resv
, 1); /* REPLY */
298 if (dir
!= 0) /* direction != CALL */
300 if (vers
!= 2) /* RPC version number */
303 /* Save position in case we later decide to reject: */
304 accept_statp
= resv
->iov_base
+ resv
->iov_len
;
306 svc_putnl(resv
, 0); /* ACCEPT */
308 rqstp
->rq_prog
= prog
= svc_getnl(argv
); /* program number */
309 rqstp
->rq_vers
= vers
= svc_getnl(argv
); /* version number */
310 rqstp
->rq_proc
= proc
= svc_getnl(argv
); /* procedure number */
312 progp
= serv
->sv_program
;
314 for (progp
= serv
->sv_program
; progp
; progp
= progp
->pg_next
)
315 if (prog
== progp
->pg_prog
)
319 * Decode auth data, and add verifier to reply buffer.
320 * We do this before anything else in order to get a decent
323 auth_res
= svc_authenticate(rqstp
, &auth_stat
);
324 /* Also give the program a chance to reject this call: */
325 if (auth_res
== SVC_OK
&& progp
) {
326 auth_stat
= rpc_autherr_badcred
;
327 auth_res
= progp
->pg_authenticate(rqstp
);
333 rpc_stat
= rpc_garbage_args
;
336 rpc_stat
= rpc_system_err
;
349 if (vers
>= progp
->pg_nvers
||
350 !(versp
= progp
->pg_vers
[vers
]))
353 procp
= versp
->vs_proc
+ proc
;
354 if (proc
>= versp
->vs_nproc
|| !procp
->pc_func
)
356 rqstp
->rq_server
= serv
;
357 rqstp
->rq_procinfo
= procp
;
359 /* Syntactic check complete */
360 serv
->sv_stats
->rpccnt
++;
362 /* Build the reply header. */
363 statp
= resv
->iov_base
+resv
->iov_len
;
364 svc_putnl(resv
, RPC_SUCCESS
);
366 /* Bump per-procedure stats counter */
369 /* Initialize storage for argp and resp */
370 memset(rqstp
->rq_argp
, 0, procp
->pc_argsize
);
371 memset(rqstp
->rq_resp
, 0, procp
->pc_ressize
);
373 /* un-reserve some of the out-queue now that we have a
374 * better idea of reply size
376 if (procp
->pc_xdrressize
)
377 svc_reserve(rqstp
, procp
->pc_xdrressize
<<2);
379 /* Call the function that processes the request. */
380 if (!versp
->vs_dispatch
) {
381 /* Decode arguments */
382 xdr
= procp
->pc_decode
;
383 if (xdr
&& !xdr(rqstp
, argv
->iov_base
, rqstp
->rq_argp
))
386 *statp
= procp
->pc_func(rqstp
, rqstp
->rq_argp
, rqstp
->rq_resp
);
389 if (*statp
== rpc_success
&& (xdr
= procp
->pc_encode
)
390 && !xdr(rqstp
, resv
->iov_base
+resv
->iov_len
, rqstp
->rq_resp
)) {
391 dprintk("svc: failed to encode reply\n");
392 /* serv->sv_stats->rpcsystemerr++; */
393 *statp
= rpc_system_err
;
396 dprintk("svc: calling dispatcher\n");
397 if (!versp
->vs_dispatch(rqstp
, statp
)) {
398 /* Release reply info */
399 if (procp
->pc_release
)
400 procp
->pc_release(rqstp
, NULL
, rqstp
->rq_resp
);
405 /* Check RPC status result */
406 if (*statp
!= rpc_success
)
407 resv
->iov_len
= ((void*)statp
) - resv
->iov_base
+ 4;
409 /* Release reply info */
410 if (procp
->pc_release
)
411 procp
->pc_release(rqstp
, NULL
, rqstp
->rq_resp
);
413 if (procp
->pc_encode
== NULL
)
417 if (svc_authorise(rqstp
))
419 return svc_send(rqstp
);
422 svc_authorise(rqstp
); /* doesn't hurt to call this twice */
423 dprintk("svc: svc_process dropit\n");
429 printk("svc: short len %Zd, dropping request\n", argv
->iov_len
);
431 goto dropit
; /* drop request */
435 printk("svc: bad direction %d, dropping request\n", dir
);
437 serv
->sv_stats
->rpcbadfmt
++;
438 goto dropit
; /* drop request */
441 serv
->sv_stats
->rpcbadfmt
++;
442 svc_putnl(resv
, 1); /* REJECT */
443 svc_putnl(resv
, 0); /* RPC_MISMATCH */
444 svc_putnl(resv
, 2); /* Only RPCv2 supported */
449 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat
));
450 serv
->sv_stats
->rpcbadauth
++;
451 /* Restore write pointer to location of accept status: */
452 xdr_ressize_check(rqstp
, accept_statp
);
453 svc_putnl(resv
, 1); /* REJECT */
454 svc_putnl(resv
, 1); /* AUTH_ERROR */
455 svc_putnl(resv
, ntohl(auth_stat
)); /* status */
459 dprintk("svc: unknown program %d\n", prog
);
460 serv
->sv_stats
->rpcbadfmt
++;
461 svc_putnl(resv
, RPC_PROG_UNAVAIL
);
466 printk("svc: unknown version (%d)\n", vers
);
468 serv
->sv_stats
->rpcbadfmt
++;
469 svc_putnl(resv
, RPC_PROG_MISMATCH
);
470 svc_putnl(resv
, progp
->pg_lovers
);
471 svc_putnl(resv
, progp
->pg_hivers
);
476 printk("svc: unknown procedure (%d)\n", proc
);
478 serv
->sv_stats
->rpcbadfmt
++;
479 svc_putnl(resv
, RPC_PROC_UNAVAIL
);
484 printk("svc: failed to decode args\n");
486 rpc_stat
= rpc_garbage_args
;
488 serv
->sv_stats
->rpcbadfmt
++;
489 svc_putnl(resv
, ntohl(rpc_stat
));
This page took 0.04212 seconds and 6 git commands to generate.