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 void *mc_private; /* opaque pointer to
41 struct monitor_callback_t *mc_next;
45 typedef struct monitor_entry_t {
46 ldap_pvt_thread_mutex_t mp_mutex; /* entry mutex */
47 Entry *mp_next; /* pointer to next sibling */
48 Entry *mp_children; /* pointer to first child */
49 struct monitor_subsys_t *mp_info; /* subsystem info */
50 #define mp_type mp_info->mss_type
51 unsigned long mp_flags; /* flags */
53 #define MONITOR_F_NONE 0x0000U
54 #define MONITOR_F_SUB 0x0001U /* subentry of subsystem */
55 #define MONITOR_F_PERSISTENT 0x0010U /* persistent entry */
56 #define MONITOR_F_PERSISTENT_CH 0x0020U /* subsystem generates
58 #define MONITOR_F_VOLATILE 0x0040U /* volatile entry */
59 #define MONITOR_F_VOLATILE_CH 0x0080U /* subsystem generates
61 #define MONITOR_F_EXTERNAL 0x0100U /* externally added - don't free */
62 /* NOTE: flags with 0xF0000000U mask are reserved for subsystem internals */
64 struct monitor_callback_t *mp_cb; /* callback sequence */
67 typedef struct monitor_info_t {
73 ldap_pvt_thread_mutex_t mi_cache_mutex;
79 struct berval mi_startTime; /* don't free it! */
80 struct berval mi_creatorsName; /* don't free it! */
83 * Specific schema entities
85 ObjectClass *mi_oc_monitor;
86 ObjectClass *mi_oc_monitorServer;
87 ObjectClass *mi_oc_monitorContainer;
88 ObjectClass *mi_oc_monitorCounterObject;
89 ObjectClass *mi_oc_monitorOperation;
90 ObjectClass *mi_oc_monitorConnection;
91 ObjectClass *mi_oc_managedObject;
92 ObjectClass *mi_oc_monitoredObject;
94 AttributeDescription *mi_ad_monitoredInfo;
95 AttributeDescription *mi_ad_managedInfo;
96 AttributeDescription *mi_ad_monitorCounter;
97 AttributeDescription *mi_ad_monitorOpCompleted;
98 AttributeDescription *mi_ad_monitorOpInitiated;
99 AttributeDescription *mi_ad_monitorConnectionNumber;
100 AttributeDescription *mi_ad_monitorConnectionAuthzDN;
101 AttributeDescription *mi_ad_monitorConnectionLocalAddress;
102 AttributeDescription *mi_ad_monitorConnectionPeerAddress;
103 AttributeDescription *mi_ad_monitorTimestamp;
104 AttributeDescription *mi_ad_monitorOverlay;
107 * Generic description attribute
109 AttributeDescription *mi_ad_description;
110 AttributeDescription *mi_ad_seeAlso;
111 AttributeDescription *mi_ad_l;
112 #ifdef MONITOR_DEFINE_LABELEDURI
113 /* enable if si_ad_labeledURI is removed from slap_schema */
114 AttributeDescription *mi_ad_labeledURI;
115 #endif /* MONITOR_DEFINE_LABELEDURI */
116 AttributeDescription *mi_ad_readOnly;
117 AttributeDescription *mi_ad_restrictedOperation;
119 void *mi_entry_limbo;
127 SLAPD_MONITOR_BACKEND = 0,
129 SLAPD_MONITOR_DATABASE,
130 SLAPD_MONITOR_LISTENER,
133 SLAPD_MONITOR_OVERLAY,
136 SLAPD_MONITOR_THREAD,
144 #define SLAPD_MONITOR_AT "cn"
146 #define SLAPD_MONITOR_BACKEND_NAME "Backends"
147 #define SLAPD_MONITOR_BACKEND_RDN \
148 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_BACKEND_NAME
149 #define SLAPD_MONITOR_BACKEND_DN \
150 SLAPD_MONITOR_BACKEND_RDN "," SLAPD_MONITOR_DN
152 #define SLAPD_MONITOR_CONN_NAME "Connections"
153 #define SLAPD_MONITOR_CONN_RDN \
154 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_CONN_NAME
155 #define SLAPD_MONITOR_CONN_DN \
156 SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
158 #define SLAPD_MONITOR_DATABASE_NAME "Databases"
159 #define SLAPD_MONITOR_DATABASE_RDN \
160 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_DATABASE_NAME
161 #define SLAPD_MONITOR_DATABASE_DN \
162 SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
164 #define SLAPD_MONITOR_LISTENER_NAME "Listeners"
165 #define SLAPD_MONITOR_LISTENER_RDN \
166 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LISTENER_NAME
167 #define SLAPD_MONITOR_LISTENER_DN \
168 SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
170 #define SLAPD_MONITOR_LOG_NAME "Log"
171 #define SLAPD_MONITOR_LOG_RDN \
172 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LOG_NAME
173 #define SLAPD_MONITOR_LOG_DN \
174 SLAPD_MONITOR_LOG_RDN "," SLAPD_MONITOR_DN
176 #define SLAPD_MONITOR_OPS_NAME "Operations"
177 #define SLAPD_MONITOR_OPS_RDN \
178 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OPS_NAME
179 #define SLAPD_MONITOR_OPS_DN \
180 SLAPD_MONITOR_OPS_RDN "," SLAPD_MONITOR_DN
182 #define SLAPD_MONITOR_OVERLAY_NAME "Overlay"
183 #define SLAPD_MONITOR_OVERLAY_RDN \
184 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OVERLAY_NAME
185 #define SLAPD_MONITOR_OVERLAY_DN \
186 SLAPD_MONITOR_OVERLAY_RDN "," SLAPD_MONITOR_DN
188 #define SLAPD_MONITOR_SASL_NAME "SASL"
189 #define SLAPD_MONITOR_SASL_RDN \
190 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SASL_NAME
191 #define SLAPD_MONITOR_SASL_DN \
192 SLAPD_MONITOR_SASL_RDN "," SLAPD_MONITOR_DN
194 #define SLAPD_MONITOR_SENT_NAME "Statistics"
195 #define SLAPD_MONITOR_SENT_RDN \
196 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SENT_NAME
197 #define SLAPD_MONITOR_SENT_DN \
198 SLAPD_MONITOR_SENT_RDN "," SLAPD_MONITOR_DN
200 #define SLAPD_MONITOR_THREAD_NAME "Threads"
201 #define SLAPD_MONITOR_THREAD_RDN \
202 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_THREAD_NAME
203 #define SLAPD_MONITOR_THREAD_DN \
204 SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
206 #define SLAPD_MONITOR_TIME_NAME "Time"
207 #define SLAPD_MONITOR_TIME_RDN \
208 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TIME_NAME
209 #define SLAPD_MONITOR_TIME_DN \
210 SLAPD_MONITOR_TIME_RDN "," SLAPD_MONITOR_DN
212 #define SLAPD_MONITOR_TLS_NAME "TLS"
213 #define SLAPD_MONITOR_TLS_RDN \
214 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TLS_NAME
215 #define SLAPD_MONITOR_TLS_DN \
216 SLAPD_MONITOR_TLS_RDN "," SLAPD_MONITOR_DN
218 #define SLAPD_MONITOR_RWW_NAME "Waiters"
219 #define SLAPD_MONITOR_RWW_RDN \
220 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_RWW_NAME
221 #define SLAPD_MONITOR_RWW_DN \
222 SLAPD_MONITOR_RWW_RDN "," SLAPD_MONITOR_DN
224 typedef struct monitor_subsys_t {
226 struct berval mss_rdn;
227 struct berval mss_dn;
228 struct berval mss_ndn;
230 #define MONITOR_F_OPENED 0x10000000U
232 #define MONITOR_HAS_VOLATILE_CH( mp ) \
233 ( ( mp )->mp_flags & MONITOR_F_VOLATILE_CH )
234 #define MONITOR_HAS_CHILDREN( mp ) \
235 ( ( mp )->mp_children || MONITOR_HAS_VOLATILE_CH( mp ) )
237 /* initialize entry and subentries */
238 int ( *mss_open )( BackendDB *, struct monitor_subsys_t *ms );
239 /* update existing dynamic entry and subentries */
240 int ( *mss_update )( Operation *, Entry * );
241 /* create new dynamic subentries */
242 int ( *mss_create )( Operation *,
243 struct berval *ndn, Entry *, Entry ** );
244 /* modify entry and subentries */
245 int ( *mss_modify )( Operation *, Entry * );
248 extern BackendDB *be_monitor;
250 /* increase this bufsize if entries in string form get too big */
251 #define BACKMONITOR_BUFSIZE 1024
255 #include "proto-back-monitor.h"
257 #endif /* _back_monitor_h_ */