]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-monitor/back-monitor.h
plug more one-time leaks; rearrange subsystems setup
[openldap] / servers / slapd / back-monitor / back-monitor.h
index 97030eef499691b8ba24689a3de6273cc0e39b80..e688f943c33950d1434ae96b6f75438da0481d1c 100644 (file)
 /* back-monitor.h - ldap monitor back-end header file */
-/*
- * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
- * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
+/* $OpenLDAP$ */
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ *
+ * Copyright 2001-2005 The OpenLDAP Foundation.
+ * Portions Copyright 2001-2003 Pierangelo Masarati.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted only as authorized by the OpenLDAP
+ * Public License.
+ *
+ * A copy of this license is available in file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
  */
-/*
- * Copyright 2001 The OpenLDAP Foundation, All Rights Reserved.
- * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
- * 
- * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
- * 
- * This work has beed deveolped for the OpenLDAP Foundation 
- * in the hope that it may be useful to the Open Source community, 
- * but WITHOUT ANY WARRANTY.
- * 
- * Permission is granted to anyone to use this software for any purpose
- * on any computer system, and to alter it and redistribute it, subject
- * to the following restrictions:
- * 
- * 1. The author and SysNet s.n.c. are not responsible for the consequences
- *    of use of this software, no matter how awful, even if they arise from
- *    flaws in it.
- * 
- * 2. The origin of this software must not be misrepresented, either by
- *    explicit claim or by omission.  Since few users ever read sources,
- *    credits should appear in the documentation.
- * 
- * 3. Altered versions must be plainly marked as such, and must not be
- *    misrepresented as being the original software.  Since few users
- *    ever read sources, credits should appear in the documentation.
- *    SysNet s.n.c. cannot be responsible for the consequences of the
- *    alterations.
- * 
- * 4. This notice may not be removed or altered.
+/* ACKNOWLEDGEMENTS:
+ * This work was initially developed by Pierangelo Masarati for inclusion
+ * in OpenLDAP Software.
  */
 
 #ifndef _BACK_MONITOR_H_
 #define _BACK_MONITOR_H_
 
-#include <slap.h>
-#include <avl.h>
 #include <ldap_pvt.h>
 #include <ldap_pvt_thread.h>
+#include <avl.h>
+#include <slap.h>
 
 LDAP_BEGIN_DECL
 
-/*
- * The cache maps DNs to Entries.
- * Each entry, on turn, holds the list of its children in the e_private field.
- * This is used by search operation to perform onelevel and subtree candidate
- * selection.
- */
-struct monitorcache {
-       char                    *mc_ndn;
-       Entry                   *mc_e;
-};
+/* define if si_ad_labeledURI is removed from slap_schema */
+#undef MONITOR_DEFINE_LABELEDURI
+
+typedef struct monitor_callback_t {
+       int                             (*mc_update)( Operation *op, SlapReply *rs, Entry *e, void *priv );
+                                               /* update callback
+                                                  for user-defined entries */
+       int                             (*mc_modify)( Operation *op, SlapReply *rs, Entry *e, void *priv );
+                                               /* modify callback
+                                                  for user-defined entries */
+       int                             (*mc_free)( Entry *e, void *priv );
+                                               /* delete callback
+                                                  for user-defined entries */
+       void                            *mc_private;    /* opaque pointer to
+                                                  private data */
+       struct monitor_callback_t       *mc_next;
+} monitor_callback_t;
 
-struct monitorentrypriv {
+
+typedef struct monitor_entry_t {
        ldap_pvt_thread_mutex_t mp_mutex;       /* entry mutex */
        Entry                   *mp_next;       /* pointer to next sibling */
        Entry                   *mp_children;   /* pointer to first child */
-       struct monitorsubsys    *mp_info;       /* subsystem info */
+       struct monitor_subsys_t *mp_info;       /* subsystem info */
 #define mp_type                mp_info->mss_type
-       int                     mp_flags;       /* flags */
+       unsigned long           mp_flags;       /* flags */
 
-#define        MONITOR_F_NONE          0x00
-#define MONITOR_F_SUB          0x01            /* subentry of subsystem */
-#define MONITOR_F_PERSISTENT   0x10            /* persistent entry */
-#define MONITOR_F_PERSISTENT_CH        0x20            /* subsystem generates 
+#define        MONITOR_F_NONE          0x0000U
+#define MONITOR_F_SUB          0x0001U         /* subentry of subsystem */
+#define MONITOR_F_PERSISTENT   0x0010U         /* persistent entry */
+#define MONITOR_F_PERSISTENT_CH        0x0020U         /* subsystem generates 
                                                   persistent entries */
-#define MONITOR_F_VOLATILE     0x40            /* volatile entry */
-#define MONITOR_F_VOLATILE_CH  0x80            /* subsystem generates 
+#define MONITOR_F_VOLATILE     0x0040U         /* volatile entry */
+#define MONITOR_F_VOLATILE_CH  0x0080U         /* subsystem generates 
                                                   volatile entries */
-};
+#define MONITOR_F_EXTERNAL     0x0100U         /* externally added - don't free */
+/* NOTE: flags with 0xF0000000U mask are reserved for subsystem internals */
+
+       struct monitor_callback_t       *mp_cb;         /* callback sequence */
+} monitor_entry_t;
 
