2 /* syncprov.c - syncrepl provider */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2004-2007 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 */
63 struct berval s_filterstr;
64 int s_flags; /* search status */
65 #define PS_IS_REFRESHING 0x01
66 #define PS_IS_DETACHED 0x02
67 #define PS_WROTE_BASE 0x04
68 #define PS_FIND_BASE 0x08
69 #define PS_FIX_FILTER 0x10
71 int s_inuse; /* reference count */
72 struct syncres *s_res;
73 struct syncres *s_restail;
74 struct re_s *s_qtask; /* task for playing psearch responses */
75 #define RUNQ_INTERVAL 36000 /* a long time */
76 ldap_pvt_thread_mutex_t s_mutex;
79 /* A received sync control */
80 typedef struct sync_control {
81 struct sync_cookie sr_state;
85 #if 0 /* moved back to slap.h */
86 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
88 /* o_sync_mode uses data bits of o_sync */
89 #define o_sync_mode o_ctrlflag[slap_cids.sc_LDAPsync]
91 #define SLAP_SYNC_NONE (LDAP_SYNC_NONE<<SLAP_CONTROL_SHIFT)
92 #define SLAP_SYNC_REFRESH (LDAP_SYNC_REFRESH_ONLY<<SLAP_CONTROL_SHIFT)
93 #define SLAP_SYNC_PERSIST (LDAP_SYNC_RESERVED<<SLAP_CONTROL_SHIFT)
94 #define SLAP_SYNC_REFRESH_AND_PERSIST (LDAP_SYNC_REFRESH_AND_PERSIST<<SLAP_CONTROL_SHIFT)
96 /* Record of which searches matched at premodify step */
97 typedef struct syncmatches {
98 struct syncmatches *sm_next;
102 /* Session log data */
103 typedef struct slog_entry {
104 struct slog_entry *se_next;
105 struct berval se_uuid;
106 struct berval se_csn;
111 typedef struct sessionlog {
112 struct berval sl_mincsn;
117 ldap_pvt_thread_mutex_t sl_mutex;
120 /* The main state for this overlay */
121 typedef struct syncprov_info_t {
123 BerVarray si_ctxcsn; /* ldapsync context */
126 int si_chkops; /* checkpointing info */
128 int si_numops; /* number of ops since last checkpoint */
129 int si_nopres; /* Skip present phase */
130 int si_usehint; /* use reload hint */
131 time_t si_chklast; /* time of last checkpoint */
132 Avlnode *si_mods; /* entries being modified */
134 ldap_pvt_thread_rdwr_t si_csn_rwlock;
135 ldap_pvt_thread_mutex_t si_ops_mutex;
136 ldap_pvt_thread_mutex_t si_mods_mutex;
139 typedef struct opcookie {
141 syncmatches *smatches;
142 struct berval sdn; /* DN of entry, for deletes */
144 struct berval suuid; /* UUID of entry */
145 struct berval sctxcsn;
146 int sreference; /* Is the entry a reference? */
149 typedef struct fbase_cookie {
150 struct berval *fdn; /* DN of a modified entry, for scope testing */
151 syncops *fss; /* persistent search we're testing against */
152 int fbase; /* if TRUE we found the search base and it's still valid */
153 int fscope; /* if TRUE then fdn is within the psearch scope */
156 static AttributeName csn_anlist[3];
157 static AttributeName uuid_anlist[2];
159 /* Build a LDAPsync intermediate state control */
165 int entry_sync_state,
169 struct berval *cookie )
174 BerElementBuffer berbuf;
175 BerElement *ber = (BerElement *)&berbuf;
177 struct berval entryuuid_bv = BER_BVNULL;
179 ber_init2( ber, 0, LBER_USE_DER );
180 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
182 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
184 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
185 AttributeDescription *desc = a->a_desc;
186 if ( desc == slap_schema.si_ad_entryUUID ) {
187 entryuuid_bv = a->a_nvals[0];
192 /* FIXME: what if entryuuid is NULL or empty ? */
194 if ( send_cookie && cookie ) {
195 ber_printf( ber, "{eOON}",
196 entry_sync_state, &entryuuid_bv, cookie );
198 ber_printf( ber, "{eON}",
199 entry_sync_state, &entryuuid_bv );
202 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_STATE;
203 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
204 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
209 Debug( LDAP_DEBUG_TRACE,
210 "slap_build_sync_ctrl: ber_flatten2 failed\n",
212 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
219 /* Build a LDAPsync final state control */
227 struct berval *cookie,
231 BerElementBuffer berbuf;
232 BerElement *ber = (BerElement *)&berbuf;
234 ber_init2( ber, NULL, LBER_USE_DER );
235 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
237 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
239 ber_printf( ber, "{" );
240 if ( send_cookie && cookie ) {
241 ber_printf( ber, "O", cookie );
243 if ( refreshDeletes == LDAP_SYNC_REFRESH_DELETES ) {
244 ber_printf( ber, "b", refreshDeletes );
246 ber_printf( ber, "N}" );
248 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_DONE;
249 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
250 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
255 Debug( LDAP_DEBUG_TRACE,
256 "syncprov_done_ctrl: ber_flatten2 failed\n",
258 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
270 struct berval *cookie,
275 BerElementBuffer berbuf;
276 BerElement *ber = (BerElement *)&berbuf;
277 struct berval rspdata;
281 ber_init2( ber, NULL, LBER_USE_DER );
282 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
286 case LDAP_TAG_SYNC_NEW_COOKIE:
287 ber_printf( ber, "tO", type, cookie );
289 case LDAP_TAG_SYNC_REFRESH_DELETE:
290 case LDAP_TAG_SYNC_REFRESH_PRESENT:
291 ber_printf( ber, "t{", type );
293 ber_printf( ber, "O", cookie );
295 if ( refreshDone == 0 ) {
296 ber_printf( ber, "b", refreshDone );
298 ber_printf( ber, "N}" );
300 case LDAP_TAG_SYNC_ID_SET:
301 ber_printf( ber, "t{", type );
303 ber_printf( ber, "O", cookie );
305 if ( refreshDeletes == 1 ) {
306 ber_printf( ber, "b", refreshDeletes );
308 ber_printf( ber, "[W]", syncUUIDs );
309 ber_printf( ber, "N}" );
312 Debug( LDAP_DEBUG_TRACE,
313 "syncprov_sendinfo: invalid syncinfo type (%d)\n",
319 ret = ber_flatten2( ber, &rspdata, 0 );
322 Debug( LDAP_DEBUG_TRACE,
323 "syncprov_sendinfo: ber_flatten2 failed\n",
325 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
329 rs->sr_rspoid = LDAP_SYNC_INFO;
330 rs->sr_rspdata = &rspdata;
331 send_ldap_intermediate( op, rs );
332 rs->sr_rspdata = NULL;
338 /* Find a modtarget in an AVL tree */
340 sp_avl_cmp( const void *c1, const void *c2 )
342 const modtarget *m1, *m2;
346 rc = m1->mt_op->o_req_ndn.bv_len - m2->mt_op->o_req_ndn.bv_len;
349 return ber_bvcmp( &m1->mt_op->o_req_ndn, &m2->mt_op->o_req_ndn );
352 /* syncprov_findbase:
353 * finds the true DN of the base of a search (with alias dereferencing) and
354 * checks to make sure the base entry doesn't get replaced with a different
355 * entry (e.g., swapping trees via ModDN, or retargeting an alias). If a
356 * change is detected, any persistent search on this base must be terminated /
358 * On the first call, we just save the DN and entryID. On subsequent calls
359 * we compare the DN and entryID with the saved values.
362 findbase_cb( Operation *op, SlapReply *rs )
364 slap_callback *sc = op->o_callback;
366 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
367 fbase_cookie *fc = sc->sc_private;
369 /* If no entryID, we're looking for the first time.
370 * Just store whatever we got.
372 if ( fc->fss->s_eid == NOID ) {
374 fc->fss->s_eid = rs->sr_entry->e_id;
375 ber_dupbv( &fc->fss->s_base, &rs->sr_entry->e_nname );
377 } else if ( rs->sr_entry->e_id == fc->fss->s_eid &&
378 dn_match( &rs->sr_entry->e_nname, &fc->fss->s_base )) {
380 /* OK, the DN is the same and the entryID is the same. */
384 if ( rs->sr_err != LDAP_SUCCESS ) {
385 Debug( LDAP_DEBUG_ANY, "findbase failed! %d\n", rs->sr_err,0,0 );
390 static Filter generic_filter = { LDAP_FILTER_PRESENT, { 0 }, NULL };
391 static struct berval generic_filterstr = BER_BVC("(objectclass=*)");
394 syncprov_findbase( Operation *op, fbase_cookie *fc )
396 opcookie *opc = op->o_callback->sc_private;
397 slap_overinst *on = opc->son;
399 /* Use basic parameters from syncrepl search, but use
400 * current op's threadctx / tmpmemctx
402 ldap_pvt_thread_mutex_lock( &fc->fss->s_mutex );
403 if ( fc->fss->s_flags & PS_FIND_BASE ) {
404 slap_callback cb = {0};
406 SlapReply frs = { REP_RESULT };
410 fc->fss->s_flags ^= PS_FIND_BASE;
411 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
413 fop = *fc->fss->s_op;
415 fop.o_hdr = op->o_hdr;
417 fop.o_time = op->o_time;
418 fop.o_tincr = op->o_tincr;
419 bi = op->o_bd->bd_info;
421 cb.sc_response = findbase_cb;
424 fop.o_sync_mode = 0; /* turn off sync mode */
425 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
426 fop.o_callback = &cb;
427 fop.o_tag = LDAP_REQ_SEARCH;
428 fop.ors_scope = LDAP_SCOPE_BASE;
429 fop.ors_limit = NULL;
431 fop.ors_tlimit = SLAP_NO_LIMIT;
432 fop.ors_attrs = slap_anlist_no_attrs;
433 fop.ors_attrsonly = 1;
434 fop.ors_filter = &generic_filter;
435 fop.ors_filterstr = generic_filterstr;
437 rc = overlay_op_walk( &fop, &frs, op_search, on->on_info, on );
438 op->o_bd->bd_info = bi;
440 ldap_pvt_thread_mutex_unlock( &fc->fss->s_mutex );
444 /* After the first call, see if the fdn resides in the scope */
445 if ( fc->fbase == 1 ) {
446 switch ( fc->fss->s_op->ors_scope ) {
447 case LDAP_SCOPE_BASE:
448 fc->fscope = dn_match( fc->fdn, &fc->fss->s_base );
450 case LDAP_SCOPE_ONELEVEL: {
452 dnParent( fc->fdn, &pdn );
453 fc->fscope = dn_match( &pdn, &fc->fss->s_base );
455 case LDAP_SCOPE_SUBTREE:
456 fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base );
458 case LDAP_SCOPE_SUBORDINATE:
459 fc->fscope = dnIsSuffix( fc->fdn, &fc->fss->s_base ) &&
460 !dn_match( fc->fdn, &fc->fss->s_base );
468 /* If entryID has changed, then the base of this search has
469 * changed. Invalidate the psearch.
471 return LDAP_NO_SUCH_OBJECT;
475 * This function has three different purposes, but they all use a search
476 * that filters on entryCSN so they're combined here.
477 * 1: at startup time, after a contextCSN has been read from the database,
478 * we search for all entries with CSN >= contextCSN in case the contextCSN
479 * was not checkpointed at the previous shutdown.
481 * 2: when the current contextCSN is known and we have a sync cookie, we search
482 * for one entry with CSN = the cookie CSN. If not found, try <= cookie CSN.
483 * If an entry is found, the cookie CSN is valid, otherwise it is stale.
485 * 3: during a refresh phase, we search for all entries with CSN <= the cookie
486 * CSN, and generate Present records for them. We always collect this result
487 * in SyncID sets, even if there's only one match.
489 typedef enum find_csn_t {
496 findmax_cb( Operation *op, SlapReply *rs )
498 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
499 struct berval *maxcsn = op->o_callback->sc_private;
500 Attribute *a = attr_find( rs->sr_entry->e_attrs,
501 slap_schema.si_ad_entryCSN );
503 if ( a && ber_bvcmp( &a->a_vals[0], maxcsn ) > 0 ) {
504 maxcsn->bv_len = a->a_vals[0].bv_len;
505 strcpy( maxcsn->bv_val, a->a_vals[0].bv_val );
512 findcsn_cb( Operation *op, SlapReply *rs )
514 slap_callback *sc = op->o_callback;
516 /* We just want to know that at least one exists, so it's OK if
517 * we exceed the unchecked limit.
519 if ( rs->sr_err == LDAP_ADMINLIMIT_EXCEEDED ||
520 (rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS )) {
521 sc->sc_private = (void *)1;
526 /* Build a list of entryUUIDs for sending in a SyncID set */
530 typedef struct fpres_cookie {
537 findpres_cb( Operation *op, SlapReply *rs )
539 slap_callback *sc = op->o_callback;
540 fpres_cookie *pc = sc->sc_private;
542 int ret = SLAP_CB_CONTINUE;
544 switch ( rs->sr_type ) {
546 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryUUID );
548 pc->uuids[pc->num].bv_val = pc->last;
549 AC_MEMCPY( pc->uuids[pc->num].bv_val, a->a_nvals[0].bv_val,
550 pc->uuids[pc->num].bv_len );
552 pc->last = pc->uuids[pc->num].bv_val;
553 pc->uuids[pc->num].bv_val = NULL;
556 if ( pc->num != SLAP_SYNCUUID_SET_SIZE )
562 ret = syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, NULL,
564 pc->uuids[pc->num].bv_val = pc->last;
566 pc->last = pc->uuids[0].bv_val;
576 syncprov_findcsn( Operation *op, find_csn_t mode )
578 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
579 syncprov_info_t *si = on->on_bi.bi_private;
581 slap_callback cb = {0};
583 SlapReply frs = { REP_RESULT };
584 char buf[LDAP_LUTIL_CSNSTR_BUFSIZE + STRLENOF("(entryCSN<=)")];
585 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
586 struct berval maxcsn;
588 AttributeAssertion eq = ATTRIBUTEASSERTION_INIT;
589 fpres_cookie pcookie;
590 sync_control *srs = NULL;
591 struct slap_limits_set fc_limits;
592 int i, rc = LDAP_SUCCESS, findcsn_retry = 1;
595 if ( mode != FIND_MAXCSN ) {
596 srs = op->o_controls[slap_cids.sc_LDAPsync];
600 fop.o_sync_mode &= SLAP_CONTROL_MASK; /* turn off sync_mode */
601 /* We want pure entries, not referrals */
602 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
605 cf.f_av_desc = slap_schema.si_ad_entryCSN;
606 BER_BVZERO( &cf.f_av_value );
609 fop.o_callback = &cb;
610 fop.ors_limit = NULL;
611 fop.ors_tlimit = SLAP_NO_LIMIT;
612 fop.ors_filter = &cf;
613 fop.ors_filterstr.bv_val = buf;
618 cf.f_choice = LDAP_FILTER_GE;
619 cf.f_av_value = si->si_ctxcsn[0];
620 /* If there are multiple CSNs, use the largest */
621 for ( i=1; i<si->si_numcsns; i++) {
622 if ( ber_bvcmp( &cf.f_av_value, &si->si_ctxcsn[i] ) < 0 ) {
623 cf.f_av_value = si->si_ctxcsn[i];
627 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN>=%s)",
628 cf.f_av_value.bv_val );
629 fop.ors_attrsonly = 0;
630 fop.ors_attrs = csn_anlist;
631 fop.ors_slimit = SLAP_NO_LIMIT;
632 cb.sc_private = &maxcsn;
633 cb.sc_response = findmax_cb;
634 strcpy( cbuf, cf.f_av_value.bv_val );
635 maxcsn.bv_val = cbuf;
636 maxcsn.bv_len = cf.f_av_value.bv_len;
639 if ( BER_BVISEMPTY( &cf.f_av_value )) {
640 cf.f_av_value = srs->sr_state.ctxcsn[0];
641 /* If there are multiple CSNs, use the smallest */
642 for ( i=1; i<srs->sr_state.numcsns; i++ ) {
643 if ( ber_bvcmp( &cf.f_av_value, &srs->sr_state.ctxcsn[i] )
645 cf.f_av_value = srs->sr_state.ctxcsn[i];
649 /* Look for exact match the first time */
650 if ( findcsn_retry ) {
651 cf.f_choice = LDAP_FILTER_EQUALITY;
652 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN=%s)",
653 cf.f_av_value.bv_val );
654 /* On retry, look for <= */
656 cf.f_choice = LDAP_FILTER_LE;
657 fop.ors_limit = &fc_limits;
658 memset( &fc_limits, 0, sizeof( fc_limits ));
659 fc_limits.lms_s_unchecked = 1;
660 fop.ors_filterstr.bv_len = sprintf( buf, "(entryCSN<=%s)",
661 cf.f_av_value.bv_val );
663 fop.ors_attrsonly = 1;
664 fop.ors_attrs = slap_anlist_no_attrs;
666 cb.sc_private = NULL;
667 cb.sc_response = findcsn_cb;
670 fop.ors_filter = op->ors_filter;
671 fop.ors_filterstr = op->ors_filterstr;
672 fop.ors_attrsonly = 0;
673 fop.ors_attrs = uuid_anlist;
674 fop.ors_slimit = SLAP_NO_LIMIT;
675 cb.sc_private = &pcookie;
676 cb.sc_response = findpres_cb;
679 /* preallocate storage for a full set */
680 pcookie.uuids = op->o_tmpalloc( (SLAP_SYNCUUID_SET_SIZE+1) *
681 sizeof(struct berval) + SLAP_SYNCUUID_SET_SIZE * UUID_LEN,
683 pcookie.last = (char *)(pcookie.uuids + SLAP_SYNCUUID_SET_SIZE+1);
684 pcookie.uuids[0].bv_val = pcookie.last;
685 pcookie.uuids[0].bv_len = UUID_LEN;
686 for (i=1; i<SLAP_SYNCUUID_SET_SIZE; i++) {
687 pcookie.uuids[i].bv_val = pcookie.uuids[i-1].bv_val + UUID_LEN;
688 pcookie.uuids[i].bv_len = UUID_LEN;
693 fop.o_bd->bd_info = on->on_info->oi_orig;
694 fop.o_bd->be_search( &fop, &frs );
695 fop.o_bd->bd_info = (BackendInfo *)on;
699 if ( ber_bvcmp( &si->si_ctxcsn[maxid], &maxcsn )) {
700 ber_bvreplace( &si->si_ctxcsn[maxid], &maxcsn );
701 si->si_numops++; /* ensure a checkpoint */
705 /* If matching CSN was not found, invalidate the context. */
706 if ( !cb.sc_private ) {
707 /* If we didn't find an exact match, then try for <= */
708 if ( findcsn_retry ) {
712 rc = LDAP_NO_SUCH_OBJECT;
716 op->o_tmpfree( pcookie.uuids, op->o_tmpmemctx );
724 syncprov_free_syncop( syncops *so )
726 syncres *sr, *srnext;
727 GroupAssertion *ga, *gnext;
729 ldap_pvt_thread_mutex_lock( &so->s_mutex );
730 if ( --so->s_inuse > 0 ) {
731 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
734 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
735 if ( so->s_flags & PS_IS_DETACHED ) {
736 filter_free( so->s_op->ors_filter );
737 for ( ga = so->s_op->o_groups; ga; ga=gnext ) {
743 ch_free( so->s_base.bv_val );
744 for ( sr=so->s_res; sr; sr=srnext ) {
748 ldap_pvt_thread_mutex_destroy( &so->s_mutex );
752 /* Send a persistent search response */
754 syncprov_sendresp( Operation *op, opcookie *opc, syncops *so,
755 Entry **e, int mode )
757 slap_overinst *on = opc->son;
759 SlapReply rs = { REP_SEARCH };
760 LDAPControl *ctrls[2];
761 struct berval cookie, csns[2];
763 Attribute a_uuid = {0};
765 if ( so->s_op->o_abandon )
766 return SLAPD_ABANDON;
769 csns[0] = opc->sctxcsn;
770 BER_BVZERO( &csns[1] );
771 slap_compose_sync_cookie( op, &cookie, csns, so->s_rid, so->s_sid );
773 Debug( LDAP_DEBUG_SYNC, "syncprov_sendresp: cookie=%s\n", cookie.bv_val, 0, 0 );
775 e_uuid.e_attrs = &a_uuid;
776 a_uuid.a_desc = slap_schema.si_ad_entryUUID;
777 a_uuid.a_nvals = &opc->suuid;
778 rs.sr_err = syncprov_state_ctrl( op, &rs, &e_uuid,
779 mode, ctrls, 0, 1, &cookie );
780 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
783 op->o_bd->bd_info = (BackendInfo *)on->on_info;
787 if ( rs.sr_entry->e_private )
788 rs.sr_flags = REP_ENTRY_MUSTRELEASE;
789 if ( opc->sreference ) {
790 rs.sr_ref = get_entry_referrals( op, rs.sr_entry );
791 rs.sr_err = send_search_reference( op, &rs );
792 ber_bvarray_free( rs.sr_ref );
798 case LDAP_SYNC_MODIFY:
800 if ( rs.sr_entry->e_private )
801 rs.sr_flags = REP_ENTRY_MUSTRELEASE;
802 rs.sr_attrs = op->ors_attrs;
803 rs.sr_err = send_search_entry( op, &rs );
807 case LDAP_SYNC_DELETE:
808 e_uuid.e_attrs = NULL;
809 e_uuid.e_name = opc->sdn;
810 e_uuid.e_nname = opc->sndn;
811 rs.sr_entry = &e_uuid;
812 if ( opc->sreference ) {
813 struct berval bv = BER_BVNULL;
815 rs.sr_err = send_search_reference( op, &rs );
817 rs.sr_err = send_search_entry( op, &rs );
823 /* In case someone else freed it already? */
825 op->o_tmpfree( rs.sr_ctrls[0], op->o_tmpmemctx );
832 /* Play back queued responses */
834 syncprov_qplay( Operation *op, slap_overinst *on, syncops *so )
844 ldap_pvt_thread_mutex_lock( &so->s_mutex );
847 so->s_res = sr->s_next;
849 so->s_restail = NULL;
850 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
852 if ( !sr || so->s_op->o_abandon )
856 opc.sndn = sr->s_ndn;
857 opc.suuid = sr->s_uuid;
858 opc.sctxcsn = sr->s_csn;
859 opc.sreference = sr->s_isreference;
862 if ( sr->s_mode != LDAP_SYNC_DELETE ) {
863 rc = overlay_entry_get_ov( op, &opc.sndn, NULL, NULL, 0, &e, on );
865 Debug( LDAP_DEBUG_SYNC, "syncprov_qplay: failed to get %s, "
866 "error (%d), ignoring...\n", opc.sndn.bv_val, rc, 0 );
872 rc = syncprov_sendresp( op, &opc, so, &e, sr->s_mode );
875 overlay_entry_release_ov( op, e, 0, on );
886 /* runqueue task for playing back queued responses */
888 syncprov_qtask( void *ctx, void *arg )
890 struct re_s *rtask = arg;
891 syncops *so = rtask->arg;
892 slap_overinst *on = so->s_op->o_private;
893 OperationBuffer opbuf;
900 op->o_hdr = &opbuf.ob_hdr;
901 op->o_controls = opbuf.ob_controls;
902 memset( op->o_controls, 0, sizeof(opbuf.ob_controls) );
904 *op->o_hdr = *so->s_op->o_hdr;
906 op->o_tmpmemctx = slap_sl_mem_create(SLAP_SLAB_SIZE, SLAP_SLAB_STACK, ctx, 1);
907 op->o_tmpmfuncs = &slap_sl_mfuncs;
908 op->o_threadctx = ctx;
910 /* syncprov_qplay expects a fake db */
911 be = *so->s_op->o_bd;
912 be.be_flags |= SLAP_DBFLAG_OVERLAY;
914 op->o_private = NULL;
915 op->o_callback = NULL;
917 rc = syncprov_qplay( op, on, so );
919 /* decrement use count... */
920 syncprov_free_syncop( so );
922 /* wait until we get explicitly scheduled again */
923 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
924 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
926 ldap_pvt_runqueue_resched( &slapd_rq, rtask, 1 );
928 /* bail out on any error */
929 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
931 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
933 #if 0 /* FIXME: connection_close isn't exported from slapd.
937 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
938 if ( connection_state_closing( op->o_conn )) {
939 connection_close( op->o_conn );
941 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
947 /* Start the task to play back queued psearch responses */
949 syncprov_qstart( syncops *so )
952 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
953 if ( !so->s_qtask ) {
954 so->s_qtask = ldap_pvt_runqueue_insert( &slapd_rq, RUNQ_INTERVAL,
955 syncprov_qtask, so, "syncprov_qtask",
956 so->s_op->o_conn->c_peer_name.bv_val );
960 if (!ldap_pvt_runqueue_isrunning( &slapd_rq, so->s_qtask ) &&
961 !so->s_qtask->next_sched.tv_sec ) {
962 so->s_qtask->interval.tv_sec = 0;
963 ldap_pvt_runqueue_resched( &slapd_rq, so->s_qtask, 0 );
964 so->s_qtask->interval.tv_sec = RUNQ_INTERVAL;
969 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
971 slap_wake_listener();
974 /* Queue a persistent search response */
976 syncprov_qresp( opcookie *opc, syncops *so, int mode )
981 /* Don't send changes back to their originator */
982 sid = slap_parse_csn_sid( &opc->sctxcsn );
983 if ( sid >= 0 && sid == so->s_sid )
986 srsize = sizeof(syncres) + opc->suuid.bv_len + 1 +
987 opc->sdn.bv_len + 1 + opc->sndn.bv_len + 1;
988 if ( opc->sctxcsn.bv_len )
989 srsize += opc->sctxcsn.bv_len + 1;
990 sr = ch_malloc( srsize );
992 sr->s_dn.bv_val = (char *)(sr + 1);
993 sr->s_dn.bv_len = opc->sdn.bv_len;
995 sr->s_isreference = opc->sreference;
996 sr->s_ndn.bv_val = lutil_strcopy( sr->s_dn.bv_val,
997 opc->sdn.bv_val ) + 1;
998 sr->s_ndn.bv_len = opc->sndn.bv_len;
999 sr->s_uuid.bv_val = lutil_strcopy( sr->s_ndn.bv_val,
1000 opc->sndn.bv_val ) + 1;
1001 sr->s_uuid.bv_len = opc->suuid.bv_len;
1002 AC_MEMCPY( sr->s_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
1003 if ( opc->sctxcsn.bv_len ) {
1004 sr->s_csn.bv_val = sr->s_uuid.bv_val + sr->s_uuid.bv_len + 1;
1005 strcpy( sr->s_csn.bv_val, opc->sctxcsn.bv_val );
1007 sr->s_csn.bv_val = NULL;
1009 sr->s_csn.bv_len = opc->sctxcsn.bv_len;
1011 ldap_pvt_thread_mutex_lock( &so->s_mutex );
1015 so->s_restail->s_next = sr;
1019 /* If the base of the psearch was modified, check it next time round */
1020 if ( so->s_flags & PS_WROTE_BASE ) {
1021 so->s_flags ^= PS_WROTE_BASE;
1022 so->s_flags |= PS_FIND_BASE;
1024 if ( so->s_flags & PS_IS_DETACHED ) {
1025 syncprov_qstart( so );
1027 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
1028 return LDAP_SUCCESS;
1032 syncprov_drop_psearch( syncops *so, int lock )
1034 if ( so->s_flags & PS_IS_DETACHED ) {
1036 ldap_pvt_thread_mutex_lock( &so->s_op->o_conn->c_mutex );
1037 so->s_op->o_conn->c_n_ops_executing--;
1038 so->s_op->o_conn->c_n_ops_completed++;
1039 LDAP_STAILQ_REMOVE( &so->s_op->o_conn->c_ops, so->s_op, Operation,
1042 ldap_pvt_thread_mutex_unlock( &so->s_op->o_conn->c_mutex );
1044 syncprov_free_syncop( so );
1050 syncprov_ab_cleanup( Operation *op, SlapReply *rs )
1052 slap_callback *sc = op->o_callback;
1053 op->o_callback = sc->sc_next;
1054 syncprov_drop_psearch( op->o_callback->sc_private, 0 );
1055 op->o_tmpfree( sc, op->o_tmpmemctx );
1060 syncprov_op_abandon( Operation *op, SlapReply *rs )
1062 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1063 syncprov_info_t *si = on->on_bi.bi_private;
1064 syncops *so, *soprev;
1066 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1067 for ( so=si->si_ops, soprev = (syncops *)&si->si_ops; so;
1068 soprev=so, so=so->s_next ) {
1069 if ( so->s_op->o_connid == op->o_connid &&
1070 so->s_op->o_msgid == op->orn_msgid ) {
1071 so->s_op->o_abandon = 1;
1072 soprev->s_next = so->s_next;
1076 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1078 /* Is this really a Cancel exop? */
1079 if ( op->o_tag != LDAP_REQ_ABANDON ) {
1080 so->s_op->o_cancel = SLAP_CANCEL_ACK;
1081 rs->sr_err = LDAP_CANCELLED;
1082 send_ldap_result( so->s_op, rs );
1083 if ( so->s_flags & PS_IS_DETACHED ) {
1085 cb = op->o_tmpcalloc( 1, sizeof(slap_callback), op->o_tmpmemctx );
1086 cb->sc_cleanup = syncprov_ab_cleanup;
1087 cb->sc_next = op->o_callback;
1088 cb->sc_private = so;
1089 return SLAP_CB_CONTINUE;
1092 syncprov_drop_psearch( so, 0 );
1094 return SLAP_CB_CONTINUE;
1097 /* Find which persistent searches are affected by this operation */
1099 syncprov_matchops( Operation *op, opcookie *opc, int saveit )
1101 slap_overinst *on = opc->son;
1102 syncprov_info_t *si = on->on_bi.bi_private;
1105 syncops *ss, *sprev, *snext;
1109 struct berval newdn;
1111 BackendDB *b0 = op->o_bd, db;
1113 fc.fdn = &op->o_req_ndn;
1114 /* compute new DN */
1115 if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1117 if ( op->orr_nnewSup ) pdn = *op->orr_nnewSup;
1118 else dnParent( fc.fdn, &pdn );
1119 build_new_dn( &newdn, &pdn, &op->orr_nnewrdn, op->o_tmpmemctx );
1123 if ( op->o_tag != LDAP_REQ_ADD ) {
1124 if ( !SLAP_ISOVERLAY( op->o_bd )) {
1128 rc = overlay_entry_get_ov( op, fc.fdn, NULL, NULL, 0, &e, on );
1129 /* If we're sending responses now, make a copy and unlock the DB */
1130 if ( e && !saveit ) {
1131 Entry *e2 = entry_dup( e );
1132 overlay_entry_release_ov( op, e, 0, on );
1143 if ( saveit || op->o_tag == LDAP_REQ_ADD ) {
1144 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1145 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1146 opc->sreference = is_entry_referral( e );
1147 a = attr_find( e->e_attrs, slap_schema.si_ad_entryUUID );
1149 ber_dupbv_x( &opc->suuid, &a->a_nvals[0], op->o_tmpmemctx );
1150 } else if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
1151 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1152 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1153 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
1154 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
1157 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1158 for (ss = si->si_ops, sprev = (syncops *)&si->si_ops; ss;
1159 sprev = ss, ss=snext)
1170 /* If the base of the search is missing, signal a refresh */
1171 rc = syncprov_findbase( op, &fc );
1172 if ( rc != LDAP_SUCCESS ) {
1173 SlapReply rs = {REP_RESULT};
1174 send_ldap_error( ss->s_op, &rs, LDAP_SYNC_REFRESH_REQUIRED,
1175 "search base has changed" );
1176 sprev->s_next = snext;
1177 syncprov_drop_psearch( ss, 1 );
1183 /* If we're sending results now, look for this op in old matches */
1187 /* Did we modify the search base? */
1188 if ( dn_match( &op->o_req_ndn, &ss->s_base )) {
1189 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1190 ss->s_flags |= PS_WROTE_BASE;
1191 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1194 for ( sm=opc->smatches, old=(syncmatches *)&opc->smatches; sm;
1195 old=sm, sm=sm->sm_next ) {
1196 if ( sm->sm_op == ss ) {
1198 old->sm_next = sm->sm_next;
1199 op->o_tmpfree( sm, op->o_tmpmemctx );
1205 /* check if current o_req_dn is in scope and matches filter */
1206 if ( fc.fscope && test_filter( op, e, ss->s_op->ors_filter ) ==
1207 LDAP_COMPARE_TRUE ) {
1209 sm = op->o_tmpalloc( sizeof(syncmatches), op->o_tmpmemctx );
1210 sm->sm_next = opc->smatches;
1212 ldap_pvt_thread_mutex_lock( &ss->s_mutex );
1214 ldap_pvt_thread_mutex_unlock( &ss->s_mutex );
1217 /* if found send UPDATE else send ADD */
1218 syncprov_qresp( opc, ss,
1219 found ? LDAP_SYNC_MODIFY : LDAP_SYNC_ADD );
1221 } else if ( !saveit && found ) {
1223 syncprov_qresp( opc, ss, LDAP_SYNC_DELETE );
1226 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1228 if ( op->o_tag != LDAP_REQ_ADD && e ) {
1229 if ( !SLAP_ISOVERLAY( op->o_bd )) {
1232 overlay_entry_release_ov( op, e, 0, on );
1236 op->o_tmpfree( fc.fdn->bv_val, op->o_tmpmemctx );
1242 syncprov_op_cleanup( Operation *op, SlapReply *rs )
1244 slap_callback *cb = op->o_callback;
1245 opcookie *opc = cb->sc_private;
1246 slap_overinst *on = opc->son;
1247 syncprov_info_t *si = on->on_bi.bi_private;
1248 syncmatches *sm, *snext;
1249 modtarget *mt, mtdummy;
1251 for (sm = opc->smatches; sm; sm=snext) {
1252 snext = sm->sm_next;
1253 syncprov_free_syncop( sm->sm_op );
1254 op->o_tmpfree( sm, op->o_tmpmemctx );
1257 /* Remove op from lock table */
1259 ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1260 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1262 modinst *mi = mt->mt_mods;
1264 /* If there are more, promote the next one */
1265 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1266 if ( mi->mi_next ) {
1267 mt->mt_mods = mi->mi_next;
1268 mt->mt_op = mt->mt_mods->mi_op;
1269 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1271 avl_delete( &si->si_mods, mt, sp_avl_cmp );
1272 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1273 ldap_pvt_thread_mutex_destroy( &mt->mt_mutex );
1277 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1278 if ( !BER_BVISNULL( &opc->suuid ))
1279 op->o_tmpfree( opc->suuid.bv_val, op->o_tmpmemctx );
1280 if ( !BER_BVISNULL( &opc->sndn ))
1281 op->o_tmpfree( opc->sndn.bv_val, op->o_tmpmemctx );
1282 if ( !BER_BVISNULL( &opc->sdn ))
1283 op->o_tmpfree( opc->sdn.bv_val, op->o_tmpmemctx );
1284 op->o_callback = cb->sc_next;
1285 op->o_tmpfree(cb, op->o_tmpmemctx);
1291 syncprov_checkpoint( Operation *op, SlapReply *rs, slap_overinst *on )
1293 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1296 SlapReply rsm = { 0 };
1297 slap_callback cb = {0};
1299 mod.sml_numvals = si->si_numcsns;
1300 mod.sml_values = si->si_ctxcsn;
1301 mod.sml_nvalues = NULL;
1302 mod.sml_desc = slap_schema.si_ad_contextCSN;
1303 mod.sml_op = LDAP_MOD_REPLACE;
1305 mod.sml_next = NULL;
1307 cb.sc_response = slap_null_cb;
1309 opm.o_tag = LDAP_REQ_MODIFY;
1310 opm.o_callback = &cb;
1311 opm.orm_modlist = &mod;
1312 opm.orm_no_opattrs = 1;
1313 opm.o_req_dn = op->o_bd->be_suffix[0];
1314 opm.o_req_ndn = op->o_bd->be_nsuffix[0];
1315 opm.o_bd->bd_info = on->on_info->oi_orig;
1316 opm.o_managedsait = SLAP_CONTROL_NONCRITICAL;
1317 opm.o_no_schema_check = 1;
1318 opm.o_bd->be_modify( &opm, &rsm );
1319 if ( mod.sml_next != NULL ) {
1320 slap_mods_free( mod.sml_next, 1 );
1322 opm.orm_no_opattrs = 0;
1326 syncprov_add_slog( Operation *op )
1328 opcookie *opc = op->o_callback->sc_private;
1329 slap_overinst *on = opc->son;
1330 syncprov_info_t *si = on->on_bi.bi_private;
1336 /* Allocate a record. UUIDs are not NUL-terminated. */
1337 se = ch_malloc( sizeof( slog_entry ) + opc->suuid.bv_len +
1338 op->o_csn.bv_len + 1 );
1340 se->se_tag = op->o_tag;
1342 se->se_uuid.bv_val = (char *)(&se[1]);
1343 AC_MEMCPY( se->se_uuid.bv_val, opc->suuid.bv_val, opc->suuid.bv_len );
1344 se->se_uuid.bv_len = opc->suuid.bv_len;
1346 se->se_csn.bv_val = se->se_uuid.bv_val + opc->suuid.bv_len;
1347 AC_MEMCPY( se->se_csn.bv_val, op->o_csn.bv_val, op->o_csn.bv_len );
1348 se->se_csn.bv_val[op->o_csn.bv_len] = '\0';
1349 se->se_csn.bv_len = op->o_csn.bv_len;
1350 se->se_sid = slap_parse_csn_sid( &se->se_csn );
1352 ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
1353 if ( sl->sl_head ) {
1354 sl->sl_tail->se_next = se;
1360 while ( sl->sl_num > sl->sl_size ) {
1362 sl->sl_head = se->se_next;
1363 strcpy( sl->sl_mincsn.bv_val, se->se_csn.bv_val );
1364 sl->sl_mincsn.bv_len = se->se_csn.bv_len;
1368 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1372 /* Just set a flag if we found the matching entry */
1374 playlog_cb( Operation *op, SlapReply *rs )
1376 if ( rs->sr_type == REP_SEARCH ) {
1377 op->o_callback->sc_private = (void *)1;
1382 /* enter with sl->sl_mutex locked, release before returning */
1384 syncprov_playlog( Operation *op, SlapReply *rs, sessionlog *sl,
1385 sync_control *srs, BerVarray ctxcsn, int numcsns, int *sids )
1387 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1389 int i, j, ndel, num, nmods, mmods;
1390 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1392 struct berval delcsn[2];
1394 if ( !sl->sl_num ) {
1395 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1403 uuids = op->o_tmpalloc( (num+1) * sizeof( struct berval ) +
1404 num * UUID_LEN, op->o_tmpmemctx );
1405 uuids[0].bv_val = (char *)(uuids + num + 1);
1407 delcsn[0].bv_len = 0;
1408 delcsn[0].bv_val = cbuf;
1409 BER_BVZERO(&delcsn[1]);
1411 /* Make a copy of the relevant UUIDs. Put the Deletes up front
1412 * and everything else at the end. Do this first so we can
1413 * unlock the list mutex.
1415 Debug( LDAP_DEBUG_SYNC, "srs csn %s\n",
1416 srs->sr_state.ctxcsn[0].bv_val, 0, 0 );
1417 for ( se=sl->sl_head; se; se=se->se_next ) {
1419 Debug( LDAP_DEBUG_SYNC, "log csn %s\n", se->se_csn.bv_val, 0, 0 );
1421 for ( k=0; k<srs->sr_state.numcsns; k++ ) {
1422 if ( se->se_sid == srs->sr_state.sids[k] ) {
1423 ndel = ber_bvcmp( &se->se_csn, &srs->sr_state.ctxcsn[k] );
1428 Debug( LDAP_DEBUG_SYNC, "cmp %d, too old\n", ndel, 0, 0 );
1432 for ( k=0; k<numcsns; k++ ) {
1433 if ( se->se_sid == sids[k] ) {
1434 ndel = ber_bvcmp( &se->se_csn, &ctxcsn[k] );
1439 Debug( LDAP_DEBUG_SYNC, "cmp %d, too new\n", ndel, 0, 0 );
1442 if ( se->se_tag == LDAP_REQ_DELETE ) {
1445 AC_MEMCPY( cbuf, se->se_csn.bv_val, se->se_csn.bv_len );
1446 delcsn[0].bv_len = se->se_csn.bv_len;
1447 delcsn[0].bv_val[delcsn[0].bv_len] = '\0';
1452 uuids[j].bv_val = uuids[0].bv_val + (j * UUID_LEN);
1453 AC_MEMCPY(uuids[j].bv_val, se->se_uuid.bv_val, UUID_LEN);
1454 uuids[j].bv_len = UUID_LEN;
1456 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
1460 /* Zero out unused slots */
1461 for ( i=ndel; i < num - nmods; i++ )
1462 uuids[i].bv_len = 0;
1464 /* Mods must be validated to see if they belong in this delete set.
1468 /* Strip any duplicates */
1469 for ( i=0; i<nmods; i++ ) {
1470 for ( j=0; j<ndel; j++ ) {
1471 if ( bvmatch( &uuids[j], &uuids[num - 1 - i] )) {
1472 uuids[num - 1 - i].bv_len = 0;
1477 if ( uuids[num - 1 - i].bv_len == 0 ) continue;
1478 for ( j=0; j<i; j++ ) {
1479 if ( bvmatch( &uuids[num - 1 - j], &uuids[num - 1 - i] )) {
1480 uuids[num - 1 - i].bv_len = 0;
1489 SlapReply frs = { REP_RESULT };
1492 AttributeAssertion eq = ATTRIBUTEASSERTION_INIT;
1493 slap_callback cb = {0};
1497 fop.o_sync_mode = 0;
1498 fop.o_callback = &cb;
1499 fop.ors_limit = NULL;
1500 fop.ors_tlimit = SLAP_NO_LIMIT;
1501 fop.ors_attrs = slap_anlist_all_attributes;
1502 fop.ors_attrsonly = 0;
1503 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
1505 af.f_choice = LDAP_FILTER_AND;
1508 mf.f_choice = LDAP_FILTER_EQUALITY;
1510 mf.f_av_desc = slap_schema.si_ad_entryUUID;
1511 mf.f_next = fop.ors_filter;
1513 fop.ors_filter = ⁡
1515 cb.sc_response = playlog_cb;
1516 fop.o_bd->bd_info = on->on_info->oi_orig;
1518 for ( i=ndel; i<num; i++ ) {
1519 if ( uuids[i].bv_len == 0 ) continue;
1521 mf.f_av_value = uuids[i];
1522 cb.sc_private = NULL;
1524 frs.sr_nentries = 0;
1525 rc = fop.o_bd->be_search( &fop, &frs );
1527 /* If entry was not found, add to delete list */
1528 if ( !cb.sc_private ) {
1529 uuids[ndel++] = uuids[i];
1532 fop.o_bd->bd_info = (BackendInfo *)on;
1535 struct berval cookie;
1537 slap_compose_sync_cookie( op, &cookie, delcsn, srs->sr_state.rid,
1538 srs->sr_state.sid );
1540 Debug( LDAP_DEBUG_SYNC, "syncprov_playlog: cookie=%s\n", cookie.bv_val, 0, 0 );
1542 uuids[ndel].bv_val = NULL;
1543 syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, &cookie, 0, uuids, 1 );
1544 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
1546 op->o_tmpfree( uuids, op->o_tmpmemctx );
1550 syncprov_op_response( Operation *op, SlapReply *rs )
1552 opcookie *opc = op->o_callback->sc_private;
1553 slap_overinst *on = opc->son;
1554 syncprov_info_t *si = on->on_bi.bi_private;
1557 if ( rs->sr_err == LDAP_SUCCESS )
1559 struct berval maxcsn = BER_BVNULL;
1560 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
1561 int do_check = 0, have_psearches;
1563 /* Update our context CSN */
1565 ldap_pvt_thread_rdwr_wlock( &si->si_csn_rwlock );
1566 slap_get_commit_csn( op, &maxcsn );
1567 if ( !BER_BVISNULL( &maxcsn ) ) {
1569 strcpy( cbuf, maxcsn.bv_val );
1570 sid = slap_parse_csn_sid( &maxcsn );
1571 for ( i=0; i<si->si_numcsns; i++ ) {
1572 if ( sid == si->si_sids[i] ) {
1573 if ( ber_bvcmp( &maxcsn, &si->si_ctxcsn[i] ) > 0 ) {
1574 ber_bvreplace( &si->si_ctxcsn[i], &maxcsn );
1579 /* It's a new SID for us */
1580 if ( i == si->si_numcsns ) {
1581 value_add_one( &si->si_ctxcsn, &maxcsn );
1583 si->si_sids = ch_realloc( si->si_sids, si->si_numcsns *
1585 si->si_sids[i] = sid;
1589 /* Don't do any processing for consumer contextCSN updates */
1590 if ( SLAP_SYNC_SHADOW( op->o_bd ) &&
1591 op->o_msgid == SLAP_SYNC_UPDATE_MSGID ) {
1592 ldap_pvt_thread_rdwr_wunlock( &si->si_csn_rwlock );
1593 return SLAP_CB_CONTINUE;
1597 if ( si->si_chkops || si->si_chktime ) {
1598 if ( si->si_chkops && si->si_numops >= si->si_chkops ) {
1602 if ( si->si_chktime &&
1603 (op->o_time - si->si_chklast >= si->si_chktime )) {
1605 si->si_chklast = op->o_time;
1608 ldap_pvt_thread_rdwr_wunlock( &si->si_csn_rwlock );
1611 ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
1612 syncprov_checkpoint( op, rs, on );
1613 ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
1616 opc->sctxcsn.bv_len = maxcsn.bv_len;
1617 opc->sctxcsn.bv_val = cbuf;
1619 /* Handle any persistent searches */
1620 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1621 have_psearches = ( si->si_ops != NULL );
1622 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1623 if ( have_psearches ) {
1626 case LDAP_REQ_MODIFY:
1627 case LDAP_REQ_MODRDN:
1628 case LDAP_REQ_EXTENDED:
1629 syncprov_matchops( op, opc, 0 );
1631 case LDAP_REQ_DELETE:
1632 /* for each match in opc->smatches:
1635 for ( sm = opc->smatches; sm; sm=sm->sm_next ) {
1636 if ( sm->sm_op->s_op->o_abandon )
1638 syncprov_qresp( opc, sm->sm_op, LDAP_SYNC_DELETE );
1644 /* Add any log records */
1645 if ( si->si_logs && op->o_tag != LDAP_REQ_ADD ) {
1646 syncprov_add_slog( op );
1650 return SLAP_CB_CONTINUE;
1653 /* We don't use a subentry to store the context CSN any more.
1654 * We expose the current context CSN as an operational attribute
1655 * of the suffix entry.
1658 syncprov_op_compare( Operation *op, SlapReply *rs )
1660 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1661 syncprov_info_t *si = on->on_bi.bi_private;
1662 int rc = SLAP_CB_CONTINUE;
1664 if ( dn_match( &op->o_req_ndn, op->o_bd->be_nsuffix ) &&
1665 op->oq_compare.rs_ava->aa_desc == slap_schema.si_ad_contextCSN )
1670 e.e_name = op->o_bd->be_suffix[0];
1671 e.e_nname = op->o_bd->be_nsuffix[0];
1674 a.a_desc = slap_schema.si_ad_contextCSN;
1676 ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
1678 a.a_vals = si->si_ctxcsn;
1679 a.a_nvals = a.a_vals;
1681 rs->sr_err = access_allowed( op, &e, op->oq_compare.rs_ava->aa_desc,
1682 &op->oq_compare.rs_ava->aa_value, ACL_COMPARE, NULL );
1683 if ( ! rs->sr_err ) {
1684 rs->sr_err = LDAP_INSUFFICIENT_ACCESS;
1685 goto return_results;
1688 if ( get_assert( op ) &&
1689 ( test_filter( op, &e, get_assertion( op ) ) != LDAP_COMPARE_TRUE ) )
1691 rs->sr_err = LDAP_ASSERTION_FAILED;
1692 goto return_results;
1696 rs->sr_err = LDAP_COMPARE_FALSE;
1698 if ( attr_valfind( &a,
1699 SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH |
1700 SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH,
1701 &op->oq_compare.rs_ava->aa_value, NULL, op->o_tmpmemctx ) == 0 )
1703 rs->sr_err = LDAP_COMPARE_TRUE;
1708 ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
1710 send_ldap_result( op, rs );
1712 if( rs->sr_err == LDAP_COMPARE_FALSE || rs->sr_err == LDAP_COMPARE_TRUE ) {
1713 rs->sr_err = LDAP_SUCCESS;
1722 syncprov_op_mod( Operation *op, SlapReply *rs )
1724 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1725 syncprov_info_t *si = on->on_bi.bi_private;
1728 int have_psearches, cbsize;
1730 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1731 have_psearches = ( si->si_ops != NULL );
1732 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1734 cbsize = sizeof(slap_callback) + sizeof(opcookie) +
1735 (have_psearches ? sizeof(modinst) : 0 );
1737 cb = op->o_tmpcalloc(1, cbsize, op->o_tmpmemctx);
1738 opc = (opcookie *)(cb+1);
1740 cb->sc_response = syncprov_op_response;
1741 cb->sc_cleanup = syncprov_op_cleanup;
1742 cb->sc_private = opc;
1743 cb->sc_next = op->o_callback;
1744 op->o_callback = cb;
1746 /* If there are active persistent searches, lock this operation.
1747 * See seqmod.c for the locking logic on its own.
1749 if ( have_psearches ) {
1750 modtarget *mt, mtdummy;
1753 mi = (modinst *)(opc+1);
1756 /* See if we're already modifying this entry... */
1758 ldap_pvt_thread_mutex_lock( &si->si_mods_mutex );
1759 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1761 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1762 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1763 mt->mt_tail->mi_next = mi;
1765 /* wait for this op to get to head of list */
1766 while ( mt->mt_mods != mi ) {
1767 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1768 ldap_pvt_thread_yield();
1769 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1771 /* clean up if the caller is giving up */
1772 if ( op->o_abandon ) {
1774 for ( m2 = mt->mt_mods; m2->mi_next != mi;
1776 m2->mi_next = mi->mi_next;
1777 if ( mt->mt_tail == mi ) mt->mt_tail = m2;
1778 op->o_tmpfree( cb, op->o_tmpmemctx );
1779 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1780 return SLAPD_ABANDON;
1783 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1785 /* Record that we're modifying this entry now */
1786 mt = ch_malloc( sizeof(modtarget) );
1789 mt->mt_op = mi->mi_op;
1790 ldap_pvt_thread_mutex_init( &mt->mt_mutex );
1791 avl_insert( &si->si_mods, mt, sp_avl_cmp, avl_dup_error );
1792 ldap_pvt_thread_mutex_unlock( &si->si_mods_mutex );
1796 if (( have_psearches || si->si_logs ) && op->o_tag != LDAP_REQ_ADD )
1797 syncprov_matchops( op, opc, 1 );
1799 return SLAP_CB_CONTINUE;
1803 syncprov_op_extended( Operation *op, SlapReply *rs )
1805 if ( exop_is_write( op ))
1806 return syncprov_op_mod( op, rs );
1808 return SLAP_CB_CONTINUE;
1811 typedef struct searchstate {
1812 slap_overinst *ss_on;
1814 BerVarray ss_ctxcsn;
1817 #define SS_PRESENT 0x01
1818 #define SS_CHANGED 0x02
1823 syncprov_search_cleanup( Operation *op, SlapReply *rs )
1825 if ( rs->sr_ctrls ) {
1826 op->o_tmpfree( rs->sr_ctrls[0], op->o_tmpmemctx );
1827 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
1828 rs->sr_ctrls = NULL;
1833 typedef struct SyncOperationBuffer {
1836 AttributeName sob_extra; /* not always present */
1837 /* Further data allocated here */
1838 } SyncOperationBuffer;
1841 syncprov_detach_op( Operation *op, syncops *so, slap_overinst *on )
1843 SyncOperationBuffer *sopbuf2;
1848 GroupAssertion *g1, *g2;
1850 /* count the search attrs */
1851 for (i=0; op->ors_attrs && !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1852 alen += op->ors_attrs[i].an_name.bv_len + 1;
1854 /* Make a new copy of the operation */
1855 size = offsetof( SyncOperationBuffer, sob_extra ) +
1856 (i ? ( (i+1) * sizeof(AttributeName) + alen) : 0) +
1857 op->o_req_dn.bv_len + 1 +
1858 op->o_req_ndn.bv_len + 1 +
1859 op->o_ndn.bv_len + 1 +
1860 so->s_filterstr.bv_len + 1;
1861 sopbuf2 = ch_calloc( 1, size );
1862 op2 = &sopbuf2->sob_op;
1863 op2->o_hdr = &sopbuf2->sob_hdr;
1865 /* Copy the fields we care about explicitly, leave the rest alone */
1866 *op2->o_hdr = *op->o_hdr;
1867 op2->o_tag = op->o_tag;
1868 op2->o_time = op->o_time;
1869 op2->o_bd = on->on_info->oi_origdb;
1870 op2->o_request = op->o_request;
1871 op2->o_private = on;
1873 ptr = (char *) sopbuf2 + offsetof( SyncOperationBuffer, sob_extra );
1875 op2->ors_attrs = (AttributeName *) ptr;
1876 ptr = (char *) &op2->ors_attrs[i+1];
1877 for (i=0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1878 op2->ors_attrs[i] = op->ors_attrs[i];
1879 op2->ors_attrs[i].an_name.bv_val = ptr;
1880 ptr = lutil_strcopy( ptr, op->ors_attrs[i].an_name.bv_val ) + 1;
1882 BER_BVZERO( &op2->ors_attrs[i].an_name );
1885 op2->o_authz = op->o_authz;
1886 op2->o_ndn.bv_val = ptr;
1887 ptr = lutil_strcopy(ptr, op->o_ndn.bv_val) + 1;
1888 op2->o_dn = op2->o_ndn;
1889 op2->o_req_dn.bv_len = op->o_req_dn.bv_len;
1890 op2->o_req_dn.bv_val = ptr;
1891 ptr = lutil_strcopy(ptr, op->o_req_dn.bv_val) + 1;
1892 op2->o_req_ndn.bv_len = op->o_req_ndn.bv_len;
1893 op2->o_req_ndn.bv_val = ptr;
1894 ptr = lutil_strcopy(ptr, op->o_req_ndn.bv_val) + 1;
1895 op2->ors_filterstr.bv_val = ptr;
1896 strcpy( ptr, so->s_filterstr.bv_val );
1897 op2->ors_filterstr.bv_len = so->s_filterstr.bv_len;
1899 /* Skip the AND/GE clause that we stuck on in front */
1900 if ( so->s_flags & PS_FIX_FILTER ) {
1901 op2->ors_filter = op->ors_filter->f_and->f_next;
1902 so->s_flags ^= PS_FIX_FILTER;
1904 op2->ors_filter = op->ors_filter;
1906 op2->ors_filter = filter_dup( op2->ors_filter, NULL );
1909 /* Copy any cached group ACLs individually */
1910 op2->o_groups = NULL;
1911 for ( g1=op->o_groups; g1; g1=g1->ga_next ) {
1912 g2 = ch_malloc( sizeof(GroupAssertion) + g1->ga_len );
1914 strcpy( g2->ga_ndn, g1->ga_ndn );
1915 g2->ga_next = op2->o_groups;
1918 /* Don't allow any further group caching */
1919 op2->o_do_not_cache = 1;
1921 /* Add op2 to conn so abandon will find us */
1922 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1923 op->o_conn->c_n_ops_executing++;
1924 op->o_conn->c_n_ops_completed--;
1925 LDAP_STAILQ_INSERT_TAIL( &op->o_conn->c_ops, op2, o_next );
1926 so->s_flags |= PS_IS_DETACHED;
1927 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1929 /* Prevent anyone else from trying to send a result for this op */
1934 syncprov_search_response( Operation *op, SlapReply *rs )
1936 searchstate *ss = op->o_callback->sc_private;
1937 slap_overinst *on = ss->ss_on;
1938 sync_control *srs = op->o_controls[slap_cids.sc_LDAPsync];
1940 if ( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF ) {
1942 /* If we got a referral without a referral object, there's
1943 * something missing that we cannot replicate. Just ignore it.
1944 * The consumer will abort because we didn't send the expected
1947 if ( !rs->sr_entry ) {
1948 assert( rs->sr_entry != NULL );
1949 Debug( LDAP_DEBUG_ANY, "bogus referral in context\n",0,0,0 );
1950 return SLAP_CB_CONTINUE;
1952 a = attr_find( rs->sr_entry->e_attrs, slap_schema.si_ad_entryCSN );
1953 if ( a == NULL && rs->sr_operational_attrs != NULL ) {
1954 a = attr_find( rs->sr_operational_attrs, slap_schema.si_ad_entryCSN );
1958 sid = slap_parse_csn_sid( &a->a_nvals[0] );
1960 /* Don't send changed entries back to the originator */
1961 if ( sid == srs->sr_state.sid && srs->sr_state.numcsns ) {
1962 Debug( LDAP_DEBUG_SYNC,
1963 "Entry %s changed by peer, ignored\n",
1964 rs->sr_entry->e_name.bv_val, 0, 0 );
1965 return LDAP_SUCCESS;
1968 /* If not a persistent search */
1970 /* Make sure entry is less than the snapshot'd contextCSN */
1971 for ( i=0; i<ss->ss_numcsns; i++ ) {
1972 if ( sid == ss->ss_sids[i] && ber_bvcmp( &a->a_nvals[0],
1973 &ss->ss_ctxcsn[i] ) > 0 ) {
1974 Debug( LDAP_DEBUG_SYNC,
1975 "Entry %s CSN %s greater than snapshot %s\n",
1976 rs->sr_entry->e_name.bv_val,
1977 a->a_nvals[0].bv_val,
1978 ss->ss_ctxcsn[i].bv_val );
1979 return LDAP_SUCCESS;
1984 /* Don't send old entries twice */
1985 if ( srs->sr_state.ctxcsn ) {
1986 for ( i=0; i<srs->sr_state.numcsns; i++ ) {
1987 if ( sid == srs->sr_state.sids[i] &&
1988 ber_bvcmp( &a->a_nvals[0],
1989 &srs->sr_state.ctxcsn[i] )<= 0 ) {
1990 Debug( LDAP_DEBUG_SYNC,
1991 "Entry %s CSN %s older or equal to ctx %s\n",
1992 rs->sr_entry->e_name.bv_val,
1993 a->a_nvals[0].bv_val,
1994 srs->sr_state.ctxcsn[i].bv_val );
1995 return LDAP_SUCCESS;
2000 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
2002 rs->sr_ctrls[1] = NULL;
2003 rs->sr_err = syncprov_state_ctrl( op, rs, rs->sr_entry,
2004 LDAP_SYNC_ADD, rs->sr_ctrls, 0, 0, NULL );
2005 } else if ( rs->sr_type == REP_RESULT && rs->sr_err == LDAP_SUCCESS ) {
2006 struct berval cookie;
2008 if ( ss->ss_flags & SS_CHANGED ) {
2009 slap_compose_sync_cookie( op, &cookie, ss->ss_ctxcsn,
2010 srs->sr_state.rid, srs->sr_state.sid );
2012 Debug( LDAP_DEBUG_SYNC, "syncprov_search_response: cookie=%s\n", cookie.bv_val, 0, 0 );
2015 /* Is this a regular refresh?
2016 * Note: refresh never gets here if there were no changes
2019 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
2021 rs->sr_ctrls[1] = NULL;
2022 rs->sr_err = syncprov_done_ctrl( op, rs, rs->sr_ctrls,
2023 0, 1, &cookie, ( ss->ss_flags & SS_PRESENT ) ? LDAP_SYNC_REFRESH_PRESENTS :
2024 LDAP_SYNC_REFRESH_DELETES );
2025 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
2027 /* It's RefreshAndPersist, transition to Persist phase */
2028 syncprov_sendinfo( op, rs, ( ss->ss_flags & SS_PRESENT ) ?
2029 LDAP_TAG_SYNC_REFRESH_PRESENT : LDAP_TAG_SYNC_REFRESH_DELETE,
2030 ( ss->ss_flags & SS_CHANGED ) ? &cookie : NULL,
2032 if ( ss->ss_flags & SS_CHANGED )
2033 op->o_tmpfree( cookie.bv_val, op->o_tmpmemctx );
2035 /* Detach this Op from frontend control */
2036 ldap_pvt_thread_mutex_lock( &ss->ss_so->s_mutex );
2038 /* Turn off the refreshing flag */
2039 ss->ss_so->s_flags ^= PS_IS_REFRESHING;
2041 syncprov_detach_op( op, ss->ss_so, on );
2043 /* If there are queued responses, fire them off */
2044 if ( ss->ss_so->s_res )
2045 syncprov_qstart( ss->ss_so );
2046 ldap_pvt_thread_mutex_unlock( &ss->ss_so->s_mutex );
2048 return LDAP_SUCCESS;
2052 return SLAP_CB_CONTINUE;
2056 syncprov_op_search( Operation *op, SlapReply *rs )
2058 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2059 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2061 int gotstate = 0, changed = 0, do_present = 0;
2062 syncops *sop = NULL;
2066 int i, *sids, numcsns;
2067 struct berval mincsn;
2069 if ( !(op->o_sync_mode & SLAP_SYNC_REFRESH) ) return SLAP_CB_CONTINUE;
2071 if ( op->ors_deref & LDAP_DEREF_SEARCHING ) {
2072 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "illegal value for derefAliases" );
2076 srs = op->o_controls[slap_cids.sc_LDAPsync];
2077 op->o_managedsait = SLAP_CONTROL_NONCRITICAL;
2079 /* If this is a persistent search, set it up right away */
2080 if ( op->o_sync_mode & SLAP_SYNC_PERSIST ) {
2090 so.s_flags = PS_IS_REFRESHING | PS_FIND_BASE;
2091 /* syncprov_findbase expects to be called as a callback... */
2092 sc.sc_private = &opc;
2094 ldap_pvt_thread_mutex_init( &so.s_mutex );
2095 cb = op->o_callback;
2096 op->o_callback = ≻
2097 rs->sr_err = syncprov_findbase( op, &fc );
2098 op->o_callback = cb;
2099 ldap_pvt_thread_mutex_destroy( &so.s_mutex );
2101 if ( rs->sr_err != LDAP_SUCCESS ) {
2102 send_ldap_result( op, rs );
2105 sop = ch_malloc( sizeof( syncops ));
2107 ldap_pvt_thread_mutex_init( &sop->s_mutex );
2108 sop->s_rid = srs->sr_state.rid;
2109 sop->s_sid = srs->sr_state.sid;
2112 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
2113 sop->s_next = si->si_ops;
2115 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
2118 /* snapshot the ctxcsn */
2119 ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
2120 numcsns = si->si_numcsns;
2122 ber_bvarray_dup_x( &ctxcsn, si->si_ctxcsn, op->o_tmpmemctx );
2123 sids = op->o_tmpalloc( numcsns * sizeof(int), op->o_tmpmemctx );
2124 for ( i=0; i<numcsns; i++ )
2125 sids[i] = si->si_sids[i];
2130 ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
2132 /* If we have a cookie, handle the PRESENT lookups */
2133 if ( srs->sr_state.ctxcsn ) {
2137 /* If we don't have any CSN of our own yet, pretend nothing
2143 if ( !si->si_nopres )
2144 do_present = SS_PRESENT;
2146 /* If there are SIDs we don't recognize in the cookie, drop them */
2147 for (i=0; i<srs->sr_state.numcsns; ) {
2148 for (j=0; j<numcsns; j++) {
2149 if ( srs->sr_state.sids[i] == sids[j] ) {
2154 if ( j == numcsns ) {
2155 struct berval tmp = srs->sr_state.ctxcsn[i];
2156 j = srs->sr_state.numcsns - 1;
2157 srs->sr_state.ctxcsn[i] = srs->sr_state.ctxcsn[j];
2159 srs->sr_state.ctxcsn[j] = tmp;
2160 srs->sr_state.numcsns = j;
2161 srs->sr_state.sids[i] = srs->sr_state.sids[j];
2167 /* Find the smallest CSN */
2168 mincsn = srs->sr_state.ctxcsn[0];
2169 for ( i=1; i<srs->sr_state.numcsns; i++ ) {
2170 if ( ber_bvcmp( &mincsn, &srs->sr_state.ctxcsn[i] ) > 0 )
2171 mincsn = srs->sr_state.ctxcsn[i];
2174 /* If nothing has changed, shortcut it */
2175 if ( srs->sr_state.numcsns == numcsns ) {
2177 for ( i=0; i<srs->sr_state.numcsns; i++ ) {
2178 for ( j=0; j<numcsns; j++ ) {
2179 if ( srs->sr_state.sids[i] != sids[j] )
2181 if ( !bvmatch( &srs->sr_state.ctxcsn[i], &ctxcsn[j] ))
2182 changed = SS_CHANGED;
2190 no_change: if ( !(op->o_sync_mode & SLAP_SYNC_PERSIST) ) {
2191 LDAPControl *ctrls[2];
2195 syncprov_done_ctrl( op, rs, ctrls, 0, 0,
2196 NULL, LDAP_SYNC_REFRESH_DELETES );
2197 rs->sr_ctrls = ctrls;
2198 rs->sr_err = LDAP_SUCCESS;
2199 send_ldap_result( op, rs );
2200 rs->sr_ctrls = NULL;
2206 /* Do we have a sessionlog for this search? */
2209 ldap_pvt_thread_mutex_lock( &sl->sl_mutex );
2210 /* Are there any log entries, and is the consumer state
2211 * present in the session log?
2213 if ( sl->sl_num > 0 && ber_bvcmp( &mincsn, &sl->sl_mincsn ) >= 0 ) {
2215 /* mutex is unlocked in playlog */
2216 syncprov_playlog( op, rs, sl, srs, ctxcsn, numcsns, sids );
2218 ldap_pvt_thread_mutex_unlock( &sl->sl_mutex );
2221 /* Is the CSN still present in the database? */
2222 if ( syncprov_findcsn( op, FIND_CSN ) != LDAP_SUCCESS ) {
2223 /* No, so a reload is required */
2224 /* the 2.2 consumer doesn't send this hint */
2225 if ( si->si_usehint && srs->sr_rhint == 0 ) {
2227 ber_bvarray_free_x( ctxcsn, op->o_tmpmemctx );
2229 op->o_tmpfree( sids, op->o_tmpmemctx );
2230 send_ldap_error( op, rs, LDAP_SYNC_REFRESH_REQUIRED, "sync cookie is stale" );
2235 /* If changed and doing Present lookup, send Present UUIDs */
2236 if ( do_present && syncprov_findcsn( op, FIND_PRESENT ) !=
2239 ber_bvarray_free_x( ctxcsn, op->o_tmpmemctx );
2241 op->o_tmpfree( sids, op->o_tmpmemctx );
2242 send_ldap_result( op, rs );
2247 /* No consumer state, assume something has changed */
2248 changed = SS_CHANGED;
2252 /* Append CSN range to search filter, save original filter
2253 * for persistent search evaluation
2256 sop->s_filterstr= op->ors_filterstr;
2259 /* If something changed, find the changes */
2260 if ( gotstate && changed ) {
2261 Filter *fand, *fava;
2263 fand = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2264 fand->f_choice = LDAP_FILTER_AND;
2265 fand->f_next = NULL;
2266 fava = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
2268 fava->f_choice = LDAP_FILTER_GE;
2269 fava->f_ava = op->o_tmpalloc( sizeof(AttributeAssertion), op->o_tmpmemctx );
2270 fava->f_ava->aa_desc = slap_schema.si_ad_entryCSN;
2271 #ifdef LDAP_COMP_MATCH
2272 fava->f_ava->aa_cf = NULL;
2274 ber_dupbv_x( &fava->f_ava->aa_value, &mincsn, op->o_tmpmemctx );
2275 fava->f_next = op->ors_filter;
2276 op->ors_filter = fand;
2277 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
2279 sop->s_flags |= PS_FIX_FILTER;
2282 /* Let our callback add needed info to returned entries */
2283 cb = op->o_tmpcalloc(1, sizeof(slap_callback)+sizeof(searchstate), op->o_tmpmemctx);
2284 ss = (searchstate *)(cb+1);
2287 ss->ss_flags = do_present | changed;
2288 ss->ss_ctxcsn = ctxcsn;
2289 ss->ss_numcsns = numcsns;
2291 cb->sc_response = syncprov_search_response;
2292 cb->sc_cleanup = syncprov_search_cleanup;
2293 cb->sc_private = ss;
2294 cb->sc_next = op->o_callback;
2295 op->o_callback = cb;
2297 /* If this is a persistent search and no changes were reported during
2298 * the refresh phase, just invoke the response callback to transition
2299 * us into persist phase
2302 rs->sr_err = LDAP_SUCCESS;
2303 rs->sr_nentries = 0;
2304 send_ldap_result( op, rs );
2307 return SLAP_CB_CONTINUE;
2311 syncprov_operational(
2315 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
2316 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2318 if ( rs->sr_entry &&
2319 dn_match( &rs->sr_entry->e_nname, op->o_bd->be_nsuffix )) {
2321 if ( SLAP_OPATTRS( rs->sr_attr_flags ) ||
2322 ad_inlist( slap_schema.si_ad_contextCSN, rs->sr_attrs )) {
2323 Attribute *a, **ap = NULL;
2325 for ( a=rs->sr_entry->e_attrs; a; a=a->a_next ) {
2326 if ( a->a_desc == slap_schema.si_ad_contextCSN )
2330 ldap_pvt_thread_rdwr_rlock( &si->si_csn_rwlock );
2331 if ( si->si_ctxcsn ) {
2333 for ( ap = &rs->sr_operational_attrs; *ap;
2334 ap=&(*ap)->a_next );
2336 a = attr_alloc( slap_schema.si_ad_contextCSN );
2341 if ( !rs->sr_flags & REP_ENTRY_MODIFIABLE ) {
2342 rs->sr_entry = entry_dup( rs->sr_entry );
2344 REP_ENTRY_MODIFIABLE|REP_ENTRY_MUSTBEFREED;
2345 a = attr_find( rs->sr_entry->e_attrs,
2346 slap_schema.si_ad_contextCSN );
2348 if ( a->a_nvals != a->a_vals ) {
2349 ber_bvarray_free( a->a_nvals );
2352 ber_bvarray_free( a->a_vals );
2356 attr_valadd( a, si->si_ctxcsn, si->si_ctxcsn, si->si_numcsns );
2358 ldap_pvt_thread_rdwr_runlock( &si->si_csn_rwlock );
2361 return SLAP_CB_CONTINUE;
2371 static ConfigDriver sp_cf_gen;
2373 static ConfigTable spcfg[] = {
2374 { "syncprov-checkpoint", "ops> <minutes", 3, 3, 0, ARG_MAGIC|SP_CHKPT,
2375 sp_cf_gen, "( OLcfgOvAt:1.1 NAME 'olcSpCheckpoint' "
2376 "DESC 'ContextCSN checkpoint interval in ops and minutes' "
2377 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
2378 { "syncprov-sessionlog", "ops", 2, 2, 0, ARG_INT|ARG_MAGIC|SP_SESSL,
2379 sp_cf_gen, "( OLcfgOvAt:1.2 NAME 'olcSpSessionlog' "
2380 "DESC 'Session log size in ops' "
2381 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
2382 { "syncprov-nopresent", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_NOPRES,
2383 sp_cf_gen, "( OLcfgOvAt:1.3 NAME 'olcSpNoPresent' "
2384 "DESC 'Omit Present phase processing' "
2385 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2386 { "syncprov-reloadhint", NULL, 2, 2, 0, ARG_ON_OFF|ARG_MAGIC|SP_USEHINT,
2387 sp_cf_gen, "( OLcfgOvAt:1.4 NAME 'olcSpReloadHint' "
2388 "DESC 'Observe Reload Hint in Request control' "
2389 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
2390 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
2393 static ConfigOCs spocs[] = {
2394 { "( OLcfgOvOc:1.1 "
2395 "NAME 'olcSyncProvConfig' "
2396 "DESC 'SyncRepl Provider configuration' "
2397 "SUP olcOverlayConfig "
2398 "MAY ( olcSpCheckpoint $ olcSpSessionlog $ olcSpNoPresent ) )",
2399 Cft_Overlay, spcfg },
2404 sp_cf_gen(ConfigArgs *c)
2406 slap_overinst *on = (slap_overinst *)c->bi;
2407 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2410 if ( c->op == SLAP_CONFIG_EMIT ) {
2411 switch ( c->type ) {
2413 if ( si->si_chkops || si->si_chktime ) {
2415 bv.bv_len = sprintf( c->cr_msg, "%d %d",
2416 si->si_chkops, si->si_chktime );
2417 bv.bv_val = c->cr_msg;
2418 value_add_one( &c->rvalue_vals, &bv );
2424 if ( si->si_logs ) {
2425 c->value_int = si->si_logs->sl_size;
2431 if ( si->si_nopres ) {
2438 if ( si->si_usehint ) {
2446 } else if ( c->op == LDAP_MOD_DELETE ) {
2447 switch ( c->type ) {
2454 si->si_logs->sl_size = 0;
2456 rc = LDAP_NO_SUCH_ATTRIBUTE;
2459 if ( si->si_nopres )
2462 rc = LDAP_NO_SUCH_ATTRIBUTE;
2465 if ( si->si_usehint )
2468 rc = LDAP_NO_SUCH_ATTRIBUTE;
2473 switch ( c->type ) {
2475 if ( lutil_atoi( &si->si_chkops, c->argv[1] ) != 0 ) {
2476 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s unable to parse checkpoint ops # \"%s\"",
2477 c->argv[0], c->argv[1] );
2478 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2479 "%s: %s\n", c->log, c->cr_msg, 0 );
2480 return ARG_BAD_CONF;
2482 if ( si->si_chkops <= 0 ) {
2483 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s invalid checkpoint ops # \"%d\"",
2484 c->argv[0], si->si_chkops );
2485 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2486 "%s: %s\n", c->log, c->cr_msg, 0 );
2487 return ARG_BAD_CONF;
2489 if ( lutil_atoi( &si->si_chktime, c->argv[2] ) != 0 ) {
2490 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s unable to parse checkpoint time \"%s\"",
2491 c->argv[0], c->argv[1] );
2492 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2493 "%s: %s\n", c->log, c->cr_msg, 0 );
2494 return ARG_BAD_CONF;
2496 if ( si->si_chktime <= 0 ) {
2497 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s invalid checkpoint time \"%d\"",
2498 c->argv[0], si->si_chkops );
2499 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2500 "%s: %s\n", c->log, c->cr_msg, 0 );
2501 return ARG_BAD_CONF;
2503 si->si_chktime *= 60;
2507 int size = c->value_int;
2510 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s size %d is negative",
2512 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
2513 "%s: %s\n", c->log, c->cr_msg, 0 );
2514 return ARG_BAD_CONF;
2518 sl = ch_malloc( sizeof( sessionlog ) + LDAP_LUTIL_CSNSTR_BUFSIZE );
2519 sl->sl_mincsn.bv_val = (char *)(sl+1);
2520 sl->sl_mincsn.bv_len = 0;
2522 sl->sl_head = sl->sl_tail = NULL;
2523 ldap_pvt_thread_mutex_init( &sl->sl_mutex );
2530 si->si_nopres = c->value_int;
2533 si->si_usehint = c->value_int;
2539 /* ITS#3456 we cannot run this search on the main thread, must use a
2540 * child thread in order to insure we have a big enough stack.
2547 syncprov_findcsn( ptr, FIND_MAXCSN );
2551 /* Read any existing contextCSN from the underlying db.
2552 * Then search for any entries newer than that. If no value exists,
2553 * just generate it. Cache whatever result.
2561 slap_overinst *on = (slap_overinst *) be->bd_info;
2562 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2564 Connection conn = { 0 };
2565 OperationBuffer opbuf;
2570 void *thrctx = NULL;
2572 if ( !SLAP_LASTMOD( be )) {
2573 Debug( LDAP_DEBUG_ANY,
2574 "syncprov_db_open: invalid config, lastmod must be enabled\n", 0, 0, 0 );
2578 if ( slapMode & SLAP_TOOL_MODE ) {
2582 rc = overlay_register_control( be, LDAP_CONTROL_SYNC );
2587 thrctx = ldap_pvt_thread_pool_context();
2588 connection_fake_init( &conn, &opbuf, thrctx );
2591 op->o_dn = be->be_rootdn;
2592 op->o_ndn = be->be_rootndn;
2594 rc = overlay_entry_get_ov( op, be->be_nsuffix, NULL,
2595 slap_schema.si_ad_contextCSN, 0, &e, on );
2598 ldap_pvt_thread_t tid;
2600 a = attr_find( e->e_attrs, slap_schema.si_ad_contextCSN );
2602 ber_bvarray_dup_x( &si->si_ctxcsn, a->a_vals, NULL );
2603 si->si_numcsns = a->a_numvals;
2604 si->si_sids = slap_parse_csn_sids( si->si_ctxcsn, a->a_numvals, NULL );
2606 overlay_entry_release_ov( op, e, 0, on );
2607 if ( si->si_ctxcsn ) {
2608 op->o_req_dn = be->be_suffix[0];
2609 op->o_req_ndn = be->be_nsuffix[0];
2610 op->ors_scope = LDAP_SCOPE_SUBTREE;
2611 ldap_pvt_thread_create( &tid, 0, syncprov_db_otask, op );
2612 ldap_pvt_thread_join( tid, NULL );
2616 /* Didn't find a contextCSN, should we generate one? */
2617 if ( !si->si_ctxcsn ) {
2618 char csnbuf[ LDAP_LUTIL_CSNSTR_BUFSIZE ];
2621 if ( SLAP_SYNC_SHADOW( op->o_bd )) {
2622 /* If we're also a consumer, then don't generate anything.
2623 * Wait for our provider to send it to us, or for a local
2624 * modify if we have multimaster.
2628 csn.bv_val = csnbuf;
2629 csn.bv_len = sizeof( csnbuf );
2630 slap_get_csn( op, &csn, 0 );
2631 value_add_one( &si->si_ctxcsn, &csn );
2633 si->si_sids = ch_malloc( sizeof(int) );
2634 si->si_sids[0] = slap_serverID;
2636 /* make sure we do a checkpoint on close */
2641 op->o_bd->bd_info = (BackendInfo *)on;
2645 /* Write the current contextCSN into the underlying db.
2653 slap_overinst *on = (slap_overinst *) be->bd_info;
2654 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2656 if ( slapMode & SLAP_TOOL_MODE ) {
2659 if ( si->si_numops ) {
2660 Connection conn = {0};
2661 OperationBuffer opbuf;
2663 SlapReply rs = {REP_RESULT};
2666 thrctx = ldap_pvt_thread_pool_context();
2667 connection_fake_init( &conn, &opbuf, thrctx );
2670 op->o_dn = be->be_rootdn;
2671 op->o_ndn = be->be_rootndn;
2672 syncprov_checkpoint( op, &rs, on );
2684 slap_overinst *on = (slap_overinst *)be->bd_info;
2685 syncprov_info_t *si;
2687 if ( SLAP_ISGLOBALOVERLAY( be ) ) {
2688 Debug( LDAP_DEBUG_ANY,
2689 "syncprov must be instantiated within a database.\n",
2694 si = ch_calloc(1, sizeof(syncprov_info_t));
2695 on->on_bi.bi_private = si;
2696 ldap_pvt_thread_rdwr_init( &si->si_csn_rwlock );
2697 ldap_pvt_thread_mutex_init( &si->si_ops_mutex );
2698 ldap_pvt_thread_mutex_init( &si->si_mods_mutex );
2700 csn_anlist[0].an_desc = slap_schema.si_ad_entryCSN;
2701 csn_anlist[0].an_name = slap_schema.si_ad_entryCSN->ad_cname;
2702 csn_anlist[1].an_desc = slap_schema.si_ad_entryUUID;
2703 csn_anlist[1].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2705 uuid_anlist[0].an_desc = slap_schema.si_ad_entryUUID;
2706 uuid_anlist[0].an_name = slap_schema.si_ad_entryUUID->ad_cname;
2712 syncprov_db_destroy(
2717 slap_overinst *on = (slap_overinst *)be->bd_info;
2718 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
2721 if ( si->si_logs ) {
2722 slog_entry *se = si->si_logs->sl_head;
2725 slog_entry *se_next = se->se_next;
2730 ch_free( si->si_logs );
2732 if ( si->si_ctxcsn )
2733 ber_bvarray_free( si->si_ctxcsn );
2735 ch_free( si->si_sids );
2736 ldap_pvt_thread_mutex_destroy( &si->si_mods_mutex );
2737 ldap_pvt_thread_mutex_destroy( &si->si_ops_mutex );
2738 ldap_pvt_thread_rdwr_destroy( &si->si_csn_rwlock );
2745 static int syncprov_parseCtrl (
2751 BerElementBuffer berbuf;
2752 BerElement *ber = (BerElement *)&berbuf;
2755 struct berval cookie = BER_BVNULL;
2759 if ( op->o_sync != SLAP_CONTROL_NONE ) {
2760 rs->sr_text = "Sync control specified multiple times";
2761 return LDAP_PROTOCOL_ERROR;
2764 if ( op->o_pagedresults != SLAP_CONTROL_NONE ) {
2765 rs->sr_text = "Sync control specified with pagedResults control";
2766 return LDAP_PROTOCOL_ERROR;
2769 if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
2770 rs->sr_text = "Sync control value is absent";
2771 return LDAP_PROTOCOL_ERROR;
2774 if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
2775 rs->sr_text = "Sync control value is empty";
2776 return LDAP_PROTOCOL_ERROR;
2779 /* Parse the control value
2780 * syncRequestValue ::= SEQUENCE {
2785 * refreshAndPersist (3)
2787 * cookie syncCookie OPTIONAL
2791 ber_init2( ber, &ctrl->ldctl_value, 0 );
2793 if ( (tag = ber_scanf( ber, "{i" /*}*/, &mode )) == LBER_ERROR ) {
2794 rs->sr_text = "Sync control : mode decoding error";
2795 return LDAP_PROTOCOL_ERROR;
2799 case LDAP_SYNC_REFRESH_ONLY:
2800 mode = SLAP_SYNC_REFRESH;
2802 case LDAP_SYNC_REFRESH_AND_PERSIST:
2803 mode = SLAP_SYNC_REFRESH_AND_PERSIST;
2806 rs->sr_text = "Sync control : unknown update mode";
2807 return LDAP_PROTOCOL_ERROR;
2810 tag = ber_peek_tag( ber, &len );
2812 if ( tag == LDAP_TAG_SYNC_COOKIE ) {
2813 if (( ber_scanf( ber, /*{*/ "m", &cookie )) == LBER_ERROR ) {
2814 rs->sr_text = "Sync control : cookie decoding error";
2815 return LDAP_PROTOCOL_ERROR;
2817 tag = ber_peek_tag( ber, &len );
2819 if ( tag == LDAP_TAG_RELOAD_HINT ) {
2820 if (( ber_scanf( ber, /*{*/ "b", &rhint )) == LBER_ERROR ) {
2821 rs->sr_text = "Sync control : rhint decoding error";
2822 return LDAP_PROTOCOL_ERROR;
2825 if (( ber_scanf( ber, /*{*/ "}")) == LBER_ERROR ) {
2826 rs->sr_text = "Sync control : decoding error";
2827 return LDAP_PROTOCOL_ERROR;
2829 sr = op->o_tmpcalloc( 1, sizeof(struct sync_control), op->o_tmpmemctx );
2830 sr->sr_rhint = rhint;
2831 if (!BER_BVISNULL(&cookie)) {
2832 ber_dupbv_x( &sr->sr_state.octet_str, &cookie, op->o_tmpmemctx );
2833 /* If parse fails, pretend no cookie was sent */
2834 if ( slap_parse_sync_cookie( &sr->sr_state, op->o_tmpmemctx ) ||
2835 sr->sr_state.rid == -1 ) {
2836 if ( sr->sr_state.ctxcsn ) {
2837 ber_bvarray_free_x( sr->sr_state.ctxcsn, op->o_tmpmemctx );
2838 sr->sr_state.ctxcsn = NULL;
2840 sr->sr_state.numcsns = 0;
2844 op->o_controls[slap_cids.sc_LDAPsync] = sr;
2846 op->o_sync = ctrl->ldctl_iscritical
2847 ? SLAP_CONTROL_CRITICAL
2848 : SLAP_CONTROL_NONCRITICAL;
2850 op->o_sync_mode |= mode; /* o_sync_mode shares o_sync */
2852 return LDAP_SUCCESS;
2855 /* This overlay is set up for dynamic loading via moduleload. For static
2856 * configuration, you'll need to arrange for the slap_overinst to be
2857 * initialized and registered by some other function inside slapd.
2860 static slap_overinst syncprov;
2863 syncprov_initialize()
2867 rc = register_supported_control( LDAP_CONTROL_SYNC,
2868 SLAP_CTRL_SEARCH, NULL,
2869 syncprov_parseCtrl, &slap_cids.sc_LDAPsync );
2870 if ( rc != LDAP_SUCCESS ) {
2871 Debug( LDAP_DEBUG_ANY,
2872 "syncprov_init: Failed to register control %d\n", rc, 0, 0 );
2876 syncprov.on_bi.bi_type = "syncprov";
2877 syncprov.on_bi.bi_db_init = syncprov_db_init;
2878 syncprov.on_bi.bi_db_destroy = syncprov_db_destroy;
2879 syncprov.on_bi.bi_db_open = syncprov_db_open;
2880 syncprov.on_bi.bi_db_close = syncprov_db_close;
2882 syncprov.on_bi.bi_op_abandon = syncprov_op_abandon;
2883 syncprov.on_bi.bi_op_cancel = syncprov_op_abandon;
2885 syncprov.on_bi.bi_op_add = syncprov_op_mod;
2886 syncprov.on_bi.bi_op_compare = syncprov_op_compare;
2887 syncprov.on_bi.bi_op_delete = syncprov_op_mod;
2888 syncprov.on_bi.bi_op_modify = syncprov_op_mod;
2889 syncprov.on_bi.bi_op_modrdn = syncprov_op_mod;
2890 syncprov.on_bi.bi_op_search = syncprov_op_search;
2891 syncprov.on_bi.bi_extended = syncprov_op_extended;
2892 syncprov.on_bi.bi_operational = syncprov_operational;
2894 syncprov.on_bi.bi_cf_ocs = spocs;
2896 generic_filter.f_desc = slap_schema.si_ad_objectClass;
2898 rc = config_register_schema( spcfg, spocs );
2899 if ( rc ) return rc;
2901 return overlay_register( &syncprov );
2904 #if SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC
2906 init_module( int argc, char *argv[] )
2908 return syncprov_initialize();
2910 #endif /* SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC */
2912 #endif /* defined(SLAPD_OVER_SYNCPROV) */