Add a comment to the r345818 patch to explain why cl_refs is initialized to 2.

PR: 235582 MFC after: 2 weeks
svn path=/head/; revision=345828
2019-04-03 03:50:16 +00:00 · 2019-04-03 03:50:16 +00:00 · 1406895958 · 2020-12-20 02:59:44 +00:00
commit 1406895958
parent b0e14530a0
1 changed files with 5 additions and 0 deletions
--- a/sys/rpc/rpcsec_gss/svc_rpcsec_gss.c
+++ b/sys/rpc/rpcsec_gss/svc_rpcsec_gss.c
@ -568,6 +568,11 @@ svc_rpc_gss_create_client(void)

 	client = mem_alloc(sizeof(struct svc_rpc_gss_client));
 	memset(client, 0, sizeof(struct svc_rpc_gss_client));
+
+	/*
+	 * Set the initial value of cl_refs to two.  One for the caller
+	 * and the other to hold onto the client structure until it expires.
+	 */
 	refcount_init(&client->cl_refs, 2);
 	sx_init(&client->cl_lock, "GSS-client");
 	getcredhostid(curthread->td_ucred, &hostid);