-struct monitorinfo {
+typedef struct monitor_info_t {
+
+       /*
+        * Internal data
+        */
        Avlnode                 *mi_cache;
        ldap_pvt_thread_mutex_t mi_cache_mutex;
-};
+
+       /*
+        * Config parameters
+        */
+       struct berval           mi_startTime;           /* don't free it! */
+       struct berval           mi_creatorsName;        /* don't free it! */
+
+       /*
+        * Specific schema entities
+        */
+       ObjectClass             *mi_oc_monitor;
+       ObjectClass             *mi_oc_monitorServer;
+       ObjectClass             *mi_oc_monitorContainer;
+       ObjectClass             *mi_oc_monitorCounterObject;
+       ObjectClass             *mi_oc_monitorOperation;
+       ObjectClass             *mi_oc_monitorConnection;
+       ObjectClass             *mi_oc_managedObject;
+       ObjectClass             *mi_oc_monitoredObject;
+
+       AttributeDescription    *mi_ad_monitoredInfo;
+       AttributeDescription    *mi_ad_managedInfo;
+       AttributeDescription    *mi_ad_monitorCounter;
+       AttributeDescription    *mi_ad_monitorOpCompleted;
+       AttributeDescription    *mi_ad_monitorOpInitiated;
+       AttributeDescription    *mi_ad_monitorConnectionNumber;
+       AttributeDescription    *mi_ad_monitorConnectionAuthzDN;
+       AttributeDescription    *mi_ad_monitorConnectionLocalAddress;
+       AttributeDescription    *mi_ad_monitorConnectionPeerAddress;
+       AttributeDescription    *mi_ad_monitorTimestamp;
+       AttributeDescription    *mi_ad_monitorOverlay;
+       AttributeDescription    *mi_ad_monitorConnectionProtocol;
+       AttributeDescription    *mi_ad_monitorConnectionOpsReceived;
+       AttributeDescription    *mi_ad_monitorConnectionOpsExecuting;
+       AttributeDescription    *mi_ad_monitorConnectionOpsPending;
+       AttributeDescription    *mi_ad_monitorConnectionOpsCompleted;
+       AttributeDescription    *mi_ad_monitorConnectionGet;
+       AttributeDescription    *mi_ad_monitorConnectionRead;
+       AttributeDescription    *mi_ad_monitorConnectionWrite;
+       AttributeDescription    *mi_ad_monitorConnectionMask;
+       AttributeDescription    *mi_ad_monitorConnectionListener;
+       AttributeDescription    *mi_ad_monitorConnectionPeerDomain;
+       AttributeDescription    *mi_ad_monitorConnectionStartTime;
+       AttributeDescription    *mi_ad_monitorConnectionActivityTime;
+       AttributeDescription    *mi_ad_monitorIsShadow;
+       AttributeDescription    *mi_ad_monitorUpdateRef;
+       AttributeDescription    *mi_ad_monitorRuntimeConfig;
+
+       /*
+        * Generic description attribute
+        */
+       AttributeDescription    *mi_ad_readOnly;
+       AttributeDescription    *mi_ad_restrictedOperation;
+
+       void                    *mi_entry_limbo;
+} monitor_info_t;
 
 /*
  * DNs
  */
-#define        SLAPD_MONITOR_LISTENER          0
-#define SLAPD_MONITOR_LISTENER_NAME    "Listener"
-#define SLAPD_MONITOR_LISTENER_RDN     \
-       "cn=" SLAPD_MONITOR_LISTENER_NAME
-#define SLAPD_MONITOR_LISTENER_DN      \
-       SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
 
-#define SLAPD_MONITOR_DATABASE         1
-#define SLAPD_MONITOR_DATABASE_NAME    "Databases"
-#define SLAPD_MONITOR_DATABASE_RDN     \
-       "cn=" SLAPD_MONITOR_DATABASE_NAME
-#define SLAPD_MONITOR_DATABASE_DN      \
-       SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
+enum {
+       SLAPD_MONITOR_BACKEND = 0,
+       SLAPD_MONITOR_CONN,
+       SLAPD_MONITOR_DATABASE,
+       SLAPD_MONITOR_LISTENER,
+       SLAPD_MONITOR_LOG,
+       SLAPD_MONITOR_OPS,
+       SLAPD_MONITOR_OVERLAY,
+       SLAPD_MONITOR_SASL,
+       SLAPD_MONITOR_SENT,
+       SLAPD_MONITOR_THREAD,
+       SLAPD_MONITOR_TIME,
+       SLAPD_MONITOR_TLS,
+       SLAPD_MONITOR_RWW,
+
+       SLAPD_MONITOR_LAST
+};
+
+#define SLAPD_MONITOR_AT               "cn"
 
