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;
105 AttributeDescription *mi_ad_labeledURI;
112 #define SLAPD_MONITOR_AT "cn"
114 #define SLAPD_MONITOR_LISTENER 0
115 #define SLAPD_MONITOR_LISTENER_NAME "Listeners"
116 #define SLAPD_MONITOR_LISTENER_RDN \
117 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LISTENER_NAME
118 #define SLAPD_MONITOR_LISTENER_DN \
119 SLAPD_MONITOR_LISTENER_RDN "," SLAPD_MONITOR_DN
121 #define SLAPD_MONITOR_DATABASE 1
122 #define SLAPD_MONITOR_DATABASE_NAME "Databases"
123 #define SLAPD_MONITOR_DATABASE_RDN \
124 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_DATABASE_NAME
125 #define SLAPD_MONITOR_DATABASE_DN \
126 SLAPD_MONITOR_DATABASE_RDN "," SLAPD_MONITOR_DN
128 #define SLAPD_MONITOR_BACKEND 2
129 #define SLAPD_MONITOR_BACKEND_NAME "Backends"
130 #define SLAPD_MONITOR_BACKEND_RDN \
131 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_BACKEND_NAME
132 #define SLAPD_MONITOR_BACKEND_DN \
133 SLAPD_MONITOR_BACKEND_RDN "," SLAPD_MONITOR_DN
135 #define SLAPD_MONITOR_THREAD 3
136 #define SLAPD_MONITOR_THREAD_NAME "Threads"
137 #define SLAPD_MONITOR_THREAD_RDN \
138 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_THREAD_NAME
139 #define SLAPD_MONITOR_THREAD_DN \
140 SLAPD_MONITOR_THREAD_RDN "," SLAPD_MONITOR_DN
142 #define SLAPD_MONITOR_SASL 4
143 #define SLAPD_MONITOR_SASL_NAME "SASL"
144 #define SLAPD_MONITOR_SASL_RDN \
145 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SASL_NAME
146 #define SLAPD_MONITOR_SASL_DN \
147 SLAPD_MONITOR_SASL_RDN "," SLAPD_MONITOR_DN
149 #define SLAPD_MONITOR_TLS 5
150 #define SLAPD_MONITOR_TLS_NAME "TLS"
151 #define SLAPD_MONITOR_TLS_RDN \
152 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TLS_NAME
153 #define SLAPD_MONITOR_TLS_DN \
154 SLAPD_MONITOR_TLS_RDN "," SLAPD_MONITOR_DN
156 #define SLAPD_MONITOR_CONN 6
157 #define SLAPD_MONITOR_CONN_NAME "Connections"
158 #define SLAPD_MONITOR_CONN_RDN \
159 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_CONN_NAME
160 #define SLAPD_MONITOR_CONN_DN \
161 SLAPD_MONITOR_CONN_RDN "," SLAPD_MONITOR_DN
163 #define SLAPD_MONITOR_RWW 7
164 #define SLAPD_MONITOR_RWW_NAME "Waiters"
165 #define SLAPD_MONITOR_RWW_RDN \
166 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_RWW_NAME
167 #define SLAPD_MONITOR_RWW_DN \
168 SLAPD_MONITOR_RWW_RDN "," SLAPD_MONITOR_DN
170 #define SLAPD_MONITOR_LOG 8
171 #define SLAPD_MONITOR_LOG_NAME "Log"
172 #define SLAPD_MONITOR_LOG_RDN \
173 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_LOG_NAME
174 #define SLAPD_MONITOR_LOG_DN \
175 SLAPD_MONITOR_LOG_RDN "," SLAPD_MONITOR_DN
177 #define SLAPD_MONITOR_OPS 9
178 #define SLAPD_MONITOR_OPS_NAME "Operations"
179 #define SLAPD_MONITOR_OPS_RDN \
180 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OPS_NAME
181 #define SLAPD_MONITOR_OPS_DN \
182 SLAPD_MONITOR_OPS_RDN "," SLAPD_MONITOR_DN
184 #define SLAPD_MONITOR_SENT 10
185 #define SLAPD_MONITOR_SENT_NAME "Statistics"
186 #define SLAPD_MONITOR_SENT_RDN \
187 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_SENT_NAME
188 #define SLAPD_MONITOR_SENT_DN \
189 SLAPD_MONITOR_SENT_RDN "," SLAPD_MONITOR_DN
191 #define SLAPD_MONITOR_TIME 11
192 #define SLAPD_MONITOR_TIME_NAME "Time"
193 #define SLAPD_MONITOR_TIME_RDN \
194 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_TIME_NAME
195 #define SLAPD_MONITOR_TIME_DN \
196 SLAPD_MONITOR_TIME_RDN "," SLAPD_MONITOR_DN
198 #define SLAPD_MONITOR_OVERLAY 12
199 #define SLAPD_MONITOR_OVERLAY_NAME "Overlay"
200 #define SLAPD_MONITOR_OVERLAY_RDN \
201 SLAPD_MONITOR_AT "=" SLAPD_MONITOR_OVERLAY_NAME
202 #define SLAPD_MONITOR_OVERLAY_DN \
203 SLAPD_MONITOR_OVERLAY_RDN "," SLAPD_MONITOR_DN
205 struct monitorsubsys {
208 struct berval mss_rdn;
209 struct berval mss_dn;
210 struct berval mss_ndn;
213 #define MONITOR_HAS_VOLATILE_CH( mp ) \
214 ( ( mp )->mp_flags & MONITOR_F_VOLATILE_CH )
215 #define MONITOR_HAS_CHILDREN( mp ) \
216 ( ( mp )->mp_children || MONITOR_HAS_VOLATILE_CH( mp ) )
218 /* initialize entry and subentries */
219 int ( *mss_init )( BackendDB * );
220 /* update existing dynamic entry and subentries */
221 int ( *mss_update )( Operation *, Entry * );
222 /* create new dynamic subentries */
223 int ( *mss_create )( Operation *,
224 struct berval *ndn, Entry *, Entry ** );
225 /* modify entry and subentries */
226 int ( *mss_modify )( Operation *, Entry * );
229 extern struct monitorsubsys monitor_subsys[];
231 extern BackendDB *be_monitor;
233 /* increase this bufsize if entries in string form get too big */
234 #define BACKMONITOR_BUFSIZE 1024
240 extern int monitor_cache_cmp LDAP_P(( const void *c1, const void *c2 ));
241 extern int monitor_cache_dup LDAP_P(( void *c1, void *c2 ));
242 extern int monitor_cache_add LDAP_P(( struct monitorinfo *mi, Entry *e ));
243 extern int monitor_cache_get LDAP_P(( struct monitorinfo *mi, struct berval *ndn, Entry **ep ));
244 extern int monitor_cache_dn2entry LDAP_P(( Operation *op, struct berval *ndn, Entry **ep, Entry **matched ));
245 extern int monitor_cache_lock LDAP_P(( Entry *e ));
246 extern int monitor_cache_release LDAP_P(( struct monitorinfo *mi, Entry *e ));
252 extern int monitor_entry_update LDAP_P(( Operation *op, Entry *e ));
253 extern int monitor_entry_create LDAP_P(( Operation *op, struct berval *ndn,
254 Entry *e_parent, Entry **ep ));
255 extern int monitor_entry_modify LDAP_P(( Operation *op, Entry *e ));
259 #include "proto-back-monitor.h"
261 #endif /* _back_monitor_h_ */