Apr 08

svc_process函数是一条RPC报文的处理入口. 在该函数被调用之前, RPC报文只是一段字节数组, 被放在结构体svc_rqst中. 结构体还包含了整个RPC服务器的上下文环境, 包括所有的程序和它们的过程处理器.

在svc_process函数中, RPC报文字节数组被解码, 然后交给相应的程序和过程进行处理. svc_process的处理流程大致可以分为如下(但代码中并没有按这个顺序进行处理, 而是交叉在一起, 造成了不必要的混乱):

1. RPC请求报文长度验证.
2. 解码出请求首部.
3. 装配部分响应首部.
4. 身份验证, 并将验证信息装配进首部.
5. 查找RPC程序和过程.
6. 调用过程, 处理请求. 此时响应数据已经被写入响应报文中, 或者出错.
7. 发送响应.

/*
 * Process the RPC request.
 */
int
svc_process(struct svc_rqst *rqstp)
{
	struct svc_program	*progp;
	struct svc_version	*versp = NULL;	/* compiler food */
	struct svc_procedure	*procp = NULL;
	struct kvec *		argv = &rqstp->rq_arg.head[0];
	struct kvec *		resv = &rqstp->rq_res.head[0];
	struct svc_serv		*serv = rqstp->rq_server;
	kxdrproc_t		xdr;
	__be32			*statp;
	u32			dir, prog, vers, proc;
	__be32			auth_stat, rpc_stat;
	int			auth_res;
	__be32			*reply_statp;
 
	rpc_stat = rpc_success;
 
	if (argv->iov_len < 6*4)
		goto err_short_len;

RPC消息的首部至少有6个XDR: xid, dir, rpcvers, prog, progvers, proc, 而每一个XDR的长度是4个字节.

	/* setup response xdr_buf.
	 * Initially it has just one page
	 */
	rqstp->rq_resused = 1;
	resv->iov_base = page_address(rqstp->rq_respages[0]);
	resv->iov_len = 0;
	rqstp->rq_res.pages = rqstp->rq_respages + 1;
	rqstp->rq_res.len = 0;
	rqstp->rq_res.page_base = 0;
	rqstp->rq_res.page_len = 0;
	rqstp->rq_res.buflen = PAGE_SIZE;
	rqstp->rq_res.tail[0].iov_base = NULL;
	rqstp->rq_res.tail[0].iov_len = 0;
	/* Will be turned off only in gss privacy case: */
	rqstp->rq_splice_ok = 1;
 
	/* Setup reply header */
	rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
 
	rqstp->rq_xid = svc_getu32(argv);
	svc_putu32(resv, rqstp->rq_xid);

RPC响应报文的xid字段必须和请求报文相同.

	dir  = svc_getnl(argv);
	vers = svc_getnl(argv);
 
	/* First words of reply: */
	svc_putnl(resv, 1);		/* REPLY */
 
	if (dir != 0)		/* direction != CALL */
		goto err_bad_dir;
	if (vers != 2)		/* RPC version number */
		goto err_bad_rpc;
 
	/* Save position in case we later decide to reject: */
	reply_statp = resv->iov_base + resv->iov_len;
 
	svc_putnl(resv, 0);		/* ACCEPT */
 
	rqstp->rq_prog = prog = svc_getnl(argv);	/* program number */
	rqstp->rq_vers = vers = svc_getnl(argv);	/* version number */
	rqstp->rq_proc = proc = svc_getnl(argv);	/* procedure number */
 
	progp = serv->sv_program;
 
	for (progp = serv->sv_program; progp; progp = progp->pg_next)
		if (prog == progp->pg_prog)
			break;

查找处理该请求的程序.

	/*
	 * Decode auth data, and add verifier to reply buffer.
	 * We do this before anything else in order to get a decent
	 * auth verifier.
	 */
	auth_res = svc_authenticate(rqstp, &auth_stat);
	/* Also give the program a chance to reject this call: */
	if (auth_res == SVC_OK && progp) {
		auth_stat = rpc_autherr_badcred;
		auth_res = progp->pg_authenticate(rqstp);
	}
	switch (auth_res) {
	case SVC_OK:
		break;
	case SVC_GARBAGE:
		goto err_garbage;
	case SVC_SYSERR:
		rpc_stat = rpc_system_err;
		goto err_bad;
	case SVC_DENIED:
		goto err_bad_auth;
	case SVC_DROP:
		goto dropit;
	case SVC_COMPLETE:
		goto sendit;
	}

身份验证.

	if (progp == NULL)
		goto err_bad_prog;
 
	if (vers >= progp->pg_nvers ||
	  !(versp = progp->pg_vers[vers]))
		goto err_bad_vers;
 
	procp = versp->vs_proc + proc;

获取处理该请求的过程的指针. 所有的过程被保存在一个数组里, 过程的编号就是数组的下标. 这种哈希方式可以快速地进行查找.

	if (proc >= versp->vs_nproc || !procp->pc_func)
		goto err_bad_proc;
	rqstp->rq_server   = serv;
	rqstp->rq_procinfo = procp;
 
	/* Syntactic check complete */
	serv->sv_stats->rpccnt++;
 
	/* Build the reply header. */
	statp = resv->iov_base +resv->iov_len;
	svc_putnl(resv, RPC_SUCCESS);
 
	/* Bump per-procedure stats counter */
	procp->pc_count++;
 
	/* Initialize storage for argp and resp */
	memset(rqstp->rq_argp, 0, procp->pc_argsize);
	memset(rqstp->rq_resp, 0, procp->pc_ressize);
 
	/* un-reserve some of the out-queue now that we have a
	 * better idea of reply size
	 */
	if (procp->pc_xdrressize)
		svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
 
	/* Call the function that processes the request. */
	if (!versp->vs_dispatch) {
		/* Decode arguments */
		xdr = procp->pc_decode;
		if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
			goto err_garbage;
 
		*statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
 
		/* Encode reply */
		if (*statp == rpc_drop_reply) {
			if (procp->pc_release)
				procp->pc_release(rqstp, NULL, rqstp->rq_resp);
			goto dropit;
		}
		if (*statp == rpc_success && (xdr = procp->pc_encode)
		 && !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
			dprintk("svc: failed to encode reply\n");
			/* serv->sv_stats->rpcsystemerr++; */
			*statp = rpc_system_err;
		}

如果一个RPC程序没有实现vs_dispatch接口, 那么将使用默认的方式进行处理: 首先解码请求消息, 然后进行处理, 最后编码响应.

	} else {
		dprintk("svc: calling dispatcher\n");
		if (!versp->vs_dispatch(rqstp, statp)) {
			/* Release reply info */
			if (procp->pc_release)
				procp->pc_release(rqstp, NULL, rqstp->rq_resp);
			goto dropit;
		}
	}

即使是自定义的vs_dispatch, 执行的步骤和默认的也几乎是相同, 只是进行了额外的工作.

	/* Check RPC status result */
	if (*statp != rpc_success)
		resv->iov_len = ((void*)statp)  - resv->iov_base + 4;
 
	/* Release reply info */
	if (procp->pc_release)
		procp->pc_release(rqstp, NULL, rqstp->rq_resp);
 
	if (procp->pc_encode == NULL)
		goto dropit;
 
 sendit:
	if (svc_authorise(rqstp))
		goto dropit;
	return svc_send(rqstp);

接着是一些带有标号的语句段落, 用于错误处理. 在之前的代码中, 一旦出现错误, 将跳转到下面的任何一段代码进行处理.

dropit:
	svc_authorise(rqstp);	/* doesn't hurt to call this twice */
	dprintk("svc: svc_process dropit\n");
	svc_drop(rqstp);
	return 0;
 
err_short_len:
	svc_printk(rqstp, "short len %Zd, dropping request\n",
			argv->iov_len);
 
	goto dropit;			/* drop request */
 
err_bad_dir:
	svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
 
	serv->sv_stats->rpcbadfmt++;
	goto dropit;			/* drop request */
 
err_bad_rpc:
	serv->sv_stats->rpcbadfmt++;
	svc_putnl(resv, 1);	/* REJECT */
	svc_putnl(resv, 0);	/* RPC_MISMATCH */
	svc_putnl(resv, 2);	/* Only RPCv2 supported */
	svc_putnl(resv, 2);
	goto sendit;
 
err_bad_auth:
	dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
	serv->sv_stats->rpcbadauth++;
	/* Restore write pointer to location of accept status: */
	xdr_ressize_check(rqstp, reply_statp);
	svc_putnl(resv, 1);	/* REJECT */
	svc_putnl(resv, 1);	/* AUTH_ERROR */
	svc_putnl(resv, ntohl(auth_stat));	/* status */
	goto sendit;
 
err_bad_prog:
	dprintk("svc: unknown program %d\n", prog);
	serv->sv_stats->rpcbadfmt++;
	svc_putnl(resv, RPC_PROG_UNAVAIL);
	goto sendit;
 
err_bad_vers:
	svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
		       vers, prog, progp->pg_name);
 
	serv->sv_stats->rpcbadfmt++;
	svc_putnl(resv, RPC_PROG_MISMATCH);
	svc_putnl(resv, progp->pg_lovers);
	svc_putnl(resv, progp->pg_hivers);
	goto sendit;
 
