s4-ldb: add a LDB_FLG_ENABLE_TRACING for full ldb tracing
authorAndrew Tridgell <tridge@samba.org>
Mon, 21 Sep 2009 22:24:14 +0000 (15:24 -0700)
committerAndrew Tridgell <tridge@samba.org>
Mon, 21 Sep 2009 22:27:05 +0000 (15:27 -0700)
When LDB_FLG_ENABLE_TRACING is set ldb will send full traces
of all operations and results

source4/lib/ldb/common/ldb.c
source4/lib/ldb/common/ldb_debug.c
source4/lib/ldb/common/ldb_modules.c
source4/lib/ldb/include/ldb.h

index b75d837674c3c1f9bd362422632732a7c3818523..2ad5905318235f01c858ac242cbaf12fadd7a0fc 100644 (file)
@@ -622,6 +622,86 @@ int ldb_request_get_status(struct ldb_request *req)
        return req->handle->status;
 }
 
+
+/*
+  trace a ldb request
+*/
+static void ldb_trace_request(struct ldb_context *ldb, struct ldb_request *req)
+{
+       TALLOC_CTX *tmp_ctx = talloc_new(req);
+       int i;
+
+       switch (req->operation) {
+       case LDB_SEARCH:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: SEARCH");
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " dn: %s",
+                         ldb_dn_get_linearized(req->op.search.base));
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " scope: %s", 
+                         req->op.search.scope==LDB_SCOPE_BASE?"base":
+                         req->op.search.scope==LDB_SCOPE_ONELEVEL?"one":
+                         req->op.search.scope==LDB_SCOPE_SUBTREE?"sub":"UNKNOWN");
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " expr: %s", 
+                         ldb_filter_from_tree(tmp_ctx, req->op.search.tree));
+               for (i=0; req->op.search.attrs && req->op.search.attrs[i]; i++) {
+                       ldb_debug(ldb, LDB_DEBUG_TRACE, " attr: %s", req->op.search.attrs[i]);
+               }
+               break;
+       case LDB_DELETE:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: DELETE");
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " dn: %s", 
+                         ldb_dn_get_linearized(req->op.del.dn));
+               break;
+       case LDB_RENAME:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: RENAME");
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " olddn: %s", 
+                         ldb_dn_get_linearized(req->op.rename.olddn));
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " newdn: %s", 
+                         ldb_dn_get_linearized(req->op.rename.newdn));
+               break;
+       case LDB_EXTENDED:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: EXTENDED");
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " oid: %s", req->op.extended.oid);
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " data: %s", req->op.extended.data?"yes":"no");
+               break;
+       case LDB_ADD:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: ADD");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "%s", 
+                         ldb_ldif_message_string(req->handle->ldb, tmp_ctx, 
+                                                 LDB_CHANGETYPE_ADD, req->op.add.message));
+               break;
+       case LDB_MODIFY:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: MODIFY");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "%s", 
+                         ldb_ldif_message_string(req->handle->ldb, tmp_ctx, 
+                                                 LDB_CHANGETYPE_ADD, req->op.mod.message));
+               break;
+       case LDB_REQ_REGISTER_CONTROL:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: REGISTER_CONTROL");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "%s", 
+                         req->op.reg_control.oid);
+               break;
+       case LDB_REQ_REGISTER_PARTITION:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: REGISTER_PARTITION");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "%s", 
+                         ldb_dn_get_linearized(req->op.reg_partition.dn));
+               break;
+       default:
+               ldb_debug(ldb, LDB_DEBUG_TRACE, "ldb_trace_request: UNKNOWN(%u)", 
+                         req->operation);
+               break;
+       }
+
+       for (i=0; req->controls && req->controls[i]; i++) {
+               ldb_debug(ldb, LDB_DEBUG_TRACE, " control: %s  crit:%u  data:%s", 
+                         req->controls[i]->oid, 
+                         req->controls[i]->critical, 
+                         req->controls[i]->data?"yes":"no");
+       }
+
+       talloc_free(tmp_ctx);
+}
+
+
 /*
   start an ldb request
   NOTE: the request must be a talloc context.
@@ -639,6 +719,10 @@ int ldb_request(struct ldb_context *ldb, struct ldb_request *req)
 
        ldb_reset_err_string(ldb);
 
+       if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
+               ldb_trace_request(ldb, req);
+       }
+
        /* call the first module in the chain */
        switch (req->operation) {
        case LDB_SEARCH:
@@ -1509,3 +1593,9 @@ unsigned int ldb_get_flags(struct ldb_context *ldb)
 {
        return ldb->flags;
 }
+
+/* set the ldb flags */
+void ldb_set_flags(struct ldb_context *ldb, unsigned flags)
+{
+       ldb->flags = flags;
+}
index 7680862c2cd9485ba1470b8b71e27e54adc91f99..4612b016f6b68a03ad7889c482cfc625984021ab 100644 (file)
@@ -60,6 +60,15 @@ static void ldb_debug_stderr(void *context, enum ldb_debug_level level,
        }
 }
 
