1 /* syncprov.c - syncrepl provider */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 2004 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
11 * A copy of this license is available in the file LICENSE in the
12 * top-level directory of the distribution or, alternatively, at
13 * <http://www.OpenLDAP.org/license.html>.
16 * This work was initially developed by Howard Chu for inclusion in
22 #ifdef SLAPD_OVER_SYNCPROV
24 #include <ac/string.h>
28 /* A modify request on a particular entry */
29 typedef struct modinst {
30 struct modinst *mi_next;
34 typedef struct modtarget {
35 struct modinst *mt_mods;
36 struct modinst *mt_tail;
38 ldap_pvt_thread_mutex_t mt_mutex;
41 /* A queued result of a persistent search */
42 typedef struct syncres {
43 struct syncres *s_next;
52 /* Record of a persistent search */
53 typedef struct syncops {
54 struct syncops *s_next;
55 struct berval s_base; /* ndn of search base */
56 ID s_eid; /* entryID of search base */
57 Operation *s_op; /* search op */
60 struct berval s_filterstr;
61 int s_flags; /* search status */
62 int s_inuse; /* reference count */
63 struct syncres *s_res;
64 struct syncres *s_restail;
65 ldap_pvt_thread_mutex_t s_mutex;
68 /* A received sync control */
69 typedef struct sync_control {
70 struct sync_cookie sr_state;
74 #if 0 /* moved back to slap.h */
75 #define o_sync o_ctrlflag[slap_cids.sc_LDAPsync]
77 /* o_sync_mode uses data bits of o_sync */
78 #define o_sync_mode o_ctrlflag[slap_cids.sc_LDAPsync]
80 #define SLAP_SYNC_NONE (LDAP_SYNC_NONE<<SLAP_CONTROL_SHIFT)
81 #define SLAP_SYNC_REFRESH (LDAP_SYNC_REFRESH_ONLY<<SLAP_CONTROL_SHIFT)
82 #define SLAP_SYNC_PERSIST (LDAP_SYNC_RESERVED<<SLAP_CONTROL_SHIFT)
83 #define SLAP_SYNC_REFRESH_AND_PERSIST (LDAP_SYNC_REFRESH_AND_PERSIST<<SLAP_CONTROL_SHIFT)
85 #define PS_IS_REFRESHING 0x01
87 /* Record of which searches matched at premodify step */
88 typedef struct syncmatches {
89 struct syncmatches *sm_next;
93 /* The main state for this overlay */
94 typedef struct syncprov_info_t {
96 struct berval si_ctxcsn; /* ldapsync context */
97 int si_chkops; /* checkpointing info */
99 int si_numops; /* number of ops since last checkpoint */
100 time_t si_chklast; /* time of last checkpoint */
101 Avlnode *si_mods; /* entries being modified */
102 ldap_pvt_thread_mutex_t si_csn_mutex;
103 ldap_pvt_thread_mutex_t si_ops_mutex;
104 ldap_pvt_thread_rdwr_t si_mods_rwlock;
105 char si_ctxcsnbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
108 typedef struct opcookie {
110 syncmatches *smatches;
111 struct berval sdn; /* DN of entry, for deletes */
113 struct berval suuid; /* UUID of entry */
114 struct berval sctxcsn;
115 int sreference; /* Is the entry a reference? */
118 typedef struct fbase_cookie {
119 struct berval *fdn; /* DN of a modified entry, for scope testing */
120 syncops *fss; /* persistent search we're testing against */
121 int fbase; /* if TRUE we found the search base and it's still valid */
122 int fscope; /* if TRUE then fdn is within the psearch scope */
125 static AttributeName csn_anlist[2];
126 static AttributeName uuid_anlist[2];
128 /* Build a LDAPsync intermediate state control */
134 int entry_sync_state,
138 struct berval *cookie )
143 const char *text = NULL;
145 BerElementBuffer berbuf;
146 BerElement *ber = (BerElement *)&berbuf;
148 struct berval entryuuid_bv = BER_BVNULL;
150 ber_init2( ber, 0, LBER_USE_DER );
151 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
153 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
155 /* NOTE: this function is called also for referrals;
156 * in this case, e is null, right? */
158 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
159 AttributeDescription *desc = a->a_desc;
160 if ( desc == slap_schema.si_ad_entryUUID ) {
161 entryuuid_bv = a->a_nvals[0];
166 if ( send_cookie && cookie ) {
167 ber_printf( ber, "{eOON}",
168 entry_sync_state, &entryuuid_bv, cookie );
170 ber_printf( ber, "{eON}",
171 entry_sync_state, &entryuuid_bv );
175 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_STATE;
176 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
177 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
182 Debug( LDAP_DEBUG_TRACE,
183 "slap_build_sync_ctrl: ber_flatten2 failed\n",
185 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
192 /* Build a LDAPsync final state control */
200 struct berval *cookie,
204 BerElementBuffer berbuf;
205 BerElement *ber = (BerElement *)&berbuf;
207 ber_init2( ber, NULL, LBER_USE_DER );
208 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
210 ctrls[num_ctrls] = op->o_tmpalloc( sizeof ( LDAPControl ), op->o_tmpmemctx );
212 ber_printf( ber, "{" );
213 if ( send_cookie && cookie ) {
214 ber_printf( ber, "O", cookie );
216 if ( refreshDeletes == LDAP_SYNC_REFRESH_DELETES ) {
217 ber_printf( ber, "b", refreshDeletes );
219 ber_printf( ber, "N}" );
221 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_DONE;
222 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
223 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
228 Debug( LDAP_DEBUG_TRACE,
229 "syncprov_done_ctrl: ber_flatten2 failed\n",
231 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
239 /* Generate state based on session log - not implemented yet */
241 syncprov_state_ctrl_from_slog(
244 struct slog_entry *slog_e,
245 int entry_sync_state,
249 struct berval *cookie)
254 const char *text = NULL;
256 BerElementBuffer berbuf;
257 BerElement *ber = (BerElement *)&berbuf;
259 struct berval entryuuid_bv = BER_BVNULL;
261 ber_init2( ber, NULL, LBER_USE_DER );
262 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
264 ctrls[num_ctrls] = ch_malloc ( sizeof ( LDAPControl ) );
266 entryuuid_bv = slog_e->sl_uuid;
268 if ( send_cookie && cookie ) {
269 ber_printf( ber, "{eOON}",
270 entry_sync_state, &entryuuid_bv, cookie );
272 ber_printf( ber, "{eON}",
273 entry_sync_state, &entryuuid_bv );
276 ctrls[num_ctrls]->ldctl_oid = LDAP_CONTROL_SYNC_STATE;
277 ctrls[num_ctrls]->ldctl_iscritical = (op->o_sync == SLAP_CONTROL_CRITICAL);
278 ret = ber_flatten2( ber, &ctrls[num_ctrls]->ldctl_value, 1 );
283 Debug( LDAP_DEBUG_TRACE,
284 "slap_build_sync_ctrl: ber_flatten2 failed\n",
286 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
299 struct berval *cookie,
304 BerElementBuffer berbuf;
305 BerElement *ber = (BerElement *)&berbuf;
306 struct berval rspdata;
310 ber_init2( ber, NULL, LBER_USE_DER );
311 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
315 case LDAP_TAG_SYNC_NEW_COOKIE:
316 ber_printf( ber, "tO", type, cookie );
318 case LDAP_TAG_SYNC_REFRESH_DELETE:
319 case LDAP_TAG_SYNC_REFRESH_PRESENT:
320 ber_printf( ber, "t{", type );
322 ber_printf( ber, "O", cookie );
324 if ( refreshDone == 0 ) {
325 ber_printf( ber, "b", refreshDone );
327 ber_printf( ber, "N}" );
329 case LDAP_TAG_SYNC_ID_SET:
330 ber_printf( ber, "t{", type );
332 ber_printf( ber, "O", cookie );
334 if ( refreshDeletes == 1 ) {
335 ber_printf( ber, "b", refreshDeletes );
337 ber_printf( ber, "[W]", syncUUIDs );
338 ber_printf( ber, "N}" );
341 Debug( LDAP_DEBUG_TRACE,
342 "syncprov_sendinfo: invalid syncinfo type (%d)\n",
348 ret = ber_flatten2( ber, &rspdata, 0 );
351 Debug( LDAP_DEBUG_TRACE,
352 "syncprov_sendinfo: ber_flatten2 failed\n",
354 send_ldap_error( op, rs, LDAP_OTHER, "internal error" );
358 rs->sr_rspoid = LDAP_SYNC_INFO;
359 rs->sr_rspdata = &rspdata;
360 send_ldap_intermediate( op, rs );
361 rs->sr_rspdata = NULL;
367 /* Find a modtarget in an AVL tree */
369 sp_avl_cmp( const void *c1, const void *c2 )
371 const modtarget *m1, *m2;
375 rc = m1->mt_op->o_req_ndn.bv_len - m2->mt_op->o_req_ndn.bv_len;
378 return ber_bvcmp( &m1->mt_op->o_req_ndn, &m2->mt_op->o_req_ndn );
381 /* syncprov_findbase:
382 * finds the true DN of the base of a search (with alias dereferencing) and
383 * checks to make sure the base entry doesn't get replaced with a different
384 * entry (e.g., swapping trees via ModDN, or retargeting an alias). If a
385 * change is detected, any persistent search on this base must be terminated /
387 * On the first call, we just save the DN and entryID. On subsequent calls
388 * we compare the DN and entryID with the saved values.
391 findbase_cb( Operation *op, SlapReply *rs )
393 slap_callback *sc = op->o_callback;
395 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
396 fbase_cookie *fc = sc->sc_private;
398 /* If no entryID, we're looking for the first time.
399 * Just store whatever we got.
401 if ( fc->fss->s_eid == NOID ) {
403 fc->fss->s_eid = rs->sr_entry->e_id;
404 ber_dupbv( &fc->fss->s_base, &rs->sr_entry->e_nname );
406 } else if ( rs->sr_entry->e_id == fc->fss->s_eid &&
407 dn_match( &rs->sr_entry->e_nname, &fc->fss->s_base )) {
409 /* OK, the DN is the same and the entryID is the same. Now
410 * see if the fdn resides in the scope.
413 switch ( fc->fss->s_op->ors_scope ) {
414 case LDAP_SCOPE_BASE:
415 fc->fscope = dn_match( fc->fdn, &rs->sr_entry->e_nname );
417 case LDAP_SCOPE_ONELEVEL: {
419 dnParent( fc->fdn, &pdn );
420 fc->fscope = dn_match( &pdn, &rs->sr_entry->e_nname );
422 case LDAP_SCOPE_SUBTREE:
423 fc->fscope = dnIsSuffix( fc->fdn, &rs->sr_entry->e_nname );
425 #ifdef LDAP_SCOPE_SUBORDINATE
426 case LDAP_SCOPE_SUBORDINATE:
427 fc->fscope = dnIsSuffix( fc->fdn, &rs->sr_entry->e_nname ) &&
428 !dn_match( fc->fdn, &rs->sr_entry->e_nname );
438 syncprov_findbase( Operation *op, fbase_cookie *fc )
440 opcookie *opc = op->o_callback->sc_private;
441 slap_overinst *on = opc->son;
442 syncprov_info_t *si = on->on_bi.bi_private;
444 slap_callback cb = {0};
446 SlapReply frs = { REP_RESULT };
451 cb.sc_response = findbase_cb;
454 fop.o_sync_mode &= SLAP_CONTROL_MASK; /* turn off sync mode */
455 fop.o_callback = &cb;
456 fop.o_tag = LDAP_REQ_SEARCH;
457 fop.ors_scope = LDAP_SCOPE_BASE;
458 fop.ors_deref = fc->fss->s_op->ors_deref;
460 fop.ors_tlimit = SLAP_NO_LIMIT;
461 fop.ors_attrs = slap_anlist_no_attrs;
462 fop.ors_attrsonly = 1;
463 fop.ors_filter = fc->fss->s_op->ors_filter;
464 fop.ors_filterstr = fc->fss->s_op->ors_filterstr;
466 fop.o_req_ndn = fc->fss->s_op->o_req_ndn;
468 fop.o_bd->bd_info = on->on_info->oi_orig;
469 rc = fop.o_bd->be_search( &fop, &frs );
470 fop.o_bd->bd_info = (BackendInfo *)on;
472 if ( fc->fbase ) return LDAP_SUCCESS;
474 /* If entryID has changed, then the base of this search has
475 * changed. Invalidate the psearch.
477 return LDAP_NO_SUCH_OBJECT;
481 * This function has two different purposes, but they both use a search
482 * that filters on entryCSN so they're combined here.
483 * 1: when the current contextCSN is known and we have a sync cookie, we search
484 * for one entry with CSN <= the cookie CSN. (Used to search for =.) If an
485 * entry is found, the cookie CSN is valid, otherwise it is stale.
487 * 2: during a refresh phase, we search for all entries with CSN <= the cookie
488 * CSN, and generate Present records for them. We always collect this result
489 * in SyncID sets, even if there's only one match.
492 #define FIND_PRESENT 2
495 findcsn_cb( Operation *op, SlapReply *rs )
497 slap_callback *sc = op->o_callback;
499 if ( rs->sr_type == REP_SEARCH && rs->sr_err == LDAP_SUCCESS ) {
500 sc->sc_private = (void *)1;
505 /* Build a list of entryUUIDs for sending in a SyncID set */
507 typedef struct fpres_cookie {
513 findpres_cb( Operation *op, SlapReply *rs )
515 slap_callback *sc = op->o_callback;
516 fpres_cookie *pc = sc->sc_private;
517 int ret = SLAP_CB_CONTINUE;
519 if ( rs->sr_type == REP_SEARCH ) {
520 ret = slap_build_syncUUID_set( op, &pc->uuids, rs->sr_entry );
524 if ( pc->num == SLAP_SYNCUUID_SET_SIZE ) {
525 ret = syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, NULL,
527 ber_bvarray_free_x( pc->uuids, op->o_tmpmemctx );
534 } else if ( rs->sr_type == REP_RESULT ) {
537 ret = syncprov_sendinfo( op, rs, LDAP_TAG_SYNC_ID_SET, NULL,
539 ber_bvarray_free_x( pc->uuids, op->o_tmpmemctx );
549 syncprov_findcsn( Operation *op, int mode )
551 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
552 syncprov_info_t *si = on->on_bi.bi_private;
554 slap_callback cb = {0};
556 SlapReply frs = { REP_RESULT };
557 char buf[LDAP_LUTIL_CSNSTR_BUFSIZE + STRLENOF("(entryCSN<=)")];
558 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
561 AttributeAssertion eq;
563 fpres_cookie pcookie;
565 sync_control *srs = op->o_controls[slap_cids.sc_LDAPsync];
567 if ( srs->sr_state.ctxcsn->bv_len >= LDAP_LUTIL_CSNSTR_BUFSIZE ) {
572 fop.o_sync_mode &= SLAP_CONTROL_MASK; /* turn off sync_mode */
575 if ( mode == FIND_CSN ) {
576 fop.ors_attrsonly = 1;
577 fop.ors_attrs = slap_anlist_no_attrs;
579 cb.sc_private = NULL;
580 cb.sc_response = findcsn_cb;
582 } else if ( mode == FIND_PRESENT ) {
583 fop.ors_attrsonly = 0;
584 fop.ors_attrs = uuid_anlist;
585 fop.ors_slimit = SLAP_NO_LIMIT;
586 /* We want pure entries, not referrals */
587 fop.o_managedsait = SLAP_CONTROL_CRITICAL;
588 cb.sc_private = &pcookie;
589 cb.sc_response = findpres_cb;
591 pcookie.uuids = NULL;
593 cf.f_choice = LDAP_FILTER_LE;
595 cf.f_av_desc = slap_schema.si_ad_entryCSN;
596 cf.f_av_value = *srs->sr_state.ctxcsn;
598 fbuf.bv_len = sprintf( buf, "(entryCSN<=%s)",
599 srs->sr_state.ctxcsn->bv_val );
601 fop.o_callback = &cb;
602 fop.ors_tlimit = SLAP_NO_LIMIT;
603 fop.ors_filter = &cf;
604 fop.ors_filterstr = fbuf;
606 fop.o_bd->bd_info = on->on_info->oi_orig;
607 rc = fop.o_bd->be_search( &fop, &frs );
608 fop.o_bd->bd_info = (BackendInfo *)on;
610 if ( mode == FIND_CSN ) {
611 if ( cb.sc_private ) return LDAP_SUCCESS;
612 } else if ( mode == FIND_PRESENT ) {
616 /* If matching CSN was not found, invalidate the context. */
617 return LDAP_NO_SUCH_OBJECT;
620 /* Queue a persistent search response if still in Refresh stage */
622 syncprov_qresp( opcookie *opc, syncops *so, int mode )
626 sr = ch_malloc(sizeof(syncres) + opc->suuid.bv_len + 1 +
627 opc->sdn.bv_len + 1 + opc->sndn.bv_len + 1 + opc->sctxcsn.bv_len + 1 );
629 sr->s_dn.bv_val = (char *)(sr + 1);
631 sr->s_isreference = opc->sreference;
632 sr->s_ndn.bv_val = lutil_strcopy( sr->s_dn.bv_val, opc->sdn.bv_val );
633 *(sr->s_ndn.bv_val++) = '\0';
634 sr->s_uuid.bv_val = lutil_strcopy( sr->s_ndn.bv_val, opc->sndn.bv_val );
635 *(sr->s_uuid.bv_val++) = '\0';
636 sr->s_csn.bv_val = lutil_strcopy( sr->s_uuid.bv_val, opc->suuid.bv_val );
641 so->s_restail->s_next = sr;
644 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
648 /* Send a persistent search response */
650 syncprov_sendresp( Operation *op, opcookie *opc, syncops *so, Entry *e, int mode, int queue )
652 slap_overinst *on = opc->son;
653 syncprov_info_t *si = on->on_bi.bi_private;
655 SlapReply rs = { REP_SEARCH };
656 LDAPControl *ctrls[2];
657 struct berval cookie;
659 Attribute a_uuid = {0};
660 Operation sop = *so->s_op;
665 sop.o_tmpmemctx = op->o_tmpmemctx;
667 sop.o_controls = op->o_controls;
669 if ( queue && (so->s_flags & PS_IS_REFRESHING) ) {
670 ldap_pvt_thread_mutex_lock( &so->s_mutex );
671 if ( so->s_flags & PS_IS_REFRESHING )
672 return syncprov_qresp( opc, so, mode );
673 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
677 slap_compose_sync_cookie( op, &cookie, &opc->sctxcsn,
678 so->s_sid, so->s_rid );
680 e_uuid.e_attrs = &a_uuid;
681 a_uuid.a_desc = slap_schema.si_ad_entryUUID;
682 a_uuid.a_nvals = &opc->suuid;
683 rs.sr_err = syncprov_state_ctrl( &sop, &rs, &e_uuid,
684 mode, ctrls, 0, 1, &cookie );
690 if ( opc->sreference ) {
691 rs.sr_ref = get_entry_referrals( &sop, e );
692 send_search_reference( &sop, &rs );
693 ber_bvarray_free( rs.sr_ref );
697 case LDAP_SYNC_MODIFY:
698 rs.sr_attrs = sop.ors_attrs;
699 send_search_entry( &sop, &rs );
701 case LDAP_SYNC_DELETE:
702 e_uuid.e_attrs = NULL;
703 e_uuid.e_name = opc->sdn;
704 e_uuid.e_nname = opc->sndn;
705 rs.sr_entry = &e_uuid;
706 if ( opc->sreference ) {
707 struct berval bv = BER_BVNULL;
709 send_search_reference( &sop, &rs );
711 send_search_entry( &sop, &rs );
717 op->o_tmpfree( rs.sr_ctrls[0], op->o_tmpmemctx );
723 syncprov_free_syncop( syncops *so )
725 syncres *sr, *srnext;
727 ldap_pvt_thread_mutex_lock( &so->s_mutex );
729 if ( so->s_inuse > 0 ) {
730 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
733 ldap_pvt_thread_mutex_unlock( &so->s_mutex );
734 filter_free( so->s_op->ors_filter );
736 ch_free( so->s_base.bv_val );
737 for ( sr=so->s_res; sr; sr=srnext ) {
741 ldap_pvt_thread_mutex_destroy( &so->s_mutex );
746 syncprov_drop_psearch( syncops *so )
748 ldap_pvt_thread_mutex_lock( &so->s_op->o_conn->c_mutex );
749 so->s_op->o_conn->c_n_ops_executing--;
750 so->s_op->o_conn->c_n_ops_completed++;
751 ldap_pvt_thread_mutex_unlock( &so->s_op->o_conn->c_mutex );
752 syncprov_free_syncop( so );
756 syncprov_op_abandon( Operation *op, SlapReply *rs )
758 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
759 syncprov_info_t *si = on->on_bi.bi_private;
760 syncops *so, *soprev;
762 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
763 for ( so=si->si_ops, soprev = (syncops *)&si->si_ops; so;
764 soprev=so, so=so->s_next ) {
765 if ( so->s_op->o_connid == op->o_connid &&
766 so->s_op->o_msgid == op->orn_msgid ) {
767 so->s_op->o_abandon = 1;
768 soprev->s_next = so->s_next;
772 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
774 /* Is this really a Cancel exop? */
775 if ( op->o_tag != LDAP_REQ_ABANDON ) {
776 rs->sr_err = LDAP_CANCELLED;
777 send_ldap_result( so->s_op, rs );
779 syncprov_drop_psearch( so );
781 return SLAP_CB_CONTINUE;
784 /* Find which persistent searches are affected by this operation */
786 syncprov_matchops( Operation *op, opcookie *opc, int saveit )
788 slap_overinst *on = opc->son;
789 syncprov_info_t *si = on->on_bi.bi_private;
792 syncops *ss, *sprev, *snext;
798 fc.fdn = &op->o_req_ndn;
800 if ( op->o_tag == LDAP_REQ_MODRDN && !saveit ) {
802 if ( op->orr_nnewSup ) pdn = *op->orr_nnewSup;
803 else dnParent( fc.fdn, &pdn );
804 build_new_dn( &newdn, &pdn, &op->orr_nnewrdn, op->o_tmpmemctx );
807 if ( op->o_tag != LDAP_REQ_ADD ) {
808 op->o_bd->bd_info = (BackendInfo *)on->on_info;
809 rc = be_entry_get_rw( op, fc.fdn, NULL, NULL, 0, &e );
810 op->o_bd->bd_info = (BackendInfo *)on;
817 ber_dupbv_x( &opc->sdn, &e->e_name, op->o_tmpmemctx );
818 ber_dupbv_x( &opc->sndn, &e->e_nname, op->o_tmpmemctx );
819 opc->sreference = is_entry_referral( e );
821 if ( saveit || op->o_tag == LDAP_REQ_ADD ) {
822 a = attr_find( e->e_attrs, slap_schema.si_ad_entryUUID );
824 ber_dupbv_x( &opc->suuid, &a->a_nvals[0], op->o_tmpmemctx );
827 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
828 for (ss = si->si_ops, sprev = (syncops *)&si->si_ops; ss;
829 sprev = ss, ss=snext)
840 /* If the base of the search is missing, signal a refresh */
841 rc = syncprov_findbase( op, &fc );
842 if ( rc != LDAP_SUCCESS ) {
843 SlapReply rs = {REP_RESULT};
844 send_ldap_error( ss->s_op, &rs, LDAP_SYNC_REFRESH_REQUIRED,
845 "search base has changed" );
846 sprev->s_next = snext;
847 syncprov_drop_psearch( ss );
851 /* If we're sending results now, look for this op in old matches */
854 for ( sm=opc->smatches, old=(syncmatches *)&opc->smatches; sm;
855 old=sm, sm=sm->sm_next ) {
856 if ( sm->sm_op == ss ) {
858 old->sm_next = sm->sm_next;
859 op->o_tmpfree( sm, op->o_tmpmemctx );
865 /* check if current o_req_dn is in scope and matches filter */
866 if ( fc.fscope && test_filter( op, e, ss->s_op->ors_filter ) ==
867 LDAP_COMPARE_TRUE ) {
869 sm = op->o_tmpalloc( sizeof(syncmatches), op->o_tmpmemctx );
870 sm->sm_next = opc->smatches;
875 /* if found send UPDATE else send ADD */
876 syncprov_sendresp( op, opc, ss, e,
877 found ? LDAP_SYNC_MODIFY : LDAP_SYNC_ADD, 1 );
879 } else if ( !saveit && found ) {
881 syncprov_sendresp( op, opc, ss, NULL, LDAP_SYNC_DELETE, 1 );
884 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
885 if ( op->o_tag != LDAP_REQ_ADD ) {
886 op->o_bd->bd_info = (BackendInfo *)on->on_info;
887 be_entry_release_r( op, e );
888 op->o_bd->bd_info = (BackendInfo *)on;
893 syncprov_op_cleanup( Operation *op, SlapReply *rs )
895 slap_callback *cb = op->o_callback;
896 opcookie *opc = cb->sc_private;
897 slap_overinst *on = opc->son;
898 syncprov_info_t *si = on->on_bi.bi_private;
899 syncmatches *sm, *snext;
900 modtarget *mt, mtdummy;
902 for (sm = opc->smatches; sm; sm=snext) {
904 syncprov_free_syncop( sm->sm_op );
905 op->o_tmpfree( sm, op->o_tmpmemctx );
908 /* Remove op from lock table */
910 ldap_pvt_thread_rdwr_rlock( &si->si_mods_rwlock );
911 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
912 ldap_pvt_thread_rdwr_runlock( &si->si_mods_rwlock );
914 modinst *mi = mt->mt_mods;
916 /* If there are more, promote the next one */
917 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
919 mt->mt_mods = mi->mi_next;
920 mt->mt_op = mt->mt_mods->mi_op;
921 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
923 ldap_pvt_thread_rdwr_wlock( &si->si_mods_rwlock );
924 avl_delete( &si->si_mods, mt, sp_avl_cmp );
925 ldap_pvt_thread_rdwr_wunlock( &si->si_mods_rwlock );
926 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
927 ldap_pvt_thread_mutex_destroy( &mt->mt_mutex );
931 op->o_callback = cb->sc_next;
932 op->o_tmpfree(cb, op->o_tmpmemctx);
936 syncprov_checkpoint( Operation *op, SlapReply *rs, slap_overinst *on )
938 syncprov_info_t *si = on->on_bi.bi_private;
943 slap_callback cb = {0};
947 bv[0] = si->si_ctxcsn;
948 mod.sml_nvalues = NULL;
949 mod.sml_desc = slap_schema.si_ad_contextCSN;
950 mod.sml_op = LDAP_MOD_REPLACE;
953 cb.sc_response = slap_null_cb;
955 opm.o_tag = LDAP_REQ_MODIFY;
956 opm.o_callback = &cb;
957 opm.orm_modlist = &mod;
958 opm.o_req_dn = op->o_bd->be_suffix[0];
959 opm.o_req_ndn = op->o_bd->be_nsuffix[0];
960 orig = opm.o_bd->bd_info;
961 opm.o_bd->bd_info = on->on_info->oi_orig;
962 opm.o_bd->be_modify( &opm, rs );
966 syncprov_op_response( Operation *op, SlapReply *rs )
968 opcookie *opc = op->o_callback->sc_private;
969 slap_overinst *on = opc->son;
970 syncprov_info_t *si = on->on_bi.bi_private;
973 if ( rs->sr_err == LDAP_SUCCESS )
975 struct berval maxcsn;
976 char cbuf[LDAP_LUTIL_CSNSTR_BUFSIZE];
978 /* Update our context CSN */
980 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
981 slap_get_commit_csn( op, &maxcsn );
982 if ( !BER_BVISNULL( &maxcsn ) ) {
983 strcpy( cbuf, maxcsn.bv_val );
984 if ( ber_bvcmp( &maxcsn, &si->si_ctxcsn ) > 0 ) {
985 strcpy( si->si_ctxcsnbuf, cbuf );
986 si->si_ctxcsn.bv_len = maxcsn.bv_len;
991 if ( si->si_chkops || si->si_chktime ) {
993 if ( si->si_chkops && si->si_numops >= si->si_chkops ) {
997 if ( si->si_chktime &&
998 (op->o_time - si->si_chklast >= si->si_chktime )) {
1000 si->si_chklast = op->o_time;
1003 syncprov_checkpoint( op, rs, on );
1006 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1008 opc->sctxcsn.bv_len = maxcsn.bv_len;
1009 opc->sctxcsn.bv_val = cbuf;
1011 /* Handle any persistent searches */
1015 case LDAP_REQ_MODIFY:
1016 case LDAP_REQ_MODRDN:
1017 case LDAP_REQ_EXTENDED:
1018 syncprov_matchops( op, opc, 0 );
1020 case LDAP_REQ_DELETE:
1021 /* for each match in opc->smatches:
1024 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1025 for ( sm = opc->smatches; sm; sm=sm->sm_next ) {
1026 if ( sm->sm_op->s_op->o_abandon )
1028 syncprov_sendresp( op, opc, sm->sm_op, NULL,
1029 LDAP_SYNC_DELETE, 1 );
1031 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1037 return SLAP_CB_CONTINUE;
1040 /* We don't use a subentry to store the context CSN any more.
1041 * We expose the current context CSN as an operational attribute
1042 * of the suffix entry.
1045 syncprov_op_compare( Operation *op, SlapReply *rs )
1047 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1048 syncprov_info_t *si = on->on_bi.bi_private;
1049 int rc = SLAP_CB_CONTINUE;
1051 if ( dn_match( &op->o_req_ndn, op->o_bd->be_nsuffix ) &&
1052 op->oq_compare.rs_ava->aa_desc == slap_schema.si_ad_contextCSN )
1056 struct berval bv[2];
1058 e.e_name = op->o_bd->be_suffix[0];
1059 e.e_nname = op->o_bd->be_nsuffix[0];
1061 BER_BVZERO( &bv[1] );
1062 bv[0] = si->si_ctxcsn;
1064 a.a_desc = slap_schema.si_ad_contextCSN;
1066 a.a_nvals = a.a_vals;
1068 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1070 rs->sr_err = access_allowed( op, &e, op->oq_compare.rs_ava->aa_desc,
1071 &op->oq_compare.rs_ava->aa_value, ACL_COMPARE, NULL );
1072 if ( ! rs->sr_err ) {
1073 rs->sr_err = LDAP_INSUFFICIENT_ACCESS;
1074 goto return_results;
1077 if ( get_assert( op ) &&
1078 ( test_filter( op, &e, get_assertion( op ) ) != LDAP_COMPARE_TRUE ) )
1080 rs->sr_err = LDAP_ASSERTION_FAILED;
1081 goto return_results;
1085 rs->sr_err = LDAP_COMPARE_FALSE;
1087 if ( value_find_ex( op->oq_compare.rs_ava->aa_desc,
1088 SLAP_MR_ATTRIBUTE_VALUE_NORMALIZED_MATCH |
1089 SLAP_MR_ASSERTED_VALUE_NORMALIZED_MATCH,
1090 a.a_nvals, &op->oq_compare.rs_ava->aa_value, op->o_tmpmemctx ) == 0 )
1092 rs->sr_err = LDAP_COMPARE_TRUE;
1097 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1099 send_ldap_result( op, rs );
1101 if( rs->sr_err == LDAP_COMPARE_FALSE || rs->sr_err == LDAP_COMPARE_TRUE ) {
1102 rs->sr_err = LDAP_SUCCESS;
1111 syncprov_op_mod( Operation *op, SlapReply *rs )
1113 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1114 syncprov_info_t *si = on->on_bi.bi_private;
1116 slap_callback *cb = op->o_tmpcalloc(1, sizeof(slap_callback)+
1118 (si->si_ops ? sizeof(modinst) : 0 ),
1120 opcookie *opc = (opcookie *)(cb+1);
1122 cb->sc_response = syncprov_op_response;
1123 cb->sc_cleanup = syncprov_op_cleanup;
1124 cb->sc_private = opc;
1125 cb->sc_next = op->o_callback;
1126 op->o_callback = cb;
1128 /* If there are active persistent searches, lock this operation.
1129 * See seqmod.c for the locking logic on its own.
1132 modtarget *mt, mtdummy;
1135 mi = (modinst *)(opc+1);
1138 /* See if we're already modifying this entry... */
1140 ldap_pvt_thread_rdwr_wlock( &si->si_mods_rwlock );
1141 mt = avl_find( si->si_mods, &mtdummy, sp_avl_cmp );
1143 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1144 ldap_pvt_thread_rdwr_wunlock( &si->si_mods_rwlock );
1145 mt->mt_tail->mi_next = mi;
1147 /* wait for this op to get to head of list */
1148 while ( mt->mt_mods != mi ) {
1149 ldap_pvt_thread_mutex_unlock( &mt->mt_mutex );
1150 ldap_pvt_thread_yield();
1151 ldap_pvt_thread_mutex_lock( &mt->mt_mutex );
1154 /* Record that we're modifying this entry now */
1155 mt = ch_malloc( sizeof(modtarget) );
1158 mt->mt_op = mi->mi_op;
1159 ldap_pvt_thread_mutex_init( &mt->mt_mutex );
1160 avl_insert( &si->si_mods, mt, sp_avl_cmp, avl_dup_error );
1161 ldap_pvt_thread_rdwr_wunlock( &si->si_mods_rwlock );
1164 if ( op->o_tag != LDAP_REQ_ADD )
1165 syncprov_matchops( op, opc, 1 );
1168 return SLAP_CB_CONTINUE;
1172 syncprov_op_extended( Operation *op, SlapReply *rs )
1174 if ( exop_is_write( op ))
1175 return syncprov_op_mod( op, rs );
1177 return SLAP_CB_CONTINUE;
1180 typedef struct searchstate {
1181 slap_overinst *ss_on;
1186 syncprov_search_cleanup( Operation *op, SlapReply *rs )
1189 if ( rs->sr_ctrls ) {
1190 free( rs->sr_ctrls[0] );
1191 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
1192 rs->sr_ctrls = NULL;
1199 syncprov_detach_op( Operation *op, syncops *so )
1206 /* count the search attrs */
1207 for (i=0; op->ors_attrs && !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1208 alen += op->ors_attrs[i].an_name.bv_len + 1;
1210 /* Make a new copy of the operation */
1211 size = sizeof(Operation) + sizeof(Opheader) +
1212 (i ? ( (i+1) * sizeof(AttributeName) + alen) : 0) +
1213 op->o_req_dn.bv_len + 1 +
1214 op->o_req_ndn.bv_len + 1 +
1215 op->o_ndn.bv_len + 1 +
1216 so->s_filterstr.bv_len + 1;
1217 op2 = (Operation *)ch_malloc( size );
1219 op2->o_hdr = (Opheader *)(op2+1);
1220 *op2->o_hdr = *op->o_hdr;
1222 op2->ors_attrs = (AttributeName *)(op2->o_hdr + 1);
1223 ptr = (char *)(op2->ors_attrs+i+1);
1224 for (i=0; !BER_BVISNULL( &op->ors_attrs[i].an_name ); i++) {
1225 op2->ors_attrs[i] = op->ors_attrs[i];
1226 op2->ors_attrs[i].an_name.bv_val = ptr;
1227 ptr = lutil_strcopy( ptr, op->ors_attrs[i].an_name.bv_val ) + 1;
1229 BER_BVZERO( &op2->ors_attrs[i].an_name );
1231 ptr = (char *)(op2->o_hdr + 1);
1233 op2->o_ndn.bv_val = ptr;
1234 ptr = lutil_strcopy(ptr, op->o_ndn.bv_val) + 1;
1235 op2->o_dn = op2->o_ndn;
1236 op2->o_req_dn.bv_val = ptr;
1237 ptr = lutil_strcopy(ptr, op->o_req_dn.bv_val) + 1;
1238 op2->o_req_ndn.bv_val = ptr;
1239 ptr = lutil_strcopy(ptr, op->o_req_ndn.bv_val) + 1;
1240 op2->ors_filterstr.bv_val = ptr;
1241 strcpy( ptr, so->s_filterstr.bv_val );
1242 op2->ors_filterstr.bv_len = so->s_filterstr.bv_len;
1243 op2->ors_filter = str2filter( ptr );
1244 op2->o_controls = NULL;
1245 op2->o_callback = NULL;
1248 /* Increment number of ops so that idletimeout ignores us */
1249 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
1250 op->o_conn->c_n_ops_executing++;
1251 op->o_conn->c_n_ops_completed--;
1252 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
1256 syncprov_search_response( Operation *op, SlapReply *rs )
1258 searchstate *ss = op->o_callback->sc_private;
1259 slap_overinst *on = ss->ss_on;
1260 syncprov_info_t *si = on->on_bi.bi_private;
1261 sync_control *srs = op->o_controls[slap_cids.sc_LDAPsync];
1263 if ( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF ) {
1265 /* FIXME: when rs->sr_type == REP_SEARCHREF,
1266 * rs->sr_entry is NULL! */
1267 if ( srs->sr_state.ctxcsn && rs->sr_entry ) {
1268 Attribute *a = attr_find( rs->sr_entry->e_attrs,
1269 slap_schema.si_ad_entryCSN );
1270 /* Don't send the ctx entry twice */
1271 if ( bvmatch( &a->a_nvals[0], srs->sr_state.ctxcsn ))
1272 return LDAP_SUCCESS;
1274 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1276 rs->sr_ctrls[1] = NULL;
1277 rs->sr_err = syncprov_state_ctrl( op, rs, rs->sr_entry,
1278 LDAP_SYNC_ADD, rs->sr_ctrls, 0, 0, NULL );
1279 } else if ( rs->sr_type == REP_RESULT && rs->sr_err == LDAP_SUCCESS ) {
1280 struct berval cookie;
1282 slap_compose_sync_cookie( op, &cookie,
1283 &op->ors_filter->f_and->f_ava->aa_value,
1284 srs->sr_state.sid, srs->sr_state.rid );
1286 /* Is this a regular refresh? */
1288 rs->sr_ctrls = op->o_tmpalloc( sizeof(LDAPControl *)*2,
1290 rs->sr_ctrls[1] = NULL;
1291 rs->sr_err = syncprov_done_ctrl( op, rs, rs->sr_ctrls,
1292 0, 1, &cookie, LDAP_SYNC_REFRESH_PRESENTS );
1295 /* It's RefreshAndPersist, transition to Persist phase */
1296 syncprov_sendinfo( op, rs, rs->sr_nentries ?
1297 LDAP_TAG_SYNC_REFRESH_PRESENT : LDAP_TAG_SYNC_REFRESH_DELETE,
1298 &cookie, 1, NULL, 0 );
1299 /* Flush any queued persist messages */
1300 if ( ss->ss_so->s_res ) {
1301 syncres *sr, *srnext;
1306 ldap_pvt_thread_mutex_lock( &ss->ss_so->s_mutex );
1308 for (sr = ss->ss_so->s_res; sr; sr=srnext) {
1309 int rc = LDAP_SUCCESS;
1310 srnext = sr->s_next;
1312 opc.sndn = sr->s_ndn;
1313 opc.suuid = sr->s_uuid;
1314 opc.sctxcsn = sr->s_csn;
1315 opc.sreference = sr->s_isreference;
1318 if ( sr->s_mode != LDAP_SYNC_DELETE ) {
1319 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1320 rc = be_entry_get_rw( op, &opc.sndn, NULL, NULL, 0, &e );
1321 op->o_bd->bd_info = (BackendInfo *)on;
1323 if ( rc == LDAP_SUCCESS )
1324 syncprov_sendresp( op, &opc, ss->ss_so, e,
1328 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1329 be_entry_release_r( op, e );
1330 op->o_bd->bd_info = (BackendInfo *)on;
1334 ss->ss_so->s_res = NULL;
1335 ss->ss_so->s_restail = NULL;
1338 /* Turn off the refreshing flag */
1339 ss->ss_so->s_flags ^= PS_IS_REFRESHING;
1341 ldap_pvt_thread_mutex_unlock( &ss->ss_so->s_mutex );
1343 /* Detach this Op from frontend control */
1344 syncprov_detach_op( op, ss->ss_so );
1346 return LDAP_SUCCESS;
1350 return SLAP_CB_CONTINUE;
1354 syncprov_op_search( Operation *op, SlapReply *rs )
1356 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1357 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1359 int gotstate = 0, nochange = 0;
1360 Filter *fand, *fava;
1361 syncops *sop = NULL;
1365 if ( !(op->o_sync_mode & SLAP_SYNC_REFRESH) ) return SLAP_CB_CONTINUE;
1367 if ( op->ors_deref & LDAP_DEREF_SEARCHING ) {
1368 send_ldap_error( op, rs, LDAP_PROTOCOL_ERROR, "illegal value for derefAliases" );
1372 srs = op->o_controls[slap_cids.sc_LDAPsync];
1374 /* If this is a persistent search, set it up right away */
1375 if ( op->o_sync_mode & SLAP_SYNC_PERSIST ) {
1385 so.s_flags = PS_IS_REFRESHING;
1386 /* syncprov_findbase expects to be called as a callback... */
1387 sc.sc_private = &opc;
1389 cb = op->o_callback;
1390 op->o_callback = ≻
1391 rs->sr_err = syncprov_findbase( op, &fc );
1392 op->o_callback = cb;
1394 if ( rs->sr_err != LDAP_SUCCESS ) {
1395 send_ldap_result( op, rs );
1398 sop = ch_malloc( sizeof( syncops ));
1400 ldap_pvt_thread_mutex_init( &sop->s_mutex );
1401 ldap_pvt_thread_mutex_lock( &si->si_ops_mutex );
1402 sop->s_sid = srs->sr_state.sid;
1403 sop->s_rid = srs->sr_state.rid;
1404 sop->s_next = si->si_ops;
1407 ldap_pvt_thread_mutex_unlock( &si->si_ops_mutex );
1410 /* If we have a cookie, handle the PRESENT lookups
1412 if ( srs->sr_state.ctxcsn ) {
1413 /* Is the CSN in a valid format? */
1414 if ( srs->sr_state.ctxcsn->bv_len >= LDAP_LUTIL_CSNSTR_BUFSIZE ) {
1415 send_ldap_error( op, rs, LDAP_OTHER, "invalid sync cookie" );
1418 /* Is the CSN still present in the database? */
1419 if ( syncprov_findcsn( op, FIND_CSN ) != LDAP_SUCCESS ) {
1420 /* No, so a reload is required */
1421 #if 0 /* the consumer doesn't seem to send this hint */
1422 if ( op->o_sync_rhint == 0 ) {
1423 send_ldap_error( op, rs, LDAP_SYNC_REFRESH_REQUIRED, "sync cookie is stale" );
1429 /* If just Refreshing and nothing has changed, shortcut it */
1430 if ( bvmatch( srs->sr_state.ctxcsn, &si->si_ctxcsn )) {
1432 if ( !(op->o_sync_mode & SLAP_SYNC_PERSIST) ) {
1433 LDAPControl *ctrls[2];
1437 syncprov_done_ctrl( op, rs, ctrls, 0, 0,
1438 NULL, LDAP_SYNC_REFRESH_DELETES );
1439 rs->sr_ctrls = ctrls;
1440 rs->sr_err = LDAP_SUCCESS;
1441 send_ldap_result( op, rs );
1442 rs->sr_ctrls = NULL;
1447 /* If context has changed, check for Present UUIDs */
1448 if ( syncprov_findcsn( op, FIND_PRESENT ) != LDAP_SUCCESS ) {
1449 send_ldap_result( op, rs );
1455 /* Append CSN range to search filter, save original filter
1456 * for persistent search evaluation
1459 sop->s_filterstr= op->ors_filterstr;
1462 fand = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
1463 fand->f_choice = LDAP_FILTER_AND;
1464 fand->f_next = NULL;
1465 fava = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
1466 fava->f_choice = LDAP_FILTER_LE;
1467 fava->f_ava = op->o_tmpalloc( sizeof(AttributeAssertion), op->o_tmpmemctx );
1468 fava->f_ava->aa_desc = slap_schema.si_ad_entryCSN;
1469 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1470 ber_dupbv_x( &fava->f_ava->aa_value, &si->si_ctxcsn, op->o_tmpmemctx );
1471 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1474 fava->f_next = op->o_tmpalloc( sizeof(Filter), op->o_tmpmemctx );
1475 fava = fava->f_next;
1476 fava->f_choice = LDAP_FILTER_GE;
1477 fava->f_ava = op->o_tmpalloc( sizeof(AttributeAssertion), op->o_tmpmemctx );
1478 fava->f_ava->aa_desc = slap_schema.si_ad_entryCSN;
1479 ber_dupbv_x( &fava->f_ava->aa_value, srs->sr_state.ctxcsn, op->o_tmpmemctx );
1481 fava->f_next = op->ors_filter;
1482 op->ors_filter = fand;
1483 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
1486 /* Let our callback add needed info to returned entries */
1487 cb = op->o_tmpcalloc(1, sizeof(slap_callback)+sizeof(searchstate), op->o_tmpmemctx);
1488 ss = (searchstate *)(cb+1);
1491 cb->sc_response = syncprov_search_response;
1492 cb->sc_cleanup = syncprov_search_cleanup;
1493 cb->sc_private = ss;
1494 cb->sc_next = op->o_callback;
1495 op->o_callback = cb;
1497 #if 0 /* I don't think we need to shortcircuit back-bdb any more */
1498 op->o_sync_mode &= SLAP_CONTROL_MASK;
1501 /* If this is a persistent search and no changes were reported during
1502 * the refresh phase, just invoke the response callback to transition
1503 * us into persist phase
1506 rs->sr_err = LDAP_SUCCESS;
1507 rs->sr_nentries = 0;
1508 send_ldap_result( op, rs );
1511 return SLAP_CB_CONTINUE;
1515 syncprov_operational(
1519 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1520 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1522 if ( rs->sr_entry &&
1523 dn_match( &rs->sr_entry->e_nname, op->o_bd->be_nsuffix )) {
1525 if ( SLAP_OPATTRS( rs->sr_attr_flags ) ||
1526 ad_inlist( slap_schema.si_ad_contextCSN, rs->sr_attrs )) {
1527 Attribute *a, **ap = NULL;
1530 for ( a=rs->sr_entry->e_attrs; a; a=a->a_next ) {
1531 if ( a->a_desc == slap_schema.si_ad_contextCSN )
1536 for ( ap = &rs->sr_operational_attrs; *ap; ap=&(*ap)->a_next );
1538 a = ch_malloc( sizeof(Attribute));
1539 a->a_desc = slap_schema.si_ad_contextCSN;
1540 a->a_vals = ch_malloc( 2 * sizeof(struct berval));
1541 a->a_vals[1].bv_val = NULL;
1542 a->a_nvals = a->a_vals;
1548 ldap_pvt_thread_mutex_lock( &si->si_csn_mutex );
1550 strcpy( a->a_vals[0].bv_val, si->si_ctxcsnbuf );
1552 ber_dupbv( &a->a_vals[0], &si->si_ctxcsn );
1554 ldap_pvt_thread_mutex_unlock( &si->si_csn_mutex );
1557 return LDAP_SUCCESS;
1569 slap_overinst *on = (slap_overinst *)be->bd_info;
1570 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1573 if ( strcasecmp( argv[ 0 ], "syncprov-checkpoint" ) == 0 ) {
1575 fprintf( stderr, "%s: line %d: wrong number of arguments in "
1576 "\"syncprov-checkpoint <ops> <minutes>\"\n", fname, lineno );
1579 si->si_chkops = atoi( argv[1] );
1580 si->si_chktime = atoi( argv[2] ) * 60;
1583 return SLAP_CONF_UNKNOWN;
1587 return SLAP_CONF_UNKNOWN;
1590 /* Cheating - we have no thread pool context for these functions,
1593 typedef struct thread_keys {
1596 ldap_pvt_thread_pool_keyfree_t *xfree;
1600 /* A fake thread context */
1601 static thread_keys thrctx[MAXKEYS];
1603 /* Read any existing contextCSN from the underlying db.
1604 * Then search for any entries newer than that. If no value exists,
1605 * just generate it. Cache whatever result.
1612 slap_overinst *on = (slap_overinst *) be->bd_info;
1613 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1615 char opbuf[OPERATION_BUFFER_SIZE];
1616 Operation *op = (Operation *)opbuf;
1621 memset(opbuf, 0, sizeof(opbuf));
1622 op->o_hdr = (Opheader *)(op+1);
1624 op->o_dn = be->be_rootdn;
1625 op->o_ndn = be->be_rootndn;
1626 op->o_threadctx = thrctx;
1627 op->o_tmpmfuncs = &ch_mfuncs;
1629 op->o_bd->bd_info = on->on_info->oi_orig;
1630 rc = be_entry_get_rw( op, be->be_nsuffix, NULL,
1631 slap_schema.si_ad_contextCSN, 0, &e );
1633 BER_BVZERO( &si->si_ctxcsn );
1635 /* FIXME: when rs->sr_type == REP_SEARCHREF,
1636 * rs->sr_entry == NULL! */
1638 a = attr_find( e->e_attrs, slap_schema.si_ad_contextCSN );
1640 si->si_ctxcsn.bv_len = a->a_nvals[0].bv_len;
1641 if ( si->si_ctxcsn.bv_len >= sizeof(si->si_ctxcsnbuf ))
1642 si->si_ctxcsn.bv_len = sizeof(si->si_ctxcsnbuf)-1;
1643 strncpy( si->si_ctxcsnbuf, a->a_nvals[0].bv_val,
1644 si->si_ctxcsn.bv_len );
1645 si->si_ctxcsnbuf[si->si_ctxcsn.bv_len] = '\0';
1647 be_entry_release_r( op, e );
1650 if ( BER_BVISNULL( &si->si_ctxcsn ) ) {
1651 slap_get_csn( op, si->si_ctxcsnbuf, sizeof(si->si_ctxcsnbuf),
1652 &si->si_ctxcsn, 0 );
1655 op->o_bd->bd_info = (BackendInfo *)on;
1659 /* Write the current contextCSN into the underlying db.
1666 slap_overinst *on = (slap_overinst *) be->bd_info;
1667 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1670 if ( si->si_numops ) {
1672 char opbuf[OPERATION_BUFFER_SIZE];
1673 Operation *op = (Operation *)opbuf;
1674 SlapReply rs = {REP_RESULT};
1676 connection_fake_init( &conn, op, thrctx );
1678 op->o_dn = be->be_rootdn;
1679 op->o_ndn = be->be_rootndn;
1680 syncprov_checkpoint( op, &rs, on );
1682 for ( i=0; thrctx[i].key; i++) {
1683 if ( thrctx[i].xfree )
1684 thrctx[i].xfree( thrctx[i].key, thrctx[i].data );
1685 thrctx[i].key = NULL;
1696 slap_overinst *on = (slap_overinst *)be->bd_info;
1697 syncprov_info_t *si;
1699 si = ch_calloc(1, sizeof(syncprov_info_t));
1700 on->on_bi.bi_private = si;
1701 ldap_pvt_thread_mutex_init( &si->si_csn_mutex );
1702 ldap_pvt_thread_mutex_init( &si->si_ops_mutex );
1703 ldap_pvt_thread_rdwr_init( &si->si_mods_rwlock );
1704 si->si_ctxcsn.bv_val = si->si_ctxcsnbuf;
1706 csn_anlist[0].an_desc = slap_schema.si_ad_entryCSN;
1707 csn_anlist[0].an_name = slap_schema.si_ad_entryCSN->ad_cname;
1709 uuid_anlist[0].an_desc = slap_schema.si_ad_entryUUID;
1710 uuid_anlist[0].an_name = slap_schema.si_ad_entryUUID->ad_cname;
1716 syncprov_db_destroy(
1720 slap_overinst *on = (slap_overinst *)be->bd_info;
1721 syncprov_info_t *si = (syncprov_info_t *)on->on_bi.bi_private;
1724 ldap_pvt_thread_rdwr_destroy( &si->si_mods_rwlock );
1725 ldap_pvt_thread_mutex_destroy( &si->si_ops_mutex );
1726 ldap_pvt_thread_mutex_destroy( &si->si_csn_mutex );
1733 static int syncprov_parseCtrl (
1742 struct berval cookie = BER_BVNULL;
1746 if ( op->o_sync != SLAP_CONTROL_NONE ) {
1747 rs->sr_text = "Sync control specified multiple times";
1748 return LDAP_PROTOCOL_ERROR;
1751 if ( op->o_pagedresults != SLAP_CONTROL_NONE ) {
1752 rs->sr_text = "Sync control specified with pagedResults control";
1753 return LDAP_PROTOCOL_ERROR;
1756 if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
1757 rs->sr_text = "Sync control value is empty (or absent)";
1758 return LDAP_PROTOCOL_ERROR;
1761 /* Parse the control value
1762 * syncRequestValue ::= SEQUENCE {
1767 * refreshAndPersist (3)
1769 * cookie syncCookie OPTIONAL
1773 ber = ber_init( &ctrl->ldctl_value );
1775 rs->sr_text = "internal error";
1779 if ( (tag = ber_scanf( ber, "{i" /*}*/, &mode )) == LBER_ERROR ) {
1780 rs->sr_text = "Sync control : mode decoding error";
1781 return LDAP_PROTOCOL_ERROR;
1785 case LDAP_SYNC_REFRESH_ONLY:
1786 mode = SLAP_SYNC_REFRESH;
1788 case LDAP_SYNC_REFRESH_AND_PERSIST:
1789 mode = SLAP_SYNC_REFRESH_AND_PERSIST;
1792 rs->sr_text = "Sync control : unknown update mode";
1793 return LDAP_PROTOCOL_ERROR;
1796 tag = ber_peek_tag( ber, &len );
1798 if ( tag == LDAP_TAG_SYNC_COOKIE ) {
1799 if (( ber_scanf( ber, /*{*/ "o", &cookie )) == LBER_ERROR ) {
1800 rs->sr_text = "Sync control : cookie decoding error";
1801 return LDAP_PROTOCOL_ERROR;
1804 if ( tag == LDAP_TAG_RELOAD_HINT ) {
1805 if (( ber_scanf( ber, /*{*/ "b", &rhint )) == LBER_ERROR ) {
1806 rs->sr_text = "Sync control : rhint decoding error";
1807 return LDAP_PROTOCOL_ERROR;
1810 if (( ber_scanf( ber, /*{*/ "}")) == LBER_ERROR ) {
1811 rs->sr_text = "Sync control : decoding error";
1812 return LDAP_PROTOCOL_ERROR;
1814 sr = op->o_tmpcalloc( 1, sizeof(struct sync_control), op->o_tmpmemctx );
1815 sr->sr_rhint = rhint;
1816 if (!BER_BVISNULL(&cookie)) {
1817 ber_bvarray_add( &sr->sr_state.octet_str, &cookie );
1818 slap_parse_sync_cookie( &sr->sr_state );
1821 op->o_controls[slap_cids.sc_LDAPsync] = sr;
1823 (void) ber_free( ber, 1 );
1825 op->o_sync = ctrl->ldctl_iscritical
1826 ? SLAP_CONTROL_CRITICAL
1827 : SLAP_CONTROL_NONCRITICAL;
1829 op->o_sync_mode |= mode; /* o_sync_mode shares o_sync */
1831 return LDAP_SUCCESS;
1834 /* This overlay is set up for dynamic loading via moduleload. For static
1835 * configuration, you'll need to arrange for the slap_overinst to be
1836 * initialized and registered by some other function inside slapd.
1839 static slap_overinst syncprov;
1846 rc = register_supported_control( LDAP_CONTROL_SYNC,
1847 SLAP_CTRL_HIDE|SLAP_CTRL_SEARCH, NULL,
1848 syncprov_parseCtrl, &slap_cids.sc_LDAPsync );
1849 if ( rc != LDAP_SUCCESS ) {
1850 fprintf( stderr, "Failed to register control %d\n", rc );
1854 syncprov.on_bi.bi_type = "syncprov";
1855 syncprov.on_bi.bi_db_init = syncprov_db_init;
1856 syncprov.on_bi.bi_db_config = syncprov_db_config;
1857 syncprov.on_bi.bi_db_destroy = syncprov_db_destroy;
1858 syncprov.on_bi.bi_db_open = syncprov_db_open;
1859 syncprov.on_bi.bi_db_close = syncprov_db_close;
1861 syncprov.on_bi.bi_op_abandon = syncprov_op_abandon;
1862 syncprov.on_bi.bi_op_cancel = syncprov_op_abandon;
1864 syncprov.on_bi.bi_op_add = syncprov_op_mod;
1865 syncprov.on_bi.bi_op_compare = syncprov_op_compare;
1866 syncprov.on_bi.bi_op_delete = syncprov_op_mod;
1867 syncprov.on_bi.bi_op_modify = syncprov_op_mod;
1868 syncprov.on_bi.bi_op_modrdn = syncprov_op_mod;
1869 syncprov.on_bi.bi_op_search = syncprov_op_search;
1870 syncprov.on_bi.bi_extended = syncprov_op_extended;
1871 syncprov.on_bi.bi_operational = syncprov_operational;
1874 syncprov.on_response = syncprov_response;
1877 return overlay_register( &syncprov );
1880 #if SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC
1882 init_module( int argc, char *argv[] )
1884 return syncprov_init();
1886 #endif /* SLAPD_OVER_SYNCPROV == SLAPD_MOD_DYNAMIC */
1888 #endif /* defined(SLAPD_OVER_SYNCPROV) */