err_bad_proc:
	svc_printk(rqstp, "unknown procedure (%d)\n", proc);
 
	serv->sv_stats->rpcbadfmt++;
	svc_putnl(resv, RPC_PROC_UNAVAIL);
	goto sendit;
 
err_garbage:
	svc_printk(rqstp, "failed to decode args\n");
 
	rpc_stat = rpc_garbage_args;
err_bad:
	serv->sv_stats->rpcbadfmt++;
	svc_putnl(resv, ntohl(rpc_stat));
	goto sendit;
}

可以看出, 代码编写本身其实非常简单, 只要你了解了处理步骤. 在实现一段代码的过程中, 数据结构的设计和代码的组织是最困难的部分. 分析的容易做的难.

Related posts:

  1. svc_recv函数实现详解
  2. C语言网络程序惯用法-参数传递
  3. RPC程序的一般结构 – nfsd
  4. sunrpc 函数功能分析
  5. 用SDL在Linux实现图像的移动

Written by benegg at 2009-04-08 08:49:48 | Views: 5976 | tags: ,

One Response to “svc_process函数”

  1. 1. benegg blog - sunrpc 函数功能分析 Says:

    [...] 在本函数中解码请求, 处理, 编码响应, 发送响应. 详见: svc_process函数. [...]

Pages:

Leave a Reply

必须登录, 或者浏览器开启JavaScript支持才可以评论!