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-2004 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>
33 * The cache maps DNs to Entries.
34 * Each entry, on turn, holds the list of its children in the e_private field.
35 * This is used by search operation to perform onelevel and subtree candidate
43 struct monitorentrypriv {
44 ldap_pvt_thread_mutex_t mp_mutex; /* entry mutex */
45 Entry *mp_next; /* pointer to next sibling */
46 Entry *mp_children; /* pointer to first child */
47 struct monitorsubsys *mp_info; /* subsystem info */
48 #define mp_type mp_info->mss_type
49 int mp_flags; /* flags */
51 #define MONITOR_F_NONE 0x00
52 #define MONITOR_F_SUB 0x01 /* subentry of subsystem */
53 #define MONITOR_F_PERSISTENT 0x10 /* persistent entry */
54 #define MONITOR_F_PERSISTENT_CH 0x20 /* subsystem generates
56 #define MONITOR_F_VOLATILE 0x40 /* volatile entry */
57 #define MONITOR_F_VOLATILE_CH 0x80 /* subsystem generates
67 ldap_pvt_thread_mutex_t mi_cache_mutex;
73 struct berval mi_startTime; /* don't free it */
76 * Specific schema entities
78 ObjectClass *mi_oc_monitor;
79 ObjectClass *mi_oc_monitorServer;
80 ObjectClass *mi_oc_monitorContainer;
81 ObjectClass *mi_oc_monitorCounterObject;
82 ObjectClass *mi_oc_monitorOperation;
83 ObjectClass *mi_oc_monitorConnection;
84 ObjectClass *mi_oc_managedObject;
85 ObjectClass *mi_oc_monitoredObject;
87 AttributeDescription *mi_ad_monitoredInfo;
88 AttributeDescription *mi_ad_managedInfo;
89 AttributeDescription *mi_ad_monitorCounter;
90 AttributeDescription *mi_ad_monitorOpCompleted;
91 AttributeDescription *mi_ad_monitorOpInitiated;
92 AttributeDescription *mi_ad_monitorConnectionNumber;
93 AttributeDescription *mi_ad_monitorConnectionAuthzDN;
94 AttributeDescription *mi_ad_monitorConnectionLocalAddress;
95 AttributeDescription *mi_ad_monitorConnectionPeerAddress;
96 AttributeDescription *mi_ad_monitorTimestamp;
97 AttributeDescription *mi_ad_monitorOverlay;
100 * Generic description attribute
102 AttributeDescription *mi_ad_description;
103 AttributeDescription *mi_ad_seeAlso;
104 AttributeDescription *mi_ad_l;
111 #define SLAPD_MONITOR_AT "cn"
113 #define SLAPD_MONITOR_LISTENER 0
114 #define SLAPD_MONITOR_LISTENER_NAME "Listeners"
115 #define SLAPD_MONITOR_LISTENER_RDN \
116 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LISTENER_NAME
117 #define SLAPD_MONITOR_LISTENER_DN \
118 SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
120 #define SLAPD_MONITOR_DATABASE 1
121 #define SLAPD_MONITOR_DATABASE_NAME "Databases"
122 #define SLAPD_MONITOR_DATABASE_RDN \
123 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_DATABASE_NAME
124 #define SLAPD_MONITOR_DATABASE_DN \
125 SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
127 #define SLAPD_MONITOR_BACKEND 2
128 #define SLAPD_MONITOR_BACKEND_NAME "Backends"
129 #define SLAPD_MONITOR_BACKEND_RDN \
130 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_BACKEND_NAME
131 #define SLAPD_MONITOR_BACKEND_DN \
132 SLAPD_MONITOR_BACKEND_RDN "," SLAPD_MONITOR_DN
134 #define SLAPD_MONITOR_THREAD 3
135 #define SLAPD_MONITOR_THREAD_NAME "Threads"
136 #define SLAPD_MONITOR_THREAD_RDN \
137 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_THREAD_NAME
138 #define SLAPD_MONITOR_THREAD_DN \
139 SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
141 #define SLAPD_MONITOR_SASL 4
142 #define SLAPD_MONITOR_SASL_NAME "SASL"
143 #define SLAPD_MONITOR_SASL_RDN \
144 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SASL_NAME
145 #define SLAPD_MONITOR_SASL_DN \
146 SLAPD_MONITOR_SASL_RDN "," SLAPD_MONITOR_DN
148 #define SLAPD_MONITOR_TLS 5
149 #define SLAPD_MONITOR_TLS_NAME "TLS"
150 #define SLAPD_MONITOR_TLS_RDN \
151 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TLS_NAME
152 #define SLAPD_MONITOR_TLS_DN \
153 SLAPD_MONITOR_TLS_RDN "," SLAPD_MONITOR_DN
155 #define SLAPD_MONITOR_CONN 6
156 #define SLAPD_MONITOR_CONN_NAME "Connections"
157 #define SLAPD_MONITOR_CONN_RDN \
158 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_CONN_NAME
159 #define SLAPD_MONITOR_CONN_DN \
160 SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
162 #define SLAPD_MONITOR_RWW 7
163 #define SLAPD_MONITOR_RWW_NAME "Waiters"
164 #define SLAPD_MONITOR_RWW_RDN \
165 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_RWW_NAME
166 #define SLAPD_MONITOR_RWW_DN \
167 SLAPD_MONITOR_RWW_RDN "," SLAPD_MONITOR_DN
169 #define SLAPD_MONITOR_LOG 8
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 9
177 #define SLAPD_MONITOR_OPS_NAME "Operations"
178 #define SLAPD_MONITOR_OPS_RDN \
179 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OPS_NAME
180 #define SLAPD_MONITOR_OPS_DN \
181 SLAPD_MONITOR_OPS_RDN "," SLAPD_MONITOR_DN
183 #define SLAPD_MONITOR_SENT 10
184 #define SLAPD_MONITOR_SENT_NAME "Statistics"
185 #define SLAPD_MONITOR_SENT_RDN \
186 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SENT_NAME
187 #define SLAPD_MONITOR_SENT_DN \
188 SLAPD_MONITOR_SENT_RDN "," SLAPD_MONITOR_DN
190 #define SLAPD_MONITOR_TIME 11
191 #define SLAPD_MONITOR_TIME_NAME "Time"
192 #define SLAPD_MONITOR_TIME_RDN \
193 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TIME_NAME
194 #define SLAPD_MONITOR_TIME_DN \
195 SLAPD_MONITOR_TIME_RDN "," SLAPD_MONITOR_DN
197 #define SLAPD_MONITOR_OVERLAY 12
198 #define SLAPD_MONITOR_OVERLAY_NAME "Overlay"
199 #define SLAPD_MONITOR_OVERLAY_RDN \
200 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OVERLAY_NAME
201 #define SLAPD_MONITOR_OVERLAY_DN \
202 SLAPD_MONITOR_OVERLAY_RDN "," SLAPD_MONITOR_DN
204 struct monitorsubsys {
207 struct berval mss_rdn;
208 struct berval mss_dn;
209 struct berval mss_ndn;
212 #define MONITOR_HAS_VOLATILE_CH( mp ) \
213 ( ( mp )->mp_flags & MONITOR_F_VOLATILE_CH )
214 #define MONITOR_HAS_CHILDREN( mp ) \
215 ( ( mp )->mp_children || MONITOR_HAS_VOLATILE_CH( mp ) )
217 /* initialize entry and subentries */
218 int ( *mss_init )( BackendDB * );
219 /* update existing dynamic entry and subentries */
220 int ( *mss_update )( Operation *, Entry * );
221 /* create new dynamic subentries */
222 int ( *mss_create )( Operation *,
223 struct berval *ndn, Entry *, Entry ** );
224 /* modify entry and subentries */
225 int ( *mss_modify )( Operation *, Entry * );
228 extern struct monitorsubsys monitor_subsys[];
230 extern BackendDB *be_monitor;
232 /* increase this bufsize if entries in string form get too big */
233 #define BACKMONITOR_BUFSIZE 1024
239 extern int monitor_cache_cmp LDAP_P(( const void *c1, const void *c2 ));
240 extern int monitor_cache_dup LDAP_P(( void *c1, void *c2 ));
241 extern int monitor_cache_add LDAP_P(( struct monitorinfo *mi, Entry *e ));
242 extern int monitor_cache_get LDAP_P(( struct monitorinfo *mi, struct berval *ndn, Entry **ep ));
243 extern int monitor_cache_dn2entry LDAP_P(( Operation *op, struct berval *ndn, Entry **ep, Entry **matched ));
244 extern int monitor_cache_lock LDAP_P(( Entry *e ));
245 extern int monitor_cache_release LDAP_P(( struct monitorinfo *mi, Entry *e ));
251 extern int monitor_entry_update LDAP_P(( Operation *op, Entry *e ));
252 extern int monitor_entry_create LDAP_P(( Operation *op, struct berval *ndn,
253 Entry *e_parent, Entry **ep ));
254 extern int monitor_entry_modify LDAP_P(( Operation *op, Entry *e ));
258 #include "proto-back-monitor.h"
260 #endif /* _back_monitor_h_ */