1 /* sssvlv.c - server side sort / virtual list view */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2009-2011 The OpenLDAP Foundation.
6 * Portions copyright 2009 Symas Corporation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Howard Chu for inclusion in
19 * OpenLDAP Software. Support for multiple sorts per connection added
25 #ifdef SLAPD_OVER_SSSVLV
29 #include <ac/string.h>
38 #include "../../../libraries/liblber/lber-int.h" /* ber_rewind */
40 /* RFC2891: Server Side Sorting
41 * RFC2696: Paged Results
43 #ifndef LDAP_MATCHRULE_IDENTIFIER
44 #define LDAP_MATCHRULE_IDENTIFIER 0x80L
45 #define LDAP_REVERSEORDER_IDENTIFIER 0x81L
46 #define LDAP_ATTRTYPES_IDENTIFIER 0x80L
49 /* draft-ietf-ldapext-ldapv3-vlv-09.txt: Virtual List Views
51 #ifndef LDAP_VLVBYINDEX_IDENTIFIER
52 #define LDAP_VLVBYINDEX_IDENTIFIER 0xa0L
53 #define LDAP_VLVBYVALUE_IDENTIFIER 0x81L
54 #define LDAP_VLVCONTEXT_IDENTIFIER 0x04L
56 #define LDAP_VLV_SSS_MISSING 0x4C
57 #define LDAP_VLV_RANGE_ERROR 0x4D
60 #define SAFESTR(macro_str, macro_def) ((macro_str) ? (macro_str) : (macro_def))
62 #define SSSVLV_DEFAULT_MAX_KEYS 5
63 #define SSSVLV_DEFAULT_MAX_REQUEST_PER_CONN 5
65 #define NO_PS_COOKIE (PagedResultsCookie) -1
66 #define NO_VC_CONTEXT (unsigned long) -1
68 typedef struct vlv_ctrl {
73 struct berval vc_value;
74 unsigned long vc_context;
77 typedef struct sort_key
79 AttributeDescription *sk_ad;
80 MatchingRule *sk_ordering;
81 int sk_direction; /* 1=normal, -1=reverse */
84 typedef struct sort_ctrl {
90 typedef struct sort_node
95 struct berval *sn_vals;
98 typedef struct sssvlv_info
100 int svi_max; /* max concurrent sorts */
101 int svi_num; /* current # sorts */
102 int svi_max_keys; /* max sort keys per request */
103 int svi_max_percon; /* max concurrent sorts per con */
106 typedef struct sort_op
110 sssvlv_info *so_info;
118 unsigned long so_vcontext;
121 /* There is only one conn table for all overlay instances */
122 /* Each conn can handle one session by context */
123 static sort_op ***sort_conns;
124 static ldap_pvt_thread_mutex_t sort_conns_mutex;
126 static const char *debug_header = "sssvlv";
131 /* RFC 2981 Section 2.2
132 * If a sort key is a multi-valued attribute, and an entry happens to
133 * have multiple values for that attribute and no other controls are
134 * present that affect the sorting order, then the server SHOULD use the
135 * least value (according to the ORDERING rule for that attribute).
137 static struct berval* select_value(
141 struct berval* ber1, *ber2;
142 MatchingRule *mr = key->sk_ordering;
146 ber1 = &(attr->a_nvals[0]);
148 for ( i = 1; i < attr->a_numvals; i++,ber2++ ) {
149 mr->smr_match( &cmp, 0, mr->smr_syntax, mr, ber1, ber2 );
155 Debug(LDAP_DEBUG_TRACE, "%s: value selected for compare: %s\n",
157 SAFESTR(ber1->bv_val, "<Empty>"),
163 static int node_cmp( const void* val1, const void* val2 )
165 sort_node *sn1 = (sort_node *)val1;
166 sort_node *sn2 = (sort_node *)val2;
170 assert( sort_conns[sn1->sn_conn]
171 && sort_conns[sn1->sn_conn][sn1->sn_session]
172 && sort_conns[sn1->sn_conn][sn1->sn_session]->so_ctrl );
173 sc = sort_conns[sn1->sn_conn][sn1->sn_session]->so_ctrl;
175 for ( i=0; cmp == 0 && i<sc->sc_nkeys; i++ ) {
176 if ( BER_BVISNULL( &sn1->sn_vals[i] )) {
177 if ( BER_BVISNULL( &sn2->sn_vals[i] ))
180 cmp = sc->sc_keys[i].sk_direction;
181 } else if ( BER_BVISNULL( &sn2->sn_vals[i] )) {
182 cmp = sc->sc_keys[i].sk_direction * -1;
184 mr = sc->sc_keys[i].sk_ordering;
185 mr->smr_match( &cmp, 0, mr->smr_syntax, mr,
186 &sn1->sn_vals[i], &sn2->sn_vals[i] );
188 cmp *= sc->sc_keys[i].sk_direction;
194 static int node_insert( const void *val1, const void *val2 )
196 /* Never return equal so that new entries are always inserted */
197 return node_cmp( val1, val2 ) < 0 ? -1 : 1;
200 static int pack_vlv_response_control(
204 LDAPControl **ctrlsp )
207 BerElementBuffer berbuf;
208 BerElement *ber = (BerElement *)&berbuf;
209 struct berval cookie, bv;
212 ber_init2( ber, NULL, LBER_USE_DER );
213 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
215 rc = ber_printf( ber, "{iie", so->so_vlv_target, so->so_nentries,
218 if ( rc != -1 && so->so_vcontext ) {
219 cookie.bv_val = (char *)&so->so_vcontext;
220 cookie.bv_len = sizeof(so->so_vcontext);
221 rc = ber_printf( ber, "tO", LDAP_VLVCONTEXT_IDENTIFIER, &cookie );
225 rc = ber_printf( ber, "}" );
229 rc = ber_flatten2( ber, &bv, 0 );
233 ctrl = (LDAPControl *)op->o_tmpalloc( sizeof(LDAPControl)+
234 bv.bv_len, op->o_tmpmemctx );
235 ctrl->ldctl_oid = LDAP_CONTROL_VLVRESPONSE;
236 ctrl->ldctl_iscritical = 0;
237 ctrl->ldctl_value.bv_val = (char *)(ctrl+1);
238 ctrl->ldctl_value.bv_len = bv.bv_len;
239 AC_MEMCPY( ctrl->ldctl_value.bv_val, bv.bv_val, bv.bv_len );
243 rs->sr_err = LDAP_OTHER;
251 static int pack_pagedresult_response_control(
255 LDAPControl **ctrlsp )
258 BerElementBuffer berbuf;
259 BerElement *ber = (BerElement *)&berbuf;
260 PagedResultsCookie resp_cookie;
261 struct berval cookie, bv;
264 ber_init2( ber, NULL, LBER_USE_DER );
265 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
267 if ( so->so_nentries > 0 ) {
268 resp_cookie = ( PagedResultsCookie )so->so_tree;
269 cookie.bv_len = sizeof( PagedResultsCookie );
270 cookie.bv_val = (char *)&resp_cookie;
272 resp_cookie = ( PagedResultsCookie )0;
273 BER_BVZERO( &cookie );
276 op->o_conn->c_pagedresults_state.ps_cookie = resp_cookie;
277 op->o_conn->c_pagedresults_state.ps_count
278 = ((PagedResultsState *)op->o_pagedresults_state)->ps_count
281 rc = ber_printf( ber, "{iO}", so->so_nentries, &cookie );
283 rc = ber_flatten2( ber, &bv, 0 );
287 ctrl = (LDAPControl *)op->o_tmpalloc( sizeof(LDAPControl)+
288 bv.bv_len, op->o_tmpmemctx );
289 ctrl->ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
290 ctrl->ldctl_iscritical = 0;
291 ctrl->ldctl_value.bv_val = (char *)(ctrl+1);
292 ctrl->ldctl_value.bv_len = bv.bv_len;
293 AC_MEMCPY( ctrl->ldctl_value.bv_val, bv.bv_val, bv.bv_len );
297 rs->sr_err = LDAP_OTHER;
305 static int pack_sss_response_control(
308 LDAPControl **ctrlsp )
311 BerElementBuffer berbuf;
312 BerElement *ber = (BerElement *)&berbuf;
316 ber_init2( ber, NULL, LBER_USE_DER );
317 ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
319 /* Pack error code */
320 rc = ber_printf(ber, "{e}", rs->sr_err);
323 rc = ber_flatten2( ber, &bv, 0 );
326 ctrl = (LDAPControl *)op->o_tmpalloc( sizeof(LDAPControl)+
327 bv.bv_len, op->o_tmpmemctx );
328 ctrl->ldctl_oid = LDAP_CONTROL_SORTRESPONSE;
329 ctrl->ldctl_iscritical = 0;
330 ctrl->ldctl_value.bv_val = (char *)(ctrl+1);
331 ctrl->ldctl_value.bv_len = bv.bv_len;
332 AC_MEMCPY( ctrl->ldctl_value.bv_val, bv.bv_val, bv.bv_len );
336 rs->sr_err = LDAP_OTHER;
344 /* Return the session id or -1 if unknown */
345 static int find_session_by_so(
354 for (sess_id = 0; sess_id < svi_max_percon; sess_id++) {
355 if ( sort_conns[conn_id] && sort_conns[conn_id][sess_id] == so )
361 /* Return the session id or -1 if unknown */
362 static int find_session_by_context(
365 unsigned long vc_context,
366 PagedResultsCookie ps_cookie )
369 for(sess_id = 0; sess_id < svi_max_percon; sess_id++) {
370 if( sort_conns[conn_id] && sort_conns[conn_id][sess_id] &&
371 ( sort_conns[conn_id][sess_id]->so_vcontext == vc_context ||
372 (PagedResultsCookie) sort_conns[conn_id][sess_id]->so_tree == ps_cookie ) )
378 static int find_next_session(
383 assert(sort_conns[conn_id] != NULL);
384 for(sess_id = 0; sess_id < svi_max_percon; sess_id++) {
385 if(!sort_conns[conn_id][sess_id]) {
389 if (sess_id >= svi_max_percon) {
396 static void free_sort_op( Connection *conn, sort_op *so )
400 tavl_free( so->so_tree, ch_free );
404 ldap_pvt_thread_mutex_lock( &sort_conns_mutex );
405 sess_id = find_session_by_so( so->so_info->svi_max_percon, conn->c_conn_idx, so );
406 sort_conns[conn->c_conn_idx][sess_id] = NULL;
407 so->so_info->svi_num--;
408 ldap_pvt_thread_mutex_unlock( &sort_conns_mutex );
413 static void free_sort_ops( Connection *conn, sort_op **sos, int svi_max_percon )
418 for( sess_id = 0; sess_id < svi_max_percon ; sess_id++ ) {
419 so = sort_conns[conn->c_conn_idx][sess_id];
421 free_sort_op( conn, so );
422 sort_conns[conn->c_conn_idx][sess_id] = NULL;
427 static void send_list(
432 Avlnode *cur_node, *tmp_node;
433 vlv_ctrl *vc = op->o_controls[vlv_cid];
437 LDAPControl *ctrls[2];
439 /* FIXME: it may be better to just flatten the tree into
440 * an array before doing all of this...
443 /* Are we just counting an offset? */
444 if ( BER_BVISNULL( &vc->vc_value )) {
445 if ( vc->vc_offset == vc->vc_count ) {
446 /* wants the last entry in the list */
447 cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
448 so->so_vlv_target = so->so_nentries;
449 } else if ( vc->vc_offset == 1 ) {
450 /* wants the first entry in the list */
451 cur_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
452 so->so_vlv_target = 1;
455 /* Just iterate to the right spot */
456 if ( vc->vc_count && vc->vc_count != so->so_nentries ) {
457 if ( vc->vc_offset > vc->vc_count )
459 target = so->so_nentries * vc->vc_offset / vc->vc_count;
461 if ( vc->vc_offset > so->so_nentries ) {
463 so->so_vlv_rc = LDAP_VLV_RANGE_ERROR;
464 pack_vlv_response_control( op, rs, so, ctrls );
466 slap_add_ctrls( op, rs, ctrls );
467 rs->sr_err = LDAP_VLV_ERROR;
470 target = vc->vc_offset;
472 so->so_vlv_target = target;
473 /* Start at left and go right, or start at right and go left? */
474 if ( target < so->so_nentries / 2 ) {
475 cur_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
476 dir = TAVL_DIR_RIGHT;
478 cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
480 target = so->so_nentries - target + 1;
482 for ( i=1; i<target; i++ )
483 cur_node = tavl_next( cur_node, dir );
486 /* we're looking for a specific value */
487 sort_ctrl *sc = so->so_ctrl;
488 MatchingRule *mr = sc->sc_keys[0].sk_ordering;
492 if ( mr->smr_normalize ) {
493 rc = mr->smr_normalize( SLAP_MR_VALUE_OF_SYNTAX,
494 mr->smr_syntax, mr, &vc->vc_value, &bv, op->o_tmpmemctx );
496 so->so_vlv_rc = LDAP_INAPPROPRIATE_MATCHING;
497 pack_vlv_response_control( op, rs, so, ctrls );
499 slap_add_ctrls( op, rs, ctrls );
500 rs->sr_err = LDAP_VLV_ERROR;
507 sn = op->o_tmpalloc( sizeof(sort_node) +
508 sc->sc_nkeys * sizeof(struct berval), op->o_tmpmemctx );
509 sn->sn_vals = (struct berval *)(sn+1);
510 sn->sn_conn = op->o_conn->c_conn_idx;
511 sn->sn_session = find_session_by_so( so->so_info->svi_max_percon, op->o_conn->c_conn_idx, so );
513 for (i=1; i<sc->sc_nkeys; i++) {
514 BER_BVZERO( &sn->sn_vals[i] );
516 cur_node = tavl_find3( so->so_tree, sn, node_cmp, &j );
517 /* didn't find >= match */
520 cur_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
522 op->o_tmpfree( sn, op->o_tmpmemctx );
525 so->so_vlv_target = so->so_nentries + 1;
527 sort_node *sn = so->so_tree->avl_data;
528 /* start from the left or the right side? */
529 mr->smr_match( &i, 0, mr->smr_syntax, mr, &bv, &sn->sn_vals[0] );
531 tmp_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
534 tmp_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
535 dir = TAVL_DIR_RIGHT;
537 for (i=0; tmp_node != cur_node;
538 tmp_node = tavl_next( tmp_node, dir ), i++);
539 so->so_vlv_target = (dir == TAVL_DIR_RIGHT) ? i+1 : so->so_nentries - i;
541 if ( bv.bv_val != vc->vc_value.bv_val )
542 op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
546 cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
550 for ( ; i<vc->vc_before; i++ ) {
551 tmp_node = tavl_next( cur_node, TAVL_DIR_LEFT );
552 if ( !tmp_node ) break;
555 j = i + vc->vc_after + 1;
557 for ( i=0; i<j; i++ ) {
558 sort_node *sn = cur_node->avl_data;
560 if ( slapd_shutdown ) break;
562 op->o_bd = select_backend( &sn->sn_dn, 0 );
564 rc = be_entry_get_rw( op, &sn->sn_dn, NULL, NULL, 0, &e );
566 if ( e && rc == LDAP_SUCCESS ) {
568 rs->sr_flags = REP_ENTRY_MUSTRELEASE;
569 rs->sr_err = send_search_entry( op, rs );
570 if ( rs->sr_err == LDAP_UNAVAILABLE )
573 cur_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
574 if ( !cur_node ) break;
576 so->so_vlv_rc = LDAP_SUCCESS;
581 static void send_page( Operation *op, SlapReply *rs, sort_op *so )
583 Avlnode *cur_node = so->so_tree;
584 Avlnode *next_node = NULL;
585 BackendDB *be = op->o_bd;
589 while ( cur_node && rs->sr_nentries < so->so_page_size ) {
590 sort_node *sn = cur_node->avl_data;
592 if ( slapd_shutdown ) break;
594 next_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
596 op->o_bd = select_backend( &sn->sn_dn, 0 );
598 rc = be_entry_get_rw( op, &sn->sn_dn, NULL, NULL, 0, &e );
600 ch_free( cur_node->avl_data );
601 ber_memfree( cur_node );
603 cur_node = next_node;
606 if ( e && rc == LDAP_SUCCESS ) {
608 rs->sr_flags = REP_ENTRY_MUSTRELEASE;
609 rs->sr_err = send_search_entry( op, rs );
610 if ( rs->sr_err == LDAP_UNAVAILABLE )
615 /* Set the first entry to send for the next page */
616 so->so_tree = next_node;
621 static void send_entry(
626 Debug(LDAP_DEBUG_TRACE,
627 "%s: response control: status=%d, text=%s\n",
628 debug_header, rs->sr_err, SAFESTR(rs->sr_text, "<None>"));
633 rs->sr_attrs = op->ors_attrs;
635 /* RFC 2891: If critical then send the entries iff they were
636 * succesfully sorted. If non-critical send all entries
637 * whether they were sorted or not.
639 if ( (op->o_ctrlflag[sss_cid] != SLAP_CONTROL_CRITICAL) ||
640 (rs->sr_err == LDAP_SUCCESS) )
642 if ( so->so_vlv > SLAP_CONTROL_IGNORED ) {
643 send_list( op, rs, so );
645 /* Get the first node to send */
646 Avlnode *start_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
647 so->so_tree = start_node;
649 if ( so->so_paged <= SLAP_CONTROL_IGNORED ) {
650 /* Not paged result search. Send all entries.
651 * Set the page size to the number of entries
652 * so that send_page() will send all entries.
654 so->so_page_size = so->so_nentries;
657 send_page( op, rs, so );
662 static void send_result(
667 LDAPControl *ctrls[3];
670 rc = pack_sss_response_control( op, rs, ctrls );
671 if ( rc == LDAP_SUCCESS ) {
674 if ( so->so_paged > SLAP_CONTROL_IGNORED ) {
675 rc = pack_pagedresult_response_control( op, rs, so, ctrls+1 );
676 } else if ( so->so_vlv > SLAP_CONTROL_IGNORED ) {
677 rc = pack_vlv_response_control( op, rs, so, ctrls+1 );
679 if ( rc == LDAP_SUCCESS )
684 if ( ctrls[0] != NULL )
685 slap_add_ctrls( op, rs, ctrls );
686 send_ldap_result( op, rs );
688 if ( so->so_tree == NULL ) {
689 /* Search finished, so clean up */
690 free_sort_op( op->o_conn, so );
694 static int sssvlv_op_response(
698 sort_ctrl *sc = op->o_controls[sss_cid];
699 sort_op *so = op->o_callback->sc_private;
701 if ( rs->sr_type == REP_SEARCH ) {
708 len = sizeof(sort_node) + sc->sc_nkeys * sizeof(struct berval) +
709 rs->sr_entry->e_nname.bv_len + 1;
710 sn = op->o_tmpalloc( len, op->o_tmpmemctx );
711 sn->sn_vals = (struct berval *)(sn+1);
713 /* Build tmp list of key values */
714 for ( i=0; i<sc->sc_nkeys; i++ ) {
715 Attribute *a = attr_find( rs->sr_entry->e_attrs,
716 sc->sc_keys[i].sk_ad );
718 if ( a->a_numvals > 1 ) {
719 bv = select_value( a, &sc->sc_keys[i] );
723 sn->sn_vals[i] = *bv;
724 len += bv->bv_len + 1;
726 BER_BVZERO( &sn->sn_vals[i] );
730 /* Now dup into regular memory */
731 sn2 = ch_malloc( len );
732 sn2->sn_vals = (struct berval *)(sn2+1);
733 AC_MEMCPY( sn2->sn_vals, sn->sn_vals,
734 sc->sc_nkeys * sizeof(struct berval));
736 ptr = (char *)(sn2->sn_vals + sc->sc_nkeys);
737 sn2->sn_dn.bv_val = ptr;
738 sn2->sn_dn.bv_len = rs->sr_entry->e_nname.bv_len;
739 AC_MEMCPY( ptr, rs->sr_entry->e_nname.bv_val,
740 rs->sr_entry->e_nname.bv_len );
741 ptr += rs->sr_entry->e_nname.bv_len;
743 for ( i=0; i<sc->sc_nkeys; i++ ) {
744 if ( !BER_BVISNULL( &sn2->sn_vals[i] )) {
745 AC_MEMCPY(ptr, sn2->sn_vals[i].bv_val, sn2->sn_vals[i].bv_len);
746 sn2->sn_vals[i].bv_val = ptr;
747 ptr += sn2->sn_vals[i].bv_len;
751 op->o_tmpfree( sn, op->o_tmpmemctx );
753 sn->sn_conn = op->o_conn->c_conn_idx;
754 sn->sn_session = find_session_by_so( so->so_info->svi_max_percon, op->o_conn->c_conn_idx, so );
756 /* Insert into the AVL tree */
757 tavl_insert(&(so->so_tree), sn, node_insert, avl_dup_error);
761 /* Collected the keys so that they can be sorted. Thus, stop
762 * the entry from propagating.
764 rs->sr_err = LDAP_SUCCESS;
766 else if ( rs->sr_type == REP_RESULT ) {
767 /* Remove serversort response callback.
768 * We don't want the entries that we are about to send to be
769 * processed by serversort response again.
771 if ( op->o_callback->sc_response == sssvlv_op_response ) {
772 op->o_callback = op->o_callback->sc_next;
775 send_entry( op, rs, so );
776 send_result( op, rs, so );
782 static int sssvlv_op_search(
786 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
787 sssvlv_info *si = on->on_bi.bi_private;
788 int rc = SLAP_CB_CONTINUE;
790 sort_op *so = NULL, so2;
792 PagedResultsState *ps;
796 if ( op->o_ctrlflag[sss_cid] <= SLAP_CONTROL_IGNORED ) {
797 if ( op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ) {
798 LDAPControl *ctrls[2];
800 so2.so_vlv_target = 0;
802 so2.so_vlv_rc = LDAP_VLV_SSS_MISSING;
803 so2.so_vlv = op->o_ctrlflag[vlv_cid];
804 rc = pack_vlv_response_control( op, rs, &so2, ctrls );
805 if ( rc == LDAP_SUCCESS ) {
807 slap_add_ctrls( op, rs, ctrls );
809 rs->sr_err = LDAP_VLV_ERROR;
810 rs->sr_text = "Sort control is required with VLV";
813 /* Not server side sort so just continue */
814 return SLAP_CB_CONTINUE;
817 Debug(LDAP_DEBUG_TRACE,
818 "==> sssvlv_search: <%s> %s, control flag: %d\n",
819 op->o_req_dn.bv_val, op->ors_filterstr.bv_val,
820 op->o_ctrlflag[sss_cid]);
822 sc = op->o_controls[sss_cid];
823 if ( sc->sc_nkeys > si->svi_max_keys ) {
824 rs->sr_text = "Too many sort keys";
825 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
829 ps = ( op->o_pagedresults > SLAP_CONTROL_IGNORED ) ?
830 (PagedResultsState*)(op->o_pagedresults_state) : NULL;
831 vc = op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ?
832 op->o_controls[vlv_cid] : NULL;
835 rs->sr_text = "VLV incompatible with PagedResults";
836 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
841 ldap_pvt_thread_mutex_lock( &sort_conns_mutex );
842 /* Is there already a sort running on this conn? */
843 sess_id = find_session_by_context( si->svi_max_percon, op->o_conn->c_conn_idx, vc ? vc->vc_context : NO_VC_CONTEXT, ps ? ps->ps_cookie : NO_PS_COOKIE );
844 if ( sess_id >= 0 ) {
845 so = sort_conns[op->o_conn->c_conn_idx][sess_id];
846 /* Is it a continuation of a VLV search? */
847 if ( !vc || so->so_vlv <= SLAP_CONTROL_IGNORED ||
848 vc->vc_context != so->so_vcontext ) {
849 /* Is it a continuation of a paged search? */
850 if ( !ps || so->so_paged <= SLAP_CONTROL_IGNORED ||
851 op->o_conn->c_pagedresults_state.ps_cookie != ps->ps_cookie ) {
853 } else if ( !ps->ps_size ) {
854 /* Abandoning current request */
857 rs->sr_err = LDAP_SUCCESS;
860 if (( vc && so->so_paged > SLAP_CONTROL_IGNORED ) ||
861 ( ps && so->so_vlv > SLAP_CONTROL_IGNORED )) {
862 /* changed from paged to vlv or vice versa, abandon */
865 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
867 /* Are there too many running overall? */
868 } else if ( si->svi_num >= si->svi_max ) {
870 } else if ( ( sess_id = find_next_session(si->svi_max_percon, op->o_conn->c_conn_idx ) ) < 0 ) {
873 /* OK, this connection now has a sort running */
875 sort_conns[op->o_conn->c_conn_idx][sess_id] = &so2;
876 sort_conns[op->o_conn->c_conn_idx][sess_id]->so_session = sess_id;
878 ldap_pvt_thread_mutex_unlock( &sort_conns_mutex );
880 /* If we're a global overlay, this check got bypassed */
881 if ( !op->ors_limit && limits_check( op, rs ))
883 /* are we continuing a VLV search? */
884 if ( so && vc && vc->vc_context ) {
886 send_list( op, rs, so );
887 send_result( op, rs, so );
889 /* are we continuing a paged search? */
890 } else if ( so && ps && ps->ps_cookie ) {
892 send_page( op, rs, so );
893 send_result( op, rs, so );
896 slap_callback *cb = op->o_tmpalloc( sizeof(slap_callback),
898 /* Install serversort response callback to handle a new search */
900 so = ch_calloc( 1, sizeof(sort_op));
902 so = op->o_tmpcalloc( 1, sizeof(sort_op), op->o_tmpmemctx );
904 sort_conns[op->o_conn->c_conn_idx][sess_id] = so;
906 cb->sc_cleanup = NULL;
907 cb->sc_response = sssvlv_op_response;
908 cb->sc_next = op->o_callback;
915 so->so_paged = op->o_pagedresults;
916 so->so_page_size = ps->ps_size;
917 op->o_pagedresults = SLAP_CONTROL_IGNORED;
920 so->so_page_size = 0;
922 so->so_vlv = op->o_ctrlflag[vlv_cid];
923 so->so_vlv_target = 0;
926 so->so_vlv = SLAP_CONTROL_NONE;
929 so->so_session = sess_id;
930 so->so_vlv = op->o_ctrlflag[vlv_cid];
931 so->so_vcontext = (unsigned long)so;
937 if ( so && !so->so_nentries ) {
938 free_sort_op( op->o_conn, so );
940 rs->sr_text = "Other sort requests already in progress";
941 rs->sr_err = LDAP_BUSY;
945 send_ldap_result( op, rs );
951 static int get_ordering_rule(
952 AttributeDescription *ad,
953 struct berval *matchrule,
955 MatchingRule **ordering )
959 if ( matchrule && matchrule->bv_val ) {
960 mr = mr_find( matchrule->bv_val );
962 rs->sr_err = LDAP_INAPPROPRIATE_MATCHING;
963 rs->sr_text = "serverSort control: No ordering rule";
964 Debug(LDAP_DEBUG_TRACE, "%s: no ordering rule function for %s\n",
965 debug_header, matchrule->bv_val, 0);
969 mr = ad->ad_type->sat_ordering;
971 rs->sr_err = LDAP_INAPPROPRIATE_MATCHING;
972 rs->sr_text = "serverSort control: No ordering rule";
973 Debug(LDAP_DEBUG_TRACE,
974 "%s: no ordering rule specified and no default ordering rule for attribute %s\n",
975 debug_header, ad->ad_cname.bv_val, 0);
983 static int count_key(BerElement *ber)
990 /* Server Side Sort Control is a SEQUENCE of SEQUENCE */
991 for ( tag = ber_first_element( ber, &len, &end );
992 tag == LBER_SEQUENCE;
993 tag = ber_next_element( ber, &len, end ))
995 tag = ber_skip_tag( ber, &len );
996 ber_skip_data( ber, len );
1004 static int build_key(
1010 struct berval matchrule = BER_BVNULL;
1011 ber_int_t reverse = 0;
1014 MatchingRule *ordering = NULL;
1015 AttributeDescription *ad = NULL;
1018 if (( tag = ber_scanf( ber, "{" )) == LBER_ERROR ) {
1019 rs->sr_text = "serverSort control: decoding error";
1020 rs->sr_err = LDAP_PROTOCOL_ERROR;
1024 if (( tag = ber_scanf( ber, "m", &attr )) == LBER_ERROR ) {
1025 rs->sr_text = "serverSort control: attribute decoding error";
1026 rs->sr_err = LDAP_PROTOCOL_ERROR;
1030 tag = ber_peek_tag( ber, &len );
1031 if ( tag == LDAP_MATCHRULE_IDENTIFIER ) {
1032 if (( tag = ber_scanf( ber, "m", &matchrule )) == LBER_ERROR ) {
1033 rs->sr_text = "serverSort control: matchrule decoding error";
1034 rs->sr_err = LDAP_PROTOCOL_ERROR;
1037 tag = ber_peek_tag( ber, &len );
1040 if ( tag == LDAP_REVERSEORDER_IDENTIFIER ) {
1041 if (( tag = ber_scanf( ber, "b", &reverse )) == LBER_ERROR ) {
1042 rs->sr_text = "serverSort control: reverse decoding error";
1043 rs->sr_err = LDAP_PROTOCOL_ERROR;
1048 if (( tag = ber_scanf( ber, "}" )) == LBER_ERROR ) {
1049 rs->sr_text = "serverSort control: decoding error";
1050 rs->sr_err = LDAP_PROTOCOL_ERROR;
1054 if ( slap_bv2ad( &attr, &ad, &text ) != LDAP_SUCCESS ) {
1056 "serverSort control: Unrecognized attribute type in sort key";
1057 Debug(LDAP_DEBUG_TRACE,
1058 "%s: Unrecognized attribute type in sort key: %s\n",
1059 debug_header, SAFESTR(attr.bv_val, "<None>"), 0);
1060 rs->sr_err = LDAP_NO_SUCH_ATTRIBUTE;
1064 /* get_ordering_rule will set sr_err and sr_text */
1065 get_ordering_rule( ad, &matchrule, rs, &ordering );
1066 if ( rs->sr_err != LDAP_SUCCESS ) {
1071 key->sk_ordering = ordering;
1072 key->sk_direction = reverse ? -1 : 1;
1077 static int sss_parseCtrl(
1082 BerElementBuffer berbuf;
1089 rs->sr_err = LDAP_PROTOCOL_ERROR;
1091 if ( op->o_ctrlflag[sss_cid] > SLAP_CONTROL_IGNORED ) {
1092 rs->sr_text = "sorted results control specified multiple times";
1093 } else if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
1094 rs->sr_text = "sorted results control value is absent";
1095 } else if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
1096 rs->sr_text = "sorted results control value is empty";
1098 rs->sr_err = LDAP_SUCCESS;
1100 if ( rs->sr_err != LDAP_SUCCESS )
1103 op->o_ctrlflag[sss_cid] = ctrl->ldctl_iscritical ?
1104 SLAP_CONTROL_CRITICAL : SLAP_CONTROL_NONCRITICAL;
1106 ber = (BerElement *)&berbuf;
1107 ber_init2( ber, &ctrl->ldctl_value, 0 );
1108 i = count_key( ber );
1110 sc = op->o_tmpalloc( sizeof(sort_ctrl) +
1111 (i-1) * sizeof(sort_key), op->o_tmpmemctx );
1113 op->o_controls[sss_cid] = sc;
1115 /* peel off initial sequence */
1116 ber_scanf( ber, "{" );
1120 if ( build_key( ber, rs, &sc->sc_keys[i] ) != LDAP_SUCCESS )
1123 tag = ber_peek_tag( ber, &len );
1124 } while ( tag != LBER_DEFAULT );
1129 static int vlv_parseCtrl(
1134 BerElementBuffer berbuf;
1140 rs->sr_err = LDAP_PROTOCOL_ERROR;
1143 if ( op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ) {
1144 rs->sr_text = "vlv control specified multiple times";
1145 } else if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
1146 rs->sr_text = "vlv control value is absent";
1147 } else if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
1148 rs->sr_text = "vlv control value is empty";
1150 if ( rs->sr_text != NULL )
1153 op->o_ctrlflag[vlv_cid] = ctrl->ldctl_iscritical ?
1154 SLAP_CONTROL_CRITICAL : SLAP_CONTROL_NONCRITICAL;
1156 ber = (BerElement *)&berbuf;
1157 ber_init2( ber, &ctrl->ldctl_value, 0 );
1159 rs->sr_err = LDAP_PROTOCOL_ERROR;
1161 tag = ber_scanf( ber, "{ii", &vc2.vc_before, &vc2.vc_after );
1162 if ( tag == LBER_ERROR ) {
1166 tag = ber_peek_tag( ber, &len );
1167 if ( tag == LDAP_VLVBYINDEX_IDENTIFIER ) {
1168 tag = ber_scanf( ber, "{ii}", &vc2.vc_offset, &vc2.vc_count );
1169 if ( tag == LBER_ERROR )
1171 BER_BVZERO( &vc2.vc_value );
1172 } else if ( tag == LDAP_VLVBYVALUE_IDENTIFIER ) {
1173 tag = ber_scanf( ber, "m", &vc2.vc_value );
1174 if ( tag == LBER_ERROR || BER_BVISNULL( &vc2.vc_value ))
1179 tag = ber_peek_tag( ber, &len );
1180 if ( tag == LDAP_VLVCONTEXT_IDENTIFIER ) {
1182 tag = ber_scanf( ber, "m", &bv );
1183 if ( tag == LBER_ERROR || bv.bv_len != sizeof(vc2.vc_context))
1185 AC_MEMCPY( &vc2.vc_context, bv.bv_val, bv.bv_len );
1190 vc = op->o_tmpalloc( sizeof(vlv_ctrl), op->o_tmpmemctx );
1192 op->o_controls[vlv_cid] = vc;
1193 rs->sr_err = LDAP_SUCCESS;
1198 static int sssvlv_connection_destroy( BackendDB *be, Connection *conn )
1200 slap_overinst *on = (slap_overinst *)be->bd_info;
1201 sssvlv_info *si = on->on_bi.bi_private;
1203 if ( sort_conns[conn->c_conn_idx] ) {
1204 free_sort_ops( conn, sort_conns[conn->c_conn_idx], si->svi_max_percon );
1207 return LDAP_SUCCESS;
1210 static int sssvlv_db_open(
1214 slap_overinst *on = (slap_overinst *)be->bd_info;
1215 sssvlv_info *si = on->on_bi.bi_private;
1219 /* If not set, default to 1/2 of available threads */
1221 si->svi_max = connection_pool_max / 2;
1223 if ( dtblsize && !sort_conns ) {
1224 ldap_pvt_thread_mutex_init( &sort_conns_mutex );
1225 /* accommodate for c_conn_idx == -1 */
1226 sort_conns = ch_calloc( dtblsize + 1, sizeof(sort_op **) );
1227 for ( conn_index = 0 ; conn_index < dtblsize + 1 ; conn_index++ ) {
1228 sort_conns[conn_index] = ch_calloc( si->svi_max_percon, sizeof(sort_op *) );
1233 rc = overlay_register_control( be, LDAP_CONTROL_SORTREQUEST );
1234 if ( rc == LDAP_SUCCESS )
1235 rc = overlay_register_control( be, LDAP_CONTROL_VLVREQUEST );
1239 static ConfigTable sssvlv_cfg[] = {
1240 { "sssvlv-max", "num",
1241 2, 2, 0, ARG_INT|ARG_OFFSET,
1242 (void *)offsetof(sssvlv_info, svi_max),
1243 "( OLcfgOvAt:21.1 NAME 'olcSssVlvMax' "
1244 "DESC 'Maximum number of concurrent Sort requests' "
1245 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1246 { "sssvlv-maxkeys", "num",
1247 2, 2, 0, ARG_INT|ARG_OFFSET,
1248 (void *)offsetof(sssvlv_info, svi_max_keys),
1249 "( OLcfgOvAt:21.2 NAME 'olcSssVlvMaxKeys' "
1250 "DESC 'Maximum number of Keys in a Sort request' "
1251 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1252 { "sssvlv-maxpercon", "num",
1253 2, 2, 0, ARG_INT|ARG_OFFSET,
1254 (void *)offsetof(sssvlv_info, svi_max_percon),
1255 "( OLcfgOvAt:21.3 NAME 'olcSssVlvMaxPerConn' "
1256 "DESC 'Maximum number of concurrent paged search requests per connection' "
1257 "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1258 { NULL, NULL, 0, 0, 0, ARG_IGNORED }
1261 static ConfigOCs sssvlv_ocs[] = {
1262 { "( OLcfgOvOc:21.1 "
1263 "NAME 'olcSssVlvConfig' "
1264 "DESC 'SSS VLV configuration' "
1265 "SUP olcOverlayConfig "
1266 "MAY ( olcSssVlvMax $ olcSssVlvMaxKeys ) )",
1267 Cft_Overlay, sssvlv_cfg, NULL, NULL },
1271 static int sssvlv_db_init(
1275 slap_overinst *on = (slap_overinst *)be->bd_info;
1278 if ( ov_count == 0 ) {
1281 rc = register_supported_control2( LDAP_CONTROL_SORTREQUEST,
1287 if ( rc != LDAP_SUCCESS ) {
1288 Debug( LDAP_DEBUG_ANY, "Failed to register Sort Request control '%s' (%d)\n",
1289 LDAP_CONTROL_SORTREQUEST, rc, 0 );
1293 rc = register_supported_control2( LDAP_CONTROL_VLVREQUEST,
1299 if ( rc != LDAP_SUCCESS ) {
1300 Debug( LDAP_DEBUG_ANY, "Failed to register VLV Request control '%s' (%d)\n",
1301 LDAP_CONTROL_VLVREQUEST, rc, 0 );
1302 #ifdef SLAP_CONFIG_DELETE
1303 overlay_unregister_control( be, LDAP_CONTROL_SORTREQUEST );
1304 unregister_supported_control( LDAP_CONTROL_SORTREQUEST );
1305 #endif /* SLAP_CONFIG_DELETE */
1310 si = (sssvlv_info *)ch_malloc(sizeof(sssvlv_info));
1311 on->on_bi.bi_private = si;
1315 si->svi_max_keys = SSSVLV_DEFAULT_MAX_KEYS;
1316 si->svi_max_percon = SSSVLV_DEFAULT_MAX_REQUEST_PER_CONN;
1320 return LDAP_SUCCESS;
1323 static int sssvlv_db_destroy(
1327 slap_overinst *on = (slap_overinst *)be->bd_info;
1328 sssvlv_info *si = (sssvlv_info *)on->on_bi.bi_private;
1332 if ( !ov_count && sort_conns) {
1334 for ( conn_index = 0 ; conn_index < dtblsize + 1 ; conn_index++ ) {
1335 ch_free(sort_conns[conn_index]);
1337 ch_free(sort_conns);
1338 ldap_pvt_thread_mutex_destroy( &sort_conns_mutex );
1341 #ifdef SLAP_CONFIG_DELETE
1342 overlay_unregister_control( be, LDAP_CONTROL_SORTREQUEST );
1343 overlay_unregister_control( be, LDAP_CONTROL_VLVREQUEST );
1344 if ( ov_count == 0 ) {
1345 unregister_supported_control( LDAP_CONTROL_SORTREQUEST );
1346 unregister_supported_control( LDAP_CONTROL_VLVREQUEST );
1348 #endif /* SLAP_CONFIG_DELETE */
1352 on->on_bi.bi_private = NULL;
1354 return LDAP_SUCCESS;
1357 static slap_overinst sssvlv;
1359 int sssvlv_initialize()
1363 sssvlv.on_bi.bi_type = "sssvlv";
1364 sssvlv.on_bi.bi_db_init = sssvlv_db_init;
1365 sssvlv.on_bi.bi_db_destroy = sssvlv_db_destroy;
1366 sssvlv.on_bi.bi_db_open = sssvlv_db_open;
1367 sssvlv.on_bi.bi_connection_destroy = sssvlv_connection_destroy;
1368 sssvlv.on_bi.bi_op_search = sssvlv_op_search;
1370 sssvlv.on_bi.bi_cf_ocs = sssvlv_ocs;
1372 rc = config_register_schema( sssvlv_cfg, sssvlv_ocs );
1376 rc = overlay_register( &sssvlv );
1377 if ( rc != LDAP_SUCCESS ) {
1378 Debug( LDAP_DEBUG_ANY, "Failed to register server side sort overlay\n", 0, 0, 0 );
1384 #if SLAPD_OVER_SSSVLV == SLAPD_MOD_DYNAMIC
1385 int init_module( int argc, char *argv[])
1387 return sssvlv_initialize();
1391 #endif /* SLAPD_OVER_SSSVLV */