git.sur5r.net Git - openldap/blob - servers/slapd/overlays/sssvlv.c

   1 /* sssvlv.c - server side sort / virtual list view */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2009-2011 The OpenLDAP Foundation.
   6  * Portions copyright 2009 Symas Corporation.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  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>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by Howard Chu for inclusion in
  19  * OpenLDAP Software. Support for multiple sorts per connection added
  20  * by Raphael Ouazana.
  21  */
  22
  23 #include "portable.h"
  24
  25 #ifdef SLAPD_OVER_SSSVLV
  26
  27 #include <stdio.h>
  28
  29 #include <ac/string.h>
  30 #include <ac/ctype.h>
  31
  32 #include <avl.h>
  33
  34 #include "slap.h"
  35 #include "lutil.h"
  36 #include "config.h"
  37
  38 #include "../../../libraries/liblber/lber-int.h"        /* ber_rewind */
  39
  40 /* RFC2891: Server Side Sorting
  41  * RFC2696: Paged Results
  42  */
  43 #ifndef LDAP_MATCHRULE_IDENTIFIER
  44 #define LDAP_MATCHRULE_IDENTIFIER      0x80L
  45 #define LDAP_REVERSEORDER_IDENTIFIER   0x81L
  46 #define LDAP_ATTRTYPES_IDENTIFIER      0x80L
  47 #endif
  48
  49 /* draft-ietf-ldapext-ldapv3-vlv-09.txt: Virtual List Views
  50  */
  51 #ifndef LDAP_VLVBYINDEX_IDENTIFIER
  52 #define LDAP_VLVBYINDEX_IDENTIFIER         0xa0L
  53 #define LDAP_VLVBYVALUE_IDENTIFIER     0x81L
  54 #define LDAP_VLVCONTEXT_IDENTIFIER     0x04L
  55
  56 #define LDAP_VLV_SSS_MISSING    0x4C
  57 #define LDAP_VLV_RANGE_ERROR    0x4D
  58 #endif
  59
  60 #define SAFESTR(macro_str, macro_def) ((macro_str) ? (macro_str) : (macro_def))
  61
  62 #define SSSVLV_DEFAULT_MAX_KEYS 5
  63 #define SSSVLV_DEFAULT_MAX_REQUEST_PER_CONN 5
  64
  65 #define NO_PS_COOKIE (PagedResultsCookie) -1
  66 #define NO_VC_CONTEXT (unsigned long) -1
  67
  68 typedef struct vlv_ctrl {
  69         int vc_before;
  70         int vc_after;
  71         int     vc_offset;
  72         int vc_count;
  73         struct berval vc_value;
  74         unsigned long vc_context;
  75 } vlv_ctrl;
  76
  77 typedef struct sort_key
  78 {
  79         AttributeDescription    *sk_ad;
  80         MatchingRule                    *sk_ordering;
  81         int                                             sk_direction;   /* 1=normal, -1=reverse */
  82 } sort_key;
  83
  84 typedef struct sort_ctrl {
  85         int sc_nkeys;
  86         sort_key sc_keys[1];
  87 } sort_ctrl;
  88
  89
  90 typedef struct sort_node
  91 {
  92         int sn_conn;
  93         int sn_session;
  94         struct berval sn_dn;
  95         struct berval *sn_vals;
  96 } sort_node;
  97
  98 typedef struct sssvlv_info
  99 {
 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 */
 104 } sssvlv_info;
 105
 106 typedef struct sort_op
 107 {
 108         Avlnode *so_tree;
 109         sort_ctrl *so_ctrl;
 110         sssvlv_info *so_info;
 111         int so_paged;
 112         int so_page_size;
 113         int so_nentries;
 114         int so_vlv;
 115         int so_vlv_rc;
 116         int so_vlv_target;
 117         int so_session;
 118         unsigned long so_vcontext;
 119 } sort_op;
 120
 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;
 125 static int ov_count;
 126 static const char *debug_header = "sssvlv";
 127
 128 static int sss_cid;
 129 static int vlv_cid;
 130
 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).
 136  */
 137 static struct berval* select_value(
 138         Attribute               *attr,
 139         sort_key                        *key )
 140 {
 141         struct berval* ber1, *ber2;
 142         MatchingRule *mr = key->sk_ordering;
 143         unsigned i;
 144         int cmp;
 145
 146         ber1 = &(attr->a_nvals[0]);
 147         ber2 = ber1+1;
 148         for ( i = 1; i < attr->a_numvals; i++,ber2++ ) {
 149                 mr->smr_match( &cmp, 0, mr->smr_syntax, mr, ber1, ber2 );
 150                 if ( cmp > 0 ) {
 151                         ber1 = ber2;
 152                 }
 153         }
 154
 155         Debug(LDAP_DEBUG_TRACE, "%s: value selected for compare: %s\n",
 156                 debug_header,
 157                 SAFESTR(ber1->bv_val, "<Empty>"),
 158                 0);
 159
 160         return ber1;
 161 }
 162
 163 static int node_cmp( const void* val1, const void* val2 )
 164 {
 165         sort_node *sn1 = (sort_node *)val1;
 166         sort_node *sn2 = (sort_node *)val2;
 167         sort_ctrl *sc;
 168         MatchingRule *mr;
 169         int i, cmp = 0;
 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;
 174
 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] ))
 178                                 cmp = 0;
 179                         else
 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;
 183                 } else {
 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] );
 187                         if ( cmp )
 188                                 cmp *= sc->sc_keys[i].sk_direction;
 189                 }
 190         }
 191         return cmp;
 192 }
 193
 194 static int node_insert( const void *val1, const void *val2 )
 195 {
 196         /* Never return equal so that new entries are always inserted */
 197         return node_cmp( val1, val2 ) < 0 ? -1 : 1;
 198 }
 199
 200 static int pack_vlv_response_control(
 201         Operation               *op,
 202         SlapReply               *rs,
 203         sort_op                 *so,
 204         LDAPControl     **ctrlsp )
 205 {
 206         LDAPControl                     *ctrl;
 207         BerElementBuffer        berbuf;
 208         BerElement                      *ber            = (BerElement *)&berbuf;
 209         struct berval           cookie, bv;
 210         int                                     rc;
 211
 212         ber_init2( ber, NULL, LBER_USE_DER );
 213         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
 214
 215         rc = ber_printf( ber, "{iie", so->so_vlv_target, so->so_nentries,
 216                 so->so_vlv_rc );
 217
 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 );
 222         }
 223
 224         if ( rc != -1 ) {
 225                 rc = ber_printf( ber, "}" );
 226         }
 227
 228         if ( rc != -1 ) {
 229                 rc = ber_flatten2( ber, &bv, 0 );
 230         }
 231
 232         if ( rc != -1 ) {
 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 );
 240                 ctrlsp[0] = ctrl;
 241         } else {
 242                 ctrlsp[0] = NULL;
 243                 rs->sr_err = LDAP_OTHER;
 244         }
 245
 246         ber_free_buf( ber );
 247
 248         return rs->sr_err;
 249 }
 250
 251 static int pack_pagedresult_response_control(
 252         Operation               *op,
 253         SlapReply               *rs,
 254         sort_op                 *so,
 255         LDAPControl     **ctrlsp )
 256 {
 257         LDAPControl                     *ctrl;
 258         BerElementBuffer        berbuf;
 259         BerElement                      *ber            = (BerElement *)&berbuf;
 260         PagedResultsCookie      resp_cookie;
 261         struct berval           cookie, bv;
 262         int                                     rc;
 263
 264         ber_init2( ber, NULL, LBER_USE_DER );
 265         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
 266
 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;
 271         } else {
 272                 resp_cookie             = ( PagedResultsCookie )0;
 273                 BER_BVZERO( &cookie );
 274         }
 275
 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
 279                   + rs->sr_nentries;
 280
 281         rc = ber_printf( ber, "{iO}", so->so_nentries, &cookie );
 282         if ( rc != -1 ) {
 283                 rc = ber_flatten2( ber, &bv, 0 );
 284         }
 285
 286         if ( rc != -1 ) {
 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 );
 294                 ctrlsp[0] = ctrl;
 295         } else {
 296                 ctrlsp[0] = NULL;
 297                 rs->sr_err = LDAP_OTHER;
 298         }
 299
 300         ber_free_buf( ber );
 301
 302         return rs->sr_err;
 303 }
 304
 305 static int pack_sss_response_control(
 306         Operation               *op,
 307         SlapReply               *rs,
 308         LDAPControl     **ctrlsp )
 309 {
 310         LDAPControl                     *ctrl;
 311         BerElementBuffer        berbuf;
 312         BerElement                      *ber            = (BerElement *)&berbuf;
 313         struct berval           bv;
 314         int                                     rc;
 315
 316         ber_init2( ber, NULL, LBER_USE_DER );
 317         ber_set_option( ber, LBER_OPT_BER_MEMCTX, &op->o_tmpmemctx );
 318
 319         /* Pack error code */
 320         rc = ber_printf(ber, "{e}", rs->sr_err);
 321
 322         if ( rc != -1)
 323                 rc = ber_flatten2( ber, &bv, 0 );
 324
 325         if ( rc != -1 ) {
 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 );
 333                 ctrlsp[0] = ctrl;
 334         } else {
 335                 ctrlsp[0] = NULL;
 336                 rs->sr_err = LDAP_OTHER;
 337         }
 338
 339         ber_free_buf( ber );
 340
 341         return rs->sr_err;
 342 }
 343
 344 /* Return the session id or -1 if unknown */
 345 static int find_session_by_so(
 346         int svi_max_percon,
 347         int conn_id,
 348         sort_op *so )
 349 {
 350         int sess_id;
 351         if (so == NULL) {
 352                 return -1;
 353         }
 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 )
 356                         return sess_id;
 357         }
 358         return -1;
 359 }
 360
 361 /* Return the session id or -1 if unknown */
 362 static int find_session_by_context(
 363         int svi_max_percon,
 364         int conn_id,
 365         unsigned long vc_context,
 366         PagedResultsCookie ps_cookie )
 367 {
 368         int sess_id;
 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 ) )
 373                         return sess_id;
 374         }
 375         return -1;
 376 }
 377
 378 static int find_next_session(
 379         int svi_max_percon,
 380         int conn_id )
 381 {
 382         int sess_id;
 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]) {
 386                         return sess_id;
 387                 }
 388         }
 389         if (sess_id >= svi_max_percon) {
 390                 return -1;
 391         } else {
 392                 return sess_id;
 393         }
 394 }
 395
 396 static void free_sort_op( Connection *conn, sort_op *so )
 397 {
 398         int sess_id;
 399         if ( so->so_tree ) {
 400                 tavl_free( so->so_tree, ch_free );
 401                 so->so_tree = NULL;
 402         }
 403
 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 );
 409
 410         ch_free( so );
 411 }
 412
 413 static void free_sort_ops( Connection *conn, sort_op **sos, int svi_max_percon )
 414 {
 415         int sess_id;
 416         sort_op *so;
 417
 418         for( sess_id = 0; sess_id < svi_max_percon ; sess_id++ ) {
 419                 so = sort_conns[conn->c_conn_idx][sess_id];
 420                 if ( so ) {
 421                         free_sort_op( conn, so );
 422                         sort_conns[conn->c_conn_idx][sess_id] = NULL;
 423                 }
 424         }
 425 }
 426
 427 static void send_list(
 428         Operation               *op,
 429         SlapReply               *rs,
 430         sort_op                 *so)
 431 {
 432         Avlnode *cur_node, *tmp_node;
 433         vlv_ctrl *vc = op->o_controls[vlv_cid];
 434         int i, j, dir, rc;
 435         BackendDB *be;
 436         Entry *e;
 437         LDAPControl *ctrls[2];
 438
 439         rs->sr_attrs = op->ors_attrs;
 440
 441         /* FIXME: it may be better to just flatten the tree into
 442          * an array before doing all of this...
 443          */
 444
 445         /* Are we just counting an offset? */
 446         if ( BER_BVISNULL( &vc->vc_value )) {
 447                 if ( vc->vc_offset == vc->vc_count ) {
 448                         /* wants the last entry in the list */
 449                         cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
 450                         so->so_vlv_target = so->so_nentries;
 451                 } else if ( vc->vc_offset == 1 ) {
 452                         /* wants the first entry in the list */
 453                         cur_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
 454                         so->so_vlv_target = 1;
 455                 } else {
 456                         int target;
 457                         /* Just iterate to the right spot */
 458                         if ( vc->vc_count && vc->vc_count != so->so_nentries ) {
 459                                 if ( vc->vc_offset > vc->vc_count )
 460                                         goto range_err;
 461                                 target = so->so_nentries * vc->vc_offset / vc->vc_count;
 462                         } else {
 463                                 if ( vc->vc_offset > so->so_nentries ) {
 464 range_err:
 465                                         so->so_vlv_rc = LDAP_VLV_RANGE_ERROR;
 466                                         pack_vlv_response_control( op, rs, so, ctrls );
 467                                         ctrls[1] = NULL;
 468                                         slap_add_ctrls( op, rs, ctrls );
 469                                         rs->sr_err = LDAP_VLV_ERROR;
 470                                         return;
 471                                 }
 472                                 target = vc->vc_offset;
 473                         }
 474                         so->so_vlv_target = target;
 475                         /* Start at left and go right, or start at right and go left? */
 476                         if ( target < so->so_nentries / 2 ) {
 477                                 cur_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
 478                                 dir = TAVL_DIR_RIGHT;
 479                         } else {
 480                                 cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
 481                                 dir = TAVL_DIR_LEFT;
 482                                 target = so->so_nentries - target + 1;
 483                         }
 484                         for ( i=1; i<target; i++ )
 485                                 cur_node = tavl_next( cur_node, dir );
 486                 }
 487         } else {
 488         /* we're looking for a specific value */
 489                 sort_ctrl *sc = so->so_ctrl;
 490                 MatchingRule *mr = sc->sc_keys[0].sk_ordering;
 491                 sort_node *sn;
 492                 struct berval bv;
 493
 494                 if ( mr->smr_normalize ) {
 495                         rc = mr->smr_normalize( SLAP_MR_VALUE_OF_SYNTAX,
 496                                 mr->smr_syntax, mr, &vc->vc_value, &bv, op->o_tmpmemctx );
 497                         if ( rc ) {
 498                                 so->so_vlv_rc = LDAP_INAPPROPRIATE_MATCHING;
 499                                 pack_vlv_response_control( op, rs, so, ctrls );
 500                                 ctrls[1] = NULL;
 501                                 slap_add_ctrls( op, rs, ctrls );
 502                                 rs->sr_err = LDAP_VLV_ERROR;
 503                                 return;
 504                         }
 505                 } else {
 506                         bv = vc->vc_value;
 507                 }
 508
 509                 sn = op->o_tmpalloc( sizeof(sort_node) +
 510                         sc->sc_nkeys * sizeof(struct berval), op->o_tmpmemctx );
 511                 sn->sn_vals = (struct berval *)(sn+1);
 512                 sn->sn_conn = op->o_conn->c_conn_idx;
 513                 sn->sn_session = find_session_by_so( so->so_info->svi_max_percon, op->o_conn->c_conn_idx, so );
 514                 sn->sn_vals[0] = bv;
 515                 for (i=1; i<sc->sc_nkeys; i++) {
 516                         BER_BVZERO( &sn->sn_vals[i] );
 517                 }
 518                 cur_node = tavl_find3( so->so_tree, sn, node_cmp, &j );
 519                 /* didn't find >= match */
 520                 if ( j > 0 ) {
 521                         if ( cur_node )
 522                                 cur_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
 523                 }
 524                 op->o_tmpfree( sn, op->o_tmpmemctx );
 525
 526                 if ( !cur_node ) {
 527                         so->so_vlv_target = so->so_nentries + 1;
 528                 } else {
 529                         sort_node *sn = so->so_tree->avl_data;
 530                         /* start from the left or the right side? */
 531                         mr->smr_match( &i, 0, mr->smr_syntax, mr, &bv, &sn->sn_vals[0] );
 532                         if ( i > 0 ) {
 533                                 tmp_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
 534                                 dir = TAVL_DIR_LEFT;
 535                         } else {
 536                                 tmp_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
 537                                 dir = TAVL_DIR_RIGHT;
 538                         }
 539                         for (i=0; tmp_node != cur_node;
 540                                 tmp_node = tavl_next( tmp_node, dir ), i++);
 541                         so->so_vlv_target = (dir == TAVL_DIR_RIGHT) ? i+1 : so->so_nentries - i;
 542                 }
 543                 if ( bv.bv_val != vc->vc_value.bv_val )
 544                         op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
 545         }
 546         if ( !cur_node ) {
 547                 i = 1;
 548                 cur_node = tavl_end(so->so_tree, TAVL_DIR_RIGHT);
 549         } else {
 550                 i = 0;
 551         }
 552         for ( ; i<vc->vc_before; i++ ) {
 553                 tmp_node = tavl_next( cur_node, TAVL_DIR_LEFT );
 554                 if ( !tmp_node ) break;
 555                 cur_node = tmp_node;
 556         }
 557         j = i + vc->vc_after + 1;
 558         be = op->o_bd;
 559         for ( i=0; i<j; i++ ) {
 560                 sort_node *sn = cur_node->avl_data;
 561
 562                 if ( slapd_shutdown ) break;
 563
 564                 op->o_bd = select_backend( &sn->sn_dn, 0 );
 565                 e = NULL;
 566                 rc = be_entry_get_rw( op, &sn->sn_dn, NULL, NULL, 0, &e );
 567
 568                 if ( e && rc == LDAP_SUCCESS ) {
 569                         rs->sr_entry = e;
 570                         rs->sr_flags = REP_ENTRY_MUSTRELEASE;
 571                         rs->sr_err = send_search_entry( op, rs );
 572                         if ( rs->sr_err == LDAP_UNAVAILABLE )
 573                                 break;
 574                 }
 575                 cur_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
 576                 if ( !cur_node ) break;
 577         }
 578         so->so_vlv_rc = LDAP_SUCCESS;
 579
 580         op->o_bd = be;
 581 }
 582
 583 static void send_page( Operation *op, SlapReply *rs, sort_op *so )
 584 {
 585         Avlnode         *cur_node               = so->so_tree;
 586         Avlnode         *next_node              = NULL;
 587         BackendDB *be = op->o_bd;
 588         Entry *e;
 589         int rc;
 590
 591         rs->sr_attrs = op->ors_attrs;
 592
 593         while ( cur_node && rs->sr_nentries < so->so_page_size ) {
 594                 sort_node *sn = cur_node->avl_data;
 595
 596                 if ( slapd_shutdown ) break;
 597
 598                 next_node = tavl_next( cur_node, TAVL_DIR_RIGHT );
 599
 600                 op->o_bd = select_backend( &sn->sn_dn, 0 );
 601                 e = NULL;
 602                 rc = be_entry_get_rw( op, &sn->sn_dn, NULL, NULL, 0, &e );
 603
 604                 ch_free( cur_node->avl_data );
 605                 ber_memfree( cur_node );
 606
 607                 cur_node = next_node;
 608                 so->so_nentries--;
 609
 610                 if ( e && rc == LDAP_SUCCESS ) {
 611                         rs->sr_entry = e;
 612                         rs->sr_flags = REP_ENTRY_MUSTRELEASE;
 613                         rs->sr_err = send_search_entry( op, rs );
 614                         if ( rs->sr_err == LDAP_UNAVAILABLE )
 615                                 break;
 616                 }
 617         }
 618
 619         /* Set the first entry to send for the next page */
 620         so->so_tree = next_node;
 621
 622         op->o_bd = be;
 623 }
 624
 625 static void send_entry(
 626         Operation               *op,
 627         SlapReply               *rs,
 628         sort_op                 *so)
 629 {
 630         Debug(LDAP_DEBUG_TRACE,
 631                 "%s: response control: status=%d, text=%s\n",
 632                 debug_header, rs->sr_err, SAFESTR(rs->sr_text, "<None>"));
 633
 634         if ( !so->so_tree )
 635                 return;
 636
 637         /* RFC 2891: If critical then send the entries iff they were
 638          * succesfully sorted.  If non-critical send all entries
 639          * whether they were sorted or not.
 640          */
 641         if ( (op->o_ctrlflag[sss_cid] != SLAP_CONTROL_CRITICAL) ||
 642                  (rs->sr_err == LDAP_SUCCESS) )
 643         {
 644                 if ( so->so_vlv > SLAP_CONTROL_IGNORED ) {
 645                         send_list( op, rs, so );
 646                 } else {
 647                         /* Get the first node to send */
 648                         Avlnode *start_node = tavl_end(so->so_tree, TAVL_DIR_LEFT);
 649                         so->so_tree = start_node;
 650
 651                         if ( so->so_paged <= SLAP_CONTROL_IGNORED ) {
 652                                 /* Not paged result search.  Send all entries.
 653                                  * Set the page size to the number of entries
 654                                  * so that send_page() will send all entries.
 655                                  */
 656                                 so->so_page_size = so->so_nentries;
 657                         }
 658
 659                         send_page( op, rs, so );
 660                 }
 661         }
 662 }
 663
 664 static void send_result(
 665         Operation               *op,
 666         SlapReply               *rs,
 667         sort_op                 *so)
 668 {
 669         LDAPControl *ctrls[3];
 670         int rc, i = 0;
 671
 672         rc = pack_sss_response_control( op, rs, ctrls );
 673         if ( rc == LDAP_SUCCESS ) {
 674                 i++;
 675                 rc = -1;
 676                 if ( so->so_paged > SLAP_CONTROL_IGNORED ) {
 677                         rc = pack_pagedresult_response_control( op, rs, so, ctrls+1 );
 678                 } else if ( so->so_vlv > SLAP_CONTROL_IGNORED ) {
 679                         rc = pack_vlv_response_control( op, rs, so, ctrls+1 );
 680                 }
 681                 if ( rc == LDAP_SUCCESS )
 682                         i++;
 683         }
 684         ctrls[i] = NULL;
 685
 686         if ( ctrls[0] != NULL )
 687                 slap_add_ctrls( op, rs, ctrls );
 688         send_ldap_result( op, rs );
 689
 690         if ( so->so_tree == NULL ) {
 691                 /* Search finished, so clean up */
 692                 free_sort_op( op->o_conn, so );
 693         }
 694 }
 695
 696 static int sssvlv_op_response(
 697         Operation       *op,
 698         SlapReply       *rs )
 699 {
 700         sort_ctrl *sc = op->o_controls[sss_cid];
 701         sort_op *so = op->o_callback->sc_private;
 702
 703         if ( rs->sr_type == REP_SEARCH ) {
 704                 int i;
 705                 size_t len;
 706                 sort_node *sn, *sn2;
 707                 struct berval *bv;
 708                 char *ptr;
 709
 710                 len = sizeof(sort_node) + sc->sc_nkeys * sizeof(struct berval) +
 711                         rs->sr_entry->e_nname.bv_len + 1;
 712                 sn = op->o_tmpalloc( len, op->o_tmpmemctx );
 713                 sn->sn_vals = (struct berval *)(sn+1);
 714
 715                 /* Build tmp list of key values */
 716                 for ( i=0; i<sc->sc_nkeys; i++ ) {
 717                         Attribute *a = attr_find( rs->sr_entry->e_attrs,
 718                                 sc->sc_keys[i].sk_ad );
 719                         if ( a ) {
 720                                 if ( a->a_numvals > 1 ) {
 721                                         bv = select_value( a, &sc->sc_keys[i] );
 722                                 } else {
 723                                         bv = a->a_nvals;
 724                                 }
 725                                 sn->sn_vals[i] = *bv;
 726                                 len += bv->bv_len + 1;
 727                         } else {
 728                                 BER_BVZERO( &sn->sn_vals[i] );
 729                         }
 730                 }
 731
 732                 /* Now dup into regular memory */
 733                 sn2 = ch_malloc( len );
 734                 sn2->sn_vals = (struct berval *)(sn2+1);
 735                 AC_MEMCPY( sn2->sn_vals, sn->sn_vals,
 736                                 sc->sc_nkeys * sizeof(struct berval));
 737
 738                 ptr = (char *)(sn2->sn_vals + sc->sc_nkeys);
 739                 sn2->sn_dn.bv_val = ptr;
 740                 sn2->sn_dn.bv_len = rs->sr_entry->e_nname.bv_len;
 741                 AC_MEMCPY( ptr, rs->sr_entry->e_nname.bv_val,
 742                         rs->sr_entry->e_nname.bv_len );
 743                 ptr += rs->sr_entry->e_nname.bv_len;
 744                 *ptr++ = '\0';
 745                 for ( i=0; i<sc->sc_nkeys; i++ ) {
 746                         if ( !BER_BVISNULL( &sn2->sn_vals[i] )) {
 747                                 AC_MEMCPY(ptr, sn2->sn_vals[i].bv_val, sn2->sn_vals[i].bv_len);
 748                                 sn2->sn_vals[i].bv_val = ptr;
 749                                 ptr += sn2->sn_vals[i].bv_len;
 750                                 *ptr++ = '\0';
 751                         }
 752                 }
 753                 op->o_tmpfree( sn, op->o_tmpmemctx );
 754                 sn = sn2;
 755                 sn->sn_conn = op->o_conn->c_conn_idx;
 756                 sn->sn_session = find_session_by_so( so->so_info->svi_max_percon, op->o_conn->c_conn_idx, so );
 757
 758                 /* Insert into the AVL tree */
 759                 tavl_insert(&(so->so_tree), sn, node_insert, avl_dup_error);
 760
 761                 so->so_nentries++;
 762
 763                 /* Collected the keys so that they can be sorted.  Thus, stop
 764                  * the entry from propagating.
 765                  */
 766                 rs->sr_err = LDAP_SUCCESS;
 767         }
 768         else if ( rs->sr_type == REP_RESULT ) {
 769                 /* Remove serversort response callback.
 770                  * We don't want the entries that we are about to send to be
 771                  * processed by serversort response again.
 772                  */
 773                 if ( op->o_callback->sc_response == sssvlv_op_response ) {
 774                         op->o_callback = op->o_callback->sc_next;
 775                 }
 776
 777                 send_entry( op, rs, so );
 778                 send_result( op, rs, so );
 779         }
 780
 781         return rs->sr_err;
 782 }
 783
 784 static int sssvlv_op_search(
 785         Operation               *op,
 786         SlapReply               *rs)
 787 {
 788         slap_overinst                   *on                     = (slap_overinst *)op->o_bd->bd_info;
 789         sssvlv_info                             *si                     = on->on_bi.bi_private;
 790         int                                             rc                      = SLAP_CB_CONTINUE;
 791         int     ok;
 792         sort_op *so = NULL, so2;
 793         sort_ctrl *sc;
 794         PagedResultsState *ps;
 795         vlv_ctrl *vc;
 796         int sess_id;
 797
 798         if ( op->o_ctrlflag[sss_cid] <= SLAP_CONTROL_IGNORED ) {
 799                 if ( op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ) {
 800                         LDAPControl *ctrls[2];
 801                         so2.so_vcontext = 0;
 802                         so2.so_vlv_target = 0;
 803                         so2.so_nentries = 0;
 804                         so2.so_vlv_rc = LDAP_VLV_SSS_MISSING;
 805                         so2.so_vlv = op->o_ctrlflag[vlv_cid];
 806                         rc = pack_vlv_response_control( op, rs, &so2, ctrls );
 807                         if ( rc == LDAP_SUCCESS ) {
 808                                 ctrls[1] = NULL;
 809                                 slap_add_ctrls( op, rs, ctrls );
 810                         }
 811                         rs->sr_err = LDAP_VLV_ERROR;
 812                         rs->sr_text = "Sort control is required with VLV";
 813                         goto leave;
 814                 }
 815                 /* Not server side sort so just continue */
 816                 return SLAP_CB_CONTINUE;
 817         }
 818
 819         Debug(LDAP_DEBUG_TRACE,
 820                 "==> sssvlv_search: <%s> %s, control flag: %d\n",
 821                 op->o_req_dn.bv_val, op->ors_filterstr.bv_val,
 822                 op->o_ctrlflag[sss_cid]);
 823
 824         sc = op->o_controls[sss_cid];
 825         if ( sc->sc_nkeys > si->svi_max_keys ) {
 826                 rs->sr_text = "Too many sort keys";
 827                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 828                 goto leave;
 829         }
 830
 831         ps = ( op->o_pagedresults > SLAP_CONTROL_IGNORED ) ?
 832                 (PagedResultsState*)(op->o_pagedresults_state) : NULL;
 833         vc = op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ?
 834                 op->o_controls[vlv_cid] : NULL;
 835
 836         if ( ps && vc ) {
 837                 rs->sr_text = "VLV incompatible with PagedResults";
 838                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 839                 goto leave;
 840         }
 841
 842         ok = 1;
 843         ldap_pvt_thread_mutex_lock( &sort_conns_mutex );
 844         /* Is there already a sort running on this conn? */
 845         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 );
 846         if ( sess_id >= 0 ) {
 847                 so = sort_conns[op->o_conn->c_conn_idx][sess_id];
 848                 /* Is it a continuation of a VLV search? */
 849                 if ( !vc || so->so_vlv <= SLAP_CONTROL_IGNORED ||
 850                         vc->vc_context != so->so_vcontext ) {
 851                         /* Is it a continuation of a paged search? */
 852                         if ( !ps || so->so_paged <= SLAP_CONTROL_IGNORED ||
 853                                 op->o_conn->c_pagedresults_state.ps_cookie != ps->ps_cookie ) {
 854                                 ok = 0;
 855                         } else if ( !ps->ps_size ) {
 856                         /* Abandoning current request */
 857                                 ok = 0;
 858                                 so->so_nentries = 0;
 859                                 rs->sr_err = LDAP_SUCCESS;
 860                         }
 861                 }
 862                 if (( vc && so->so_paged > SLAP_CONTROL_IGNORED ) ||
 863                         ( ps && so->so_vlv > SLAP_CONTROL_IGNORED )) {
 864                         /* changed from paged to vlv or vice versa, abandon */
 865                         ok = 0;
 866                         so->so_nentries = 0;
 867                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 868                 }
 869         /* Are there too many running overall? */
 870         } else if ( si->svi_num >= si->svi_max ) {
 871                 ok = 0;
 872         } else if ( ( sess_id = find_next_session(si->svi_max_percon, op->o_conn->c_conn_idx ) ) < 0 ) {
 873                 ok = 0;
 874         } else {
 875                 /* OK, this connection now has a sort running */
 876                 si->svi_num++;
 877                 sort_conns[op->o_conn->c_conn_idx][sess_id] = &so2;
 878                 sort_conns[op->o_conn->c_conn_idx][sess_id]->so_session = sess_id;
 879         }
 880         ldap_pvt_thread_mutex_unlock( &sort_conns_mutex );
 881         if ( ok ) {
 882                 /* If we're a global overlay, this check got bypassed */
 883                 if ( !op->ors_limit && limits_check( op, rs ))
 884                         return rs->sr_err;
 885                 /* are we continuing a VLV search? */
 886                 if ( so && vc && vc->vc_context ) {
 887                         so->so_ctrl = sc;
 888                         send_list( op, rs, so );
 889                         send_result( op, rs, so );
 890                         rc = LDAP_SUCCESS;
 891                 /* are we continuing a paged search? */
 892                 } else if ( so && ps && ps->ps_cookie ) {
 893                         so->so_ctrl = sc;
 894                         send_page( op, rs, so );
 895                         send_result( op, rs, so );
 896                         rc = LDAP_SUCCESS;
 897                 } else {
 898                         slap_callback *cb = op->o_tmpalloc( sizeof(slap_callback),
 899                                 op->o_tmpmemctx );
 900                         /* Install serversort response callback to handle a new search */
 901                         if ( ps || vc ) {
 902                                 so = ch_calloc( 1, sizeof(sort_op));
 903                         } else {
 904                                 so = op->o_tmpcalloc( 1, sizeof(sort_op), op->o_tmpmemctx );
 905                         }
 906                         sort_conns[op->o_conn->c_conn_idx][sess_id] = so;
 907
 908                         cb->sc_cleanup          = NULL;
 909                         cb->sc_response         = sssvlv_op_response;
 910                         cb->sc_next                     = op->o_callback;
 911                         cb->sc_private          = so;
 912
 913                         so->so_tree = NULL;
 914                         so->so_ctrl = sc;
 915                         so->so_info = si;
 916                         if ( ps ) {
 917                                 so->so_paged = op->o_pagedresults;
 918                                 so->so_page_size = ps->ps_size;
 919                                 op->o_pagedresults = SLAP_CONTROL_IGNORED;
 920                         } else {
 921                                 so->so_paged = 0;
 922                                 so->so_page_size = 0;
 923                                 if ( vc ) {
 924                                         so->so_vlv = op->o_ctrlflag[vlv_cid];
 925                                         so->so_vlv_target = 0;
 926                                         so->so_vlv_rc = 0;
 927                                 } else {
 928                                         so->so_vlv = SLAP_CONTROL_NONE;
 929                                 }
 930                         }
 931                         so->so_session = sess_id;
 932                         so->so_vlv = op->o_ctrlflag[vlv_cid];
 933                         so->so_vcontext = (unsigned long)so;
 934                         so->so_nentries = 0;
 935
 936                         op->o_callback          = cb;
 937                 }
 938         } else {
 939                 if ( so && !so->so_nentries ) {
 940                         free_sort_op( op->o_conn, so );
 941                 } else {
 942                         rs->sr_text = "Other sort requests already in progress";
 943                         rs->sr_err = LDAP_BUSY;
 944                 }
 945 leave:
 946                 rc = rs->sr_err;
 947                 send_ldap_result( op, rs );
 948         }
 949
 950         return rc;
 951 }
 952
 953 static int get_ordering_rule(
 954         AttributeDescription    *ad,
 955         struct berval                   *matchrule,
 956         SlapReply                               *rs,
 957         MatchingRule                    **ordering )
 958 {
 959         MatchingRule* mr;
 960
 961         if ( matchrule && matchrule->bv_val ) {
 962                 mr = mr_find( matchrule->bv_val );
 963                 if ( mr == NULL ) {
 964                         rs->sr_err = LDAP_INAPPROPRIATE_MATCHING;
 965                         rs->sr_text = "serverSort control: No ordering rule";
 966                         Debug(LDAP_DEBUG_TRACE, "%s: no ordering rule function for %s\n",
 967                                 debug_header, matchrule->bv_val, 0);
 968                 }
 969         }
 970         else {
 971                 mr = ad->ad_type->sat_ordering;
 972                 if ( mr == NULL ) {
 973                         rs->sr_err = LDAP_INAPPROPRIATE_MATCHING;
 974                         rs->sr_text = "serverSort control: No ordering rule";
 975                         Debug(LDAP_DEBUG_TRACE,
 976                                 "%s: no ordering rule specified and no default ordering rule for attribute %s\n",
 977                                 debug_header, ad->ad_cname.bv_val, 0);
 978                 }
 979         }
 980
 981         *ordering = mr;
 982         return rs->sr_err;
 983 }
 984
 985 static int count_key(BerElement *ber)
 986 {
 987         char *end;
 988         ber_len_t len;
 989         ber_tag_t tag;
 990         int count = 0;
 991
 992         /* Server Side Sort Control is a SEQUENCE of SEQUENCE */
 993         for ( tag = ber_first_element( ber, &len, &end );
 994                   tag == LBER_SEQUENCE;
 995                   tag = ber_next_element( ber, &len, end ))
 996         {
 997                 tag = ber_skip_tag( ber, &len );
 998                 ber_skip_data( ber, len );
 999                 ++count;
1000         }
1001         ber_rewind( ber );
1002
1003         return count;
1004 }
1005
1006 static int build_key(
1007         BerElement              *ber,
1008         SlapReply               *rs,
1009         sort_key                        *key )
1010 {
1011         struct berval attr;
1012         struct berval matchrule = BER_BVNULL;
1013         ber_int_t reverse = 0;
1014         ber_tag_t tag;
1015         ber_len_t len;
1016         MatchingRule *ordering = NULL;
1017         AttributeDescription *ad = NULL;
1018         const char *text;
1019
1020         if (( tag = ber_scanf( ber, "{" )) == LBER_ERROR ) {
1021                 rs->sr_text = "serverSort control: decoding error";
1022                 rs->sr_err = LDAP_PROTOCOL_ERROR;
1023                 return rs->sr_err;
1024         }
1025
1026         if (( tag = ber_scanf( ber, "m", &attr )) == LBER_ERROR ) {
1027                 rs->sr_text = "serverSort control: attribute decoding error";
1028                 rs->sr_err = LDAP_PROTOCOL_ERROR;
1029                 return rs->sr_err;
1030         }
1031
1032         tag = ber_peek_tag( ber, &len );
1033         if ( tag == LDAP_MATCHRULE_IDENTIFIER ) {
1034                 if (( tag = ber_scanf( ber, "m", &matchrule )) == LBER_ERROR ) {
1035                         rs->sr_text = "serverSort control: matchrule decoding error";
1036                         rs->sr_err = LDAP_PROTOCOL_ERROR;
1037                         return rs->sr_err;
1038                 }
1039                 tag = ber_peek_tag( ber, &len );
1040         }
1041
1042         if ( tag == LDAP_REVERSEORDER_IDENTIFIER ) {
1043                 if (( tag = ber_scanf( ber, "b", &reverse )) == LBER_ERROR ) {
1044                         rs->sr_text = "serverSort control: reverse decoding error";
1045                         rs->sr_err = LDAP_PROTOCOL_ERROR;
1046                         return rs->sr_err;
1047                 }
1048         }
1049
1050         if (( tag = ber_scanf( ber, "}" )) == LBER_ERROR ) {
1051                 rs->sr_text = "serverSort control: decoding error";
1052                 rs->sr_err = LDAP_PROTOCOL_ERROR;
1053                 return rs->sr_err;
1054         }
1055
1056         if ( slap_bv2ad( &attr, &ad, &text ) != LDAP_SUCCESS ) {
1057                 rs->sr_text =
1058                         "serverSort control: Unrecognized attribute type in sort key";
1059                 Debug(LDAP_DEBUG_TRACE,
1060                         "%s: Unrecognized attribute type in sort key: %s\n",
1061                         debug_header, SAFESTR(attr.bv_val, "<None>"), 0);
1062                 rs->sr_err = LDAP_NO_SUCH_ATTRIBUTE;
1063                 return rs->sr_err;
1064         }
1065
1066         /* get_ordering_rule will set sr_err and sr_text */
1067         get_ordering_rule( ad, &matchrule, rs, &ordering );
1068         if ( rs->sr_err != LDAP_SUCCESS ) {
1069                 return rs->sr_err;
1070         }
1071
1072         key->sk_ad = ad;
1073         key->sk_ordering = ordering;
1074         key->sk_direction = reverse ? -1 : 1;
1075
1076         return rs->sr_err;
1077 }
1078
1079 static int sss_parseCtrl(
1080         Operation               *op,
1081         SlapReply               *rs,
1082         LDAPControl             *ctrl )
1083 {
1084         BerElementBuffer        berbuf;
1085         BerElement                      *ber;
1086         ber_tag_t               tag;
1087         ber_len_t               len;
1088         int                                     i;
1089         sort_ctrl       *sc;
1090
1091         rs->sr_err = LDAP_PROTOCOL_ERROR;
1092
1093         if ( op->o_ctrlflag[sss_cid] > SLAP_CONTROL_IGNORED ) {
1094                 rs->sr_text = "sorted results control specified multiple times";
1095         } else if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
1096                 rs->sr_text = "sorted results control value is absent";
1097         } else if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
1098                 rs->sr_text = "sorted results control value is empty";
1099         } else {
1100                 rs->sr_err = LDAP_SUCCESS;
1101         }
1102         if ( rs->sr_err != LDAP_SUCCESS )
1103                 return rs->sr_err;
1104
1105         op->o_ctrlflag[sss_cid] = ctrl->ldctl_iscritical ?
1106                 SLAP_CONTROL_CRITICAL : SLAP_CONTROL_NONCRITICAL;
1107
1108         ber = (BerElement *)&berbuf;
1109         ber_init2( ber, &ctrl->ldctl_value, 0 );
1110         i = count_key( ber );
1111
1112         sc = op->o_tmpalloc( sizeof(sort_ctrl) +
1113                 (i-1) * sizeof(sort_key), op->o_tmpmemctx );
1114         sc->sc_nkeys = i;
1115         op->o_controls[sss_cid] = sc;
1116
1117         /* peel off initial sequence */
1118         ber_scanf( ber, "{" );
1119
1120         i = 0;
1121         do {
1122                 if ( build_key( ber, rs, &sc->sc_keys[i] ) != LDAP_SUCCESS )
1123                         break;
1124                 i++;
1125                 tag = ber_peek_tag( ber, &len );
1126         } while ( tag != LBER_DEFAULT );
1127
1128         return rs->sr_err;
1129 }
1130
1131 static int vlv_parseCtrl(
1132         Operation               *op,
1133         SlapReply               *rs,
1134         LDAPControl             *ctrl )
1135 {
1136         BerElementBuffer        berbuf;
1137         BerElement                      *ber;
1138         ber_tag_t               tag;
1139         ber_len_t               len;
1140         vlv_ctrl        *vc, vc2;
1141
1142         rs->sr_err = LDAP_PROTOCOL_ERROR;
1143         rs->sr_text = NULL;
1144
1145         if ( op->o_ctrlflag[vlv_cid] > SLAP_CONTROL_IGNORED ) {
1146                 rs->sr_text = "vlv control specified multiple times";
1147         } else if ( BER_BVISNULL( &ctrl->ldctl_value ) ) {
1148                 rs->sr_text = "vlv control value is absent";
1149         } else if ( BER_BVISEMPTY( &ctrl->ldctl_value ) ) {
1150                 rs->sr_text = "vlv control value is empty";
1151         }
1152         if ( rs->sr_text != NULL )
1153                 return rs->sr_err;
1154
1155         op->o_ctrlflag[vlv_cid] = ctrl->ldctl_iscritical ?
1156                 SLAP_CONTROL_CRITICAL : SLAP_CONTROL_NONCRITICAL;
1157
1158         ber = (BerElement *)&berbuf;
1159         ber_init2( ber, &ctrl->ldctl_value, 0 );
1160
1161         rs->sr_err = LDAP_PROTOCOL_ERROR;
1162
1163         tag = ber_scanf( ber, "{ii", &vc2.vc_before, &vc2.vc_after );
1164         if ( tag == LBER_ERROR ) {
1165                 return rs->sr_err;
1166         }
1167
1168         tag = ber_peek_tag( ber, &len );
1169         if ( tag == LDAP_VLVBYINDEX_IDENTIFIER ) {
1170                 tag = ber_scanf( ber, "{ii}", &vc2.vc_offset, &vc2.vc_count );
1171                 if ( tag == LBER_ERROR )
1172                         return rs->sr_err;
1173                 BER_BVZERO( &vc2.vc_value );
1174         } else if ( tag == LDAP_VLVBYVALUE_IDENTIFIER ) {
1175                 tag = ber_scanf( ber, "m", &vc2.vc_value );
1176                 if ( tag == LBER_ERROR || BER_BVISNULL( &vc2.vc_value ))
1177                         return rs->sr_err;
1178         } else {
1179                 return rs->sr_err;
1180         }
1181         tag = ber_peek_tag( ber, &len );
1182         if ( tag == LDAP_VLVCONTEXT_IDENTIFIER ) {
1183                 struct berval bv;
1184                 tag = ber_scanf( ber, "m", &bv );
1185                 if ( tag == LBER_ERROR || bv.bv_len != sizeof(vc2.vc_context))
1186                         return rs->sr_err;
1187                 AC_MEMCPY( &vc2.vc_context, bv.bv_val, bv.bv_len );
1188         } else {
1189                 vc2.vc_context = 0;
1190         }
1191
1192         vc = op->o_tmpalloc( sizeof(vlv_ctrl), op->o_tmpmemctx );
1193         *vc = vc2;
1194         op->o_controls[vlv_cid] = vc;
1195         rs->sr_err = LDAP_SUCCESS;
1196
1197         return rs->sr_err;
1198 }
1199
1200 static int sssvlv_connection_destroy( BackendDB *be, Connection *conn )
1201 {
1202         slap_overinst   *on             = (slap_overinst *)be->bd_info;
1203         sssvlv_info *si = on->on_bi.bi_private;
1204
1205         if ( sort_conns[conn->c_conn_idx] ) {
1206                 free_sort_ops( conn, sort_conns[conn->c_conn_idx], si->svi_max_percon );
1207         }
1208
1209         return LDAP_SUCCESS;
1210 }
1211
1212 static int sssvlv_db_open(
1213         BackendDB               *be,
1214         ConfigReply             *cr )
1215 {
1216         slap_overinst   *on = (slap_overinst *)be->bd_info;
1217         sssvlv_info *si = on->on_bi.bi_private;
1218         int rc;
1219         int conn_index;
1220
1221         /* If not set, default to 1/2 of available threads */
1222         if ( !si->svi_max )
1223                 si->svi_max = connection_pool_max / 2;
1224
1225         if ( dtblsize && !sort_conns ) {
1226                 ldap_pvt_thread_mutex_init( &sort_conns_mutex );
1227                 /* accommodate for c_conn_idx == -1 */
1228                 sort_conns = ch_calloc( dtblsize + 1, sizeof(sort_op **) );
1229                 for ( conn_index = 0 ; conn_index < dtblsize + 1 ; conn_index++ ) {
1230                         sort_conns[conn_index] = ch_calloc( si->svi_max_percon, sizeof(sort_op *) );
1231                 }
1232                 sort_conns++;
1233         }
1234
1235         rc = overlay_register_control( be, LDAP_CONTROL_SORTREQUEST );
1236         if ( rc == LDAP_SUCCESS )
1237                 rc = overlay_register_control( be, LDAP_CONTROL_VLVREQUEST );
1238         return rc;
1239 }
1240
1241 static ConfigTable sssvlv_cfg[] = {
1242         { "sssvlv-max", "num",
1243                 2, 2, 0, ARG_INT|ARG_OFFSET,
1244                         (void *)offsetof(sssvlv_info, svi_max),
1245                 "( OLcfgOvAt:21.1 NAME 'olcSssVlvMax' "
1246                         "DESC 'Maximum number of concurrent Sort requests' "
1247                         "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1248         { "sssvlv-maxkeys", "num",
1249                 2, 2, 0, ARG_INT|ARG_OFFSET,
1250                         (void *)offsetof(sssvlv_info, svi_max_keys),
1251                 "( OLcfgOvAt:21.2 NAME 'olcSssVlvMaxKeys' "
1252                         "DESC 'Maximum number of Keys in a Sort request' "
1253                         "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1254         { "sssvlv-maxpercon", "num",
1255                 2, 2, 0, ARG_INT|ARG_OFFSET,
1256                         (void *)offsetof(sssvlv_info, svi_max_percon),
1257                 "( OLcfgOvAt:21.3 NAME 'olcSssVlvMaxPerConn' "
1258                         "DESC 'Maximum number of concurrent paged search requests per connection' "
1259                         "SYNTAX OMsInteger SINGLE-VALUE )", NULL, NULL },
1260         { NULL, NULL, 0, 0, 0, ARG_IGNORED }
1261 };
1262
1263 static ConfigOCs sssvlv_ocs[] = {
1264         { "( OLcfgOvOc:21.1 "
1265                 "NAME 'olcSssVlvConfig' "
1266                 "DESC 'SSS VLV configuration' "
1267                 "SUP olcOverlayConfig "
1268                 "MAY ( olcSssVlvMax $ olcSssVlvMaxKeys ) )",
1269                 Cft_Overlay, sssvlv_cfg, NULL, NULL },
1270         { NULL, 0, NULL }
1271 };
1272
1273 static int sssvlv_db_init(
1274         BackendDB               *be,
1275         ConfigReply             *cr)
1276 {
1277         slap_overinst   *on = (slap_overinst *)be->bd_info;
1278         sssvlv_info *si;
1279
1280         if ( ov_count == 0 ) {
1281                 int rc;
1282
1283                 rc = register_supported_control2( LDAP_CONTROL_SORTREQUEST,
1284                         SLAP_CTRL_SEARCH,
1285                         NULL,
1286                         sss_parseCtrl,
1287                         1 /* replace */,
1288                         &sss_cid );
1289                 if ( rc != LDAP_SUCCESS ) {
1290                         Debug( LDAP_DEBUG_ANY, "Failed to register Sort Request control '%s' (%d)\n",
1291                                 LDAP_CONTROL_SORTREQUEST, rc, 0 );
1292                         return rc;
1293                 }
1294
1295                 rc = register_supported_control2( LDAP_CONTROL_VLVREQUEST,
1296                         SLAP_CTRL_SEARCH,
1297                         NULL,
1298                         vlv_parseCtrl,
1299                         1 /* replace */,
1300                         &vlv_cid );
1301                 if ( rc != LDAP_SUCCESS ) {
1302                         Debug( LDAP_DEBUG_ANY, "Failed to register VLV Request control '%s' (%d)\n",
1303                                 LDAP_CONTROL_VLVREQUEST, rc, 0 );
1304 #ifdef SLAP_CONFIG_DELETE
1305                         overlay_unregister_control( be, LDAP_CONTROL_SORTREQUEST );
1306                         unregister_supported_control( LDAP_CONTROL_SORTREQUEST );
1307 #endif /* SLAP_CONFIG_DELETE */
1308                         return rc;
1309                 }
1310         }
1311
1312         si = (sssvlv_info *)ch_malloc(sizeof(sssvlv_info));
1313         on->on_bi.bi_private = si;
1314
1315         si->svi_max = 0;
1316         si->svi_num = 0;
1317         si->svi_max_keys = SSSVLV_DEFAULT_MAX_KEYS;
1318         si->svi_max_percon = SSSVLV_DEFAULT_MAX_REQUEST_PER_CONN;
1319
1320         ov_count++;
1321
1322         return LDAP_SUCCESS;
1323 }
1324
1325 static int sssvlv_db_destroy(
1326         BackendDB               *be,
1327         ConfigReply             *cr )
1328 {
1329         slap_overinst   *on = (slap_overinst *)be->bd_info;
1330         sssvlv_info *si = (sssvlv_info *)on->on_bi.bi_private;
1331         int conn_index;
1332
1333         ov_count--;
1334         if ( !ov_count && sort_conns) {
1335                 sort_conns--;
1336                 for ( conn_index = 0 ; conn_index < dtblsize + 1 ; conn_index++ ) {
1337                         ch_free(sort_conns[conn_index]);
1338                 }
1339                 ch_free(sort_conns);
1340                 ldap_pvt_thread_mutex_destroy( &sort_conns_mutex );
1341         }
1342
1343 #ifdef SLAP_CONFIG_DELETE
1344         overlay_unregister_control( be, LDAP_CONTROL_SORTREQUEST );
1345         overlay_unregister_control( be, LDAP_CONTROL_VLVREQUEST );
1346         if ( ov_count == 0 ) {
1347                 unregister_supported_control( LDAP_CONTROL_SORTREQUEST );
1348                 unregister_supported_control( LDAP_CONTROL_VLVREQUEST );
1349         }
1350 #endif /* SLAP_CONFIG_DELETE */
1351
1352         if ( si ) {
1353                 ch_free( si );
1354                 on->on_bi.bi_private = NULL;
1355         }
1356         return LDAP_SUCCESS;
1357 }
1358
1359 static slap_overinst sssvlv;
1360
1361 int sssvlv_initialize()
1362 {
1363         int rc;
1364
1365         sssvlv.on_bi.bi_type                            = "sssvlv";
1366         sssvlv.on_bi.bi_db_init                         = sssvlv_db_init;
1367         sssvlv.on_bi.bi_db_destroy                      = sssvlv_db_destroy;
1368         sssvlv.on_bi.bi_db_open                         = sssvlv_db_open;
1369         sssvlv.on_bi.bi_connection_destroy      = sssvlv_connection_destroy;
1370         sssvlv.on_bi.bi_op_search                       = sssvlv_op_search;
1371
1372         sssvlv.on_bi.bi_cf_ocs = sssvlv_ocs;
1373
1374         rc = config_register_schema( sssvlv_cfg, sssvlv_ocs );
1375         if ( rc )
1376                 return rc;
1377
1378         rc = overlay_register( &sssvlv );
1379         if ( rc != LDAP_SUCCESS ) {
1380                 Debug( LDAP_DEBUG_ANY, "Failed to register server side sort overlay\n", 0, 0, 0 );
1381         }
1382
1383         return rc;
1384 }
1385
1386 #if SLAPD_OVER_SSSVLV == SLAPD_MOD_DYNAMIC
1387 int init_module( int argc, char *argv[])
1388 {
1389         return sssvlv_initialize();
1390 }
1391 #endif
1392
1393 #endif /* SLAPD_OVER_SSSVLV */