2 /* syncprov.c - syncrepl provider */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2004-2006 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
17 * This work was initially developed by Howard Chu for inclusion in
23 #ifdef SLAPD_OVER_SYNCPROV
25 #include <ac/string.h>
31 /* A modify request on a particular entry */
32 typedef struct modinst {
33 struct modinst *mi_next;
37 typedef struct modtarget {
38 struct modinst *mt_mods;
39 struct modinst *mt_tail;
41 ldap_pvt_thread_mutex_t mt_mutex;
44 /* A queued result of a persistent search */
45 typedef struct syncres {
46 struct syncres *s_next;
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 */
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
69 int s_inuse; /* reference count */
70 struct syncres *s_res;
71 struct syncres *s_restail;
72 struct re_s *s_qtask; /* task for playing psearch responses */
73 #define RUNQ_INTERVAL 36000 /* a long time */
74 ldap_pvt_thread_mutex_t s_mutex;
77 /* A received sync control */
78 typedef struct sync_control {
79 struct sync_cookie sr_state;
83 #if 0 /* moved back to slap.h */
84 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
86 /* o_sync_mode uses data bits of o_sync */
87 #define o_sync_mode o_ctrlflag[slap_cids.sc_LDAPsync]
89 #define SLAP_SYNC_NONE (LDAP_SYNC_NONE<<SLAP_CONTROL_SHIFT)
90 #define SLAP_SYNC_REFRESH (LDAP_SYNC_REFRESH_ONLY<<SLAP_CONTROL_SHIFT)
91 #define SLAP_SYNC_PERSIST (LDAP_SYNC_RESERVED<<SLAP_CONTROL_SHIFT)
92 #define SLAP_SYNC_REFRESH_AND_PERSIST (LDAP_SYNC_REFRESH_AND_PERSIST<<SLAP_CONTROL_SHIFT)
94 /* Record of which searches matched at premodify step */
95 typedef struct syncmatches {
96 struct syncmatches *sm_next;
100 /* Session log data */
101 typedef struct slog_entry {
102 struct slog_entry *se_next;
103 struct berval se_uuid;
104 struct berval se_csn;
108 typedef struct sessionlog {
109 struct berval sl_mincsn;
114 ldap_pvt_thread_mutex_t sl_mutex;
117 /* The main state for this overlay */
118 typedef struct syncprov_info_t {
120 struct berval si_ctxcsn; /* ldapsync context */
121 int si_chkops; /* checkpointing info */
123 int si_numops; /* number of ops since last checkpoint */
124 int si_nopres; /* Skip present phase */
125 int si_usehint; /* use reload hint */
126 time_t si_chklast; /* time of last checkpoint */
127 Avlnode *si_mods; /* entries being modified */
129 ldap_pvt_thread_mutex_t si_csn_mutex;
130 ldap_pvt_thread_mutex_t si_ops_mutex;
131 ldap_pvt_thread_mutex_t si_mods_mutex;
132 char si_ctxcsnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
135 typedef struct opcookie {
137 syncmatches *smatches;
138 struct berval sdn; /* DN of entry, for deletes */
140 struct berval suuid; /* UUID of entry */
141 struct berval sctxcsn;
142 int sreference; /* Is the entry a reference? */
145 typedef struct fbase_cookie {
146 struct berval *fdn; /* DN of a modified entry, for scope testing */
147 syncops *fss; /* persistent search we're testing against */
148 int fbase; /* if TRUE we found the search base and it's still valid */
149 int fscope; /* if TRUE then fdn is within the psearch scope */
152 static AttributeName csn_anlist[3];
153 static AttributeName uuid_anlist[2];
155 /* Build a LDAPsync intermediate state control */
161 int entry_sync_state,
165 struct berval *cookie )
170 BerElementBuffer berbuf;
171 BerElement *ber = (BerElement *)&berbuf;
173 struct berval entryuuid_bv = BER_BVNULL;
175 ber_init2( ber, 0, LBER_USE_DER );
176 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
178 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
180 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
181 AttributeDescription *desc = a->a_desc;
182 if ( desc == slap_schema.si_ad_entryUUID ) {
183 entryuuid_bv = a->a_nvals[0];
188 /* FIXME: what if entryuuid is NULL or empty ? */
190 if ( send_cookie && cookie ) {
191 ber_printf( ber, "{eOON}",
192 entry_sync_state, &entryuuid_bv, cookie );
194 ber_printf( ber, "{eON}",
195 entry_sync_state, &entryuuid_bv );
198 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_STATE;
199 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
200 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
205 Debug( LDAP_DEBUG_TRACE,
206 "slap_build_sync_ctrl: ber_flatten2 failed\n",
208 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
215 /* Build a LDAPsync final state control */
223 struct berval *cookie,
227 BerElementBuffer berbuf;
228 BerElement *ber = (BerElement *)&berbuf;
230 ber_init2( ber, NULL, LBER_USE_DER );
231 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
233 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
235 ber_printf( ber, "{" );
236 if ( send_cookie && cookie ) {
237 ber_printf( ber, "O", cookie );
239 if ( refreshDeletes == LDAP_SYNC_REFRESH_DELETES ) {
240 ber_printf( ber, "b", refreshDeletes );
242 ber_printf( ber, "N}" );
244 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_DONE;
245 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
246 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
251 Debug( LDAP_DEBUG_TRACE,
252 "syncprov_done_ctrl: ber_flatten2 failed\n",
254 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
266 struct berval *cookie,
271 BerElementBuffer berbuf;
272 BerElement *ber = (BerElement *)&berbuf;
273 struct berval rspdata;
277 ber_init2( ber, NULL, LBER_USE_DER );
278 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
282 case LDAP_TAG_SYNC_NEW_COOKIE:
283 ber_printf( ber, "tO", type, cookie );
285 case LDAP_TAG_SYNC_REFRESH_DELETE:
286 case LDAP_TAG_SYNC_REFRESH_PRESENT:
287 ber_printf( ber, "t{", type );
289 ber_printf( ber, "O", cookie );
291 if ( refreshDone == 0 ) {
292 ber_printf( ber, "b", refreshDone );
294 ber_printf( ber, "N}" );
296 case LDAP_TAG_SYNC_ID_SET:
297 ber_printf( ber, "t{", type );
299 ber_printf( ber, "O", cookie );
301 if ( refreshDeletes == 1 ) {
302 ber_printf( ber, "b", refreshDeletes );
304 ber_printf( ber, "[W]", syncUUIDs );
305 ber_printf( ber, "N}" );
308 Debug( LDAP_DEBUG_TRACE,
309 "syncprov_sendinfo: invalid syncinfo type (%d)\n",
315 ret = ber_flatten2( ber, &rspdata, 0 );
318 Debug( LDAP_DEBUG_TRACE,
319 "syncprov_sendinfo: ber_flatten2 failed\n",
321 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
325 rs->sr_rspoid = LDAP_SYNC_INFO;
326 rs->sr_rspdata = &rspdata;
327 send_ldap_intermediate( op, rs );
328 rs->sr_rspdata = NULL;
334 /* Find a modtarget in an AVL tree */
336 sp_avl_cmp( const void *c1, const void *c2 )
338 const modtarget *m1, *m2;
342 rc = m1->mt_op->o_req_ndn.bv_len - m2->mt_op->o_req_ndn.bv_len;
345 return ber_bvcmp( &m1->mt_op->o_req_ndn, &m2->mt_op->o_req_ndn );
348 /* syncprov_findbase:
349 * finds the true DN of the base of a search (with alias dereferencing) and
350 * checks to make sure the base entry doesn't get replaced with a different
351 * entry (e.g., swapping trees via ModDN, or retargeting an alias). If a
352 * change is detected, any persistent search on this base must be terminated /
354 * On the first call, we just save the DN and entryID. On subsequent calls
355 * we compare the DN and entryID with the saved values.
358 findbase_cb( Operation *op, SlapReply *rs )
360 slap_callback *sc = op->o_callback;
362 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
363 fbase_cookie *fc = sc->sc_private;
365 /* If no entryID, we're looking for the first time.
366 * Just store whatever we got.
368 if ( fc->fss->s_eid == NOID ) {
370 fc->fss->s_eid = rs->sr_entry->e_id;
371 ber_dupbv( &fc->fss->s_base, &rs->sr_entry->e_nname );
373 } else if ( rs->sr_entry->e_id == fc->fss->s_eid &&
374 dn_match( &rs->sr_entry->e_nname, &fc->fss->s_base )) {
376 /* OK, the DN is the same and the entryID is the same. */
380 if ( rs->sr_err != LDAP_SUCCESS ) {
381 Debug( LDAP_DEBUG_ANY, "findbase failed! %d\n", rs->sr_err,0,0 );
386 static Filter generic_filter = { LDAP_FILTER_PRESENT, { 0 }, NULL };
387 static struct berval generic_filterstr = BER_BVC("(objectclass=*)");
390 syncprov_findbase( Operation *op, fbase_cookie *fc )
392 opcookie *opc = op->o_callback->sc_private;
393 slap_overinst *on = opc->son;
395 /* Use basic parameters from syncrepl search, but use
396 * current op's threadctx / tmpmemctx
398 ldap_pvt_thread_mutex_lock( &fc->fss->s_mutex );
399 if ( fc->fss->s_flags & PS_FIND_BASE ) {
400 slap_callback cb = {0};
402 SlapReply frs = { REP_RESULT };
405 fc->fss->s_flags ^= PS_FIND_BASE;
406 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
408 fop = *fc->fss->s_op;
410 fop.o_hdr = op->o_hdr;
412 fop.o_time = op->o_time;
413 fop.o_tincr = op->o_tincr;
415 cb.sc_response = findbase_cb;
418 fop.o_sync_mode = 0; /* turn off sync mode */
419 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
420 fop.o_callback = &cb;
421 fop.o_tag = LDAP_REQ_SEARCH;
422 fop.ors_scope = LDAP_SCOPE_BASE;
423 fop.ors_limit = NULL;
425 fop.ors_tlimit = SLAP_NO_LIMIT;
426 fop.ors_attrs = slap_anlist_no_attrs;
427 fop.ors_attrsonly = 1;
428 fop.ors_filter = &generic_filter;
429 fop.ors_filterstr = generic_filterstr;
431 fop.o_bd->bd_info = on->on_info->oi_orig;
432 rc = fop.o_bd->be_search( &fop, &frs );
433 fop.o_bd->bd_info = (BackendInfo *)on;
435 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
439 /* After the first call, see if the fdn resides in the scope */
440 if ( fc->fbase == 1 ) {
441 switch ( fc->fss->s_op->ors_scope ) {
442 case LDAP_SCOPE_BASE:
443 fc->fscope = dn_match( fc->fdn, &fc->fss->s_base );
445 case LDAP_SCOPE_ONELEVEL: {
447 dnParent( fc->fdn, &pdn );
448 fc->fscope = dn_match( &pdn, &fc->fss->s_base );
450 case LDAP_SCOPE_SUBTREE:
451 fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base );
453 case LDAP_SCOPE_SUBORDINATE:
454 fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base ) &&
455 !dn_match( fc->fdn, &fc->fss->s_base );
463 /* If entryID has changed, then the base of this search has
464 * changed. Invalidate the psearch.
466 return LDAP_NO_SUCH_OBJECT;
470 * This function has three different purposes, but they all use a search
471 * that filters on entryCSN so they're combined here.
472 * 1: at startup time, after a contextCSN has been read from the database,
473 * we search for all entries with CSN >= contextCSN in case the contextCSN
474 * was not checkpointed at the previous shutdown.
476 * 2: when the current contextCSN is known and we have a sync cookie, we search
477 * for one entry with CSN = the cookie CSN. If not found, try <= cookie CSN.
478 * If an entry is found, the cookie CSN is valid, otherwise it is stale.
480 * 3: during a refresh phase, we search for all entries with CSN <= the cookie
481 * CSN, and generate Present records for them. We always collect this result
482 * in SyncID sets, even if there's only one match.
484 typedef enum find_csn_t {
491 findmax_cb( Operation *op, SlapReply *rs )
493 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
494 struct berval *maxcsn = op->o_callback->sc_private;
495 Attribute *a = attr_find( rs->sr_entry->e_attrs,
496 slap_schema.si_ad_entryCSN );
498 if ( a && ber_bvcmp( &a->a_vals[0], maxcsn ) > 0 ) {
499 maxcsn->bv_len = a->a_vals[0].bv_len;
500 strcpy( maxcsn->bv_val, a->a_vals[0].bv_val );
507 findcsn_cb( Operation *op, SlapReply *rs )
509 slap_callback *sc = op->o_callback;
511 /* We just want to know that at least one exists, so it's OK if
512 * we exceed the unchecked limit.
514 if ( rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
515 (rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS )) {
516 sc->sc_private = (void *)1;
521 /* Build a list of entryUUIDs for sending in a SyncID set */
525 typedef struct fpres_cookie {
532 findpres_cb( Operation *op, SlapReply *rs )
534 slap_callback *sc = op->o_callback;
535 fpres_cookie *pc = sc->sc_private;
537 int ret = SLAP_CB_CONTINUE;
539 switch ( rs->sr_type ) {
541 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryUUID );
543 pc->uuids[pc->num].bv_val = pc->last;
544 AC_MEMCPY( pc->uuids[pc->num].bv_val, a->a_nvals[0].bv_val,
545 pc->uuids[pc->num].bv_len );
547 pc->last = pc->uuids[pc->num].bv_val;
548 pc->uuids[pc->num].bv_val = NULL;
551 if ( pc->num != SLAP_SYNCUUID_SET_SIZE )
557 ret = syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, NULL,
559 pc->uuids[pc->num].bv_val = pc->last;
561 pc->last = pc->uuids[0].bv_val;
571 syncprov_findcsn( Operation *op, find_csn_t mode )
573 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
574 syncprov_info_t *si = on->on_bi.bi_private;
576 slap_callback cb = {0};
578 SlapReply frs = { REP_RESULT };
579 char buf[LDAP_LUTIL_CSNSTR_BUFSIZE + STRLENOF("(entryCSN<=)")];
580 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
581 struct berval maxcsn;
583 #ifdef LDAP_COMP_MATCH
584 AttributeAssertion eq = { NULL, BER_BVNULL, NULL };
586 AttributeAssertion eq = { NULL, BER_BVNULL };
588 fpres_cookie pcookie;
589 sync_control *srs = NULL;
590 struct slap_limits_set fc_limits;
591 int i, rc = LDAP_SUCCESS, findcsn_retry = 1;
593 if ( mode != FIND_MAXCSN ) {
594 srs = op->o_controls[slap_cids.sc_LDAPsync];
596 if ( srs->sr_state.ctxcsn.bv_len >= LDAP_LUTIL_CSNSTR_BUFSIZE ) {
602 fop.o_sync_mode &= SLAP_CONTROL_MASK; /* turn off sync_mode */
603 /* We want pure entries, not referrals */
604 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
607 cf.f_av_desc = slap_schema.si_ad_entryCSN;
610 fop.o_callback = &cb;
611 fop.ors_limit = NULL;
612 fop.ors_tlimit = SLAP_NO_LIMIT;
613 fop.ors_filter = &cf;
614 fop.ors_filterstr.bv_val = buf;
619 cf.f_choice = LDAP_FILTER_GE;
620 cf.f_av_value = si->si_ctxcsn;
621 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN>=%s)",
622 cf.f_av_value.bv_val );
623 fop.ors_attrsonly = 0;
624 fop.ors_attrs = csn_anlist;
625 fop.ors_slimit = SLAP_NO_LIMIT;
626 cb.sc_private = &maxcsn;
627 cb.sc_response = findmax_cb;
628 strcpy( cbuf, si->si_ctxcsn.bv_val );
629 maxcsn.bv_val = cbuf;
630 maxcsn.bv_len = si->si_ctxcsn.bv_len;
633 cf.f_av_value = srs->sr_state.ctxcsn;
634 /* Look for exact match the first time */
635 if ( findcsn_retry ) {
636 cf.f_choice = LDAP_FILTER_EQUALITY;
637 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN=%s)",
638 cf.f_av_value.bv_val );
639 /* On retry, look for <= */
641 cf.f_choice = LDAP_FILTER_LE;
642 fop.ors_limit = &fc_limits;
643 fc_limits.lms_s_unchecked = 1;
644 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN<=%s)",
645 cf.f_av_value.bv_val );
647 fop.ors_attrsonly = 1;
648 fop.ors_attrs = slap_anlist_no_attrs;
650 cb.sc_private = NULL;
651 cb.sc_response = findcsn_cb;
654 af.f_choice = LDAP_FILTER_AND;
657 cf.f_choice = LDAP_FILTER_LE;
658 cf.f_av_value = srs->sr_state.ctxcsn;
659 cf.f_next = op->ors_filter;
660 fop.ors_filter = ⁡
661 filter2bv_x( &fop, fop.ors_filter, &fop.ors_filterstr );
662 fop.ors_attrsonly = 0;
663 fop.ors_attrs = uuid_anlist;
664 fop.ors_slimit = SLAP_NO_LIMIT;
665 cb.sc_private = &pcookie;
666 cb.sc_response = findpres_cb;
669 /* preallocate storage for a full set */
670 pcookie.uuids = op->o_tmpalloc( (SLAP_SYNCUUID_SET_SIZE+1) *
671 sizeof(struct berval) + SLAP_SYNCUUID_SET_SIZE * UUID_LEN,
673 pcookie.last = (char *)(pcookie.uuids + SLAP_SYNCUUID_SET_SIZE+1);
674 pcookie.uuids[0].bv_val = pcookie.last;
675 pcookie.uuids[0].bv_len = UUID_LEN;
676 for (i=1; i<SLAP_SYNCUUID_SET_SIZE; i++) {
677 pcookie.uuids[i].bv_val = pcookie.uuids[i-1].bv_val + UUID_LEN;
678 pcookie.uuids[i].bv_len = UUID_LEN;
683 fop.o_bd->bd_info = on->on_info->oi_orig;
684 fop.o_bd->be_search( &fop, &frs );
685 fop.o_bd->bd_info = (BackendInfo *)on;
689 strcpy( si->si_ctxcsnbuf, maxcsn.bv_val );
690 si->si_ctxcsn.bv_len = maxcsn.bv_len;
693 /* If matching CSN was not found, invalidate the context. */
694 if ( !cb.sc_private ) {
695 /* If we didn't find an exact match, then try for <= */
696 if ( findcsn_retry ) {
700 rc = LDAP_NO_SUCH_OBJECT;
704 op->o_tmpfree( pcookie.uuids, op->o_tmpmemctx );
705 op->o_tmpfree( fop.ors_filterstr.bv_val, op->o_tmpmemctx );
713 syncprov_free_syncop( syncops *so )
715 syncres *sr, *srnext;
716 GroupAssertion *ga, *gnext;
718 ldap_pvt_thread_mutex_lock( &so->s_mutex );
719 if ( --so->s_inuse > 0 ) {
720 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
723 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
724 if ( so->s_flags & PS_IS_DETACHED ) {
725 filter_free( so->s_op->ors_filter );
726 for ( ga = so->s_op->o_groups; ga; ga=gnext ) {
732 ch_free( so->s_base.bv_val );
733 for ( sr=so->s_res; sr; sr=srnext ) {
737 ldap_pvt_thread_mutex_destroy( &so->s_mutex );
741 /* Send a persistent search response */
743 syncprov_sendresp( Operation *op, opcookie *opc, syncops *so,
744 Entry **e, int mode )
746 slap_overinst *on = opc->son;
748 SlapReply rs = { REP_SEARCH };
749 LDAPControl *ctrls[2];
750 struct berval cookie;
752 Attribute a_uuid = {0};
754 if ( so->s_op->o_abandon )
755 return SLAPD_ABANDON;
758 slap_compose_sync_cookie( op, &cookie, &opc->sctxcsn, so->s_rid );
760 e_uuid.e_attrs = &a_uuid;
761 a_uuid.a_desc = slap_schema.si_ad_entryUUID;
762 a_uuid.a_nvals = &opc->suuid;
763 rs.sr_err = syncprov_state_ctrl( op, &rs, &e_uuid,
764 mode, ctrls, 0, 1, &cookie );
765 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
768 op->o_bd->bd_info = (BackendInfo *)on->on_info;
772 if ( rs.sr_entry->e_private )
773 rs.sr_flags = REP_ENTRY_MUSTRELEASE;
774 if ( opc->sreference ) {
775 rs.sr_ref = get_entry_referrals( op, rs.sr_entry );
776 send_search_reference( op, &rs );
777 ber_bvarray_free( rs.sr_ref );
783 case LDAP_SYNC_MODIFY:
785 if ( rs.sr_entry->e_private )
786 rs.sr_flags = REP_ENTRY_MUSTRELEASE;
787 rs.sr_attrs = op->ors_attrs;
788 send_search_entry( op, &rs );
792 case LDAP_SYNC_DELETE:
793 e_uuid.e_attrs = NULL;
794 e_uuid.e_name = opc->sdn;
795 e_uuid.e_nname = opc->sndn;
796 rs.sr_entry = &e_uuid;
797 if ( opc->sreference ) {
798 struct berval bv = BER_BVNULL;
800 send_search_reference( op, &rs );
802 send_search_entry( op, &rs );
808 /* In case someone else freed it already? */
810 op->o_tmpfree( rs.sr_ctrls[0], op->o_tmpmemctx );
817 /* Play back queued responses */
819 syncprov_qplay( Operation *op, slap_overinst *on, syncops *so )
827 op->o_bd->bd_info = (BackendInfo *)on->on_info;
830 ldap_pvt_thread_mutex_lock( &so->s_mutex );
833 so->s_res = sr->s_next;
835 so->s_restail = NULL;
836 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
838 if ( !sr || so->s_op->o_abandon )
842 opc.sndn = sr->s_ndn;
843 opc.suuid = sr->s_uuid;
844 opc.sctxcsn = sr->s_csn;
845 opc.sreference = sr->s_isreference;
848 if ( sr->s_mode != LDAP_SYNC_DELETE ) {
849 rc = be_entry_get_rw( op, &opc.sndn, NULL, NULL, 0, &e );
855 rc = syncprov_sendresp( op, &opc, so, &e, sr->s_mode );
858 be_entry_release_rw( op, e, 0 );
866 op->o_bd->bd_info = (BackendInfo *)on;
870 /* runqueue task for playing back queued responses */
872 syncprov_qtask( void *ctx, void *arg )
874 struct re_s *rtask = arg;
875 syncops *so = rtask->arg;
876 slap_overinst *on = so->s_op->o_private;
877 OperationBuffer opbuf;
881 op = (Operation *) &opbuf;
883 op->o_hdr = (Opheader *)(op+1);
884 op->o_controls = (void **)(op->o_hdr+1);
885 memset( op->o_controls, 0, SLAP_MAX_CIDS * sizeof(void *));
887 *op->o_hdr = *so->s_op->o_hdr;
889 op->o_tmpmemctx = slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, ctx);
890 op->o_tmpmfuncs = &slap_sl_mfuncs;
891 op->o_threadctx = ctx;
893 /* syncprov_qplay expects a fake db */
894 be = *so->s_op->o_bd;
895 be.be_flags |= SLAP_DBFLAG_OVERLAY;
897 op->o_private = NULL;
898 op->o_callback = NULL;
900 (void)syncprov_qplay( op, on, so );
902 /* decrement use count... */
903 syncprov_free_syncop( so );
905 /* wait until we get explicitly scheduled again */
906 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
907 ldap_pvt_runqueue_stoptask( &slapd_rq, so->s_qtask );
908 ldap_pvt_runqueue_resched( &slapd_rq, so->s_qtask, 1 );
909 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
914 /* Start the task to play back queued psearch responses */
916 syncprov_qstart( syncops *so )
919 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
920 if ( !so->s_qtask ) {
921 so->s_qtask = ldap_pvt_runqueue_insert( &slapd_rq, RUNQ_INTERVAL,
922 syncprov_qtask, so, "syncprov_qtask",
923 so->s_op->o_conn->c_peer_name.bv_val );
927 if (!ldap_pvt_runqueue_isrunning( &slapd_rq, so->s_qtask ) &&
928 !so->s_qtask->next_sched.tv_sec ) {
929 so->s_qtask->interval.tv_sec = 0;
930 ldap_pvt_runqueue_resched( &slapd_rq, so->s_qtask, 0 );
931 so->s_qtask->interval.tv_sec = RUNQ_INTERVAL;
936 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
938 slap_wake_listener();
941 /* Queue a persistent search response */
943 syncprov_qresp( opcookie *opc, syncops *so, int mode )
947 sr = ch_malloc(sizeof(syncres) + opc->suuid.bv_len + 1 +
948 opc->sdn.bv_len + 1 + opc->sndn.bv_len + 1 + opc->sctxcsn.bv_len + 1 );
950 sr->s_dn.bv_val = (char *)(sr + 1);
951 sr->s_dn.bv_len = opc->sdn.bv_len;
953 sr->s_isreference = opc->sreference;
954 sr->s_ndn.bv_val = lutil_strcopy( sr->s_dn.bv_val,
955 opc->sdn.bv_val ) + 1;
956 sr->s_ndn.bv_len = opc->sndn.bv_len;
957 sr->s_uuid.bv_val = lutil_strcopy( sr->s_ndn.bv_val,
958 opc->sndn.bv_val ) + 1;
959 sr->s_uuid.bv_len = opc->suuid.bv_len;
960 AC_MEMCPY( sr->s_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
961 sr->s_csn.bv_val = sr->s_uuid.bv_val + sr->s_uuid.bv_len + 1;
962 sr->s_csn.bv_len = opc->sctxcsn.bv_len;
963 strcpy( sr->s_csn.bv_val, opc->sctxcsn.bv_val );
965 ldap_pvt_thread_mutex_lock( &so->s_mutex );
969 so->s_restail->s_next = sr;
973 /* If the base of the psearch was modified, check it next time round */
974 if ( so->s_flags & PS_WROTE_BASE ) {
975 so->s_flags ^= PS_WROTE_BASE;
976 so->s_flags |= PS_FIND_BASE;
978 if ( so->s_flags & PS_IS_DETACHED ) {
979 syncprov_qstart( so );
981 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
986 syncprov_drop_psearch( syncops *so, int lock )
988 if ( so->s_flags & PS_IS_DETACHED ) {
990 ldap_pvt_thread_mutex_lock( &so->s_op->o_conn->c_mutex );
991 so->s_op->o_conn->c_n_ops_executing--;
992 so->s_op->o_conn->c_n_ops_completed++;
993 LDAP_STAILQ_REMOVE( &so->s_op->o_conn->c_ops, so->s_op, slap_op,
996 ldap_pvt_thread_mutex_unlock( &so->s_op->o_conn->c_mutex );
998 syncprov_free_syncop( so );
1004 syncprov_ab_cleanup( Operation *op, SlapReply *rs )
1006 slap_callback *sc = op->o_callback;
1007 op->o_callback = sc->sc_next;
1008 syncprov_drop_psearch( op->o_callback->sc_private, 0 );
1009 op->o_tmpfree( sc, op->o_tmpmemctx );
1014 syncprov_op_abandon( Operation *op, SlapReply *rs )
1016 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1017 syncprov_info_t *si = on->on_bi.bi_private;
1018 syncops *so, *soprev;
1020 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1021 for ( so=si->si_ops, soprev = (syncops *)&si->si_ops; so;
1022 soprev=so, so=so->s_next ) {
1023 if ( so->s_op->o_connid == op->o_connid &&
1024 so->s_op->o_msgid == op->orn_msgid ) {
1025 so->s_op->o_abandon = 1;
1026 soprev->s_next = so->s_next;
1030 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1032 /* Is this really a Cancel exop? */
1033 if ( op->o_tag != LDAP_REQ_ABANDON ) {
1034 so->s_op->o_cancel = SLAP_CANCEL_ACK;
1035 rs->sr_err = LDAP_CANCELLED;
1036 send_ldap_result( so->s_op, rs );
1037 if ( so->s_flags & PS_IS_DETACHED ) {
1039 cb = op->o_tmpcalloc( 1, sizeof(slap_callback), op->o_tmpmemctx );
1040 cb->sc_cleanup = syncprov_ab_cleanup;
1041 cb->sc_next = op->o_callback;
1042 cb->sc_private = so;
1043 return SLAP_CB_CONTINUE;
1046 syncprov_drop_psearch( so, 0 );
1048 return SLAP_CB_CONTINUE;
1051 /* Find which persistent searches are affected by this operation */
1053 syncprov_matchops( Operation *op, opcookie *opc, int saveit )
1055 slap_overinst *on = opc->son;
1056 syncprov_info_t *si = on->on_bi.bi_private;
1059 syncops *ss, *sprev, *snext;
1063 struct berval newdn;
1065 BackendDB *b0 = op->o_bd, db;
1067 fc.fdn = &op->o_req_ndn;
1068 /* compute new DN */
1069 if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1071 if ( op->orr_nnewSup ) pdn = *op->orr_nnewSup;
1072 else dnParent( fc.fdn, &pdn );
1073 build_new_dn( &newdn, &pdn, &op->orr_nnewrdn, op->o_tmpmemctx );
1077 if ( op->o_tag != LDAP_REQ_ADD ) {
1078 if ( !SLAP_ISOVERLAY( op->o_bd )) {
1082 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1083 rc = be_entry_get_rw( op, fc.fdn, NULL, NULL, 0, &e );
1084 /* If we're sending responses now, make a copy and unlock the DB */
1085 if ( e && !saveit ) {
1086 Entry *e2 = entry_dup( e );
1087 be_entry_release_rw( op, e, 0 );
1090 op->o_bd->bd_info = (BackendInfo *)on;
1099 if ( saveit || op->o_tag == LDAP_REQ_ADD ) {
1100 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1101 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1102 opc->sreference = is_entry_referral( e );
1103 a = attr_find( e->e_attrs, slap_schema.si_ad_entryUUID );
1105 ber_dupbv_x( &opc->suuid, &a->a_nvals[0], op->o_tmpmemctx );
1106 } else if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1107 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1108 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1109 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1110 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1113 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1114 for (ss = si->si_ops, sprev = (syncops *)&si->si_ops; ss;
1115 sprev = ss, ss=snext)
1126 /* If the base of the search is missing, signal a refresh */
1127 rc = syncprov_findbase( op, &fc );
1128 if ( rc != LDAP_SUCCESS ) {
1129 SlapReply rs = {REP_RESULT};
1130 send_ldap_error( ss->s_op, &rs, LDAP_SYNC_REFRESH_REQUIRED,
1131 "search base has changed" );
1132 sprev->s_next = snext;
1133 syncprov_drop_psearch( ss, 1 );
1139 /* If we're sending results now, look for this op in old matches */
1143 /* Did we modify the search base? */
1144 if ( dn_match( &op->o_req_ndn, &ss->s_base )) {
1145 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1146 ss->s_flags |= PS_WROTE_BASE;
1147 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1150 for ( sm=opc->smatches, old=(syncmatches *)&opc->smatches; sm;
1151 old=sm, sm=sm->sm_next ) {
1152 if ( sm->sm_op == ss ) {
1154 old->sm_next = sm->sm_next;
1155 op->o_tmpfree( sm, op->o_tmpmemctx );
1161 /* check if current o_req_dn is in scope and matches filter */
1162 if ( fc.fscope && test_filter( op, e, ss->s_op->ors_filter ) ==
1163 LDAP_COMPARE_TRUE ) {
1165 sm = op->o_tmpalloc( sizeof(syncmatches), op->o_tmpmemctx );
1166 sm->sm_next = opc->smatches;
1168 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1170 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1173 /* if found send UPDATE else send ADD */
1174 syncprov_qresp( opc, ss,
1175 found ? LDAP_SYNC_MODIFY : LDAP_SYNC_ADD );
1177 } else if ( !saveit && found ) {
1179 syncprov_qresp( opc, ss, LDAP_SYNC_DELETE );
1182 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1184 if ( op->o_tag != LDAP_REQ_ADD && e ) {
1185 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1186 be_entry_release_rw( op, e, 0 );
1187 op->o_bd->bd_info = (BackendInfo *)on;
1190 op->o_tmpfree( fc.fdn->bv_val, op->o_tmpmemctx );
1196 syncprov_op_cleanup( Operation *op, SlapReply *rs )
1198 slap_callback *cb = op->o_callback;
1199 opcookie *opc = cb->sc_private;
1200 slap_overinst *on = opc->son;
1201 syncprov_info_t *si = on->on_bi.bi_private;
1202 syncmatches *sm, *snext;
1203 modtarget *mt, mtdummy;
1205 for (sm = opc->smatches; sm; sm=snext) {
1206 snext = sm->sm_next;
1207 syncprov_free_syncop( sm->sm_op );
1208 op->o_tmpfree( sm, op->o_tmpmemctx );
1211 /* Remove op from lock table */
1213 ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1214 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1216 modinst *mi = mt->mt_mods;
1218 /* If there are more, promote the next one */
1219 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1220 if ( mi->mi_next ) {
1221 mt->mt_mods = mi->mi_next;
1222 mt->mt_op = mt->mt_mods->mi_op;
1223 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1225 avl_delete( &si->si_mods, mt, sp_avl_cmp );
1226 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1227 ldap_pvt_thread_mutex_destroy( &mt->mt_mutex );
1231 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1232 if ( !BER_BVISNULL( &opc->suuid ))
1233 op->o_tmpfree( opc->suuid.bv_val, op->o_tmpmemctx );
1234 if ( !BER_BVISNULL( &opc->sndn ))
1235 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1236 if ( !BER_BVISNULL( &opc->sdn ))
1237 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1238 op->o_callback = cb->sc_next;
1239 op->o_tmpfree(cb, op->o_tmpmemctx);
1245 syncprov_checkpoint( Operation *op, SlapReply *rs, slap_overinst *on )
1247 syncprov_info_t *si = on->on_bi.bi_private;
1250 SlapReply rsm = { 0 };
1251 struct berval bv[2];
1252 slap_callback cb = {0};
1254 /* If ctxcsn is empty, delete it */
1255 if ( BER_BVISEMPTY( &si->si_ctxcsn )) {
1256 mod.sml_values = NULL;
1258 mod.sml_values = bv;
1259 bv[1].bv_val = NULL;
1260 bv[0] = si->si_ctxcsn;
1262 mod.sml_nvalues = NULL;
1263 mod.sml_desc = slap_schema.si_ad_contextCSN;
1264 mod.sml_op = LDAP_MOD_REPLACE;
1266 mod.sml_next = NULL;
1268 cb.sc_response = slap_null_cb;
1270 opm.o_tag = LDAP_REQ_MODIFY;
1271 opm.o_callback = &cb;
1272 opm.orm_modlist = &mod;
1273 opm.o_req_dn = op->o_bd->be_suffix[0];
1274 opm.o_req_ndn = op->o_bd->be_nsuffix[0];
1275 opm.o_bd->bd_info = on->on_info->oi_orig;
1276 opm.o_managedsait = SLAP_CONTROL_NONCRITICAL;
1277 SLAP_DBFLAGS( opm.o_bd ) |= SLAP_DBFLAG_NOLASTMOD;
1278 opm.o_bd->be_modify( &opm, &rsm );
1279 SLAP_DBFLAGS( opm.o_bd ) ^= SLAP_DBFLAG_NOLASTMOD;
1280 if ( mod.sml_next != NULL ) {
1281 slap_mods_free( mod.sml_next, 1 );
1286 syncprov_add_slog( Operation *op )
1288 opcookie *opc = op->o_callback->sc_private;
1289 slap_overinst *on = opc->son;
1290 syncprov_info_t *si = on->on_bi.bi_private;
1296 /* Allocate a record. UUIDs are not NUL-terminated. */
1297 se = ch_malloc( sizeof( slog_entry ) + opc->suuid.bv_len +
1298 op->o_csn.bv_len + 1 );
1300 se->se_tag = op->o_tag;
1302 se->se_uuid.bv_val = (char *)(&se[1]);
1303 AC_MEMCPY( se->se_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
1304 se->se_uuid.bv_len = opc->suuid.bv_len;
1306 se->se_csn.bv_val = se->se_uuid.bv_val + opc->suuid.bv_len;
1307 AC_MEMCPY( se->se_csn.bv_val, op->o_csn.bv_val, op->o_csn.bv_len );
1308 se->se_csn.bv_val[op->o_csn.bv_len] = '\0';
1309 se->se_csn.bv_len = op->o_csn.bv_len;
1311 ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
1312 if ( sl->sl_head ) {
1313 sl->sl_tail->se_next = se;
1319 while ( sl->sl_num > sl->sl_size ) {
1321 sl->sl_head = se->se_next;
1322 strcpy( sl->sl_mincsn.bv_val, se->se_csn.bv_val );
1323 sl->sl_mincsn.bv_len = se->se_csn.bv_len;
1327 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1331 /* Just set a flag if we found the matching entry */
1333 playlog_cb( Operation *op, SlapReply *rs )
1335 if ( rs->sr_type == REP_SEARCH ) {
1336 op->o_callback->sc_private = (void *)1;
1341 /* enter with sl->sl_mutex locked, release before returning */
1343 syncprov_playlog( Operation *op, SlapReply *rs, sessionlog *sl,
1344 sync_control *srs, struct berval *ctxcsn )
1346 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1348 int i, j, ndel, num, nmods, mmods;
1349 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1351 struct berval delcsn;
1353 if ( !sl->sl_num ) {
1354 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1362 uuids = op->o_tmpalloc( (num+1) * sizeof( struct berval ) +
1363 num * UUID_LEN, op->o_tmpmemctx );
1364 uuids[0].bv_val = (char *)(uuids + num + 1);
1367 delcsn.bv_val = cbuf;
1369 /* Make a copy of the relevant UUIDs. Put the Deletes up front
1370 * and everything else at the end. Do this first so we can
1371 * unlock the list mutex.
1373 for ( se=sl->sl_head; se; se=se->se_next ) {
1374 if ( ber_bvcmp( &se->se_csn, &srs->sr_state.ctxcsn ) <= 0 ) continue;
1375 if ( ber_bvcmp( &se->se_csn, ctxcsn ) > 0 ) break;
1376 if ( se->se_tag == LDAP_REQ_DELETE ) {
1379 AC_MEMCPY( cbuf, se->se_csn.bv_val, se->se_csn.bv_len );
1380 delcsn.bv_len = se->se_csn.bv_len;
1381 delcsn.bv_val[delcsn.bv_len] = '\0';
1386 uuids[j].bv_val = uuids[0].bv_val + (j * UUID_LEN);
1387 AC_MEMCPY(uuids[j].bv_val, se->se_uuid.bv_val, UUID_LEN);
1388 uuids[j].bv_len = UUID_LEN;
1390 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1394 /* Zero out unused slots */
1395 for ( i=ndel; i < num - nmods; i++ )
1396 uuids[i].bv_len = 0;
1398 /* Mods must be validated to see if they belong in this delete set.
1402 /* Strip any duplicates */
1403 for ( i=0; i<nmods; i++ ) {
1404 for ( j=0; j<ndel; j++ ) {
1405 if ( bvmatch( &uuids[j], &uuids[num - 1 - i] )) {
1406 uuids[num - 1 - i].bv_len = 0;
1411 if ( uuids[num - 1 - i].bv_len == 0 ) continue;
1412 for ( j=0; j<i; j++ ) {
1413 if ( bvmatch( &uuids[num - 1 - j], &uuids[num - 1 - i] )) {
1414 uuids[num - 1 - i].bv_len = 0;
1423 SlapReply frs = { REP_RESULT };
1426 #ifdef LDAP_COMP_MATCH
1427 AttributeAssertion eq = { NULL, BER_BVNULL, NULL };
1429 AttributeAssertion eq;
1431 slap_callback cb = {0};
1435 fop.o_sync_mode = 0;
1436 fop.o_callback = &cb;
1437 fop.ors_limit = NULL;
1438 fop.ors_tlimit = SLAP_NO_LIMIT;
1439 fop.ors_attrs = slap_anlist_all_attributes;
1440 fop.ors_attrsonly = 0;
1441 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
1443 af.f_choice = LDAP_FILTER_AND;
1446 mf.f_choice = LDAP_FILTER_EQUALITY;
1448 mf.f_av_desc = slap_schema.si_ad_entryUUID;
1449 mf.f_next = fop.ors_filter;
1451 fop.ors_filter = ⁡
1453 cb.sc_response = playlog_cb;
1454 fop.o_bd->bd_info = on->on_info->oi_orig;
1456 for ( i=ndel; i<num; i++ ) {
1457 if ( uuids[i].bv_len == 0 ) continue;
1459 mf.f_av_value = uuids[i];
1460 cb.sc_private = NULL;
1462 frs.sr_nentries = 0;
1463 rc = fop.o_bd->be_search( &fop, &frs );
1465 /* If entry was not found, add to delete list */
1466 if ( !cb.sc_private ) {
1467 uuids[ndel++] = uuids[i];
1470 fop.o_bd->bd_info = (BackendInfo *)on;
1473 struct berval cookie;
1475 slap_compose_sync_cookie( op, &cookie, &delcsn, srs->sr_state.rid );
1476 uuids[ndel].bv_val = NULL;
1477 syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, &cookie, 0, uuids, 1 );
1478 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1480 op->o_tmpfree( uuids, op->o_tmpmemctx );
1484 syncprov_op_response( Operation *op, SlapReply *rs )
1486 opcookie *opc = op->o_callback->sc_private;
1487 slap_overinst *on = opc->son;
1488 syncprov_info_t *si = on->on_bi.bi_private;
1491 if ( rs->sr_err == LDAP_SUCCESS )
1493 struct berval maxcsn = BER_BVNULL;
1494 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1496 /* Update our context CSN */
1498 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1499 slap_get_commit_csn( op, &maxcsn );
1500 if ( !BER_BVISNULL( &maxcsn ) ) {
1501 strcpy( cbuf, maxcsn.bv_val );
1502 if ( ber_bvcmp( &maxcsn, &si->si_ctxcsn ) > 0 ) {
1503 strcpy( si->si_ctxcsnbuf, cbuf );
1504 si->si_ctxcsn.bv_len = maxcsn.bv_len;
1508 /* Don't do any processing for consumer contextCSN updates */
1509 if ( SLAP_SYNC_SHADOW( op->o_bd ) &&
1510 op->o_msgid == SLAP_SYNC_UPDATE_MSGID ) {
1511 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1512 return SLAP_CB_CONTINUE;
1516 if ( si->si_chkops || si->si_chktime ) {
1518 if ( si->si_chkops && si->si_numops >= si->si_chkops ) {
1522 if ( si->si_chktime &&
1523 (op->o_time - si->si_chklast >= si->si_chktime )) {
1525 si->si_chklast = op->o_time;
1528 syncprov_checkpoint( op, rs, on );
1531 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1533 opc->sctxcsn.bv_len = maxcsn.bv_len;
1534 opc->sctxcsn.bv_val = cbuf;
1536 /* Handle any persistent searches */
1540 case LDAP_REQ_MODIFY:
1541 case LDAP_REQ_MODRDN:
1542 case LDAP_REQ_EXTENDED:
1543 syncprov_matchops( op, opc, 0 );
1545 case LDAP_REQ_DELETE:
1546 /* for each match in opc->smatches:
1549 for ( sm = opc->smatches; sm; sm=sm->sm_next ) {
1550 if ( sm->sm_op->s_op->o_abandon )
1552 syncprov_qresp( opc, sm->sm_op, LDAP_SYNC_DELETE );
1558 /* Add any log records */
1559 if ( si->si_logs && op->o_tag != LDAP_REQ_ADD ) {
1560 syncprov_add_slog( op );
1564 return SLAP_CB_CONTINUE;
1567 /* We don't use a subentry to store the context CSN any more.
1568 * We expose the current context CSN as an operational attribute
1569 * of the suffix entry.
1572 syncprov_op_compare( Operation *op, SlapReply *rs )
1574 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1575 syncprov_info_t *si = on->on_bi.bi_private;
1576 int rc = SLAP_CB_CONTINUE;
1578 if ( dn_match( &op->o_req_ndn, op->o_bd->be_nsuffix ) &&
1579 op->oq_compare.rs_ava->aa_desc == slap_schema.si_ad_contextCSN )
1583 struct berval bv[2];
1585 e.e_name = op->o_bd->be_suffix[0];
1586 e.e_nname = op->o_bd->be_nsuffix[0];
1588 BER_BVZERO( &bv[1] );
1589 bv[0] = si->si_ctxcsn;
1591 a.a_desc = slap_schema.si_ad_contextCSN;
1593 a.a_nvals = a.a_vals;
1595 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1597 rs->sr_err = access_allowed( op, &e, op->oq_compare.rs_ava->aa_desc,
1598 &op->oq_compare.rs_ava->aa_value, ACL_COMPARE, NULL );
1599 if ( ! rs->sr_err ) {
1600 rs->sr_err = LDAP_INSUFFICIENT_ACCESS;
1601 goto return_results;
1604 if ( get_assert( op ) &&
1605 ( test_filter( op, &e, get_assertion( op ) ) != LDAP_COMPARE_TRUE ) )
1607 rs->sr_err = LDAP_ASSERTION_FAILED;
1608 goto return_results;
1612 rs->sr_err = LDAP_COMPARE_FALSE;
1614 if ( value_find_ex( op->oq_compare.rs_ava->aa_desc,
1615 SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH |
1616 SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH,
1617 a.a_nvals, &op->oq_compare.rs_ava->aa_value, op->o_tmpmemctx ) == 0 )
1619 rs->sr_err = LDAP_COMPARE_TRUE;
1624 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1626 send_ldap_result( op, rs );
1628 if( rs->sr_err == LDAP_COMPARE_FALSE || rs->sr_err == LDAP_COMPARE_TRUE ) {
1629 rs->sr_err = LDAP_SUCCESS;
1638 syncprov_op_mod( Operation *op, SlapReply *rs )
1640 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1641 syncprov_info_t *si = on->on_bi.bi_private;
1643 slap_callback *cb = op->o_tmpcalloc(1, sizeof(slap_callback)+
1645 (si->si_ops ? sizeof(modinst) : 0 ),
1647 opcookie *opc = (opcookie *)(cb+1);
1649 cb->sc_response = syncprov_op_response;
1650 cb->sc_cleanup = syncprov_op_cleanup;
1651 cb->sc_private = opc;
1652 cb->sc_next = op->o_callback;
1653 op->o_callback = cb;
1655 /* If there are active persistent searches, lock this operation.
1656 * See seqmod.c for the locking logic on its own.
1659 modtarget *mt, mtdummy;
1662 mi = (modinst *)(opc+1);
1665 /* See if we're already modifying this entry... */
1667 ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1668 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1670 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1671 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1672 mt->mt_tail->mi_next = mi;
1674 /* wait for this op to get to head of list */
1675 while ( mt->mt_mods != mi ) {
1676 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1677 ldap_pvt_thread_yield();
1678 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1680 /* clean up if the caller is giving up */
1681 if ( op->o_abandon ) {
1683 for ( m2 = mt->mt_mods; m2->mi_next != mi;
1685 m2->mi_next = mi->mi_next;
1686 if ( mt->mt_tail == mi ) mt->mt_tail = m2;
1687 op->o_tmpfree( cb, op->o_tmpmemctx );
1688 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1689 return SLAPD_ABANDON;
1692 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1694 /* Record that we're modifying this entry now */
1695 mt = ch_malloc( sizeof(modtarget) );
1698 mt->mt_op = mi->mi_op;
1699 ldap_pvt_thread_mutex_init( &mt->mt_mutex );
1700 avl_insert( &si->si_mods, mt, sp_avl_cmp, avl_dup_error );
1701 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1705 if (( si->si_ops || si->si_logs ) && op->o_tag != LDAP_REQ_ADD )
1706 syncprov_matchops( op, opc, 1 );
1708 return SLAP_CB_CONTINUE;
1712 syncprov_op_extended( Operation *op, SlapReply *rs )
1714 if ( exop_is_write( op ))
1715 return syncprov_op_mod( op, rs );
1717 return SLAP_CB_CONTINUE;
1720 typedef struct searchstate {
1721 slap_overinst *ss_on;
1724 struct berval ss_ctxcsn;
1725 char ss_csnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1729 syncprov_search_cleanup( Operation *op, SlapReply *rs )
1731 if ( rs->sr_ctrls ) {
1732 op->o_tmpfree( rs->sr_ctrls[0], op->o_tmpmemctx );
1733 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
1734 rs->sr_ctrls = NULL;
1740 syncprov_detach_op( Operation *op, syncops *so, slap_overinst *on )
1746 GroupAssertion *g1, *g2;
1748 /* count the search attrs */
1749 for (i=0; op->ors_attrs && !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1750 alen += op->ors_attrs[i].an_name.bv_len + 1;
1752 /* Make a new copy of the operation */
1753 size = sizeof(Operation) + sizeof(Opheader) +
1754 (i ? ( (i+1) * sizeof(AttributeName) + alen) : 0) +
1755 op->o_req_dn.bv_len + 1 +
1756 op->o_req_ndn.bv_len + 1 +
1757 op->o_ndn.bv_len + 1 +
1758 so->s_filterstr.bv_len + 1;
1759 op2 = (Operation *)ch_calloc( 1, size );
1760 op2->o_hdr = (Opheader *)(op2+1);
1762 /* Copy the fields we care about explicitly, leave the rest alone */
1763 *op2->o_hdr = *op->o_hdr;
1764 op2->o_tag = op->o_tag;
1765 op2->o_time = op->o_time;
1766 op2->o_bd = on->on_info->oi_origdb;
1767 op2->o_request = op->o_request;
1768 op2->o_private = on;
1771 op2->ors_attrs = (AttributeName *)(op2->o_hdr + 1);
1772 ptr = (char *)(op2->ors_attrs+i+1);
1773 for (i=0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1774 op2->ors_attrs[i] = op->ors_attrs[i];
1775 op2->ors_attrs[i].an_name.bv_val = ptr;
1776 ptr = lutil_strcopy( ptr, op->ors_attrs[i].an_name.bv_val ) + 1;
1778 BER_BVZERO( &op2->ors_attrs[i].an_name );
1780 ptr = (char *)(op2->o_hdr + 1);
1782 op2->o_authz = op->o_authz;
1783 op2->o_ndn.bv_val = ptr;
1784 ptr = lutil_strcopy(ptr, op->o_ndn.bv_val) + 1;
1785 op2->o_dn = op2->o_ndn;
1786 op2->o_req_dn.bv_len = op->o_req_dn.bv_len;
1787 op2->o_req_dn.bv_val = ptr;
1788 ptr = lutil_strcopy(ptr, op->o_req_dn.bv_val) + 1;
1789 op2->o_req_ndn.bv_len = op->o_req_ndn.bv_len;
1790 op2->o_req_ndn.bv_val = ptr;
1791 ptr = lutil_strcopy(ptr, op->o_req_ndn.bv_val) + 1;
1792 op2->ors_filterstr.bv_val = ptr;
1793 strcpy( ptr, so->s_filterstr.bv_val );
1794 op2->ors_filterstr.bv_len = so->s_filterstr.bv_len;
1795 op2->ors_filter = filter_dup( op->ors_filter, NULL );
1798 /* Copy any cached group ACLs individually */
1799 op2->o_groups = NULL;
1800 for ( g1=op->o_groups; g1; g1=g1->ga_next ) {
1801 g2 = ch_malloc( sizeof(GroupAssertion) + g1->ga_len );
1803 strcpy( g2->ga_ndn, g1->ga_ndn );
1804 g2->ga_next = op2->o_groups;
1807 /* Don't allow any further group caching */
1808 op2->o_do_not_cache = 1;
1810 /* Add op2 to conn so abandon will find us */
1811 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1812 op->o_conn->c_n_ops_executing++;
1813 op->o_conn->c_n_ops_completed--;
1814 LDAP_STAILQ_INSERT_TAIL( &op->o_conn->c_ops, op2, o_next );
1815 so->s_flags |= PS_IS_DETACHED;
1816 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1818 /* Prevent anyone else from trying to send a result for this op */
1823 syncprov_search_response( Operation *op, SlapReply *rs )
1825 searchstate *ss = op->o_callback->sc_private;
1826 slap_overinst *on = ss->ss_on;
1827 sync_control *srs = op->o_controls[slap_cids.sc_LDAPsync];
1829 if ( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF ) {
1831 /* If we got a referral without a referral object, there's
1832 * something missing that we cannot replicate. Just ignore it.
1833 * The consumer will abort because we didn't send the expected
1836 if ( !rs->sr_entry ) {
1837 assert( rs->sr_entry != NULL );
1838 Debug( LDAP_DEBUG_ANY, "bogus referral in context\n",0,0,0 );
1839 return SLAP_CB_CONTINUE;
1841 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryCSN );
1842 if ( a == NULL && rs->sr_operational_attrs != NULL ) {
1843 a = attr_find( rs->sr_operational_attrs, slap_schema.si_ad_entryCSN );
1846 /* Make sure entry is less than the snapshot'd contextCSN */
1847 if ( ber_bvcmp( &a->a_nvals[0], &ss->ss_ctxcsn ) > 0 ) {
1848 Debug( LDAP_DEBUG_SYNC, "Entry %s CSN %s greater than snapshot %s\n",
1849 rs->sr_entry->e_name.bv_val,
1850 a->a_nvals[0].bv_val,
1851 ss->ss_ctxcsn.bv_val );
1852 return LDAP_SUCCESS;
1855 /* Don't send the ctx entry twice */
1856 if ( !BER_BVISNULL( &srs->sr_state.ctxcsn ) &&
1857 bvmatch( &a->a_nvals[0], &srs->sr_state.ctxcsn ) ) {
1858 Debug( LDAP_DEBUG_SYNC, "Entry %s CSN %s matches ctx %s\n",
1859 rs->sr_entry->e_name.bv_val,
1860 a->a_nvals[0].bv_val,
1861 srs->sr_state.ctxcsn.bv_val );
1862 return LDAP_SUCCESS;
1865 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1867 rs->sr_ctrls[1] = NULL;
1868 rs->sr_err = syncprov_state_ctrl( op, rs, rs->sr_entry,
1869 LDAP_SYNC_ADD, rs->sr_ctrls, 0, 0, NULL );
1870 } else if ( rs->sr_type == REP_RESULT && rs->sr_err == LDAP_SUCCESS ) {
1871 struct berval cookie;
1873 slap_compose_sync_cookie( op, &cookie, &ss->ss_ctxcsn,
1874 srs->sr_state.rid );
1876 /* Is this a regular refresh? */
1878 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1880 rs->sr_ctrls[1] = NULL;
1881 rs->sr_err = syncprov_done_ctrl( op, rs, rs->sr_ctrls,
1882 0, 1, &cookie, ss->ss_present ? LDAP_SYNC_REFRESH_PRESENTS :
1883 LDAP_SYNC_REFRESH_DELETES );
1884 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1886 /* It's RefreshAndPersist, transition to Persist phase */
1887 syncprov_sendinfo( op, rs, ss->ss_present ?
1888 LDAP_TAG_SYNC_REFRESH_PRESENT : LDAP_TAG_SYNC_REFRESH_DELETE,
1889 &cookie, 1, NULL, 0 );
1890 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1892 /* Detach this Op from frontend control */
1893 ldap_pvt_thread_mutex_lock( &ss->ss_so->s_mutex );
1895 /* Turn off the refreshing flag */
1896 ss->ss_so->s_flags ^= PS_IS_REFRESHING;
1898 syncprov_detach_op( op, ss->ss_so, on );
1900 /* If there are queued responses, fire them off */
1901 if ( ss->ss_so->s_res )
1902 syncprov_qstart( ss->ss_so );
1903 ldap_pvt_thread_mutex_unlock( &ss->ss_so->s_mutex );
1905 return LDAP_SUCCESS;
1909 return SLAP_CB_CONTINUE;
1913 syncprov_op_search( Operation *op, SlapReply *rs )
1915 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1916 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1918 int gotstate = 0, nochange = 0, do_present;
1919 syncops *sop = NULL;
1922 struct berval ctxcsn;
1923 char csnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1925 if ( !(op->o_sync_mode & SLAP_SYNC_REFRESH) ) return SLAP_CB_CONTINUE;
1927 if ( op->ors_deref & LDAP_DEREF_SEARCHING ) {
1928 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "illegal value for derefAliases" );
1932 do_present = si->si_nopres ? 0 : 1;
1934 srs = op->o_controls[slap_cids.sc_LDAPsync];
1935 op->o_managedsait = SLAP_CONTROL_NONCRITICAL;
1937 /* If this is a persistent search, set it up right away */
1938 if ( op->o_sync_mode & SLAP_SYNC_PERSIST ) {
1948 so.s_flags = PS_IS_REFRESHING | PS_FIND_BASE;
1949 /* syncprov_findbase expects to be called as a callback... */
1950 sc.sc_private = &opc;
1952 ldap_pvt_thread_mutex_init( &so.s_mutex );
1953 cb = op->o_callback;
1954 op->o_callback = ≻
1955 rs->sr_err = syncprov_findbase( op, &fc );
1956 op->o_callback = cb;
1957 ldap_pvt_thread_mutex_destroy( &so.s_mutex );
1959 if ( rs->sr_err != LDAP_SUCCESS ) {
1960 send_ldap_result( op, rs );
1963 sop = ch_malloc( sizeof( syncops ));
1965 ldap_pvt_thread_mutex_init( &sop->s_mutex );
1966 sop->s_rid = srs->sr_state.rid;
1969 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1970 sop->s_next = si->si_ops;
1972 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1975 /* snapshot the ctxcsn */
1976 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1977 strcpy( csnbuf, si->si_ctxcsnbuf );
1978 ctxcsn.bv_len = si->si_ctxcsn.bv_len;
1979 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1980 ctxcsn.bv_val = csnbuf;
1982 /* If we have a cookie, handle the PRESENT lookups */
1983 if ( !BER_BVISNULL( &srs->sr_state.ctxcsn )) {
1986 /* The cookie was validated when it was parsed, just use it */
1988 /* If just Refreshing and nothing has changed, shortcut it */
1989 if ( bvmatch( &srs->sr_state.ctxcsn, &ctxcsn )) {
1991 if ( !(op->o_sync_mode & SLAP_SYNC_PERSIST) ) {
1992 LDAPControl *ctrls[2];
1996 syncprov_done_ctrl( op, rs, ctrls, 0, 0,
1997 NULL, LDAP_SYNC_REFRESH_DELETES );
1998 rs->sr_ctrls = ctrls;
1999 rs->sr_err = LDAP_SUCCESS;
2000 send_ldap_result( op, rs );
2001 rs->sr_ctrls = NULL;
2006 /* Do we have a sessionlog for this search? */
2009 ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
2010 /* Are there any log entries, and is the consumer state
2011 * present in the session log?
2013 if ( sl->sl_num > 0 && ber_bvcmp( &srs->sr_state.ctxcsn, &sl->sl_mincsn ) >= 0 ) {
2015 /* mutex is unlocked in playlog */
2016 syncprov_playlog( op, rs, sl, srs, &ctxcsn );
2018 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
2021 /* Is the CSN still present in the database? */
2022 if ( syncprov_findcsn( op, FIND_CSN ) != LDAP_SUCCESS ) {
2023 /* No, so a reload is required */
2024 /* the 2.2 consumer doesn't send this hint */
2025 if ( si->si_usehint && srs->sr_rhint == 0 ) {
2026 send_ldap_error( op, rs, LDAP_SYNC_REFRESH_REQUIRED, "sync cookie is stale" );
2031 /* If changed and doing Present lookup, send Present UUIDs */
2032 if ( do_present && syncprov_findcsn( op, FIND_PRESENT ) !=
2034 send_ldap_result( op, rs );
2041 /* Append CSN range to search filter, save original filter
2042 * for persistent search evaluation
2045 sop->s_filterstr= op->ors_filterstr;
2048 /* If something changed, find the changes */
2049 if ( gotstate && !nochange ) {
2050 Filter *fand, *fava;
2052 fand = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2053 fand->f_choice = LDAP_FILTER_AND;
2054 fand->f_next = NULL;
2055 fava = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2057 fava->f_choice = LDAP_FILTER_GE;
2058 fava->f_ava = op->o_tmpalloc( sizeof(AttributeAssertion), op->o_tmpmemctx );
2059 fava->f_ava->aa_desc = slap_schema.si_ad_entryCSN;
2060 #ifdef LDAP_COMP_MATCH
2061 fava->f_ava->aa_cf = NULL;
2063 ber_dupbv_x( &fava->f_ava->aa_value, &srs->sr_state.ctxcsn, op->o_tmpmemctx );
2064 fava->f_next = op->ors_filter;
2065 op->ors_filter = fand;
2066 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
2069 /* Let our callback add needed info to returned entries */
2070 cb = op->o_tmpcalloc(1, sizeof(slap_callback)+sizeof(searchstate), op->o_tmpmemctx);
2071 ss = (searchstate *)(cb+1);
2074 ss->ss_present = do_present;
2075 ss->ss_ctxcsn.bv_len = ctxcsn.bv_len;
2076 ss->ss_ctxcsn.bv_val = ss->ss_csnbuf;
2077 strcpy( ss->ss_ctxcsn.bv_val, ctxcsn.bv_val );
2078 cb->sc_response = syncprov_search_response;
2079 cb->sc_cleanup = syncprov_search_cleanup;
2080 cb->sc_private = ss;
2081 cb->sc_next = op->o_callback;
2082 op->o_callback = cb;
2084 #if 0 /* I don't think we need to shortcircuit back-bdb any more */
2085 op->o_sync_mode &= SLAP_CONTROL_MASK;
2088 /* If this is a persistent search and no changes were reported during
2089 * the refresh phase, just invoke the response callback to transition
2090 * us into persist phase
2093 rs->sr_err = LDAP_SUCCESS;
2094 rs->sr_nentries = 0;
2095 send_ldap_result( op, rs );
2098 return SLAP_CB_CONTINUE;
2102 syncprov_operational(
2106 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2107 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2109 if ( rs->sr_entry &&
2110 dn_match( &rs->sr_entry->e_nname, op->o_bd->be_nsuffix )) {
2112 if ( SLAP_OPATTRS( rs->sr_attr_flags ) ||
2113 ad_inlist( slap_schema.si_ad_contextCSN, rs->sr_attrs )) {
2114 Attribute *a, **ap = NULL;
2116 for ( a=rs->sr_entry->e_attrs; a; a=a->a_next ) {
2117 if ( a->a_desc == slap_schema.si_ad_contextCSN )
2122 for ( ap = &rs->sr_operational_attrs; *ap; ap=&(*ap)->a_next );
2124 a = ch_malloc( sizeof(Attribute));
2125 a->a_desc = slap_schema.si_ad_contextCSN;
2126 a->a_vals = ch_malloc( 2 * sizeof(struct berval));
2127 a->a_vals[1].bv_val = NULL;
2128 a->a_nvals = a->a_vals;
2134 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
2136 strcpy( a->a_vals[0].bv_val, si->si_ctxcsnbuf );
2138 ber_dupbv( &a->a_vals[0], &si->si_ctxcsn );
2140 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
2143 return SLAP_CB_CONTINUE;
2153 static ConfigDriver sp_cf_gen;
2155 static ConfigTable spcfg[] = {
2156 { "syncprov-checkpoint", "ops> <minutes", 3, 3, 0, ARG_MAGIC|SP_CHKPT,
2157 sp_cf_gen, "( OLcfgOvAt:1.1 NAME 'olcSpCheckpoint' "
2158 "DESC 'ContextCSN checkpoint interval in ops and minutes' "
2159 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2160 { "syncprov-sessionlog", "ops", 2, 2, 0, ARG_INT|ARG_MAGIC|SP_SESSL,
2161 sp_cf_gen, "( OLcfgOvAt:1.2 NAME 'olcSpSessionlog' "
2162 "DESC 'Session log size in ops' "
2163 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
2164 { "syncprov-nopresent", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_NOPRES,
2165 sp_cf_gen, "( OLcfgOvAt:1.3 NAME 'olcSpNoPresent' "
2166 "DESC 'Omit Present phase processing' "
2167 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2168 { "syncprov-reloadhint", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_USEHINT,
2169 sp_cf_gen, "( OLcfgOvAt:1.4 NAME 'olcSpReloadHint' "
2170 "DESC 'Observe Reload Hint in Request control' "
2171 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2172 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2175 static ConfigOCs spocs[] = {
2176 { "( OLcfgOvOc:1.1 "
2177 "NAME 'olcSyncProvConfig' "
2178 "DESC 'SyncRepl Provider configuration' "
2179 "SUP olcOverlayConfig "
2180 "MAY ( olcSpCheckpoint $ olcSpSessionlog $ olcSpNoPresent ) )",
2181 Cft_Overlay, spcfg },
2186 sp_cf_gen(ConfigArgs *c)
2188 slap_overinst *on = (slap_overinst *)c->bi;
2189 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2192 if ( c->op == SLAP_CONFIG_EMIT ) {
2193 switch ( c->type ) {
2195 if ( si->si_chkops || si->si_chktime ) {
2197 bv.bv_len = sprintf( c->msg, "%d %d",
2198 si->si_chkops, si->si_chktime );
2200 value_add_one( &c->rvalue_vals, &bv );
2206 if ( si->si_logs ) {
2207 c->value_int = si->si_logs->sl_size;
2213 if ( si->si_nopres ) {
2220 if ( si->si_usehint ) {
2228 } else if ( c->op == LDAP_MOD_DELETE ) {
2229 switch ( c->type ) {
2236 si->si_logs->sl_size = 0;
2238 rc = LDAP_NO_SUCH_ATTRIBUTE;
2241 if ( si->si_nopres )
2244 rc = LDAP_NO_SUCH_ATTRIBUTE;
2247 if ( si->si_usehint )
2250 rc = LDAP_NO_SUCH_ATTRIBUTE;
2255 switch ( c->type ) {
2257 if ( lutil_atoi( &si->si_chkops, c->argv[1] ) != 0 ) {
2258 sprintf( c->msg, "%s unable to parse checkpoint ops # \"%s\"",
2259 c->argv[0], c->argv[1] );
2260 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
2261 return ARG_BAD_CONF;
2263 if ( si->si_chkops <= 0 ) {
2264 sprintf( c->msg, "%s invalid checkpoint ops # \"%d\"",
2265 c->argv[0], si->si_chkops );
2266 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
2267 return ARG_BAD_CONF;
2269 if ( lutil_atoi( &si->si_chktime, c->argv[2] ) != 0 ) {
2270 sprintf( c->msg, "%s unable to parse checkpoint time \"%s\"",
2271 c->argv[0], c->argv[1] );
2272 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
2273 return ARG_BAD_CONF;
2275 if ( si->si_chktime <= 0 ) {
2276 sprintf( c->msg, "%s invalid checkpoint time \"%d\"",
2277 c->argv[0], si->si_chkops );
2278 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
2279 return ARG_BAD_CONF;
2281 si->si_chktime *= 60;
2285 int size = c->value_int;
2288 sprintf( c->msg, "%s size %d is negative",
2290 Debug( LDAP_DEBUG_CONFIG, "%s: %s\n", c->log, c->msg, 0 );
2291 return ARG_BAD_CONF;
2295 sl = ch_malloc( sizeof( sessionlog ) + LDAP_LUTIL_CSNSTR_BUFSIZE );
2296 sl->sl_mincsn.bv_val = (char *)(sl+1);
2297 sl->sl_mincsn.bv_len = 0;
2299 sl->sl_head = sl->sl_tail = NULL;
2300 ldap_pvt_thread_mutex_init( &sl->sl_mutex );
2307 si->si_nopres = c->value_int;
2310 si->si_usehint = c->value_int;
2316 /* ITS#3456 we cannot run this search on the main thread, must use a
2317 * child thread in order to insure we have a big enough stack.
2324 syncprov_findcsn( ptr, FIND_MAXCSN );
2328 /* Read any existing contextCSN from the underlying db.
2329 * Then search for any entries newer than that. If no value exists,
2330 * just generate it. Cache whatever result.
2337 slap_overinst *on = (slap_overinst *) be->bd_info;
2338 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2340 Connection conn = { 0 };
2341 OperationBuffer opbuf = { 0 };
2342 char ctxcsnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
2343 Operation *op = (Operation *) &opbuf;
2347 void *thrctx = NULL;
2349 if ( !SLAP_LASTMOD( be )) {
2350 Debug( LDAP_DEBUG_ANY,
2351 "syncprov_db_open: invalid config, lastmod must be enabled\n", 0, 0, 0 );
2355 if ( slapMode & SLAP_TOOL_MODE ) {
2359 rc = overlay_register_control( be, LDAP_CONTROL_SYNC );
2364 thrctx = ldap_pvt_thread_pool_context();
2365 connection_fake_init( &conn, op, thrctx );
2367 op->o_dn = be->be_rootdn;
2368 op->o_ndn = be->be_rootndn;
2370 ctxcsnbuf[0] = '\0';
2372 op->o_bd->bd_info = on->on_info->oi_orig;
2373 rc = be_entry_get_rw( op, be->be_nsuffix, NULL,
2374 slap_schema.si_ad_contextCSN, 0, &e );
2377 ldap_pvt_thread_t tid;
2379 a = attr_find( e->e_attrs, slap_schema.si_ad_contextCSN );
2381 si->si_ctxcsn.bv_len = a->a_nvals[0].bv_len;
2382 if ( si->si_ctxcsn.bv_len >= sizeof(si->si_ctxcsnbuf ))
2383 si->si_ctxcsn.bv_len = sizeof(si->si_ctxcsnbuf)-1;
2384 strncpy( si->si_ctxcsnbuf, a->a_nvals[0].bv_val,
2385 si->si_ctxcsn.bv_len );
2386 si->si_ctxcsnbuf[si->si_ctxcsn.bv_len] = '\0';
2387 strcpy( ctxcsnbuf, si->si_ctxcsnbuf );
2389 be_entry_release_rw( op, e, 0 );
2390 if ( !BER_BVISEMPTY( &si->si_ctxcsn ) ) {
2391 op->o_bd->bd_info = (BackendInfo *)on;
2392 op->o_req_dn = be->be_suffix[0];
2393 op->o_req_ndn = be->be_nsuffix[0];
2394 op->ors_scope = LDAP_SCOPE_SUBTREE;
2395 ldap_pvt_thread_create( &tid, 0, syncprov_db_otask, op );
2396 ldap_pvt_thread_join( tid, NULL );
2400 if ( BER_BVISEMPTY( &si->si_ctxcsn ) ) {
2401 if ( SLAP_SYNC_SHADOW( op->o_bd )) {
2402 /* If we're also a consumer, and we didn't get a contextCSN,
2403 * then don't generate anything, wait for our provider to send it
2408 si->si_ctxcsn.bv_len = sizeof( si->si_ctxcsnbuf );
2409 slap_get_csn( op, &si->si_ctxcsn, 0 );
2412 /* If our ctxcsn is different from what was read from the root
2413 * entry, make sure we do a checkpoint on close
2415 if ( strcmp( si->si_ctxcsnbuf, ctxcsnbuf )) {
2420 op->o_bd->bd_info = (BackendInfo *)on;
2421 ldap_pvt_thread_pool_context_reset( thrctx );
2425 /* Write the current contextCSN into the underlying db.
2432 slap_overinst *on = (slap_overinst *) be->bd_info;
2433 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2435 if ( slapMode & SLAP_TOOL_MODE ) {
2438 if ( si->si_numops ) {
2440 OperationBuffer opbuf;
2441 Operation *op = (Operation *) &opbuf;
2442 SlapReply rs = {REP_RESULT};
2445 thrctx = ldap_pvt_thread_pool_context();
2446 connection_fake_init( &conn, op, thrctx );
2448 op->o_dn = be->be_rootdn;
2449 op->o_ndn = be->be_rootndn;
2450 syncprov_checkpoint( op, &rs, on );
2451 ldap_pvt_thread_pool_context_reset( thrctx );
2462 slap_overinst *on = (slap_overinst *)be->bd_info;
2463 syncprov_info_t *si;
2465 si = ch_calloc(1, sizeof(syncprov_info_t));
2466 on->on_bi.bi_private = si;
2467 ldap_pvt_thread_mutex_init( &si->si_csn_mutex );
2468 ldap_pvt_thread_mutex_init( &si->si_ops_mutex );
2469 ldap_pvt_thread_mutex_init( &si->si_mods_mutex );
2470 si->si_ctxcsn.bv_val = si->si_ctxcsnbuf;
2472 csn_anlist[0].an_desc = slap_schema.si_ad_entryCSN;
2473 csn_anlist[0].an_name = slap_schema.si_ad_entryCSN->ad_cname;
2474 csn_anlist[1].an_desc = slap_schema.si_ad_entryUUID;
2475 csn_anlist[1].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2477 uuid_anlist[0].an_desc = slap_schema.si_ad_entryUUID;
2478 uuid_anlist[0].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2484 syncprov_db_destroy(
2488 slap_overinst *on = (slap_overinst *)be->bd_info;
2489 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2492 if ( si->si_logs ) {
2493 slog_entry *se = si->si_logs->sl_head;
2496 slog_entry *se_next = se->se_next;
2501 ch_free( si->si_logs );
2503 ldap_pvt_thread_mutex_destroy( &si->si_mods_mutex );
2504 ldap_pvt_thread_mutex_destroy( &si->si_ops_mutex );
2505 ldap_pvt_thread_mutex_destroy( &si->si_csn_mutex );
2512 static int syncprov_parseCtrl (
2518 BerElementBuffer berbuf;
2519 BerElement *ber = (BerElement *)&berbuf;
2522 struct berval cookie = BER_BVNULL;
2526 if ( op->o_sync != SLAP_CONTROL_NONE ) {
2527 rs->sr_text = "Sync control specified multiple times";
2528 return LDAP_PROTOCOL_ERROR;
2531 if ( op->o_pagedresults != SLAP_CONTROL_NONE ) {
2532 rs->sr_text = "Sync control specified with pagedResults control";
2533 return LDAP_PROTOCOL_ERROR;
2536 if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
2537 rs->sr_text = "Sync control value is empty (or absent)";
2538 return LDAP_PROTOCOL_ERROR;
2541 /* Parse the control value
2542 * syncRequestValue ::= SEQUENCE {
2547 * refreshAndPersist (3)
2549 * cookie syncCookie OPTIONAL
2553 ber_init2( ber, &ctrl->ldctl_value, 0 );
2555 if ( (tag = ber_scanf( ber, "{i" /*}*/, &mode )) == LBER_ERROR ) {
2556 rs->sr_text = "Sync control : mode decoding error";
2557 return LDAP_PROTOCOL_ERROR;
2561 case LDAP_SYNC_REFRESH_ONLY:
2562 mode = SLAP_SYNC_REFRESH;
2564 case LDAP_SYNC_REFRESH_AND_PERSIST:
2565 mode = SLAP_SYNC_REFRESH_AND_PERSIST;
2568 rs->sr_text = "Sync control : unknown update mode";
2569 return LDAP_PROTOCOL_ERROR;
2572 tag = ber_peek_tag( ber, &len );
2574 if ( tag == LDAP_TAG_SYNC_COOKIE ) {
2575 if (( ber_scanf( ber, /*{*/ "m", &cookie )) == LBER_ERROR ) {
2576 rs->sr_text = "Sync control : cookie decoding error";
2577 return LDAP_PROTOCOL_ERROR;
2579 tag = ber_peek_tag( ber, &len );
2581 if ( tag == LDAP_TAG_RELOAD_HINT ) {
2582 if (( ber_scanf( ber, /*{*/ "b", &rhint )) == LBER_ERROR ) {
2583 rs->sr_text = "Sync control : rhint decoding error";
2584 return LDAP_PROTOCOL_ERROR;
2587 if (( ber_scanf( ber, /*{*/ "}")) == LBER_ERROR ) {
2588 rs->sr_text = "Sync control : decoding error";
2589 return LDAP_PROTOCOL_ERROR;
2591 sr = op->o_tmpcalloc( 1, sizeof(struct sync_control), op->o_tmpmemctx );
2592 sr->sr_rhint = rhint;
2593 if (!BER_BVISNULL(&cookie)) {
2594 ber_dupbv_x( &sr->sr_state.octet_str, &cookie, op->o_tmpmemctx );
2595 slap_parse_sync_cookie( &sr->sr_state, op->o_tmpmemctx );
2596 if ( sr->sr_state.rid == -1 ) {
2597 rs->sr_text = "Sync control : cookie parsing error";
2598 return LDAP_PROTOCOL_ERROR;
2602 op->o_controls[slap_cids.sc_LDAPsync] = sr;
2604 op->o_sync = ctrl->ldctl_iscritical
2605 ? SLAP_CONTROL_CRITICAL
2606 : SLAP_CONTROL_NONCRITICAL;
2608 op->o_sync_mode |= mode; /* o_sync_mode shares o_sync */
2610 return LDAP_SUCCESS;
2613 /* This overlay is set up for dynamic loading via moduleload. For static
2614 * configuration, you'll need to arrange for the slap_overinst to be
2615 * initialized and registered by some other function inside slapd.
2618 static slap_overinst syncprov;
2621 syncprov_initialize()
2625 rc = register_supported_control( LDAP_CONTROL_SYNC,
2626 SLAP_CTRL_SEARCH, NULL,
2627 syncprov_parseCtrl, &slap_cids.sc_LDAPsync );
2628 if ( rc != LDAP_SUCCESS ) {
2629 Debug( LDAP_DEBUG_ANY,
2630 "syncprov_init: Failed to register control %d\n", rc, 0, 0 );
2634 syncprov.on_bi.bi_type = "syncprov";
2635 syncprov.on_bi.bi_db_init = syncprov_db_init;
2636 syncprov.on_bi.bi_db_destroy = syncprov_db_destroy;
2637 syncprov.on_bi.bi_db_open = syncprov_db_open;
2638 syncprov.on_bi.bi_db_close = syncprov_db_close;
2640 syncprov.on_bi.bi_op_abandon = syncprov_op_abandon;
2641 syncprov.on_bi.bi_op_cancel = syncprov_op_abandon;
2643 syncprov.on_bi.bi_op_add = syncprov_op_mod;
2644 syncprov.on_bi.bi_op_compare = syncprov_op_compare;
2645 syncprov.on_bi.bi_op_delete = syncprov_op_mod;
2646 syncprov.on_bi.bi_op_modify = syncprov_op_mod;
2647 syncprov.on_bi.bi_op_modrdn = syncprov_op_mod;
2648 syncprov.on_bi.bi_op_search = syncprov_op_search;
2649 syncprov.on_bi.bi_extended = syncprov_op_extended;
2650 syncprov.on_bi.bi_operational = syncprov_operational;
2652 syncprov.on_bi.bi_cf_ocs = spocs;
2654 generic_filter.f_desc = slap_schema.si_ad_objectClass;
2656 rc = config_register_schema( spcfg, spocs );
2657 if ( rc ) return rc;
2659 return overlay_register( &syncprov );
2662 #if SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC
2664 init_module( int argc, char *argv[] )
2666 return syncprov_initialize();
2668 #endif /* SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC */
2670 #endif /* defined(SLAPD_OVER_SYNCPROV) */