]> git.sur5r.net Git - openldap/blob - servers/slapd/overlays/syncprov.c
Happy new year! (belated)
[openldap] / servers / slapd / overlays / syncprov.c
1 /* $OpenLDAP$ */
2 /* syncprov.c - syncrepl provider */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4  *
5  * Copyright 2004-2008 The OpenLDAP Foundation.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted only as authorized by the OpenLDAP
10  * Public License.
11  *
12  * A copy of this license is available in the file LICENSE in the
13  * top-level directory of the distribution or, alternatively, at
14  * <http://www.OpenLDAP.org/license.html>.
15  */
16 /* ACKNOWLEDGEMENTS:
17  * This work was initially developed by Howard Chu for inclusion in
18  * OpenLDAP Software.
19  */
20
21 #include "portable.h"
22
23 #ifdef SLAPD_OVER_SYNCPROV
24
25 #include <ac/string.h>
26 #include "lutil.h"
27 #include "slap.h"
28 #include "config.h"
29 #include "ldap_rq.h"
30
31 /* A modify request on a particular entry */
32 typedef struct modinst {
33         struct modinst *mi_next;
34         Operation *mi_op;
35 } modinst;
36
37 typedef struct modtarget {
38         struct modinst *mt_mods;
39         struct modinst *mt_tail;
40         Operation *mt_op;
41         ldap_pvt_thread_mutex_t mt_mutex;
42 } modtarget;
43
44 /* A queued result of a persistent search */
45 typedef struct syncres {
46         struct syncres *s_next;
47         struct berval s_dn;
48         struct berval s_ndn;
49         struct berval s_uuid;
50         struct berval s_csn;
51         char s_mode;
52         char s_isreference;
53 } syncres;
54
55 /* Record of a persistent search */
56 typedef struct syncops {
57         struct syncops *s_next;
58         struct berval   s_base;         /* ndn of search base */
59         ID              s_eid;          /* entryID of search base */
60         Operation       *s_op;          /* search op */
61         int             s_rid;
62         struct berval s_filterstr;
63         int             s_flags;        /* search status */
64 #define PS_IS_REFRESHING        0x01
65 #define PS_IS_DETACHED          0x02
66 #define PS_WROTE_BASE           0x04
67 #define PS_FIND_BASE            0x08
68 #define PS_FIX_FILTER           0x10
69
70         int             s_inuse;        /* reference count */
71         struct syncres *s_res;
72         struct syncres *s_restail;
73         struct re_s     *s_qtask;       /* task for playing psearch responses */
74 #define RUNQ_INTERVAL   36000   /* a long time */
75         ldap_pvt_thread_mutex_t s_mutex;
76 } syncops;
77
78 /* A received sync control */
79 typedef struct sync_control {
80         struct sync_cookie sr_state;
81         int sr_rhint;
82 } sync_control;
83
84 #if 0 /* moved back to slap.h */
85 #define o_sync  o_ctrlflag[slap_cids.sc_LDAPsync]
86 #endif
87 /* o_sync_mode uses data bits of o_sync */
88 #define o_sync_mode     o_ctrlflag[slap_cids.sc_LDAPsync]
89
90 #define SLAP_SYNC_NONE                                  (LDAP_SYNC_NONE<<SLAP_CONTROL_SHIFT)
91 #define SLAP_SYNC_REFRESH                               (LDAP_SYNC_REFRESH_ONLY<<SLAP_CONTROL_SHIFT)
92 #define SLAP_SYNC_PERSIST                               (LDAP_SYNC_RESERVED<<SLAP_CONTROL_SHIFT)
93 #define SLAP_SYNC_REFRESH_AND_PERSIST   (LDAP_SYNC_REFRESH_AND_PERSIST<<SLAP_CONTROL_SHIFT)
94
95 /* Record of which searches matched at premodify step */
96 typedef struct syncmatches {
97         struct syncmatches *sm_next;
98         syncops *sm_op;
99 } syncmatches;
100
101 /* Session log data */
102 typedef struct slog_entry {
103         struct slog_entry *se_next;
104         struct berval se_uuid;
105         struct berval se_csn;
106         ber_tag_t       se_tag;
107 } slog_entry;
108
109 typedef struct sessionlog {
110         struct berval   sl_mincsn;
111         int             sl_num;
112         int             sl_size;
113         slog_entry *sl_head;
114         slog_entry *sl_tail;
115         ldap_pvt_thread_mutex_t sl_mutex;
116 } sessionlog;
117
118 /* The main state for this overlay */
119 typedef struct syncprov_info_t {
120         syncops         *si_ops;
121         struct berval   si_ctxcsn;      /* ldapsync context */
122         int             si_chkops;      /* checkpointing info */
123         int             si_chktime;
124         int             si_numops;      /* number of ops since last checkpoint */
125         int             si_nopres;      /* Skip present phase */
126         int             si_usehint;     /* use reload hint */
127         time_t  si_chklast;     /* time of last checkpoint */
128         Avlnode *si_mods;       /* entries being modified */
129         sessionlog      *si_logs;
130         ldap_pvt_thread_rdwr_t  si_csn_rwlock;
131         ldap_pvt_thread_mutex_t si_ops_mutex;
132         ldap_pvt_thread_mutex_t si_mods_mutex;
133         char            si_ctxcsnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
134 } syncprov_info_t;
135
136 typedef struct opcookie {
137         slap_overinst *son;
138         syncmatches *smatches;
139         struct berval sdn;      /* DN of entry, for deletes */
140         struct berval sndn;
141         struct berval suuid;    /* UUID of entry */
142         struct berval sctxcsn;
143         int sreference; /* Is the entry a reference? */
144 } opcookie;
145
146 typedef struct fbase_cookie {
147         struct berval *fdn;     /* DN of a modified entry, for scope testing */
148         syncops *fss;   /* persistent search we're testing against */
149         int fbase;      /* if TRUE we found the search base and it's still valid */
150         int fscope;     /* if TRUE then fdn is within the psearch scope */
151 } fbase_cookie;
152
153 static AttributeName csn_anlist[3];
154 static AttributeName uuid_anlist[2];
155
156 /* Build a LDAPsync intermediate state control */
157 static int
158 syncprov_state_ctrl(
159         Operation       *op,
160         SlapReply       *rs,
161         Entry           *e,
162         int             entry_sync_state,
163         LDAPControl     **ctrls,
164         int             num_ctrls,
165         int             send_cookie,
166         struct berval   *cookie )
167 {
168         Attribute* a;
169         int ret;
170
171         BerElementBuffer berbuf;
172         BerElement *ber = (BerElement *)&berbuf;
173
174         struct berval   entryuuid_bv = BER_BVNULL;
175
176         ber_init2( ber, 0, LBER_USE_DER );
177         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
178
179         ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
180
181         for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
182                 AttributeDescription *desc = a->a_desc;
183                 if ( desc == slap_schema.si_ad_entryUUID ) {
184                         entryuuid_bv = a->a_nvals[0];
185                         break;
186                 }
187         }
188
189         /* FIXME: what if entryuuid is NULL or empty ? */
190
191         if ( send_cookie && cookie ) {
192                 ber_printf( ber, "{eOON}",
193                         entry_sync_state, &entryuuid_bv, cookie );
194         } else {
195                 ber_printf( ber, "{eON}",
196                         entry_sync_state, &entryuuid_bv );
197         }
198
199         ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_STATE;
200         ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
201         ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
202
203         ber_free_buf( ber );
204
205         if ( ret < 0 ) {
206                 Debug( LDAP_DEBUG_TRACE,
207                         "slap_build_sync_ctrl: ber_flatten2 failed\n",
208                         0, 0, 0 );
209                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
210                 return ret;
211         }
212
213         return LDAP_SUCCESS;
214 }
215
216 /* Build a LDAPsync final state control */
217 static int
218 syncprov_done_ctrl(
219         Operation       *op,
220         SlapReply       *rs,
221         LDAPControl     **ctrls,
222         int                     num_ctrls,
223         int                     send_cookie,
224         struct berval *cookie,
225         int                     refreshDeletes )
226 {
227         int ret;
228         BerElementBuffer berbuf;
229         BerElement *ber = (BerElement *)&berbuf;
230
231         ber_init2( ber, NULL, LBER_USE_DER );
232         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
233
234         ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
235
236         ber_printf( ber, "{" );
237         if ( send_cookie && cookie ) {
238                 ber_printf( ber, "O", cookie );
239         }
240         if ( refreshDeletes == LDAP_SYNC_REFRESH_DELETES ) {
241                 ber_printf( ber, "b", refreshDeletes );
242         }
243         ber_printf( ber, "N}" );
244
245         ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_DONE;
246         ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
247         ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
248
249         ber_free_buf( ber );
250
251         if ( ret < 0 ) {
252                 Debug( LDAP_DEBUG_TRACE,
253                         "syncprov_done_ctrl: ber_flatten2 failed\n",
254                         0, 0, 0 );
255                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
256                 return ret;
257         }
258
259         return LDAP_SUCCESS;
260 }
261
262 static int
263 syncprov_sendinfo(
264         Operation       *op,
265         SlapReply       *rs,
266         int                     type,
267         struct berval *cookie,
268         int                     refreshDone,
269         BerVarray       syncUUIDs,
270         int                     refreshDeletes )
271 {
272         BerElementBuffer berbuf;
273         BerElement *ber = (BerElement *)&berbuf;
274         struct berval rspdata;
275
276         int ret;
277
278         ber_init2( ber, NULL, LBER_USE_DER );
279         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
280
281         if ( type ) {
282                 switch ( type ) {
283                 case LDAP_TAG_SYNC_NEW_COOKIE:
284                         ber_printf( ber, "tO", type, cookie );
285                         break;
286                 case LDAP_TAG_SYNC_REFRESH_DELETE:
287                 case LDAP_TAG_SYNC_REFRESH_PRESENT:
288                         ber_printf( ber, "t{", type );
289                         if ( cookie ) {
290                                 ber_printf( ber, "O", cookie );
291                         }
292                         if ( refreshDone == 0 ) {
293                                 ber_printf( ber, "b", refreshDone );
294                         }
295                         ber_printf( ber, "N}" );
296                         break;
297                 case LDAP_TAG_SYNC_ID_SET:
298                         ber_printf( ber, "t{", type );
299                         if ( cookie ) {
300                                 ber_printf( ber, "O", cookie );
301                         }
302                         if ( refreshDeletes == 1 ) {
303                                 ber_printf( ber, "b", refreshDeletes );
304                         }
305                         ber_printf( ber, "[W]", syncUUIDs );
306                         ber_printf( ber, "N}" );
307                         break;
308                 default:
309                         Debug( LDAP_DEBUG_TRACE,
310                                 "syncprov_sendinfo: invalid syncinfo type (%d)\n",
311                                 type, 0, 0 );
312                         return LDAP_OTHER;
313                 }
314         }
315
316         ret = ber_flatten2( ber, &rspdata, 0 );
317
318         if ( ret < 0 ) {
319                 Debug( LDAP_DEBUG_TRACE,
320                         "syncprov_sendinfo: ber_flatten2 failed\n",
321                         0, 0, 0 );
322                 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
323                 return ret;
324         }
325
326         rs->sr_rspoid = LDAP_SYNC_INFO;
327         rs->sr_rspdata = &rspdata;
328         send_ldap_intermediate( op, rs );
329         rs->sr_rspdata = NULL;
330         ber_free_buf( ber );
331
332         return LDAP_SUCCESS;
333 }
334
335 /* Find a modtarget in an AVL tree */
336 static int
337 sp_avl_cmp( const void *c1, const void *c2 )
338 {
339         const modtarget *m1, *m2;
340         int rc;
341
342         m1 = c1; m2 = c2;
343         rc = m1->mt_op->o_req_ndn.bv_len - m2->mt_op->o_req_ndn.bv_len;
344
345         if ( rc ) return rc;
346         return ber_bvcmp( &m1->mt_op->o_req_ndn, &m2->mt_op->o_req_ndn );
347 }
348
349 /* syncprov_findbase:
350  *   finds the true DN of the base of a search (with alias dereferencing) and
351  * checks to make sure the base entry doesn't get replaced with a different
352  * entry (e.g., swapping trees via ModDN, or retargeting an alias). If a
353  * change is detected, any persistent search on this base must be terminated /
354  * reloaded.
355  *   On the first call, we just save the DN and entryID. On subsequent calls
356  * we compare the DN and entryID with the saved values.
357  */
358 static int
359 findbase_cb( Operation *op, SlapReply *rs )
360 {
361         slap_callback *sc = op->o_callback;
362
363         if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
364                 fbase_cookie *fc = sc->sc_private;
365
366                 /* If no entryID, we're looking for the first time.
367                  * Just store whatever we got.
368                  */
369                 if ( fc->fss->s_eid == NOID ) {
370                         fc->fbase = 2;
371                         fc->fss->s_eid = rs->sr_entry->e_id;
372                         ber_dupbv( &fc->fss->s_base, &rs->sr_entry->e_nname );
373
374                 } else if ( rs->sr_entry->e_id == fc->fss->s_eid &&
375                         dn_match( &rs->sr_entry->e_nname, &fc->fss->s_base )) {
376
377                 /* OK, the DN is the same and the entryID is the same. */
378                         fc->fbase = 1;
379                 }
380         }
381         if ( rs->sr_err != LDAP_SUCCESS ) {
382                 Debug( LDAP_DEBUG_ANY, "findbase failed! %d\n", rs->sr_err,0,0 );
383         }
384         return LDAP_SUCCESS;
385 }
386
387 static Filter generic_filter = { LDAP_FILTER_PRESENT, { 0 }, NULL };
388 static struct berval generic_filterstr = BER_BVC("(objectclass=*)");
389
390 static int
391 syncprov_findbase( Operation *op, fbase_cookie *fc )
392 {
393         opcookie *opc = op->o_callback->sc_private;
394         slap_overinst *on = opc->son;
395
396         /* Use basic parameters from syncrepl search, but use
397          * current op's threadctx / tmpmemctx
398          */
399         ldap_pvt_thread_mutex_lock( &fc->fss->s_mutex );
400         if ( fc->fss->s_flags & PS_FIND_BASE ) {
401                 slap_callback cb = {0};
402                 Operation fop;
403                 SlapReply frs = { REP_RESULT };
404                 BackendInfo *bi;
405                 int rc;
406
407                 fc->fss->s_flags ^= PS_FIND_BASE;
408                 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
409
410                 fop = *fc->fss->s_op;
411
412                 fop.o_hdr = op->o_hdr;
413                 fop.o_bd = op->o_bd;
414                 fop.o_time = op->o_time;
415                 fop.o_tincr = op->o_tincr;
416                 bi = op->o_bd->bd_info;
417
418                 cb.sc_response = findbase_cb;
419                 cb.sc_private = fc;
420
421                 fop.o_sync_mode = 0;    /* turn off sync mode */
422                 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
423                 fop.o_callback = &cb;
424                 fop.o_tag = LDAP_REQ_SEARCH;
425                 fop.ors_scope = LDAP_SCOPE_BASE;
426                 fop.ors_limit = NULL;
427                 fop.ors_slimit = 1;
428                 fop.ors_tlimit = SLAP_NO_LIMIT;
429                 fop.ors_attrs = slap_anlist_no_attrs;
430                 fop.ors_attrsonly = 1;
431                 fop.ors_filter = &generic_filter;
432                 fop.ors_filterstr = generic_filterstr;
433
434                 rc = overlay_op_walk( &fop, &frs, op_search, on->on_info, on );
435                 op->o_bd->bd_info = bi;
436         } else {
437                 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
438                 fc->fbase = 1;
439         }
440
441         /* After the first call, see if the fdn resides in the scope */
442         if ( fc->fbase == 1 ) {
443                 switch ( fc->fss->s_op->ors_scope ) {
444                 case LDAP_SCOPE_BASE:
445                         fc->fscope = dn_match( fc->fdn, &fc->fss->s_base );
446                         break;
447                 case LDAP_SCOPE_ONELEVEL: {
448                         struct berval pdn;
449                         dnParent( fc->fdn, &pdn );
450                         fc->fscope = dn_match( &pdn, &fc->fss->s_base );
451                         break; }
452                 case LDAP_SCOPE_SUBTREE:
453                         fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base );
454                         break;
455                 case LDAP_SCOPE_SUBORDINATE:
456                         fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base ) &&
457                                 !dn_match( fc->fdn, &fc->fss->s_base );
458                         break;
459                 }
460         }
461
462         if ( fc->fbase )
463                 return LDAP_SUCCESS;
464
465         /* If entryID has changed, then the base of this search has
466          * changed. Invalidate the psearch.
467          */
468         return LDAP_NO_SUCH_OBJECT;
469 }
470
471 /* syncprov_findcsn:
472  *   This function has three different purposes, but they all use a search
473  * that filters on entryCSN so they're combined here.
474  * 1: at startup time, after a contextCSN has been read from the database,
475  * we search for all entries with CSN >= contextCSN in case the contextCSN
476  * was not checkpointed at the previous shutdown.
477  *
478  * 2: when the current contextCSN is known and we have a sync cookie, we search
479  * for one entry with CSN = the cookie CSN. If not found, try <= cookie CSN.
480  * If an entry is found, the cookie CSN is valid, otherwise it is stale.
481  *
482  * 3: during a refresh phase, we search for all entries with CSN <= the cookie
483  * CSN, and generate Present records for them. We always collect this result
484  * in SyncID sets, even if there's only one match.
485  */
486 typedef enum find_csn_t {
487         FIND_MAXCSN     = 1,
488         FIND_CSN        = 2,
489         FIND_PRESENT    = 3
490 } find_csn_t;
491
492 static int
493 findmax_cb( Operation *op, SlapReply *rs )
494 {
495         if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
496                 struct berval *maxcsn = op->o_callback->sc_private;
497                 Attribute *a = attr_find( rs->sr_entry->e_attrs,
498                         slap_schema.si_ad_entryCSN );
499
500                 if ( a && ber_bvcmp( &a->a_vals[0], maxcsn ) > 0 ) {
501                         maxcsn->bv_len = a->a_vals[0].bv_len;
502                         strcpy( maxcsn->bv_val, a->a_vals[0].bv_val );
503                 }
504         }
505         return LDAP_SUCCESS;
506 }
507
508 static int
509 findcsn_cb( Operation *op, SlapReply *rs )
510 {
511         slap_callback *sc = op->o_callback;
512
513         /* We just want to know that at least one exists, so it's OK if
514          * we exceed the unchecked limit.
515          */
516         if ( rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
517                 (rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS )) {
518                 sc->sc_private = (void *)1;
519         }
520         return LDAP_SUCCESS;
521 }
522
523 /* Build a list of entryUUIDs for sending in a SyncID set */
524
525 #define UUID_LEN        16
526
527 typedef struct fpres_cookie {
528         int num;
529         BerVarray uuids;
530         char *last;
531 } fpres_cookie;
532
533 static int
534 findpres_cb( Operation *op, SlapReply *rs )
535 {
536         slap_callback *sc = op->o_callback;
537         fpres_cookie *pc = sc->sc_private;
538         Attribute *a;
539         int ret = SLAP_CB_CONTINUE;
540
541         switch ( rs->sr_type ) {
542         case REP_SEARCH:
543                 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryUUID );
544                 if ( a ) {
545                         pc->uuids[pc->num].bv_val = pc->last;
546                         AC_MEMCPY( pc->uuids[pc->num].bv_val, a->a_nvals[0].bv_val,
547                                 pc->uuids[pc->num].bv_len );
548                         pc->num++;
549                         pc->last = pc->uuids[pc->num].bv_val;
550                         pc->uuids[pc->num].bv_val = NULL;
551                 }
552                 ret = LDAP_SUCCESS;
553                 if ( pc->num != SLAP_SYNCUUID_SET_SIZE )
554                         break;
555                 /* FALLTHRU */
556         case REP_RESULT:
557                 ret = rs->sr_err;
558                 if ( pc->num ) {
559                         ret = syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, NULL,
560                                 0, pc->uuids, 0 );
561                         pc->uuids[pc->num].bv_val = pc->last;
562                         pc->num = 0;
563                         pc->last = pc->uuids[0].bv_val;
564                 }
565                 break;
566         default:
567                 break;
568         }
569         return ret;
570 }
571
572 static int
573 syncprov_findcsn( Operation *op, find_csn_t mode )
574 {
575         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
576         syncprov_info_t         *si = on->on_bi.bi_private;
577
578         slap_callback cb = {0};
579         Operation fop;
580         SlapReply frs = { REP_RESULT };
581         char buf[LDAP_LUTIL_CSNSTR_BUFSIZE + STRLENOF("(entryCSN<=)")];
582         char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
583         struct berval maxcsn;
584         Filter cf;
585 #ifdef LDAP_COMP_MATCH
586         AttributeAssertion eq = { NULL, BER_BVNULL, NULL };
587 #else
588         AttributeAssertion eq = { NULL, BER_BVNULL };
589 #endif
590         fpres_cookie pcookie;
591         sync_control *srs = NULL;
592         struct slap_limits_set fc_limits;
593         int i, rc = LDAP_SUCCESS, findcsn_retry = 1;
594
595         if ( mode != FIND_MAXCSN ) {
596                 srs = op->o_controls[slap_cids.sc_LDAPsync];
597
598                 if ( srs->sr_state.ctxcsn.bv_len >= LDAP_LUTIL_CSNSTR_BUFSIZE ) {
599                         return LDAP_OTHER;
600                 }
601         }
602
603         fop = *op;
604         fop.o_sync_mode &= SLAP_CONTROL_MASK;   /* turn off sync_mode */
605         /* We want pure entries, not referrals */
606         fop.o_managedsait = SLAP_CONTROL_CRITICAL;
607
608         cf.f_ava = &eq;
609         cf.f_av_desc = slap_schema.si_ad_entryCSN;
610         cf.f_next = NULL;
611
612         fop.o_callback = &cb;
613         fop.ors_limit = NULL;
614         fop.ors_tlimit = SLAP_NO_LIMIT;
615         fop.ors_filter = &cf;
616         fop.ors_filterstr.bv_val = buf;
617
618 again:
619         switch( mode ) {
620         case FIND_MAXCSN:
621                 cf.f_choice = LDAP_FILTER_GE;
622                 cf.f_av_value = si->si_ctxcsn;
623                 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN>=%s)",
624                         cf.f_av_value.bv_val );
625                 fop.ors_attrsonly = 0;
626                 fop.ors_attrs = csn_anlist;
627                 fop.ors_slimit = SLAP_NO_LIMIT;
628                 cb.sc_private = &maxcsn;
629                 cb.sc_response = findmax_cb;
630                 strcpy( cbuf, si->si_ctxcsn.bv_val );
631                 maxcsn.bv_val = cbuf;
632                 maxcsn.bv_len = si->si_ctxcsn.bv_len;
633                 break;
634         case FIND_CSN:
635                 cf.f_av_value = srs->sr_state.ctxcsn;
636                 /* Look for exact match the first time */
637                 if ( findcsn_retry ) {
638                         cf.f_choice = LDAP_FILTER_EQUALITY;
639                         fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN=%s)",
640                                 cf.f_av_value.bv_val );
641                 /* On retry, look for <= */
642                 } else {
643                         cf.f_choice = LDAP_FILTER_LE;
644                         fop.ors_limit = &fc_limits;
645                         memset( &fc_limits, 0, sizeof( fc_limits ));
646                         fc_limits.lms_s_unchecked = 1;
647                         fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN<=%s)",
648                                 cf.f_av_value.bv_val );
649                 }
650                 fop.ors_attrsonly = 1;
651                 fop.ors_attrs = slap_anlist_no_attrs;
652                 fop.ors_slimit = 1;
653                 cb.sc_private = NULL;
654                 cb.sc_response = findcsn_cb;
655                 break;
656         case FIND_PRESENT:
657                 fop.ors_filter = op->ors_filter;
658                 fop.ors_filterstr = op->ors_filterstr;
659                 fop.ors_attrsonly = 0;
660                 fop.ors_attrs = uuid_anlist;
661                 fop.ors_slimit = SLAP_NO_LIMIT;
662                 cb.sc_private = &pcookie;
663                 cb.sc_response = findpres_cb;
664                 pcookie.num = 0;
665
666                 /* preallocate storage for a full set */
667                 pcookie.uuids = op->o_tmpalloc( (SLAP_SYNCUUID_SET_SIZE+1) *
668                         sizeof(struct berval) + SLAP_SYNCUUID_SET_SIZE * UUID_LEN,
669                         op->o_tmpmemctx );
670                 pcookie.last = (char *)(pcookie.uuids + SLAP_SYNCUUID_SET_SIZE+1);
671                 pcookie.uuids[0].bv_val = pcookie.last;
672                 pcookie.uuids[0].bv_len = UUID_LEN;
673                 for (i=1; i<SLAP_SYNCUUID_SET_SIZE; i++) {
674                         pcookie.uuids[i].bv_val = pcookie.uuids[i-1].bv_val + UUID_LEN;
675                         pcookie.uuids[i].bv_len = UUID_LEN;
676                 }
677                 break;
678         }
679
680         fop.o_bd->bd_info = on->on_info->oi_orig;
681         fop.o_bd->be_search( &fop, &frs );
682         fop.o_bd->bd_info = (BackendInfo *)on;
683
684         switch( mode ) {
685         case FIND_MAXCSN:
686                 strcpy( si->si_ctxcsnbuf, maxcsn.bv_val );
687                 si->si_ctxcsn.bv_len = maxcsn.bv_len;
688                 break;
689         case FIND_CSN:
690                 /* If matching CSN was not found, invalidate the context. */
691                 if ( !cb.sc_private ) {
692                         /* If we didn't find an exact match, then try for <= */
693                         if ( findcsn_retry ) {
694                                 findcsn_retry = 0;
695                                 goto again;
696                         }
697                         rc = LDAP_NO_SUCH_OBJECT;
698                 }
699                 break;
700         case FIND_PRESENT:
701                 op->o_tmpfree( pcookie.uuids, op->o_tmpmemctx );
702                 break;
703         }
704
705         return rc;
706 }
707
708 static void
709 syncprov_free_syncop( syncops *so )
710 {
711         syncres *sr, *srnext;
712         GroupAssertion *ga, *gnext;
713
714         ldap_pvt_thread_mutex_lock( &so->s_mutex );
715         if ( --so->s_inuse > 0 ) {
716                 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
717                 return;
718         }
719         ldap_pvt_thread_mutex_unlock( &so->s_mutex );
720         if ( so->s_flags & PS_IS_DETACHED ) {
721                 filter_free( so->s_op->ors_filter );
722                 for ( ga = so->s_op->o_groups; ga; ga=gnext ) {
723                         gnext = ga->ga_next;
724                         ch_free( ga );
725                 }
726                 ch_free( so->s_op );
727         }
728         ch_free( so->s_base.bv_val );
729         for ( sr=so->s_res; sr; sr=srnext ) {
730                 srnext = sr->s_next;
731                 ch_free( sr );
732         }
733         ldap_pvt_thread_mutex_destroy( &so->s_mutex );
734         ch_free( so );
735 }
736
737 /* Send a persistent search response */
738 static int
739 syncprov_sendresp( Operation *op, opcookie *opc, syncops *so,
740         Entry **e, int mode )
741 {
742         slap_overinst *on = opc->son;
743
744         SlapReply rs = { REP_SEARCH };
745         LDAPControl *ctrls[2];
746         struct berval cookie;
747         Entry e_uuid = {0};
748         Attribute a_uuid = {0};
749
750         if ( so->s_op->o_abandon )
751                 return SLAPD_ABANDON;
752
753         ctrls[1] = NULL;
754         slap_compose_sync_cookie( op, &cookie, &opc->sctxcsn, so->s_rid );
755
756         e_uuid.e_attrs = &a_uuid;
757         a_uuid.a_desc = slap_schema.si_ad_entryUUID;
758         a_uuid.a_nvals = &opc->suuid;
759         rs.sr_err = syncprov_state_ctrl( op, &rs, &e_uuid,
760                 mode, ctrls, 0, 1, &cookie );
761         op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
762
763         rs.sr_ctrls = ctrls;
764         op->o_bd->bd_info = (BackendInfo *)on->on_info;
765         switch( mode ) {
766         case LDAP_SYNC_ADD:
767                 rs.sr_entry = *e;
768                 if ( rs.sr_entry->e_private )
769                         rs.sr_flags = REP_ENTRY_MUSTRELEASE;
770                 if ( opc->sreference ) {
771                         rs.sr_ref = get_entry_referrals( op, rs.sr_entry );
772                         rs.sr_err = send_search_reference( op, &rs );
773                         ber_bvarray_free( rs.sr_ref );
774                         if ( !rs.sr_entry )
775                                 *e = NULL;
776                         break;
777                 }
778                 /* fallthru */
779         case LDAP_SYNC_MODIFY:
780                 rs.sr_entry = *e;
781                 if ( rs.sr_entry->e_private )
782                         rs.sr_flags = REP_ENTRY_MUSTRELEASE;
783                 rs.sr_attrs = op->ors_attrs;
784                 rs.sr_err = send_search_entry( op, &rs );
785                 if ( !rs.sr_entry )
786                         *e = NULL;
787                 break;
788         case LDAP_SYNC_DELETE:
789                 e_uuid.e_attrs = NULL;
790                 e_uuid.e_name = opc->sdn;
791                 e_uuid.e_nname = opc->sndn;
792                 rs.sr_entry = &e_uuid;
793                 if ( opc->sreference ) {
794                         struct berval bv = BER_BVNULL;
795                         rs.sr_ref = &bv;
796                         rs.sr_err = send_search_reference( op, &rs );
797                 } else {
798                         rs.sr_err = send_search_entry( op, &rs );
799                 }
800                 break;
801         default:
802                 assert(0);
803         }
804         /* In case someone else freed it already? */
805         if ( rs.sr_ctrls ) {
806                 op->o_tmpfree( rs.sr_ctrls[0], op->o_tmpmemctx );
807                 rs.sr_ctrls = NULL;
808         }
809
810         return rs.sr_err;
811 }
812
813 /* Play back queued responses */
814 static int
815 syncprov_qplay( Operation *op, slap_overinst *on, syncops *so )
816 {
817         syncres *sr;
818         Entry *e;
819         opcookie opc;
820         int rc = 0;
821
822         opc.son = on;
823
824         for (;;) {
825                 ldap_pvt_thread_mutex_lock( &so->s_mutex );
826                 sr = so->s_res;
827                 if ( sr )
828                         so->s_res = sr->s_next;
829                 if ( !so->s_res )
830                         so->s_restail = NULL;
831                 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
832
833                 if ( !sr || so->s_op->o_abandon )
834                         break;
835
836                 opc.sdn = sr->s_dn;
837                 opc.sndn = sr->s_ndn;
838                 opc.suuid = sr->s_uuid;
839                 opc.sctxcsn = sr->s_csn;
840                 opc.sreference = sr->s_isreference;
841                 e = NULL;
842
843                 if ( sr->s_mode != LDAP_SYNC_DELETE ) {
844                         rc = overlay_entry_get_ov( op, &opc.sndn, NULL, NULL, 0, &e, on );
845                         if ( rc ) {
846                                 Debug( LDAP_DEBUG_SYNC, "syncprov_qplay: failed to get %s, "
847                                         "error (%d), ignoring...\n", opc.sndn.bv_val, rc, 0 );
848                                 ch_free( sr );
849                                 rc = 0;
850                                 continue;
851                         }
852                 }
853                 rc = syncprov_sendresp( op, &opc, so, &e, sr->s_mode );
854
855                 if ( e ) {
856                         overlay_entry_release_ov( op, e, 0, on );
857                 }
858
859                 ch_free( sr );
860
861                 if ( rc )
862                         break;
863         }
864         return rc;
865 }
866
867 /* runqueue task for playing back queued responses */
868 static void *
869 syncprov_qtask( void *ctx, void *arg )
870 {
871         struct re_s *rtask = arg;
872         syncops *so = rtask->arg;
873         slap_overinst *on = so->s_op->o_private;
874         OperationBuffer opbuf;
875         Operation *op;
876         BackendDB be;
877         int rc;
878
879         op = (Operation *) &opbuf;
880         *op = *so->s_op;
881         op->o_hdr = (Opheader *)(op+1);
882         op->o_controls = (void **)(op->o_hdr+1);
883         memset( op->o_controls, 0, SLAP_MAX_CIDS * sizeof(void *));
884
885         *op->o_hdr = *so->s_op->o_hdr;
886
887         op->o_tmpmemctx = slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, ctx);
888         op->o_tmpmfuncs = &slap_sl_mfuncs;
889         op->o_threadctx = ctx;
890
891         /* syncprov_qplay expects a fake db */
892         be = *so->s_op->o_bd;
893         be.be_flags |= SLAP_DBFLAG_OVERLAY;
894         op->o_bd = &be;
895         op->o_private = NULL;
896         op->o_callback = NULL;
897
898         rc = syncprov_qplay( op, on, so );
899
900         /* decrement use count... */
901         syncprov_free_syncop( so );
902
903         /* wait until we get explicitly scheduled again */
904         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
905         ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
906         if ( rc == 0 ) {
907                 ldap_pvt_runqueue_resched( &slapd_rq, rtask, 1 );
908         } else {
909                 /* bail out on any error */
910                 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
911         }
912         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
913
914         return NULL;
915 }
916
917 /* Start the task to play back queued psearch responses */
918 static void
919 syncprov_qstart( syncops *so )
920 {
921         int wake=0;
922         ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
923         if ( !so->s_qtask ) {
924                 so->s_qtask = ldap_pvt_runqueue_insert( &slapd_rq, RUNQ_INTERVAL,
925                         syncprov_qtask, so, "syncprov_qtask",
926                         so->s_op->o_conn->c_peer_name.bv_val );
927                 ++so->s_inuse;
928                 wake = 1;
929         } else {
930                 if (!ldap_pvt_runqueue_isrunning( &slapd_rq, so->s_qtask ) &&
931                         !so->s_qtask->next_sched.tv_sec ) {
932                         so->s_qtask->interval.tv_sec = 0;
933                         ldap_pvt_runqueue_resched( &slapd_rq, so->s_qtask, 0 );
934                         so->s_qtask->interval.tv_sec = RUNQ_INTERVAL;
935                         ++so->s_inuse;
936                         wake = 1;
937                 }
938         }
939         ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
940         if ( wake )
941                 slap_wake_listener();
942 }
943
944 /* Queue a persistent search response */
945 static int
946 syncprov_qresp( opcookie *opc, syncops *so, int mode )
947 {
948         syncres *sr;
949
950         sr = ch_malloc(sizeof(syncres) + opc->suuid.bv_len + 1 +
951                 opc->sdn.bv_len + 1 + opc->sndn.bv_len + 1 + opc->sctxcsn.bv_len + 1 );
952         sr->s_next = NULL;
953         sr->s_dn.bv_val = (char *)(sr + 1);
954         sr->s_dn.bv_len = opc->sdn.bv_len;
955         sr->s_mode = mode;
956         sr->s_isreference = opc->sreference;
957         sr->s_ndn.bv_val = lutil_strcopy( sr->s_dn.bv_val,
958                  opc->sdn.bv_val ) + 1;
959         sr->s_ndn.bv_len = opc->sndn.bv_len;
960         sr->s_uuid.bv_val = lutil_strcopy( sr->s_ndn.bv_val,
961                  opc->sndn.bv_val ) + 1;
962         sr->s_uuid.bv_len = opc->suuid.bv_len;
963         AC_MEMCPY( sr->s_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
964         sr->s_csn.bv_val = sr->s_uuid.bv_val + sr->s_uuid.bv_len + 1;
965         sr->s_csn.bv_len = opc->sctxcsn.bv_len;
966         strcpy( sr->s_csn.bv_val, opc->sctxcsn.bv_val );
967
968         ldap_pvt_thread_mutex_lock( &so->s_mutex );
969         if ( !so->s_res ) {
970                 so->s_res = sr;
971         } else {
972                 so->s_restail->s_next = sr;
973         }
974         so->s_restail = sr;
975
976         /* If the base of the psearch was modified, check it next time round */
977         if ( so->s_flags & PS_WROTE_BASE ) {
978                 so->s_flags ^= PS_WROTE_BASE;
979                 so->s_flags |= PS_FIND_BASE;
980         }
981         if ( so->s_flags & PS_IS_DETACHED ) {
982                 syncprov_qstart( so );
983         }
984         ldap_pvt_thread_mutex_unlock( &so->s_mutex );
985         return LDAP_SUCCESS;
986 }
987
988 static int
989 syncprov_drop_psearch( syncops *so, int lock )
990 {
991         if ( so->s_flags & PS_IS_DETACHED ) {
992                 if ( lock )
993                         ldap_pvt_thread_mutex_lock( &so->s_op->o_conn->c_mutex );
994                 so->s_op->o_conn->c_n_ops_executing--;
995                 so->s_op->o_conn->c_n_ops_completed++;
996                 LDAP_STAILQ_REMOVE( &so->s_op->o_conn->c_ops, so->s_op, slap_op,
997                         o_next );
998                 if ( lock )
999                         ldap_pvt_thread_mutex_unlock( &so->s_op->o_conn->c_mutex );
1000         }
1001         syncprov_free_syncop( so );
1002
1003         return 0;
1004 }
1005
1006 static int
1007 syncprov_ab_cleanup( Operation *op, SlapReply *rs )
1008 {
1009         slap_callback *sc = op->o_callback;
1010         op->o_callback = sc->sc_next;
1011         syncprov_drop_psearch( op->o_callback->sc_private, 0 );
1012         op->o_tmpfree( sc, op->o_tmpmemctx );
1013         return 0;
1014 }
1015
1016 static int
1017 syncprov_op_abandon( Operation *op, SlapReply *rs )
1018 {
1019         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
1020         syncprov_info_t         *si = on->on_bi.bi_private;
1021         syncops *so, *soprev;
1022
1023         ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1024         for ( so=si->si_ops, soprev = (syncops *)&si->si_ops; so;
1025                 soprev=so, so=so->s_next ) {
1026                 if ( so->s_op->o_connid == op->o_connid &&
1027                         so->s_op->o_msgid == op->orn_msgid ) {
1028                                 so->s_op->o_abandon = 1;
1029                                 soprev->s_next = so->s_next;
1030                                 break;
1031                 }
1032         }
1033         ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1034         if ( so ) {
1035                 /* Is this really a Cancel exop? */
1036                 if ( op->o_tag != LDAP_REQ_ABANDON ) {
1037                         so->s_op->o_cancel = SLAP_CANCEL_ACK;
1038                         rs->sr_err = LDAP_CANCELLED;
1039                         send_ldap_result( so->s_op, rs );
1040                         if ( so->s_flags & PS_IS_DETACHED ) {
1041                                 slap_callback *cb;
1042                                 cb = op->o_tmpcalloc( 1, sizeof(slap_callback), op->o_tmpmemctx );
1043                                 cb->sc_cleanup = syncprov_ab_cleanup;
1044                                 cb->sc_next = op->o_callback;
1045                                 cb->sc_private = so;
1046                                 return SLAP_CB_CONTINUE;
1047                         }
1048                 }
1049                 syncprov_drop_psearch( so, 0 );
1050         }
1051         return SLAP_CB_CONTINUE;
1052 }
1053
1054 /* Find which persistent searches are affected by this operation */
1055 static void
1056 syncprov_matchops( Operation *op, opcookie *opc, int saveit )
1057 {
1058         slap_overinst *on = opc->son;
1059         syncprov_info_t         *si = on->on_bi.bi_private;
1060
1061         fbase_cookie fc;
1062         syncops *ss, *sprev, *snext;
1063         Entry *e = NULL;
1064         Attribute *a;
1065         int rc;
1066         struct berval newdn;
1067         int freefdn = 0;
1068         BackendDB *b0 = op->o_bd, db;
1069
1070         fc.fdn = &op->o_req_ndn;
1071         /* compute new DN */
1072         if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1073                 struct berval pdn;
1074                 if ( op->orr_nnewSup ) pdn = *op->orr_nnewSup;
1075                 else dnParent( fc.fdn, &pdn );
1076                 build_new_dn( &newdn, &pdn, &op->orr_nnewrdn, op->o_tmpmemctx );
1077                 fc.fdn = &newdn;
1078                 freefdn = 1;
1079         }
1080         if ( op->o_tag != LDAP_REQ_ADD ) {
1081                 if ( !SLAP_ISOVERLAY( op->o_bd )) {
1082                         db = *op->o_bd;
1083                         op->o_bd = &db;
1084                 }
1085                 rc = overlay_entry_get_ov( op, fc.fdn, NULL, NULL, 0, &e, on );
1086                 /* If we're sending responses now, make a copy and unlock the DB */
1087                 if ( e && !saveit ) {
1088                         Entry *e2 = entry_dup( e );
1089                         overlay_entry_release_ov( op, e, 0, on );
1090                         e = e2;
1091                 }
1092                 if ( rc ) {
1093                         op->o_bd = b0;
1094                         return;
1095                 }
1096         } else {
1097                 e = op->ora_e;
1098         }
1099
1100         if ( saveit || op->o_tag == LDAP_REQ_ADD ) {
1101                 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1102                 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1103                 opc->sreference = is_entry_referral( e );
1104                 a = attr_find( e->e_attrs, slap_schema.si_ad_entryUUID );
1105                 if ( a )
1106                         ber_dupbv_x( &opc->suuid, &a->a_nvals[0], op->o_tmpmemctx );
1107         } else if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1108                 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1109                 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1110                 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1111                 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1112         }
1113
1114         ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1115         for (ss = si->si_ops, sprev = (syncops *)&si->si_ops; ss;
1116                 sprev = ss, ss=snext)
1117         {
1118                 syncmatches *sm;
1119                 int found = 0;
1120
1121                 snext = ss->s_next;
1122                 /* validate base */
1123                 fc.fss = ss;
1124                 fc.fbase = 0;
1125                 fc.fscope = 0;
1126
1127                 /* If the base of the search is missing, signal a refresh */
1128                 rc = syncprov_findbase( op, &fc );
1129                 if ( rc != LDAP_SUCCESS ) {
1130                         SlapReply rs = {REP_RESULT};
1131                         send_ldap_error( ss->s_op, &rs, LDAP_SYNC_REFRESH_REQUIRED,
1132                                 "search base has changed" );
1133                         sprev->s_next = snext;
1134                         syncprov_drop_psearch( ss, 1 );
1135                         ss = sprev;
1136                         continue;
1137                 }
1138
1139
1140                 /* If we're sending results now, look for this op in old matches */
1141                 if ( !saveit ) {
1142                         syncmatches *old;
1143
1144                         /* Did we modify the search base? */
1145                         if ( dn_match( &op->o_req_ndn, &ss->s_base )) {
1146                                 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1147                                 ss->s_flags |= PS_WROTE_BASE;
1148                                 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1149                         }
1150
1151                         for ( sm=opc->smatches, old=(syncmatches *)&opc->smatches; sm;
1152                                 old=sm, sm=sm->sm_next ) {
1153                                 if ( sm->sm_op == ss ) {
1154                                         found = 1;
1155                                         old->sm_next = sm->sm_next;
1156                                         op->o_tmpfree( sm, op->o_tmpmemctx );
1157                                         break;
1158                                 }
1159                         }
1160                 }
1161
1162                 /* check if current o_req_dn is in scope and matches filter */
1163                 if ( fc.fscope && test_filter( op, e, ss->s_op->ors_filter ) ==
1164                         LDAP_COMPARE_TRUE ) {
1165                         if ( saveit ) {
1166                                 sm = op->o_tmpalloc( sizeof(syncmatches), op->o_tmpmemctx );
1167                                 sm->sm_next = opc->smatches;
1168                                 sm->sm_op = ss;
1169                                 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1170                                 ++ss->s_inuse;
1171                                 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1172                                 opc->smatches = sm;
1173                         } else {
1174                                 /* if found send UPDATE else send ADD */
1175                                 syncprov_qresp( opc, ss,
1176                                         found ? LDAP_SYNC_MODIFY : LDAP_SYNC_ADD );
1177                         }
1178                 } else if ( !saveit && found ) {
1179                         /* send DELETE */
1180                         syncprov_qresp( opc, ss, LDAP_SYNC_DELETE );
1181                 }
1182         }
1183         ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1184
1185         if ( op->o_tag != LDAP_REQ_ADD && e ) {
1186                 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1187                 be_entry_release_rw( op, e, 0 );
1188                 op->o_bd->bd_info = (BackendInfo *)on;
1189         }
1190         if ( freefdn ) {
1191                 op->o_tmpfree( fc.fdn->bv_val, op->o_tmpmemctx );
1192         }
1193         op->o_bd = b0;
1194 }
1195
1196 static int
1197 syncprov_op_cleanup( Operation *op, SlapReply *rs )
1198 {
1199         slap_callback *cb = op->o_callback;
1200         opcookie *opc = cb->sc_private;
1201         slap_overinst *on = opc->son;
1202         syncprov_info_t         *si = on->on_bi.bi_private;
1203         syncmatches *sm, *snext;
1204         modtarget *mt, mtdummy;
1205
1206         for (sm = opc->smatches; sm; sm=snext) {
1207                 snext = sm->sm_next;
1208                 syncprov_free_syncop( sm->sm_op );
1209                 op->o_tmpfree( sm, op->o_tmpmemctx );
1210         }
1211
1212         /* Remove op from lock table */
1213         mtdummy.mt_op = op;
1214         ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1215         mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1216         if ( mt ) {
1217                 modinst *mi = mt->mt_mods;
1218
1219                 /* If there are more, promote the next one */
1220                 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1221                 if ( mi->mi_next ) {
1222                         mt->mt_mods = mi->mi_next;
1223                         mt->mt_op = mt->mt_mods->mi_op;
1224                         ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1225                 } else {
1226                         avl_delete( &si->si_mods, mt, sp_avl_cmp );
1227                         ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1228                         ldap_pvt_thread_mutex_destroy( &mt->mt_mutex );
1229                         ch_free( mt );
1230                 }
1231         }
1232         ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1233         if ( !BER_BVISNULL( &opc->suuid ))
1234                 op->o_tmpfree( opc->suuid.bv_val, op->o_tmpmemctx );
1235         if ( !BER_BVISNULL( &opc->sndn ))
1236                 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1237         if ( !BER_BVISNULL( &opc->sdn ))
1238                 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1239         op->o_callback = cb->sc_next;
1240         op->o_tmpfree(cb, op->o_tmpmemctx);
1241
1242         return 0;
1243 }
1244
1245 static void
1246 syncprov_checkpoint( Operation *op, SlapReply *rs, slap_overinst *on )
1247 {
1248         syncprov_info_t         *si = on->on_bi.bi_private;
1249         Modifications mod;
1250         Operation opm;
1251         SlapReply rsm = { 0 };
1252         struct berval bv[2];
1253         slap_callback cb = {0};
1254
1255         /* If ctxcsn is empty, delete it */
1256         if ( BER_BVISEMPTY( &si->si_ctxcsn )) {
1257                 mod.sml_values = NULL;
1258         } else {
1259                 mod.sml_values = bv;
1260                 bv[1].bv_val = NULL;
1261                 bv[0] = si->si_ctxcsn;
1262         }
1263         mod.sml_nvalues = NULL;
1264         mod.sml_desc = slap_schema.si_ad_contextCSN;
1265         mod.sml_op = LDAP_MOD_REPLACE;
1266         mod.sml_flags = 0;
1267         mod.sml_next = NULL;
1268
1269         cb.sc_response = slap_null_cb;
1270         opm = *op;
1271         opm.o_tag = LDAP_REQ_MODIFY;
1272         opm.o_callback = &cb;
1273         opm.orm_modlist = &mod;
1274         opm.o_req_dn = op->o_bd->be_suffix[0];
1275         opm.o_req_ndn = op->o_bd->be_nsuffix[0];
1276         opm.o_bd->bd_info = on->on_info->oi_orig;
1277         opm.o_managedsait = SLAP_CONTROL_NONCRITICAL;
1278         SLAP_DBFLAGS( opm.o_bd ) |= SLAP_DBFLAG_NOLASTMOD;
1279         opm.o_bd->be_modify( &opm, &rsm );
1280         SLAP_DBFLAGS( opm.o_bd ) ^= SLAP_DBFLAG_NOLASTMOD;
1281         if ( mod.sml_next != NULL ) {
1282                 slap_mods_free( mod.sml_next, 1 );
1283         }
1284 }
1285
1286 static void
1287 syncprov_add_slog( Operation *op )
1288 {
1289         opcookie *opc = op->o_callback->sc_private;
1290         slap_overinst *on = opc->son;
1291         syncprov_info_t         *si = on->on_bi.bi_private;
1292         sessionlog *sl;
1293         slog_entry *se;
1294
1295         sl = si->si_logs;
1296         {
1297                 /* Allocate a record. UUIDs are not NUL-terminated. */
1298                 se = ch_malloc( sizeof( slog_entry ) + opc->suuid.bv_len + 
1299                         op->o_csn.bv_len + 1 );
1300                 se->se_next = NULL;
1301                 se->se_tag = op->o_tag;
1302
1303                 se->se_uuid.bv_val = (char *)(&se[1]);
1304                 AC_MEMCPY( se->se_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
1305                 se->se_uuid.bv_len = opc->suuid.bv_len;
1306
1307                 se->se_csn.bv_val = se->se_uuid.bv_val + opc->suuid.bv_len;
1308                 AC_MEMCPY( se->se_csn.bv_val, op->o_csn.bv_val, op->o_csn.bv_len );
1309                 se->se_csn.bv_val[op->o_csn.bv_len] = '\0';
1310                 se->se_csn.bv_len = op->o_csn.bv_len;
1311
1312                 ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
1313                 if ( sl->sl_head ) {
1314                         sl->sl_tail->se_next = se;
1315                 } else {
1316                         sl->sl_head = se;
1317                 }
1318                 sl->sl_tail = se;
1319                 sl->sl_num++;
1320                 while ( sl->sl_num > sl->sl_size ) {
1321                         se = sl->sl_head;
1322                         sl->sl_head = se->se_next;
1323                         strcpy( sl->sl_mincsn.bv_val, se->se_csn.bv_val );
1324                         sl->sl_mincsn.bv_len = se->se_csn.bv_len;
1325                         ch_free( se );
1326                         sl->sl_num--;
1327                 }
1328                 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1329         }
1330 }
1331
1332 /* Just set a flag if we found the matching entry */
1333 static int
1334 playlog_cb( Operation *op, SlapReply *rs )
1335 {
1336         if ( rs->sr_type == REP_SEARCH ) {
1337                 op->o_callback->sc_private = (void *)1;
1338         }
1339         return rs->sr_err;
1340 }
1341
1342 /* enter with sl->sl_mutex locked, release before returning */
1343 static void
1344 syncprov_playlog( Operation *op, SlapReply *rs, sessionlog *sl,
1345         sync_control *srs, struct berval *ctxcsn )
1346 {
1347         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
1348         slog_entry *se;
1349         int i, j, ndel, num, nmods, mmods;
1350         char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1351         BerVarray uuids;
1352         struct berval delcsn;
1353
1354         if ( !sl->sl_num ) {
1355                 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1356                 return;
1357         }
1358
1359         num = sl->sl_num;
1360         i = 0;
1361         nmods = 0;
1362
1363         uuids = op->o_tmpalloc( (num+1) * sizeof( struct berval ) +
1364                 num * UUID_LEN, op->o_tmpmemctx );
1365         uuids[0].bv_val = (char *)(uuids + num + 1);
1366
1367         delcsn.bv_len = 0;
1368         delcsn.bv_val = cbuf;
1369
1370         /* Make a copy of the relevant UUIDs. Put the Deletes up front
1371          * and everything else at the end. Do this first so we can
1372          * unlock the list mutex.
1373          */
1374         Debug( LDAP_DEBUG_SYNC, "srs csn %s\n", srs->sr_state.ctxcsn.bv_val, 0, 0 );
1375         for ( se=sl->sl_head; se; se=se->se_next ) {
1376                 Debug( LDAP_DEBUG_SYNC, "log csn %s\n", se->se_csn.bv_val, 0, 0 );
1377                 ndel = ber_bvcmp( &se->se_csn, &srs->sr_state.ctxcsn );
1378                 if ( ndel <= 0 ) {
1379                         Debug( LDAP_DEBUG_SYNC, "cmp %d, too old\n", ndel, 0, 0 );
1380                         continue;
1381                 }
1382                 ndel = ber_bvcmp( &se->se_csn, ctxcsn );
1383                 if ( ndel > 0 ) {
1384                         Debug( LDAP_DEBUG_SYNC, "cmp %d, too new\n", ndel, 0, 0 );
1385                         break;
1386                 }
1387                 if ( se->se_tag == LDAP_REQ_DELETE ) {
1388                         j = i;
1389                         i++;
1390                         AC_MEMCPY( cbuf, se->se_csn.bv_val, se->se_csn.bv_len );
1391                         delcsn.bv_len = se->se_csn.bv_len;
1392                         delcsn.bv_val[delcsn.bv_len] = '\0';
1393                 } else {
1394                         nmods++;
1395                         j = num - nmods;
1396                 }
1397                 uuids[j].bv_val = uuids[0].bv_val + (j * UUID_LEN);
1398                 AC_MEMCPY(uuids[j].bv_val, se->se_uuid.bv_val, UUID_LEN);
1399                 uuids[j].bv_len = UUID_LEN;
1400         }
1401         ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1402
1403         ndel = i;
1404
1405         /* Zero out unused slots */
1406         for ( i=ndel; i < num - nmods; i++ )
1407                 uuids[i].bv_len = 0;
1408
1409         /* Mods must be validated to see if they belong in this delete set.
1410          */
1411
1412         mmods = nmods;
1413         /* Strip any duplicates */
1414         for ( i=0; i<nmods; i++ ) {
1415                 for ( j=0; j<ndel; j++ ) {
1416                         if ( bvmatch( &uuids[j], &uuids[num - 1 - i] )) {
1417                                 uuids[num - 1 - i].bv_len = 0;
1418                                 mmods --;
1419                                 break;
1420                         }
1421                 }
1422                 if ( uuids[num - 1 - i].bv_len == 0 ) continue;
1423                 for ( j=0; j<i; j++ ) {
1424                         if ( bvmatch( &uuids[num - 1 - j], &uuids[num - 1 - i] )) {
1425                                 uuids[num - 1 - i].bv_len = 0;
1426                                 mmods --;
1427                                 break;
1428                         }
1429                 }
1430         }
1431
1432         if ( mmods ) {
1433                 Operation fop;
1434                 SlapReply frs = { REP_RESULT };
1435                 int rc;
1436                 Filter mf, af;
1437 #ifdef LDAP_COMP_MATCH
1438                 AttributeAssertion eq = { NULL, BER_BVNULL, NULL };
1439 #else
1440                 AttributeAssertion eq;
1441 #endif
1442                 slap_callback cb = {0};
1443
1444                 fop = *op;
1445
1446                 fop.o_sync_mode = 0;
1447                 fop.o_callback = &cb;
1448                 fop.ors_limit = NULL;
1449                 fop.ors_tlimit = SLAP_NO_LIMIT;
1450                 fop.ors_attrs = slap_anlist_all_attributes;
1451                 fop.ors_attrsonly = 0;
1452                 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
1453
1454                 af.f_choice = LDAP_FILTER_AND;
1455                 af.f_next = NULL;
1456                 af.f_and = &mf;
1457                 mf.f_choice = LDAP_FILTER_EQUALITY;
1458                 mf.f_ava = &eq;
1459                 mf.f_av_desc = slap_schema.si_ad_entryUUID;
1460                 mf.f_next = fop.ors_filter;
1461
1462                 fop.ors_filter = &af;
1463
1464                 cb.sc_response = playlog_cb;
1465                 fop.o_bd->bd_info = on->on_info->oi_orig;
1466
1467                 for ( i=ndel; i<num; i++ ) {
1468                         if ( uuids[i].bv_len == 0 ) continue;
1469
1470                         mf.f_av_value = uuids[i];
1471                         cb.sc_private = NULL;
1472                         fop.ors_slimit = 1;
1473                         frs.sr_nentries = 0;
1474                         rc = fop.o_bd->be_search( &fop, &frs );
1475
1476                         /* If entry was not found, add to delete list */
1477                         if ( !cb.sc_private ) {
1478                                 uuids[ndel++] = uuids[i];
1479                         }
1480                 }
1481                 fop.o_bd->bd_info = (BackendInfo *)on;
1482         }
1483         if ( ndel ) {
1484                 struct berval cookie;
1485
1486                 slap_compose_sync_cookie( op, &cookie, &delcsn, srs->sr_state.rid );
1487                 uuids[ndel].bv_val = NULL;
1488                 syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, &cookie, 0, uuids, 1 );
1489                 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1490         }
1491         op->o_tmpfree( uuids, op->o_tmpmemctx );
1492 }
1493
1494 static int
1495 syncprov_op_response( Operation *op, SlapReply *rs )
1496 {
1497         opcookie *opc = op->o_callback->sc_private;
1498         slap_overinst *on = opc->son;
1499         syncprov_info_t         *si = on->on_bi.bi_private;
1500         syncmatches *sm;
1501
1502         if ( rs->sr_err == LDAP_SUCCESS )
1503         {
1504                 struct berval maxcsn = BER_BVNULL;
1505                 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1506                 int do_check = 0, have_psearches;
1507
1508                 /* Update our context CSN */
1509                 cbuf[0] = '\0';
1510                 ldap_pvt_thread_rdwr_wlock( &si->si_csn_rwlock );
1511                 slap_get_commit_csn( op, &maxcsn );
1512                 if ( !BER_BVISNULL( &maxcsn ) ) {
1513                         strcpy( cbuf, maxcsn.bv_val );
1514                         if ( ber_bvcmp( &maxcsn, &si->si_ctxcsn ) > 0 ) {
1515                                 strcpy( si->si_ctxcsnbuf, cbuf );
1516                                 si->si_ctxcsn.bv_len = maxcsn.bv_len;
1517                         }
1518                 }
1519
1520                 /* Don't do any processing for consumer contextCSN updates */
1521                 if ( SLAP_SYNC_SHADOW( op->o_bd ) && 
1522                         op->o_msgid == SLAP_SYNC_UPDATE_MSGID ) {
1523                         ldap_pvt_thread_rdwr_wunlock( &si->si_csn_rwlock );
1524                         return SLAP_CB_CONTINUE;
1525                 }
1526
1527                 si->si_numops++;
1528                 if ( si->si_chkops || si->si_chktime ) {
1529                         if ( si->si_chkops && si->si_numops >= si->si_chkops ) {
1530                                 do_check = 1;
1531                                 si->si_numops = 0;
1532                         }
1533                         if ( si->si_chktime &&
1534                                 (op->o_time - si->si_chklast >= si->si_chktime )) {
1535                                 do_check = 1;
1536                                 si->si_chklast = op->o_time;
1537                         }
1538                 }
1539                 ldap_pvt_thread_rdwr_wunlock( &si->si_csn_rwlock );
1540
1541                 if ( do_check ) {
1542                         ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
1543                         syncprov_checkpoint( op, rs, on );
1544                         ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
1545                 }
1546
1547                 opc->sctxcsn.bv_len = maxcsn.bv_len;
1548                 opc->sctxcsn.bv_val = cbuf;
1549
1550                 /* Handle any persistent searches */
1551                 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1552                 have_psearches = ( si->si_ops != NULL );
1553                 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1554                 if ( have_psearches ) {
1555                         switch(op->o_tag) {
1556                         case LDAP_REQ_ADD:
1557                         case LDAP_REQ_MODIFY:
1558                         case LDAP_REQ_MODRDN:
1559                         case LDAP_REQ_EXTENDED:
1560                                 syncprov_matchops( op, opc, 0 );
1561                                 break;
1562                         case LDAP_REQ_DELETE:
1563                                 /* for each match in opc->smatches:
1564                                  *   send DELETE msg
1565                                  */
1566                                 for ( sm = opc->smatches; sm; sm=sm->sm_next ) {
1567                                         if ( sm->sm_op->s_op->o_abandon )
1568                                                 continue;
1569                                         syncprov_qresp( opc, sm->sm_op, LDAP_SYNC_DELETE );
1570                                 }
1571                                 break;
1572                         }
1573                 }
1574
1575                 /* Add any log records */
1576                 if ( si->si_logs && op->o_tag != LDAP_REQ_ADD ) {
1577                         syncprov_add_slog( op );
1578                 }
1579
1580         }
1581         return SLAP_CB_CONTINUE;
1582 }
1583
1584 /* We don't use a subentry to store the context CSN any more.
1585  * We expose the current context CSN as an operational attribute
1586  * of the suffix entry.
1587  */
1588 static int
1589 syncprov_op_compare( Operation *op, SlapReply *rs )
1590 {
1591         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
1592         syncprov_info_t         *si = on->on_bi.bi_private;
1593         int rc = SLAP_CB_CONTINUE;
1594
1595         if ( dn_match( &op->o_req_ndn, op->o_bd->be_nsuffix ) &&
1596                 op->oq_compare.rs_ava->aa_desc == slap_schema.si_ad_contextCSN )
1597         {
1598                 Entry e = {0};
1599                 Attribute a = {0};
1600                 struct berval bv[2];
1601
1602                 e.e_name = op->o_bd->be_suffix[0];
1603                 e.e_nname = op->o_bd->be_nsuffix[0];
1604
1605                 BER_BVZERO( &bv[1] );
1606                 bv[0] = si->si_ctxcsn;
1607
1608                 a.a_desc = slap_schema.si_ad_contextCSN;
1609                 a.a_vals = bv;
1610                 a.a_nvals = a.a_vals;
1611
1612                 ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
1613
1614                 rs->sr_err = access_allowed( op, &e, op->oq_compare.rs_ava->aa_desc,
1615                         &op->oq_compare.rs_ava->aa_value, ACL_COMPARE, NULL );
1616                 if ( ! rs->sr_err ) {
1617                         rs->sr_err = LDAP_INSUFFICIENT_ACCESS;
1618                         goto return_results;
1619                 }
1620
1621                 if ( get_assert( op ) &&
1622                         ( test_filter( op, &e, get_assertion( op ) ) != LDAP_COMPARE_TRUE ) )
1623                 {
1624                         rs->sr_err = LDAP_ASSERTION_FAILED;
1625                         goto return_results;
1626                 }
1627
1628
1629                 rs->sr_err = LDAP_COMPARE_FALSE;
1630
1631                 if ( value_find_ex( op->oq_compare.rs_ava->aa_desc,
1632                         SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH |
1633                                 SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH,
1634                                 a.a_nvals, &op->oq_compare.rs_ava->aa_value, op->o_tmpmemctx ) == 0 )
1635                 {
1636                         rs->sr_err = LDAP_COMPARE_TRUE;
1637                 }
1638
1639 return_results:;
1640
1641                 ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
1642
1643                 send_ldap_result( op, rs );
1644
1645                 if( rs->sr_err == LDAP_COMPARE_FALSE || rs->sr_err == LDAP_COMPARE_TRUE ) {
1646                         rs->sr_err = LDAP_SUCCESS;
1647                 }
1648                 rc = rs->sr_err;
1649         }
1650
1651         return rc;
1652 }
1653
1654 static int
1655 syncprov_op_mod( Operation *op, SlapReply *rs )
1656 {
1657         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
1658         syncprov_info_t         *si = on->on_bi.bi_private;
1659         slap_callback *cb;
1660         opcookie *opc;
1661         int have_psearches, cbsize;
1662
1663         ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1664         have_psearches = ( si->si_ops != NULL );
1665         ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1666
1667         cbsize = sizeof(slap_callback) + sizeof(opcookie) +
1668                 (have_psearches ? sizeof(modinst) : 0 );
1669
1670         cb = op->o_tmpcalloc(1, cbsize, op->o_tmpmemctx);
1671         opc = (opcookie *)(cb+1);
1672         opc->son = on;
1673         cb->sc_response = syncprov_op_response;
1674         cb->sc_cleanup = syncprov_op_cleanup;
1675         cb->sc_private = opc;
1676         cb->sc_next = op->o_callback;
1677         op->o_callback = cb;
1678
1679         /* If there are active persistent searches, lock this operation.
1680          * See seqmod.c for the locking logic on its own.
1681          */
1682         if ( have_psearches ) {
1683                 modtarget *mt, mtdummy;
1684                 modinst *mi;
1685
1686                 mi = (modinst *)(opc+1);
1687                 mi->mi_op = op;
1688
1689                 /* See if we're already modifying this entry... */
1690                 mtdummy.mt_op = op;
1691                 ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1692                 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1693                 if ( mt ) {
1694                         ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1695                         ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1696                         mt->mt_tail->mi_next = mi;
1697                         mt->mt_tail = mi;
1698                         /* wait for this op to get to head of list */
1699                         while ( mt->mt_mods != mi ) {
1700                                 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1701                                 ldap_pvt_thread_yield();
1702                                 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1703
1704                                 /* clean up if the caller is giving up */
1705                                 if ( op->o_abandon ) {
1706                                         modinst *m2;
1707                                         for ( m2 = mt->mt_mods; m2->mi_next != mi;
1708                                                 m2 = m2->mi_next );
1709                                         m2->mi_next = mi->mi_next;
1710                                         if ( mt->mt_tail == mi ) mt->mt_tail = m2;
1711                                         op->o_tmpfree( cb, op->o_tmpmemctx );
1712                                         ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1713                                         return SLAPD_ABANDON;
1714                                 }
1715                         }
1716                         ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1717                 } else {
1718                         /* Record that we're modifying this entry now */
1719                         mt = ch_malloc( sizeof(modtarget) );
1720                         mt->mt_mods = mi;
1721                         mt->mt_tail = mi;
1722                         mt->mt_op = mi->mi_op;
1723                         ldap_pvt_thread_mutex_init( &mt->mt_mutex );
1724                         avl_insert( &si->si_mods, mt, sp_avl_cmp, avl_dup_error );
1725                         ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1726                 }
1727         }
1728
1729         if (( have_psearches || si->si_logs ) && op->o_tag != LDAP_REQ_ADD )
1730                 syncprov_matchops( op, opc, 1 );
1731
1732         return SLAP_CB_CONTINUE;
1733 }
1734
1735 static int
1736 syncprov_op_extended( Operation *op, SlapReply *rs )
1737 {
1738         if ( exop_is_write( op ))
1739                 return syncprov_op_mod( op, rs );
1740
1741         return SLAP_CB_CONTINUE;
1742 }
1743
1744 typedef struct searchstate {
1745         slap_overinst *ss_on;
1746         syncops *ss_so;
1747         int ss_present;
1748         struct berval ss_ctxcsn;
1749         char ss_csnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1750 } searchstate;
1751
1752 static int
1753 syncprov_search_cleanup( Operation *op, SlapReply *rs )
1754 {
1755         if ( rs->sr_ctrls ) {
1756                 op->o_tmpfree( rs->sr_ctrls[0], op->o_tmpmemctx );
1757                 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
1758                 rs->sr_ctrls = NULL;
1759         }
1760         return 0;
1761 }
1762
1763 static void
1764 syncprov_detach_op( Operation *op, syncops *so, slap_overinst *on )
1765 {
1766         Operation *op2;
1767         int i, alen = 0;
1768         size_t size;
1769         char *ptr;
1770         GroupAssertion *g1, *g2;
1771
1772         /* count the search attrs */
1773         for (i=0; op->ors_attrs && !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1774                 alen += op->ors_attrs[i].an_name.bv_len + 1;
1775         }
1776         /* Make a new copy of the operation */
1777         size = sizeof(Operation) + sizeof(Opheader) +
1778                 (i ? ( (i+1) * sizeof(AttributeName) + alen) : 0) +
1779                 op->o_req_dn.bv_len + 1 +
1780                 op->o_req_ndn.bv_len + 1 +
1781                 op->o_ndn.bv_len + 1 +
1782                 so->s_filterstr.bv_len + 1;
1783         op2 = (Operation *)ch_calloc( 1, size );
1784         op2->o_hdr = (Opheader *)(op2+1);
1785
1786         /* Copy the fields we care about explicitly, leave the rest alone */
1787         *op2->o_hdr = *op->o_hdr;
1788         op2->o_tag = op->o_tag;
1789         op2->o_time = op->o_time;
1790         op2->o_bd = on->on_info->oi_origdb;
1791         op2->o_request = op->o_request;
1792         op2->o_private = on;
1793
1794         if ( i ) {
1795                 op2->ors_attrs = (AttributeName *)(op2->o_hdr + 1);
1796                 ptr = (char *)(op2->ors_attrs+i+1);
1797                 for (i=0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1798                         op2->ors_attrs[i] = op->ors_attrs[i];
1799                         op2->ors_attrs[i].an_name.bv_val = ptr;
1800                         ptr = lutil_strcopy( ptr, op->ors_attrs[i].an_name.bv_val ) + 1;
1801                 }
1802                 BER_BVZERO( &op2->ors_attrs[i].an_name );
1803         } else {
1804                 ptr = (char *)(op2->o_hdr + 1);
1805         }
1806         op2->o_authz = op->o_authz;
1807         op2->o_ndn.bv_val = ptr;
1808         ptr = lutil_strcopy(ptr, op->o_ndn.bv_val) + 1;
1809         op2->o_dn = op2->o_ndn;
1810         op2->o_req_dn.bv_len = op->o_req_dn.bv_len;
1811         op2->o_req_dn.bv_val = ptr;
1812         ptr = lutil_strcopy(ptr, op->o_req_dn.bv_val) + 1;
1813         op2->o_req_ndn.bv_len = op->o_req_ndn.bv_len;
1814         op2->o_req_ndn.bv_val = ptr;
1815         ptr = lutil_strcopy(ptr, op->o_req_ndn.bv_val) + 1;
1816         op2->ors_filterstr.bv_val = ptr;
1817         strcpy( ptr, so->s_filterstr.bv_val );
1818         op2->ors_filterstr.bv_len = so->s_filterstr.bv_len;
1819
1820         /* Skip the AND/GE clause that we stuck on in front */
1821         if ( so->s_flags & PS_FIX_FILTER ) {
1822                 op2->ors_filter = op->ors_filter->f_and->f_next;
1823                 so->s_flags ^= PS_FIX_FILTER;
1824         } else {
1825                 op2->ors_filter = op->ors_filter;
1826         }
1827         op2->ors_filter = filter_dup( op2->ors_filter, NULL );
1828         so->s_op = op2;
1829
1830         /* Copy any cached group ACLs individually */
1831         op2->o_groups = NULL;
1832         for ( g1=op->o_groups; g1; g1=g1->ga_next ) {
1833                 g2 = ch_malloc( sizeof(GroupAssertion) + g1->ga_len );
1834                 *g2 = *g1;
1835                 strcpy( g2->ga_ndn, g1->ga_ndn );
1836                 g2->ga_next = op2->o_groups;
1837                 op2->o_groups = g2;
1838         }
1839         /* Don't allow any further group caching */
1840         op2->o_do_not_cache = 1;
1841
1842         /* Add op2 to conn so abandon will find us */
1843         ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1844         op->o_conn->c_n_ops_executing++;
1845         op->o_conn->c_n_ops_completed--;
1846         LDAP_STAILQ_INSERT_TAIL( &op->o_conn->c_ops, op2, o_next );
1847         so->s_flags |= PS_IS_DETACHED;
1848         ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1849
1850         /* Prevent anyone else from trying to send a result for this op */
1851         op->o_abandon = 1;
1852 }
1853
1854 static int
1855 syncprov_search_response( Operation *op, SlapReply *rs )
1856 {
1857         searchstate *ss = op->o_callback->sc_private;
1858         slap_overinst *on = ss->ss_on;
1859         sync_control *srs = op->o_controls[slap_cids.sc_LDAPsync];
1860
1861         if ( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF ) {
1862                 Attribute *a;
1863                 /* If we got a referral without a referral object, there's
1864                  * something missing that we cannot replicate. Just ignore it.
1865                  * The consumer will abort because we didn't send the expected
1866                  * control.
1867                  */
1868                 if ( !rs->sr_entry ) {
1869                         assert( rs->sr_entry != NULL );
1870                         Debug( LDAP_DEBUG_ANY, "bogus referral in context\n",0,0,0 );
1871                         return SLAP_CB_CONTINUE;
1872                 }
1873                 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryCSN );
1874                 if ( a == NULL && rs->sr_operational_attrs != NULL ) {
1875                         a = attr_find( rs->sr_operational_attrs, slap_schema.si_ad_entryCSN );
1876                 }
1877                 if ( a ) {
1878                         /* If not a persistent search */
1879                         /* Make sure entry is less than the snapshot'd contextCSN */
1880                         if ( !ss->ss_so && ber_bvcmp( &a->a_nvals[0], &ss->ss_ctxcsn ) > 0 ) {
1881                                 Debug( LDAP_DEBUG_SYNC, "Entry %s CSN %s greater than snapshot %s\n",
1882                                         rs->sr_entry->e_name.bv_val,
1883                                         a->a_nvals[0].bv_val,
1884                                         ss->ss_ctxcsn.bv_val );
1885                                 return LDAP_SUCCESS;
1886                         }
1887
1888                         /* Don't send the ctx entry twice */
1889                         if ( !BER_BVISNULL( &srs->sr_state.ctxcsn ) &&
1890                                 bvmatch( &a->a_nvals[0], &srs->sr_state.ctxcsn ) ) {
1891                                 Debug( LDAP_DEBUG_SYNC, "Entry %s CSN %s matches ctx %s\n",
1892                                         rs->sr_entry->e_name.bv_val,
1893                                         a->a_nvals[0].bv_val,
1894                                         srs->sr_state.ctxcsn.bv_val );
1895                                 return LDAP_SUCCESS;
1896                         }
1897                 }
1898                 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1899                         op->o_tmpmemctx );
1900                 rs->sr_ctrls[1] = NULL;
1901                 rs->sr_err = syncprov_state_ctrl( op, rs, rs->sr_entry,
1902                         LDAP_SYNC_ADD, rs->sr_ctrls, 0, 0, NULL );
1903         } else if ( rs->sr_type == REP_RESULT && rs->sr_err == LDAP_SUCCESS ) {
1904                 struct berval cookie;
1905
1906                 slap_compose_sync_cookie( op, &cookie, &ss->ss_ctxcsn,
1907                         srs->sr_state.rid );
1908
1909                 /* Is this a regular refresh? */
1910                 if ( !ss->ss_so ) {
1911                         rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1912                                 op->o_tmpmemctx );
1913                         rs->sr_ctrls[1] = NULL;
1914                         rs->sr_err = syncprov_done_ctrl( op, rs, rs->sr_ctrls,
1915                                 0, 1, &cookie, ss->ss_present ?  LDAP_SYNC_REFRESH_PRESENTS :
1916                                         LDAP_SYNC_REFRESH_DELETES );
1917                         op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1918                 } else {
1919                 /* It's RefreshAndPersist, transition to Persist phase */
1920                         syncprov_sendinfo( op, rs, ss->ss_present ?
1921                                 LDAP_TAG_SYNC_REFRESH_PRESENT : LDAP_TAG_SYNC_REFRESH_DELETE,
1922                                 &cookie, 1, NULL, 0 );
1923                         op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1924
1925                         /* Detach this Op from frontend control */
1926                         ldap_pvt_thread_mutex_lock( &ss->ss_so->s_mutex );
1927
1928                         /* Turn off the refreshing flag */
1929                         ss->ss_so->s_flags ^= PS_IS_REFRESHING;
1930
1931                         syncprov_detach_op( op, ss->ss_so, on );
1932
1933                         /* If there are queued responses, fire them off */
1934                         if ( ss->ss_so->s_res )
1935                                 syncprov_qstart( ss->ss_so );
1936                         ldap_pvt_thread_mutex_unlock( &ss->ss_so->s_mutex );
1937
1938                         return LDAP_SUCCESS;
1939                 }
1940         }
1941
1942         return SLAP_CB_CONTINUE;
1943 }
1944
1945 static int
1946 syncprov_op_search( Operation *op, SlapReply *rs )
1947 {
1948         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
1949         syncprov_info_t         *si = (syncprov_info_t *)on->on_bi.bi_private;
1950         slap_callback   *cb;
1951         int gotstate = 0, nochange = 0, do_present;
1952         syncops *sop = NULL;
1953         searchstate *ss;
1954         sync_control *srs;
1955         struct berval ctxcsn;
1956         char csnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1957
1958         if ( !(op->o_sync_mode & SLAP_SYNC_REFRESH) ) return SLAP_CB_CONTINUE;
1959
1960         if ( op->ors_deref & LDAP_DEREF_SEARCHING ) {
1961                 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "illegal value for derefAliases" );
1962                 return rs->sr_err;
1963         }
1964
1965         do_present = si->si_nopres ? 0 : 1;
1966
1967         srs = op->o_controls[slap_cids.sc_LDAPsync];
1968         op->o_managedsait = SLAP_CONTROL_NONCRITICAL;
1969
1970         /* If this is a persistent search, set it up right away */
1971         if ( op->o_sync_mode & SLAP_SYNC_PERSIST ) {
1972                 syncops so = {0};
1973                 fbase_cookie fc;
1974                 opcookie opc;
1975                 slap_callback sc;
1976
1977                 fc.fss = &so;
1978                 fc.fbase = 0;
1979                 so.s_eid = NOID;
1980                 so.s_op = op;
1981                 so.s_flags = PS_IS_REFRESHING | PS_FIND_BASE;
1982                 /* syncprov_findbase expects to be called as a callback... */
1983                 sc.sc_private = &opc;
1984                 opc.son = on;
1985                 ldap_pvt_thread_mutex_init( &so.s_mutex );
1986                 cb = op->o_callback;
1987                 op->o_callback = &sc;
1988                 rs->sr_err = syncprov_findbase( op, &fc );
1989                 op->o_callback = cb;
1990                 ldap_pvt_thread_mutex_destroy( &so.s_mutex );
1991
1992                 if ( rs->sr_err != LDAP_SUCCESS ) {
1993                         send_ldap_result( op, rs );
1994                         return rs->sr_err;
1995                 }
1996                 sop = ch_malloc( sizeof( syncops ));
1997                 *sop = so;
1998                 ldap_pvt_thread_mutex_init( &sop->s_mutex );
1999                 sop->s_rid = srs->sr_state.rid;
2000                 sop->s_inuse = 1;
2001
2002                 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
2003                 sop->s_next = si->si_ops;
2004                 si->si_ops = sop;
2005                 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
2006         }
2007
2008         /* snapshot the ctxcsn */
2009         ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
2010         strcpy( csnbuf, si->si_ctxcsnbuf );
2011         ctxcsn.bv_len = si->si_ctxcsn.bv_len;
2012         ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
2013         ctxcsn.bv_val = csnbuf;
2014         
2015         /* If we have a cookie, handle the PRESENT lookups */
2016         if ( !BER_BVISNULL( &srs->sr_state.ctxcsn )) {
2017                 sessionlog *sl;
2018
2019                 /* The cookie was validated when it was parsed, just use it */
2020
2021                 /* If just Refreshing and nothing has changed, shortcut it */
2022                 if ( bvmatch( &srs->sr_state.ctxcsn, &ctxcsn )) {
2023                         nochange = 1;
2024                         if ( !(op->o_sync_mode & SLAP_SYNC_PERSIST) ) {
2025                                 LDAPControl     *ctrls[2];
2026
2027                                 ctrls[0] = NULL;
2028                                 ctrls[1] = NULL;
2029                                 syncprov_done_ctrl( op, rs, ctrls, 0, 0,
2030                                         NULL, LDAP_SYNC_REFRESH_DELETES );
2031                                 rs->sr_ctrls = ctrls;
2032                                 rs->sr_err = LDAP_SUCCESS;
2033                                 send_ldap_result( op, rs );
2034                                 rs->sr_ctrls = NULL;
2035                                 return rs->sr_err;
2036                         }
2037                         goto shortcut;
2038                 }
2039                 /* Do we have a sessionlog for this search? */
2040                 sl=si->si_logs;
2041                 if ( sl ) {
2042                         ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
2043                         /* Are there any log entries, and is the consumer state
2044                          * present in the session log?
2045                          */
2046                         if ( sl->sl_num > 0 && ber_bvcmp( &srs->sr_state.ctxcsn, &sl->sl_mincsn ) >= 0 ) {
2047                                 do_present = 0;
2048                                 /* mutex is unlocked in playlog */
2049                                 syncprov_playlog( op, rs, sl, srs, &ctxcsn );
2050                         } else {
2051                                 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
2052                         }
2053                 }
2054                 /* Is the CSN still present in the database? */
2055                 if ( syncprov_findcsn( op, FIND_CSN ) != LDAP_SUCCESS ) {
2056                         /* No, so a reload is required */
2057                         /* the 2.2 consumer doesn't send this hint */
2058                         if ( si->si_usehint && srs->sr_rhint == 0 ) {
2059                                 send_ldap_error( op, rs, LDAP_SYNC_REFRESH_REQUIRED, "sync cookie is stale" );
2060                                 return rs->sr_err;
2061                         }
2062                 } else {
2063                         gotstate = 1;
2064                         /* If changed and doing Present lookup, send Present UUIDs */
2065                         if ( do_present && syncprov_findcsn( op, FIND_PRESENT ) !=
2066                                 LDAP_SUCCESS ) {
2067                                 send_ldap_result( op, rs );
2068                                 return rs->sr_err;
2069                         }
2070                 }
2071         }
2072
2073 shortcut:
2074         /* Append CSN range to search filter, save original filter
2075          * for persistent search evaluation
2076          */
2077         if ( sop ) {
2078                 sop->s_filterstr= op->ors_filterstr;
2079         }
2080
2081         /* If something changed, find the changes */
2082         if ( gotstate && !nochange ) {
2083                 Filter *fand, *fava;
2084
2085                 fand = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2086                 fand->f_choice = LDAP_FILTER_AND;
2087                 fand->f_next = NULL;
2088                 fava = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2089                 fand->f_and = fava;
2090                 fava->f_choice = LDAP_FILTER_GE;
2091                 fava->f_ava = op->o_tmpalloc( sizeof(AttributeAssertion), op->o_tmpmemctx );
2092                 fava->f_ava->aa_desc = slap_schema.si_ad_entryCSN;
2093 #ifdef LDAP_COMP_MATCH
2094                 fava->f_ava->aa_cf = NULL;
2095 #endif
2096                 ber_dupbv_x( &fava->f_ava->aa_value, &srs->sr_state.ctxcsn, op->o_tmpmemctx );
2097                 fava->f_next = op->ors_filter;
2098                 op->ors_filter = fand;
2099                 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
2100                 if ( sop )
2101                         sop->s_flags |= PS_FIX_FILTER;
2102         }
2103
2104         /* Let our callback add needed info to returned entries */
2105         cb = op->o_tmpcalloc(1, sizeof(slap_callback)+sizeof(searchstate), op->o_tmpmemctx);
2106         ss = (searchstate *)(cb+1);
2107         ss->ss_on = on;
2108         ss->ss_so = sop;
2109         ss->ss_present = do_present;
2110         ss->ss_ctxcsn.bv_len = ctxcsn.bv_len;
2111         ss->ss_ctxcsn.bv_val = ss->ss_csnbuf;
2112         strcpy( ss->ss_ctxcsn.bv_val, ctxcsn.bv_val );
2113         cb->sc_response = syncprov_search_response;
2114         cb->sc_cleanup = syncprov_search_cleanup;
2115         cb->sc_private = ss;
2116         cb->sc_next = op->o_callback;
2117         op->o_callback = cb;
2118
2119 #if 0   /* I don't think we need to shortcircuit back-bdb any more */
2120         op->o_sync_mode &= SLAP_CONTROL_MASK;
2121 #endif
2122
2123         /* If this is a persistent search and no changes were reported during
2124          * the refresh phase, just invoke the response callback to transition
2125          * us into persist phase
2126          */
2127         if ( nochange ) {
2128                 rs->sr_err = LDAP_SUCCESS;
2129                 rs->sr_nentries = 0;
2130                 send_ldap_result( op, rs );
2131                 return rs->sr_err;
2132         }
2133         return SLAP_CB_CONTINUE;
2134 }
2135
2136 static int
2137 syncprov_operational(
2138         Operation *op,
2139         SlapReply *rs )
2140 {
2141         slap_overinst           *on = (slap_overinst *)op->o_bd->bd_info;
2142         syncprov_info_t         *si = (syncprov_info_t *)on->on_bi.bi_private;
2143
2144         if ( rs->sr_entry &&
2145                 dn_match( &rs->sr_entry->e_nname, op->o_bd->be_nsuffix )) {
2146
2147                 if ( SLAP_OPATTRS( rs->sr_attr_flags ) ||
2148                         ad_inlist( slap_schema.si_ad_contextCSN, rs->sr_attrs )) {
2149                         Attribute *a, **ap = NULL;
2150
2151                         for ( a=rs->sr_entry->e_attrs; a; a=a->a_next ) {
2152                                 if ( a->a_desc == slap_schema.si_ad_contextCSN )
2153                                         break;
2154                         }
2155
2156                         if ( !a ) {
2157                                 for ( ap = &rs->sr_operational_attrs; *ap; ap=&(*ap)->a_next );
2158
2159                                 a = ch_malloc( sizeof(Attribute));
2160                                 a->a_desc = slap_schema.si_ad_contextCSN;
2161                                 a->a_vals = ch_malloc( 2 * sizeof(struct berval));
2162                                 a->a_vals[1].bv_val = NULL;
2163                                 a->a_nvals = a->a_vals;
2164                                 a->a_next = NULL;
2165                                 a->a_flags = 0;
2166                                 *ap = a;
2167                         }
2168
2169                         ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
2170                         if ( !ap ) {
2171                                 strcpy( a->a_vals[0].bv_val, si->si_ctxcsnbuf );
2172                         } else {
2173                                 ber_dupbv( &a->a_vals[0], &si->si_ctxcsn );
2174                         }
2175                         ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
2176                 }
2177         }
2178         return SLAP_CB_CONTINUE;
2179 }
2180
2181 enum {
2182         SP_CHKPT = 1,
2183         SP_SESSL,
2184         SP_NOPRES,
2185         SP_USEHINT
2186 };
2187
2188 static ConfigDriver sp_cf_gen;
2189
2190 static ConfigTable spcfg[] = {
2191         { "syncprov-checkpoint", "ops> <minutes", 3, 3, 0, ARG_MAGIC|SP_CHKPT,
2192                 sp_cf_gen, "( OLcfgOvAt:1.1 NAME 'olcSpCheckpoint' "
2193                         "DESC 'ContextCSN checkpoint interval in ops and minutes' "
2194                         "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2195         { "syncprov-sessionlog", "ops", 2, 2, 0, ARG_INT|ARG_MAGIC|SP_SESSL,
2196                 sp_cf_gen, "( OLcfgOvAt:1.2 NAME 'olcSpSessionlog' "
2197                         "DESC 'Session log size in ops' "
2198                         "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
2199         { "syncprov-nopresent", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_NOPRES,
2200                 sp_cf_gen, "( OLcfgOvAt:1.3 NAME 'olcSpNoPresent' "
2201                         "DESC 'Omit Present phase processing' "
2202                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2203         { "syncprov-reloadhint", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_USEHINT,
2204                 sp_cf_gen, "( OLcfgOvAt:1.4 NAME 'olcSpReloadHint' "
2205                         "DESC 'Observe Reload Hint in Request control' "
2206                         "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2207         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2208 };
2209
2210 static ConfigOCs spocs[] = {
2211         { "( OLcfgOvOc:1.1 "
2212                 "NAME 'olcSyncProvConfig' "
2213                 "DESC 'SyncRepl Provider configuration' "
2214                 "SUP olcOverlayConfig "
2215                 "MAY ( olcSpCheckpoint $ olcSpSessionlog $ olcSpNoPresent ) )",
2216                         Cft_Overlay, spcfg },
2217         { NULL, 0, NULL }
2218 };
2219
2220 static int
2221 sp_cf_gen(ConfigArgs *c)
2222 {
2223         slap_overinst           *on = (slap_overinst *)c->bi;
2224         syncprov_info_t         *si = (syncprov_info_t *)on->on_bi.bi_private;
2225         int rc = 0;
2226
2227         if ( c->op == SLAP_CONFIG_EMIT ) {
2228                 switch ( c->type ) {
2229                 case SP_CHKPT:
2230                         if ( si->si_chkops || si->si_chktime ) {
2231                                 struct berval bv;
2232                                 bv.bv_len = sprintf( c->msg, "%d %d",
2233                                         si->si_chkops, si->si_chktime );
2234                                 bv.bv_val = c->msg;
2235                                 value_add_one( &c->rvalue_vals, &bv );
2236                         } else {
2237                                 rc = 1;
2238                         }
2239                         break;
2240                 case SP_SESSL:
2241                         if ( si->si_logs ) {
2242                                 c->value_int = si->si_logs->sl_size;
2243                         } else {
2244                                 rc = 1;
2245                         }
2246                         break;
2247                 case SP_NOPRES:
2248                         if ( si->si_nopres ) {
2249                                 c->value_int = 1;
2250                         } else {
2251                                 rc = 1;
2252                         }
2253                         break;
2254                 case SP_USEHINT:
2255                         if ( si->si_usehint ) {
2256                                 c->value_int = 1;
2257                         } else {
2258                                 rc = 1;
2259                         }
2260                         break;
2261                 }
2262                 return rc;
2263         } else if ( c->op == LDAP_MOD_DELETE ) {
2264                 switch ( c->type ) {
2265                 case SP_CHKPT:
2266                         si->si_chkops = 0;
2267                         si->si_chktime = 0;
2268                         break;
2269                 case SP_SESSL:
2270                         if ( si->si_logs )
2271                                 si->si_logs->sl_size = 0;
2272                         else
2273                                 rc = LDAP_NO_SUCH_ATTRIBUTE;
2274                         break;
2275                 case SP_NOPRES:
2276                         if ( si->si_nopres )
2277                                 si->si_nopres = 0;
2278                         else
2279                                 rc = LDAP_NO_SUCH_ATTRIBUTE;
2280                         break;
2281                 case SP_USEHINT:
2282                         if ( si->si_usehint )
2283                                 si->si_usehint = 0;
2284                         else
2285                                 rc = LDAP_NO_SUCH_ATTRIBUTE;
2286                         break;
2287                 }
2288                 return rc;
2289         }
2290         switch ( c->type ) {
2291         case SP_CHKPT:
2292                 if ( lutil_atoi( &si->si_chkops, c->argv[1] ) != 0 ) {
2293                         snprintf( c->msg, sizeof( c->msg ), "%s unable to parse checkpoint ops # \"%s\"",
2294                                 c->argv[0], c->argv[1] );
2295                         Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2296                                 "%s: %s\n", c->log, c->msg, 0 );
2297                         return ARG_BAD_CONF;
2298                 }
2299                 if ( si->si_chkops <= 0 ) {
2300                         snprintf( c->msg, sizeof( c->msg ), "%s invalid checkpoint ops # \"%d\"",
2301                                 c->argv[0], si->si_chkops );
2302                         Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2303                                 "%s: %s\n", c->log, c->msg, 0 );
2304                         return ARG_BAD_CONF;
2305                 }
2306                 if ( lutil_atoi( &si->si_chktime, c->argv[2] ) != 0 ) {
2307                         snprintf( c->msg, sizeof( c->msg ), "%s unable to parse checkpoint time \"%s\"",
2308                                 c->argv[0], c->argv[1] );
2309                         Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2310                                 "%s: %s\n", c->log, c->msg, 0 );
2311                         return ARG_BAD_CONF;
2312                 }
2313                 if ( si->si_chktime <= 0 ) {
2314                         snprintf( c->msg, sizeof( c->msg ), "%s invalid checkpoint time \"%d\"",
2315                                 c->argv[0], si->si_chkops );
2316                         Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2317                                 "%s: %s\n", c->log, c->msg, 0 );
2318                         return ARG_BAD_CONF;
2319                 }
2320                 si->si_chktime *= 60;
2321                 break;
2322         case SP_SESSL: {
2323                 sessionlog *sl;
2324                 int size = c->value_int;
2325
2326                 if ( size < 0 ) {
2327                         snprintf( c->msg, sizeof( c->msg ), "%s size %d is negative",
2328                                 c->argv[0], size );
2329                         Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2330                                 "%s: %s\n", c->log, c->msg, 0 );
2331                         return ARG_BAD_CONF;
2332                 }
2333                 sl = si->si_logs;
2334                 if ( !sl ) {
2335                         sl = ch_malloc( sizeof( sessionlog ) + LDAP_LUTIL_CSNSTR_BUFSIZE );
2336                         sl->sl_mincsn.bv_val = (char *)(sl+1);
2337                         sl->sl_mincsn.bv_len = 0;
2338                         sl->sl_num = 0;
2339                         sl->sl_head = sl->sl_tail = NULL;
2340                         ldap_pvt_thread_mutex_init( &sl->sl_mutex );
2341                         si->si_logs = sl;
2342                 }
2343                 sl->sl_size = size;
2344                 }
2345                 break;
2346         case SP_NOPRES:
2347                 si->si_nopres = c->value_int;
2348                 break;
2349         case SP_USEHINT:
2350                 si->si_usehint = c->value_int;
2351                 break;
2352         }
2353         return rc;
2354 }
2355
2356 /* ITS#3456 we cannot run this search on the main thread, must use a
2357  * child thread in order to insure we have a big enough stack.
2358  */
2359 static void *
2360 syncprov_db_otask(
2361         void *ptr
2362 )
2363 {
2364         syncprov_findcsn( ptr, FIND_MAXCSN );
2365         return NULL;
2366 }
2367
2368 /* Read any existing contextCSN from the underlying db.
2369  * Then search for any entries newer than that. If no value exists,
2370  * just generate it. Cache whatever result.
2371  */
2372 static int
2373 syncprov_db_open(
2374     BackendDB *be
2375 )
2376 {
2377         slap_overinst   *on = (slap_overinst *) be->bd_info;
2378         syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2379
2380         Connection conn = { 0 };
2381         OperationBuffer opbuf = { 0 };
2382         char ctxcsnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
2383         Operation *op = (Operation *) &opbuf;
2384         Entry *e = NULL;
2385         Attribute *a;
2386         int rc;
2387         void *thrctx = NULL;
2388
2389         if ( !SLAP_LASTMOD( be )) {
2390                 Debug( LDAP_DEBUG_ANY,
2391                         "syncprov_db_open: invalid config, lastmod must be enabled\n", 0, 0, 0 );
2392                 return -1;
2393         }
2394
2395         if ( slapMode & SLAP_TOOL_MODE ) {
2396                 return 0;
2397         }
2398
2399         rc = overlay_register_control( be, LDAP_CONTROL_SYNC );
2400         if ( rc ) {
2401                 return rc;
2402         }
2403
2404         thrctx = ldap_pvt_thread_pool_context();
2405         connection_fake_init( &conn, op, thrctx );
2406         op->o_bd = be;
2407         op->o_dn = be->be_rootdn;
2408         op->o_ndn = be->be_rootndn;
2409
2410         ctxcsnbuf[0] = '\0';
2411
2412         rc = overlay_entry_get_ov( op, be->be_nsuffix, NULL,
2413                 slap_schema.si_ad_contextCSN, 0, &e, on );
2414
2415         if ( e ) {
2416                 ldap_pvt_thread_t tid;
2417
2418                 a = attr_find( e->e_attrs, slap_schema.si_ad_contextCSN );
2419                 if ( a ) {
2420                         si->si_ctxcsn.bv_len = a->a_nvals[0].bv_len;
2421                         if ( si->si_ctxcsn.bv_len >= sizeof(si->si_ctxcsnbuf ))
2422                                 si->si_ctxcsn.bv_len = sizeof(si->si_ctxcsnbuf)-1;
2423                         strncpy( si->si_ctxcsnbuf, a->a_nvals[0].bv_val,
2424                                 si->si_ctxcsn.bv_len );
2425                         si->si_ctxcsnbuf[si->si_ctxcsn.bv_len] = '\0';
2426                         strcpy( ctxcsnbuf, si->si_ctxcsnbuf );
2427                 }
2428                 overlay_entry_release_ov( op, e, 0, on );
2429                 if ( !BER_BVISEMPTY( &si->si_ctxcsn ) ) {
2430                         op->o_req_dn = be->be_suffix[0];
2431                         op->o_req_ndn = be->be_nsuffix[0];
2432                         op->ors_scope = LDAP_SCOPE_SUBTREE;
2433                         ldap_pvt_thread_create( &tid, 0, syncprov_db_otask, op );
2434                         ldap_pvt_thread_join( tid, NULL );
2435                 }
2436         }
2437
2438         if ( BER_BVISEMPTY( &si->si_ctxcsn ) ) {
2439                 if ( SLAP_SYNC_SHADOW( op->o_bd )) {
2440                 /* If we're also a consumer, and we didn't get a contextCSN,
2441                  * then don't generate anything, wait for our provider to send it
2442                  * to us.
2443                  */
2444                         goto out;
2445                 }
2446                 si->si_ctxcsn.bv_len = sizeof( si->si_ctxcsnbuf );
2447                 slap_get_csn( op, &si->si_ctxcsn, 0 );
2448         }
2449
2450         /* If our ctxcsn is different from what was read from the root
2451          * entry, make sure we do a checkpoint on close
2452          */
2453         if ( strcmp( si->si_ctxcsnbuf, ctxcsnbuf )) {
2454                 si->si_numops++;
2455         }
2456
2457 out:
2458         op->o_bd->bd_info = (BackendInfo *)on;
2459         return 0;
2460 }
2461
2462 /* Write the current contextCSN into the underlying db.
2463  */
2464 static int
2465 syncprov_db_close(
2466     BackendDB *be
2467 )
2468 {
2469     slap_overinst   *on = (slap_overinst *) be->bd_info;
2470     syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2471
2472         if ( slapMode & SLAP_TOOL_MODE ) {
2473                 return 0;
2474         }
2475         if ( si->si_numops ) {
2476                 Connection conn = {0};
2477                 OperationBuffer opbuf;
2478                 Operation *op = (Operation *) &opbuf;
2479                 SlapReply rs = {REP_RESULT};
2480                 void *thrctx;
2481
2482                 thrctx = ldap_pvt_thread_pool_context();
2483                 connection_fake_init( &conn, op, thrctx );
2484                 op->o_bd = be;
2485                 op->o_dn = be->be_rootdn;
2486                 op->o_ndn = be->be_rootndn;
2487                 syncprov_checkpoint( op, &rs, on );
2488         }
2489
2490     return 0;
2491 }
2492
2493 static int
2494 syncprov_db_init(
2495         BackendDB *be
2496 )
2497 {
2498         slap_overinst   *on = (slap_overinst *)be->bd_info;
2499         syncprov_info_t *si;
2500
2501         if ( SLAP_ISGLOBALOVERLAY( be ) ) {
2502                 Debug( LDAP_DEBUG_ANY,
2503                         "syncprov must be instantiated within a database.\n",
2504                         0, 0, 0 );
2505                 return 1;
2506         }
2507
2508         si = ch_calloc(1, sizeof(syncprov_info_t));
2509         on->on_bi.bi_private = si;
2510         ldap_pvt_thread_rdwr_init( &si->si_csn_rwlock );
2511         ldap_pvt_thread_mutex_init( &si->si_ops_mutex );
2512         ldap_pvt_thread_mutex_init( &si->si_mods_mutex );
2513         si->si_ctxcsn.bv_val = si->si_ctxcsnbuf;
2514
2515         csn_anlist[0].an_desc = slap_schema.si_ad_entryCSN;
2516         csn_anlist[0].an_name = slap_schema.si_ad_entryCSN->ad_cname;
2517         csn_anlist[1].an_desc = slap_schema.si_ad_entryUUID;
2518         csn_anlist[1].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2519
2520         uuid_anlist[0].an_desc = slap_schema.si_ad_entryUUID;
2521         uuid_anlist[0].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2522
2523         return 0;
2524 }
2525
2526 static int
2527 syncprov_db_destroy(
2528         BackendDB *be
2529 )
2530 {
2531         slap_overinst   *on = (slap_overinst *)be->bd_info;
2532         syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2533
2534         if ( si ) {
2535                 if ( si->si_logs ) {
2536                         slog_entry *se = si->si_logs->sl_head;
2537
2538                         while ( se ) {
2539                                 slog_entry *se_next = se->se_next;
2540                                 ch_free( se );
2541                                 se = se_next;
2542                         }
2543                                 
2544                         ch_free( si->si_logs );
2545                 }
2546                 ldap_pvt_thread_mutex_destroy( &si->si_mods_mutex );
2547                 ldap_pvt_thread_mutex_destroy( &si->si_ops_mutex );
2548                 ldap_pvt_thread_rdwr_destroy( &si->si_csn_rwlock );
2549                 ch_free( si );
2550         }
2551
2552         return 0;
2553 }
2554
2555 static int syncprov_parseCtrl (
2556         Operation *op,
2557         SlapReply *rs,
2558         LDAPControl *ctrl )
2559 {
2560         ber_tag_t tag;
2561         BerElementBuffer berbuf;
2562         BerElement *ber = (BerElement *)&berbuf;
2563         ber_int_t mode;
2564         ber_len_t len;
2565         struct berval cookie = BER_BVNULL;
2566         sync_control *sr;
2567         int rhint = 0;
2568
2569         if ( op->o_sync != SLAP_CONTROL_NONE ) {
2570                 rs->sr_text = "Sync control specified multiple times";
2571                 return LDAP_PROTOCOL_ERROR;
2572         }
2573
2574         if ( op->o_pagedresults != SLAP_CONTROL_NONE ) {
2575                 rs->sr_text = "Sync control specified with pagedResults control";
2576                 return LDAP_PROTOCOL_ERROR;
2577         }
2578
2579         if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
2580                 rs->sr_text = "Sync control value is empty (or absent)";
2581                 return LDAP_PROTOCOL_ERROR;
2582         }
2583
2584         /* Parse the control value
2585          *      syncRequestValue ::= SEQUENCE {
2586          *              mode   ENUMERATED {
2587          *                      -- 0 unused
2588          *                      refreshOnly             (1),
2589          *                      -- 2 reserved
2590          *                      refreshAndPersist       (3)
2591          *              },
2592          *              cookie  syncCookie OPTIONAL
2593          *      }
2594          */
2595
2596         ber_init2( ber, &ctrl->ldctl_value, 0 );
2597
2598         if ( (tag = ber_scanf( ber, "{i" /*}*/, &mode )) == LBER_ERROR ) {
2599                 rs->sr_text = "Sync control : mode decoding error";
2600                 return LDAP_PROTOCOL_ERROR;
2601         }
2602
2603         switch( mode ) {
2604         case LDAP_SYNC_REFRESH_ONLY:
2605                 mode = SLAP_SYNC_REFRESH;
2606                 break;
2607         case LDAP_SYNC_REFRESH_AND_PERSIST:
2608                 mode = SLAP_SYNC_REFRESH_AND_PERSIST;
2609                 break;
2610         default:
2611                 rs->sr_text = "Sync control : unknown update mode";
2612                 return LDAP_PROTOCOL_ERROR;
2613         }
2614
2615         tag = ber_peek_tag( ber, &len );
2616
2617         if ( tag == LDAP_TAG_SYNC_COOKIE ) {
2618                 if (( ber_scanf( ber, /*{*/ "m", &cookie )) == LBER_ERROR ) {
2619                         rs->sr_text = "Sync control : cookie decoding error";
2620                         return LDAP_PROTOCOL_ERROR;
2621                 }
2622                 tag = ber_peek_tag( ber, &len );
2623         }
2624         if ( tag == LDAP_TAG_RELOAD_HINT ) {
2625                 if (( ber_scanf( ber, /*{*/ "b", &rhint )) == LBER_ERROR ) {
2626                         rs->sr_text = "Sync control : rhint decoding error";
2627                         return LDAP_PROTOCOL_ERROR;
2628                 }
2629         }
2630         if (( ber_scanf( ber, /*{*/ "}")) == LBER_ERROR ) {
2631                         rs->sr_text = "Sync control : decoding error";
2632                         return LDAP_PROTOCOL_ERROR;
2633         }
2634         sr = op->o_tmpcalloc( 1, sizeof(struct sync_control), op->o_tmpmemctx );
2635         sr->sr_rhint = rhint;
2636         if (!BER_BVISNULL(&cookie)) {
2637                 ber_dupbv_x( &sr->sr_state.octet_str, &cookie, op->o_tmpmemctx );
2638                 if ( slap_parse_sync_cookie( &sr->sr_state, op->o_tmpmemctx ) ||
2639                         sr->sr_state.rid == -1 ) {
2640                         rs->sr_text = "Sync control : cookie parsing error";
2641                         return LDAP_PROTOCOL_ERROR;
2642                 }
2643         }
2644
2645         op->o_controls[slap_cids.sc_LDAPsync] = sr;
2646
2647         op->o_sync = ctrl->ldctl_iscritical
2648                 ? SLAP_CONTROL_CRITICAL
2649                 : SLAP_CONTROL_NONCRITICAL;
2650
2651         op->o_sync_mode |= mode;        /* o_sync_mode shares o_sync */
2652
2653         return LDAP_SUCCESS;
2654 }
2655
2656 /* This overlay is set up for dynamic loading via moduleload. For static
2657  * configuration, you'll need to arrange for the slap_overinst to be
2658  * initialized and registered by some other function inside slapd.
2659  */
2660
2661 static slap_overinst            syncprov;
2662
2663 int
2664 syncprov_initialize()
2665 {
2666         int rc;
2667
2668         rc = register_supported_control( LDAP_CONTROL_SYNC,
2669                 SLAP_CTRL_SEARCH, NULL,
2670                 syncprov_parseCtrl, &slap_cids.sc_LDAPsync );
2671         if ( rc != LDAP_SUCCESS ) {
2672                 Debug( LDAP_DEBUG_ANY,
2673                         "syncprov_init: Failed to register control %d\n", rc, 0, 0 );
2674                 return rc;
2675         }
2676
2677         syncprov.on_bi.bi_type = "syncprov";
2678         syncprov.on_bi.bi_db_init = syncprov_db_init;
2679         syncprov.on_bi.bi_db_destroy = syncprov_db_destroy;
2680         syncprov.on_bi.bi_db_open = syncprov_db_open;
2681         syncprov.on_bi.bi_db_close = syncprov_db_close;
2682
2683         syncprov.on_bi.bi_op_abandon = syncprov_op_abandon;
2684         syncprov.on_bi.bi_op_cancel = syncprov_op_abandon;
2685
2686         syncprov.on_bi.bi_op_add = syncprov_op_mod;
2687         syncprov.on_bi.bi_op_compare = syncprov_op_compare;
2688         syncprov.on_bi.bi_op_delete = syncprov_op_mod;
2689         syncprov.on_bi.bi_op_modify = syncprov_op_mod;
2690         syncprov.on_bi.bi_op_modrdn = syncprov_op_mod;
2691         syncprov.on_bi.bi_op_search = syncprov_op_search;
2692         syncprov.on_bi.bi_extended = syncprov_op_extended;
2693         syncprov.on_bi.bi_operational = syncprov_operational;
2694
2695         syncprov.on_bi.bi_cf_ocs = spocs;
2696
2697         generic_filter.f_desc = slap_schema.si_ad_objectClass;
2698
2699         rc = config_register_schema( spcfg, spocs );
2700         if ( rc ) return rc;
2701
2702         return overlay_register( &syncprov );
2703 }
2704
2705 #if SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC
2706 int
2707 init_module( int argc, char *argv[] )
2708 {
2709         return syncprov_initialize();
2710 }
2711 #endif /* SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC */
2712
2713 #endif /* defined(SLAPD_OVER_SYNCPROV) */