-#define SLAPD_MONITOR_BACKEND          2
 #define SLAPD_MONITOR_BACKEND_NAME     "Backends"
 #define SLAPD_MONITOR_BACKEND_RDN      \
-       "cn=" SLAPD_MONITOR_BACKEND_NAME
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_BACKEND_NAME
 #define SLAPD_MONITOR_BACKEND_DN       \
        SLAPD_MONITOR_BACKEND_RDN "," SLAPD_MONITOR_DN
 
-#define SLAPD_MONITOR_THREAD           3
-#define SLAPD_MONITOR_THREAD_NAME      "Threads"
-#define SLAPD_MONITOR_THREAD_RDN       \
-       "cn=" SLAPD_MONITOR_THREAD_NAME
-#define SLAPD_MONITOR_THREAD_DN        \
-       SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
+#define SLAPD_MONITOR_CONN_NAME                "Connections"
+#define SLAPD_MONITOR_CONN_RDN \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_CONN_NAME
+#define SLAPD_MONITOR_CONN_DN  \
+       SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_DATABASE_NAME    "Databases"
+#define SLAPD_MONITOR_DATABASE_RDN     \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_DATABASE_NAME
+#define SLAPD_MONITOR_DATABASE_DN      \
+       SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_LISTENER_NAME    "Listeners"
+#define SLAPD_MONITOR_LISTENER_RDN     \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LISTENER_NAME
+#define SLAPD_MONITOR_LISTENER_DN      \
+       SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_LOG_NAME         "Log"
+#define SLAPD_MONITOR_LOG_RDN  \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LOG_NAME
+#define SLAPD_MONITOR_LOG_DN   \
+       SLAPD_MONITOR_LOG_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_OPS_NAME         "Operations"
+#define SLAPD_MONITOR_OPS_RDN  \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OPS_NAME
+#define SLAPD_MONITOR_OPS_DN   \
+       SLAPD_MONITOR_OPS_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_OVERLAY_NAME     "Overlays"
+#define SLAPD_MONITOR_OVERLAY_RDN  \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OVERLAY_NAME
+#define SLAPD_MONITOR_OVERLAY_DN   \
+       SLAPD_MONITOR_OVERLAY_RDN "," SLAPD_MONITOR_DN
 
-#define SLAPD_MONITOR_SASL             4
 #define SLAPD_MONITOR_SASL_NAME                "SASL"
 #define SLAPD_MONITOR_SASL_RDN \
-       "cn=" SLAPD_MONITOR_SASL_NAME
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SASL_NAME
 #define SLAPD_MONITOR_SASL_DN  \
        SLAPD_MONITOR_SASL_RDN "," SLAPD_MONITOR_DN
 
-#define SLAPD_MONITOR_TLS              5
+#define SLAPD_MONITOR_SENT_NAME                "Statistics"
+#define SLAPD_MONITOR_SENT_RDN \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SENT_NAME
+#define SLAPD_MONITOR_SENT_DN  \
+       SLAPD_MONITOR_SENT_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_THREAD_NAME      "Threads"
+#define SLAPD_MONITOR_THREAD_RDN       \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_THREAD_NAME
+#define SLAPD_MONITOR_THREAD_DN        \
+       SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
+
+#define SLAPD_MONITOR_TIME_NAME                "Time"
+#define SLAPD_MONITOR_TIME_RDN  \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TIME_NAME
+#define SLAPD_MONITOR_TIME_DN   \
+       SLAPD_MONITOR_TIME_RDN "," SLAPD_MONITOR_DN
+
 #define SLAPD_MONITOR_TLS_NAME         "TLS"
 #define SLAPD_MONITOR_TLS_RDN  \
-       "cn=" SLAPD_MONITOR_TLS_NAME
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TLS_NAME
 #define SLAPD_MONITOR_TLS_DN   \
        SLAPD_MONITOR_TLS_RDN "," SLAPD_MONITOR_DN
 