+static void ldb_debug_stderr_all(void *context, enum ldb_debug_level level, 
+                            const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
+static void ldb_debug_stderr_all(void *context, enum ldb_debug_level level, 
+                            const char *fmt, va_list ap)
+{
+       vfprintf(stderr, fmt, ap);
+       fprintf(stderr, "\n");
+}
+
 /*
   convenience function to setup debug messages on stderr
   messages of level LDB_DEBUG_WARNING and higher are printed
@@ -76,7 +85,11 @@ void ldb_debug(struct ldb_context *ldb, enum ldb_debug_level level, const char *
 {
        va_list ap;
        if (ldb->debug_ops.debug == NULL) {
-               ldb_set_debug_stderr(ldb);
+               if (ldb->flags & LDB_FLG_ENABLE_TRACING) {
+                       ldb_set_debug(ldb, ldb_debug_stderr_all, ldb);
+               } else {
+                       ldb_set_debug_stderr(ldb);
+               }
        }
        va_start(ap, fmt);
        ldb->debug_ops.debug(ldb->debug_ops.context, level, fmt, ap);
index 206b225ca83be6595fd9c9df88a6c97de2eec391..c57d0e407d22772cc1ec4090374c892583eb0f36 100644 (file)
@@ -672,6 +672,14 @@ int ldb_module_send_entry(struct ldb_request *req,
        ares->controls = talloc_steal(ares, ctrls);
        ares->error = LDB_SUCCESS;
 
+       if (req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) {
+               char *s;
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "ldb_trace_response: ENTRY");
+               s = ldb_ldif_message_string(req->handle->ldb, msg, LDB_CHANGETYPE_NONE, msg);
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "%s", s);
+               talloc_free(s);                   
+       }
+
        return req->callback(req, ares);
 }
 
@@ -697,6 +705,11 @@ int ldb_module_send_referral(struct ldb_request *req,
        ares->referral = talloc_steal(ares, ref);
        ares->error = LDB_SUCCESS;
 
+       if (req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) {
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "ldb_trace_response: REFERRAL");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "ref: %s", ref);
+       }
+
        return req->callback(req, ares);
 }
 
@@ -729,6 +742,15 @@ int ldb_module_done(struct ldb_request *req,
 
        req->handle->flags |= LDB_HANDLE_FLAG_DONE_CALLED;
 
+       if (req->handle->ldb->flags & LDB_FLG_ENABLE_TRACING) {
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "ldb_trace_response: DONE");
+               ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "error: %u", error);
+               if (ldb_errstring(req->handle->ldb)) {
+                       ldb_debug(req->handle->ldb, LDB_DEBUG_TRACE, "msg: %s", 
+                                 ldb_errstring(req->handle->ldb));
+               }
+       }
+
        req->callback(req, ares);
        return error;
 }
index 047e66c8b768a87d656595b3cd3934e460ae4a5a..0378697f4b086635656b34c17a12969a2cc9e6bf 100644 (file)
@@ -246,6 +246,11 @@ struct ldb_utf8_fns {
 */
 #define LDB_FLG_SHOW_BINARY 16
 
+/**
+   Flags to enable ldb tracing
+*/
+#define LDB_FLG_ENABLE_TRACING 32
+
 /*
    structures for ldb_parse_tree handling code
 */
@@ -1914,4 +1919,8 @@ struct ldb_control **ldb_parse_control_strings(struct ldb_context *ldb, TALLOC_C
 */
 unsigned int ldb_get_flags(struct ldb_context *ldb);
 
+/* set the ldb flags */
+void ldb_set_flags(struct ldb_context *ldb, unsigned flags);
+
+
 #endif