diff mbox

[5/8] libnsdb: Add debugging message near ldap_modify_ext_s(3) call sites

Message ID 20121129015008.2497.13459.stgit@seurat.1015granger.net
State Accepted
Headers show

Commit Message

Chuck Lever Nov. 29, 2012, 1:50 a.m. UTC 
Enhance observability when NSDB tools use the "-d" command line
switch.

Clean up: simplify the structure and array initialization in ldap.c.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 src/libnsdb/administrator.c |   67 +++++++++++-----
 src/libnsdb/ldap.c          |  175 +++++++++++++++++++++++--------------------
 2 files changed, 137 insertions(+), 105 deletions(-)
diff mbox

Patch

diff --git a/src/libnsdb/administrator.c b/src/libnsdb/administrator.c
index 5f0c574..d159d2e 100644
--- a/src/libnsdb/administrator.c
+++ b/src/libnsdb/administrator.c
@@ -123,6 +123,47 @@  __nsdb_search_nsdb_nofilter_s(const char *func, LDAP *ld, const char *base,
 	__nsdb_search_nsdb_nofilter_s(__func__, ld, base, response)
 
 /**
+ * Modify a FedFS-related record on an NSDB
+ *
+ * @param func NUL-terminated C string containing a function name
+ * @param ld an initialized LDAP server descriptor
+ * @param dn a NUL-terminated C string containing DN of NSDB container entry
+ * @param mods filled-in LDAP modification array
+ * @param ldap_err OUT: possibly an LDAP error code
+ * @return an LDAP result code
+ */
+static int
+__nsdb_modify_nsdb_s(const char *func, LDAP *ld, const char *dn, LDAPMod **mods,
+		unsigned int *ldap_err)
+{
+	char *uri;
+	int rc;
+
+	if (ldap_get_option(ld, LDAP_OPT_URI, &uri) == LDAP_OPT_SUCCESS) {
+		xlog(D_CALL, "%s: modifying %s on %s", func, dn, uri);
+		ldap_memfree(uri);
+	} else
+		xlog(D_CALL, "%s: modifying %s", func, dn);
+
+	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
+	if (rc != LDAP_SUCCESS) {
+		xlog(D_GENERAL, "%s: Failed to update %s: %s",
+			func, dn, ldap_err2string(rc));
+		*ldap_err = rc;
+		return FEDFS_ERR_NSDB_LDAP_VAL;
+	}
+
+	xlog(D_CALL, "%s: Successfully updated %s", func, dn);
+	return FEDFS_OK;
+}
+
+/**
+ * Hide the __func__ argument at call sites
+ */
+#define nsdb_modify_nsdb_s(ld, dn, mods, ldaperr) \
+	__nsdb_modify_nsdb_s(__func__, ld, dn, mods, ldaperr)
+
+/**
  * Construct the DN of an FSN entry
  *
  * @param nce NUL-terminated C string containing DN of NSDB container entry
@@ -1155,7 +1196,7 @@  nsdb_add_nci_attributes_s(LDAP *ld, const char *context,
 	char *ocvals[2], *ncevals[2];
 	LDAPMod *mods[3];
 	LDAPMod mod[2];
-	int i, rc;
+	int i;
 
 	for (i = 0; i < 2; i++)
 		mods[i] = &mod[i];
@@ -1167,16 +1208,7 @@  nsdb_add_nci_attributes_s(LDAP *ld, const char *context,
 				"fedfsNceDN", ncevals, nce);
 	mods[i] = NULL;
 
-	rc = ldap_modify_ext_s(ld, context, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "%s: Failed to update %s: %s",
-			__func__, context, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-
-	xlog(D_CALL, "%s: Successfully updated %s", __func__, context);
-	return FEDFS_OK;
+	return nsdb_modify_nsdb_s(ld, context, mods, ldap_err);
 }
 
 /**
@@ -1240,7 +1272,7 @@  nsdb_remove_nci_attributes_s(LDAP *ld, const char *context,
 	LDAPMod *mods[3];
 	char *ocvals[2];
 	LDAPMod mod[2];
-	int i, rc;
+	int i;
 
 	for (i = 0; i < 2; i++)
 		mods[i] = &mod[i];
@@ -1252,16 +1284,7 @@  nsdb_remove_nci_attributes_s(LDAP *ld, const char *context,
 				"fedfsNceDN", NULL, NULL);
 	mods[i] = NULL;
 
-	rc = ldap_modify_ext_s(ld, context, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "%s: Failed to update %s: %s",
-			__func__, context, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-
-	xlog(D_CALL, "%s: Successfully updated %s", __func__, context);
-	return FEDFS_OK;
+	return nsdb_modify_nsdb_s(ld, context, mods, ldap_err);
 }
 
 /**
diff --git a/src/libnsdb/ldap.c b/src/libnsdb/ldap.c
index f2a47c4..5ede0d3 100644
--- a/src/libnsdb/ldap.c
+++ b/src/libnsdb/ldap.c
@@ -66,6 +66,69 @@  nsdb_printable_scope(int scope)
 }
 
 /**
+ * Map LDAPMod operation to a printable string
+ *
+ * @param op LDAPMod operation
+ * @return static NUL-terminated C string containing operation name
+ */
+static const char *
+nsdb_printable_ldap_mod_op(int op)
+{
+	switch (op & LDAP_MOD_OP) {
+	case LDAP_MOD_ADD:
+		return "add";
+	case LDAP_MOD_DELETE:
+		return "delete";
+	case LDAP_MOD_REPLACE:
+		return "replace";
+	}
+	return "modify";
+}
+
+/**
+ * Modify a FedFS-related record on an NSDB
+ *
+ * @param func NUL-terminated C string containing a function name
+ * @param ld an initialized LDAP server descriptor
+ * @param dn a NUL-terminated C string containing DN of NSDB container entry
+ * @param mod filled-in LDAP modification argument
+ * @param ldap_err OUT: possibly an LDAP error code
+ * @return an LDAP result code
+ */
+static int
+__nsdb_modify_nsdb_s(const char *func, LDAP *ld, const char *dn, LDAPMod *mod,
+		unsigned int *ldap_err)
+{
+	char *uri, *attribute = mod->mod_type;
+	LDAPMod *mods[] = { mod, NULL };
+	int rc;
+
+	if (ldap_get_option(ld, LDAP_OPT_URI, &uri) == LDAP_OPT_SUCCESS) {
+		xlog(D_CALL, "%s: modifying %s (%s) at %s",
+			func, dn, attribute, uri);
+		ldap_memfree(uri);
+	} else
+		xlog(D_CALL, "%s: modifying %s (%s)",
+			func, dn, attribute);
+
+	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
+	if (rc != LDAP_SUCCESS) {
+		xlog(D_GENERAL, "%s: failed to %s attribute %s: %s",
+				func, nsdb_printable_ldap_mod_op(mod->mod_op),
+				attribute, ldap_err2string(rc));
+		*ldap_err = (unsigned int)rc;
+		return FEDFS_ERR_NSDB_LDAP_VAL;
+	}
+	return FEDFS_OK;
+}
+
+/**
+ * Hide the __func__ argument at call sites
+ */
+#define nsdb_modify_nsdb_s(ld, dn, mod, ldaperr) \
+	__nsdb_modify_nsdb_s(__func__, ld, dn, mod, ldaperr)
+
+/**
  * Read a password from stdin, disabling character echo
  *
  * @return a NUL-terminated C string containing the typed-in password.  Caller must free the string with free(3)
@@ -618,28 +681,14 @@  nsdb_add_attribute_s(LDAP *ld, const char *dn,
 		const char *attribute, struct berval *value,
 		unsigned int *ldap_err)
 {
-	struct berval *attrvals[2];
-	LDAPMod mod[1], *mods[2];
-	int rc;
-
-	attrvals[0] = value;
-	attrvals[1] = NULL;
-
-	mod[0].mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES;
-	mod[0].mod_type = (char *)attribute;
-	mod[0].mod_bvalues = attrvals;
-
-	mods[0] = &mod[0];
-	mods[1] = NULL;
-
-	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "Failed to add attribute %s: %s",
-				attribute, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-	return FEDFS_OK;
+	struct berval *attrvals[] = { value, NULL };
+	LDAPMod mod = {
+		.mod_op		= LDAP_MOD_ADD | LDAP_MOD_BVALUES,
+		.mod_type	= (char *)attribute,
+		.mod_bvalues	= attrvals,
+	};
+
+	return nsdb_modify_nsdb_s(ld, dn, &mod, ldap_err);
 }
 
 /**
@@ -669,28 +718,14 @@  FedFsStatus
 nsdb_modify_attribute_s(LDAP *ld, const char *dn, const char *attribute,
 		struct berval *value, unsigned int *ldap_err)
 {
-	struct berval *attrvals[2];
-	LDAPMod mod[1], *mods[2];
-	int rc;
-
-	attrvals[0] = value;
-	attrvals[1] = NULL;
-
-	mod[0].mod_op = LDAP_MOD_REPLACE | LDAP_MOD_BVALUES;
-	mod[0].mod_type = (char *)attribute;
-	mod[0].mod_bvalues = attrvals;
-
-	mods[0] = &mod[0];
-	mods[1] = NULL;
-
-	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "Failed to replace attribute %s: %s",
-				attribute, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-	return FEDFS_OK;
+	struct berval *attrvals[] = { value, NULL };
+	LDAPMod mod = {
+		.mod_op		= LDAP_MOD_REPLACE | LDAP_MOD_BVALUES,
+		.mod_type	= (char *)attribute,
+		.mod_bvalues	= attrvals,
+	};
+
+	return nsdb_modify_nsdb_s(ld, dn, &mod, ldap_err);
 }
 
 /**
@@ -723,28 +758,14 @@  FedFsStatus
 nsdb_delete_attribute_s(LDAP *ld, const char *dn, const char *attribute,
 		struct berval *value, unsigned int *ldap_err)
 {
-	struct berval *attrvals[2];
-	LDAPMod mod[1], *mods[2];
-	int rc;
-
-	attrvals[0] = value;
-	attrvals[1] = NULL;
-
-	mod[0].mod_op = LDAP_MOD_DELETE | LDAP_MOD_BVALUES;
-	mod[0].mod_type = (char *)attribute;
-	mod[0].mod_bvalues = attrvals;
-
-	mods[0] = &mod[0];
-	mods[1] = NULL;
-
-	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "%s: Failed to delete attribute %s: %s",
-				__func__, attribute, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-	return FEDFS_OK;
+	struct berval *attrvals[] = { value, NULL };
+	LDAPMod mod = {
+		.mod_op		= LDAP_MOD_DELETE | LDAP_MOD_BVALUES,
+		.mod_type	= (char *)attribute,
+		.mod_bvalues	= attrvals,
+	};
+
+	return nsdb_modify_nsdb_s(ld, dn, &mod, ldap_err);
 }
 
 /**
@@ -779,24 +800,12 @@  FedFsStatus
 nsdb_delete_attribute_all_s(LDAP *ld, const char *dn,
 		const char *attribute, unsigned int *ldap_err)
 {
-	LDAPMod mod[1], *mods[2];
-	int rc;
-
-	mod[0].mod_op = LDAP_MOD_DELETE;
-	mod[0].mod_type = (char *)attribute;
-	mod[0].mod_values = NULL;
-
-	mods[0] = &mod[0];
-	mods[1] = NULL;
+	LDAPMod mod = {
+		.mod_op		= LDAP_MOD_DELETE,
+		.mod_type	= (char *)attribute,
+	};
 
-	rc = ldap_modify_ext_s(ld, dn, mods, NULL, NULL);
-	if (rc != LDAP_SUCCESS) {
-		xlog(D_GENERAL, "%s: Failed to delete attribute %s: %s",
-				__func__, attribute, ldap_err2string(rc));
-		*ldap_err = rc;
-		return FEDFS_ERR_NSDB_LDAP_VAL;
-	}
-	return FEDFS_OK;
+	return nsdb_modify_nsdb_s(ld, dn, &mod, ldap_err);
 }
 
 /**