-#define SLAPD_MONITOR_CONN             6
-#define SLAPD_MONITOR_CONN_NAME                "Connections"
-#define SLAPD_MONITOR_CONN_RDN \
-       "cn=" SLAPD_MONITOR_CONN_NAME
-#define SLAPD_MONITOR_CONN_DN  \
-       SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
-
-#define SLAPD_MONITOR_READW            7
-#define SLAPD_MONITOR_READW_NAME       "Read Waiters"
-#define SLAPD_MONITOR_READW_RDN        \
-       "cn=" SLAPD_MONITOR_READW_NAME
-#define SLAPD_MONITOR_READW_DN \
-       SLAPD_MONITOR_READW_RDN "," SLAPD_MONITOR_DN
-
-#define SLAPD_MONITOR_WRITEW           8
-#define SLAPD_MONITOR_WRITEW_NAME      "Write Waiters"
-#define SLAPD_MONITOR_WRITEW_RDN       \
-       "cn=" SLAPD_MONITOR_WRITEW_NAME
-#define SLAPD_MONITOR_WRITEW_DN        \
-       SLAPD_MONITOR_WRITEW_RDN "," SLAPD_MONITOR_DN
-
-#define SLAPD_MONITOR_LOG              9
-#define SLAPD_MONITOR_LOG_NAME         "Log"
-#define SLAPD_MONITOR_LOG_RDN  \
-       "cn=" SLAPD_MONITOR_LOG_NAME
-#define SLAPD_MONITOR_LOG_DN   \
-       SLAPD_MONITOR_LOG_RDN "," SLAPD_MONITOR_DN
+#define SLAPD_MONITOR_RWW_NAME         "Waiters"
+#define SLAPD_MONITOR_RWW_RDN  \
+       SLAPD_MONITOR_AT "=" SLAPD_MONITOR_RWW_NAME
+#define SLAPD_MONITOR_RWW_DN   \
+       SLAPD_MONITOR_RWW_RDN "," SLAPD_MONITOR_DN
 
-struct monitorsubsys {
-       int             mss_type;
+typedef struct monitor_subsys_t {
        char            *mss_name;
-       char            *mss_rdn;
-       char            *mss_dn;
-       char            *mss_ndn;
+       struct berval   mss_rdn;
+       struct berval   mss_dn;
+       struct berval   mss_ndn;
+       struct berval   mss_desc[ 3 ];
        int             mss_flags;
+#define MONITOR_F_OPENED       0x10000000U
 
 #define MONITOR_HAS_VOLATILE_CH( mp ) \
        ( ( mp )->mp_flags & MONITOR_F_VOLATILE_CH )
+#define MONITOR_HAS_CHILDREN( mp ) \
+       ( ( mp )->mp_children || MONITOR_HAS_VOLATILE_CH( mp ) )
 
        /* initialize entry and subentries */
-       int             ( *mss_init )( BackendDB * );
+       int             ( *mss_open )( BackendDB *, struct monitor_subsys_t *ms );
+       /* destroy structure */
+       int             ( *mss_destroy )( BackendDB *, struct monitor_subsys_t *ms );
        /* update existing dynamic entry and subentries */
-       int             ( *mss_update )( struct monitorinfo *, Entry * );
+       int             ( *mss_update )( Operation *, SlapReply *, Entry * );
        /* create new dynamic subentries */
-       int             ( *mss_create )( struct monitorinfo *, const char *ndn, 
-                               Entry *, Entry ** );
+       int             ( *mss_create )( Operation *, SlapReply *,
+                               struct berval *ndn, Entry *, Entry ** );
        /* modify entry and subentries */
-       int             ( *mss_modify )( struct monitorinfo *, Entry *, 
-                               Modifications *modlist );
-};
-
-extern struct monitorsubsys monitor_subsys[];
-
-extern AttributeDescription *monitor_ad_desc;
+       int             ( *mss_modify )( Operation *, SlapReply *, Entry * );
+} monitor_subsys_t;
 
-/*
- * cache
- */
-
-extern int monitor_cache_cmp LDAP_P(( const void *c1, const void *c2 ));
-extern int monitor_cache_dup LDAP_P(( void *c1, void *c2 ));
-extern int monitor_cache_add LDAP_P(( struct monitorinfo *mi, Entry *e ));
-extern int monitor_cache_get LDAP_P(( struct monitorinfo *mi, const char *ndn, Entry **ep ));
-extern int monitor_cache_dn2entry LDAP_P(( struct monitorinfo *mi, const char *ndn, Entry **ep, Entry **matched ));
-extern int monitor_cache_lock LDAP_P(( Entry *e ));
-extern int monitor_cache_release LDAP_P(( struct monitorinfo *mi, Entry *e ));
-
-/*
- * update
- */
+extern BackendDB *be_monitor;
 
-extern int monitor_entry_update LDAP_P(( struct monitorinfo *mi, Entry *e ));
-extern int monitor_entry_create LDAP_P(( struct monitorinfo *mi, const char *ndn, Entry *e_parent, Entry **ep ));
-extern int monitor_entry_modify LDAP_P(( struct monitorinfo *mi, Entry *e, Modifications *modlist ));
+/* increase this bufsize if entries in string form get too big */
+#define BACKMONITOR_BUFSIZE    8192
 
 LDAP_END_DECL