1 /* back-monitor.h - ldap monitor back-end header file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2005 The OpenLDAP Foundation.
6 * Portions Copyright 2001-2003 Pierangelo Masarati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Pierangelo Masarati for inclusion
19 * in OpenLDAP Software.
22 #ifndef _BACK_MONITOR_H_
23 #define _BACK_MONITOR_H_
26 #include <ldap_pvt_thread.h>
32 /* define if si_ad_labeledURI is removed from slap_schema */
33 #undef MONITOR_DEFINE_LABELEDURI
35 typedef struct monitor_callback_t {
36 int (*mc_update)( Operation *op, Entry *e, void *priv );
38 for user-defined entries */
39 int (*mc_modify)( Operation *op, Entry *e, void *priv );
41 for user-defined entries */
42 int (*mc_free)( Entry *e, void *priv );
44 for user-defined entries */
45 void *mc_private; /* opaque pointer to
47 struct monitor_callback_t *mc_next;
51 typedef struct monitor_entry_t {
52 ldap_pvt_thread_mutex_t mp_mutex; /* entry mutex */
53 Entry *mp_next; /* pointer to next sibling */
54 Entry *mp_children; /* pointer to first child */
55 struct monitor_subsys_t *mp_info; /* subsystem info */
56 #define mp_type mp_info->mss_type
57 unsigned long mp_flags; /* flags */
59 #define MONITOR_F_NONE 0x0000U
60 #define MONITOR_F_SUB 0x0001U /* subentry of subsystem */
61 #define MONITOR_F_PERSISTENT 0x0010U /* persistent entry */
62 #define MONITOR_F_PERSISTENT_CH 0x0020U /* subsystem generates
64 #define MONITOR_F_VOLATILE 0x0040U /* volatile entry */
65 #define MONITOR_F_VOLATILE_CH 0x0080U /* subsystem generates
67 #define MONITOR_F_EXTERNAL 0x0100U /* externally added - don't free */
68 /* NOTE: flags with 0xF0000000U mask are reserved for subsystem internals */
70 struct monitor_callback_t *mp_cb; /* callback sequence */
73 typedef struct monitor_info_t {
79 ldap_pvt_thread_mutex_t mi_cache_mutex;
85 struct berval mi_startTime; /* don't free it! */
86 struct berval mi_creatorsName; /* don't free it! */
89 * Specific schema entities
91 ObjectClass *mi_oc_monitor;
92 ObjectClass *mi_oc_monitorServer;
93 ObjectClass *mi_oc_monitorContainer;
94 ObjectClass *mi_oc_monitorCounterObject;
95 ObjectClass *mi_oc_monitorOperation;
96 ObjectClass *mi_oc_monitorConnection;
97 ObjectClass *mi_oc_managedObject;
98 ObjectClass *mi_oc_monitoredObject;
100 AttributeDescription *mi_ad_monitoredInfo;
101 AttributeDescription *mi_ad_managedInfo;
102 AttributeDescription *mi_ad_monitorCounter;
103 AttributeDescription *mi_ad_monitorOpCompleted;
104 AttributeDescription *mi_ad_monitorOpInitiated;
105 AttributeDescription *mi_ad_monitorConnectionNumber;
106 AttributeDescription *mi_ad_monitorConnectionAuthzDN;
107 AttributeDescription *mi_ad_monitorConnectionLocalAddress;
108 AttributeDescription *mi_ad_monitorConnectionPeerAddress;
109 AttributeDescription *mi_ad_monitorTimestamp;
110 AttributeDescription *mi_ad_monitorOverlay;
113 * Generic description attribute
115 AttributeDescription *mi_ad_description;
116 AttributeDescription *mi_ad_seeAlso;
117 AttributeDescription *mi_ad_l;
118 #ifdef MONITOR_DEFINE_LABELEDURI
119 /* enable if si_ad_labeledURI is removed from slap_schema */
120 AttributeDescription *mi_ad_labeledURI;
121 #endif /* MONITOR_DEFINE_LABELEDURI */
122 AttributeDescription *mi_ad_readOnly;
123 AttributeDescription *mi_ad_restrictedOperation;
125 void *mi_entry_limbo;
133 SLAPD_MONITOR_BACKEND = 0,
135 SLAPD_MONITOR_DATABASE,
136 SLAPD_MONITOR_LISTENER,
139 SLAPD_MONITOR_OVERLAY,
142 SLAPD_MONITOR_THREAD,
150 #define SLAPD_MONITOR_AT "cn"
152 #define SLAPD_MONITOR_BACKEND_NAME "Backends"
153 #define SLAPD_MONITOR_BACKEND_RDN \
154 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_BACKEND_NAME
155 #define SLAPD_MONITOR_BACKEND_DN \
156 SLAPD_MONITOR_BACKEND_RDN "," SLAPD_MONITOR_DN
158 #define SLAPD_MONITOR_CONN_NAME "Connections"
159 #define SLAPD_MONITOR_CONN_RDN \
160 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_CONN_NAME
161 #define SLAPD_MONITOR_CONN_DN \
162 SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
164 #define SLAPD_MONITOR_DATABASE_NAME "Databases"
165 #define SLAPD_MONITOR_DATABASE_RDN \
166 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_DATABASE_NAME
167 #define SLAPD_MONITOR_DATABASE_DN \
168 SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
170 #define SLAPD_MONITOR_LISTENER_NAME "Listeners"
171 #define SLAPD_MONITOR_LISTENER_RDN \
172 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LISTENER_NAME
173 #define SLAPD_MONITOR_LISTENER_DN \
174 SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
176 #define SLAPD_MONITOR_LOG_NAME "Log"
177 #define SLAPD_MONITOR_LOG_RDN \
178 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LOG_NAME
179 #define SLAPD_MONITOR_LOG_DN \
180 SLAPD_MONITOR_LOG_RDN "," SLAPD_MONITOR_DN
182 #define SLAPD_MONITOR_OPS_NAME "Operations"
183 #define SLAPD_MONITOR_OPS_RDN \
184 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OPS_NAME
185 #define SLAPD_MONITOR_OPS_DN \
186 SLAPD_MONITOR_OPS_RDN "," SLAPD_MONITOR_DN
188 #define SLAPD_MONITOR_OVERLAY_NAME "Overlay"
189 #define SLAPD_MONITOR_OVERLAY_RDN \
190 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OVERLAY_NAME
191 #define SLAPD_MONITOR_OVERLAY_DN \
192 SLAPD_MONITOR_OVERLAY_RDN "," SLAPD_MONITOR_DN
194 #define SLAPD_MONITOR_SASL_NAME "SASL"
195 #define SLAPD_MONITOR_SASL_RDN \
196 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SASL_NAME
197 #define SLAPD_MONITOR_SASL_DN \
198 SLAPD_MONITOR_SASL_RDN "," SLAPD_MONITOR_DN
200 #define SLAPD_MONITOR_SENT_NAME "Statistics"
201 #define SLAPD_MONITOR_SENT_RDN \
202 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SENT_NAME
203 #define SLAPD_MONITOR_SENT_DN \
204 SLAPD_MONITOR_SENT_RDN "," SLAPD_MONITOR_DN
206 #define SLAPD_MONITOR_THREAD_NAME "Threads"
207 #define SLAPD_MONITOR_THREAD_RDN \
208 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_THREAD_NAME
209 #define SLAPD_MONITOR_THREAD_DN \
210 SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
212 #define SLAPD_MONITOR_TIME_NAME "Time"
213 #define SLAPD_MONITOR_TIME_RDN \
214 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TIME_NAME
215 #define SLAPD_MONITOR_TIME_DN \
216 SLAPD_MONITOR_TIME_RDN "," SLAPD_MONITOR_DN
218 #define SLAPD_MONITOR_TLS_NAME "TLS"
219 #define SLAPD_MONITOR_TLS_RDN \
220 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TLS_NAME
221 #define SLAPD_MONITOR_TLS_DN \
222 SLAPD_MONITOR_TLS_RDN "," SLAPD_MONITOR_DN
224 #define SLAPD_MONITOR_RWW_NAME "Waiters"
225 #define SLAPD_MONITOR_RWW_RDN \
226 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_RWW_NAME
227 #define SLAPD_MONITOR_RWW_DN \
228 SLAPD_MONITOR_RWW_RDN "," SLAPD_MONITOR_DN
230 typedef struct monitor_subsys_t {
232 struct berval mss_rdn;
233 struct berval mss_dn;
234 struct berval mss_ndn;
236 #define MONITOR_F_OPENED 0x10000000U
238 #define MONITOR_HAS_VOLATILE_CH( mp ) \
239 ( ( mp )->mp_flags & MONITOR_F_VOLATILE_CH )
240 #define MONITOR_HAS_CHILDREN( mp ) \
241 ( ( mp )->mp_children || MONITOR_HAS_VOLATILE_CH( mp ) )
243 /* initialize entry and subentries */
244 int ( *mss_open )( BackendDB *, struct monitor_subsys_t *ms );
245 /* update existing dynamic entry and subentries */
246 int ( *mss_update )( Operation *, Entry * );
247 /* create new dynamic subentries */
248 int ( *mss_create )( Operation *,
249 struct berval *ndn, Entry *, Entry ** );
250 /* modify entry and subentries */
251 int ( *mss_modify )( Operation *, Entry * );
254 extern BackendDB *be_monitor;
256 /* increase this bufsize if entries in string form get too big */
257 #define BACKMONITOR_BUFSIZE 1024
260 monitor_back_register_entry(
262 monitor_callback_t *cb );
265 monitor_back_register_entry_parent(
267 monitor_callback_t *cb,
270 struct berval *filter );
276 struct berval *filter,
277 struct berval *ndn );
280 monitor_back_register_entry_attrs(
281 struct berval *ndn_in,
283 monitor_callback_t *cb,
286 struct berval *filter );
289 monitor_back_register_entry_callback(
291 monitor_callback_t *cb,
294 struct berval *filter );
298 #include "proto-back-monitor.h"
300 #endif /* _back_monitor_h_ */