Skip to content

Commit a411584

Browse files
committed
cluster: implement cass_cluster_set_load_balance_rack_aware[_n]
This is an extension introduced by Scylla's fork of cpp-driver. See: scylladb/cpp-driver@9691ec0 Note: I removed this part of the docstring: ``` * With empty local_rack and local_dc, default local_dc and local_rack * is chosen from the first connected contact point, * and no remote hosts are considered in query plans. * If relying on this mechanism, be sure to use only contact * points from the local rack. ``` There are multiple reasons for this: - this behaviour does not make much sense, and we should not mimic it IMO - rust-driver does not behave like this - this is not even true for cpp-driver Why it's not true for cpp-driver: If you carefully study the changes introduced to cpp-driver in the aforementioned commit, you will notice that it's not possible for the driver to use rack aware policy with an empty strings. This is because API functions reject empty string, thus RackAwarePolicy object is never constructed in such case. ``` CassError cass_cluster_set_load_balance_rack_aware_n(CassCluster* cluster, const char* local_dc, size_t local_dc_length, const char* local_rack, size_t local_rack_length) { if (local_dc == NULL || local_dc_length == 0 || local_rack == NULL || local_rack_length == 0) { return CASS_ERROR_LIB_BAD_PARAMS; } cluster->config().set_load_balancing_policy(new RackAwarePolicy( String(local_dc, local_dc_length), String(local_rack, local_rack_length))); return CASS_OK; } ``` Why is this part of docstring included in cpp-driver then? No idea. Maybe, because `cass_cluster_set_load_balance_dc_aware` mentions something similar for empty (non-specified) dc. However, in this case it's true, since dc awareness is enabled by default in cpp-driver. See the docstring: ``` * Configures the cluster to use DC-aware load balancing. * For each query, all live nodes in a primary 'local' DC are tried first, * followed by any node from other DCs. * * <b>Note:</b> This is the default, and does not need to be called unless * switching an existing from another policy or changing settings. * Without further configuration, a default local_dc is chosen from the * first connected contact point, and no remote hosts are considered in * query plans. If relying on this mechanism, be sure to use only contact * points from the local DC. ```
1 parent 6ac2ec3 commit a411584

File tree

2 files changed

+124
-3
lines changed

2 files changed

+124
-3
lines changed

include/cassandra.h

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2233,6 +2233,46 @@ cass_cluster_set_load_balance_dc_aware_n(CassCluster* cluster,
22332233
unsigned used_hosts_per_remote_dc,
22342234
cass_bool_t allow_remote_dcs_for_local_cl);
22352235

2236+
2237+
/**
2238+
* Configures the cluster to use Rack-aware load balancing.
2239+
* For each query, all live nodes in a primary 'local' rack are tried first,
2240+
* followed by nodes from local DC and then nodes from other DCs.
2241+
*
2242+
* @public @memberof CassCluster
2243+
*
2244+
* @param[in] cluster
2245+
* @param[in] local_dc The primary data center to try first
2246+
* @param[in] local_rack The primary rack to try first
2247+
* @return CASS_OK if successful, otherwise an error occurred
2248+
*/
2249+
CASS_EXPORT CassError
2250+
cass_cluster_set_load_balance_rack_aware(CassCluster* cluster,
2251+
const char* local_dc,
2252+
const char* local_rack);
2253+
2254+
2255+
/**
2256+
* Same as cass_cluster_set_load_balance_rack_aware(), but with lengths for string
2257+
* parameters.
2258+
*
2259+
* @public @memberof CassCluster
2260+
*
2261+
* @param[in] cluster
2262+
* @param[in] local_dc
2263+
* @param[in] local_dc_length
2264+
* @return same as cass_cluster_set_load_balance_dc_aware()
2265+
*
2266+
* @see cass_cluster_set_load_balance_dc_aware()
2267+
*/
2268+
CASS_EXPORT CassError
2269+
cass_cluster_set_load_balance_rack_aware_n(CassCluster* cluster,
2270+
const char* local_dc,
2271+
size_t local_dc_length,
2272+
const char* local_rack,
2273+
size_t local_rack_length);
2274+
2275+
22362276
/**
22372277
* Configures the cluster to use token-aware request routing or not.
22382278
*

scylla-rust-wrapper/src/cluster.rs

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,22 @@ impl LoadBalancingConfig {
7575
builder =
7676
builder.enable_shuffling_replicas(self.token_aware_shuffling_replicas_enabled);
7777
}
78-
if let LoadBalancingKind::DcAware { local_dc } = load_balancing_kind {
79-
builder = builder.prefer_datacenter(local_dc).permit_dc_failover(true)
78+
79+
match load_balancing_kind {
80+
LoadBalancingKind::DcAware { local_dc } => {
81+
builder = builder.prefer_datacenter(local_dc).permit_dc_failover(true)
82+
}
83+
LoadBalancingKind::RackAware {
84+
local_dc,
85+
local_rack,
86+
} => {
87+
builder = builder
88+
.prefer_datacenter_and_rack(local_dc, local_rack)
89+
.permit_dc_failover(true)
90+
}
91+
LoadBalancingKind::RoundRobin => {}
8092
}
93+
8194
if self.latency_awareness_enabled {
8295
builder = builder.latency_awareness(self.latency_awareness_builder);
8396
}
@@ -99,7 +112,13 @@ impl Default for LoadBalancingConfig {
99112
#[derive(Clone, Debug)]
100113
pub(crate) enum LoadBalancingKind {
101114
RoundRobin,
102-
DcAware { local_dc: String },
115+
DcAware {
116+
local_dc: String,
117+
},
118+
RackAware {
119+
local_dc: String,
120+
local_rack: String,
121+
},
103122
}
104123

105124
#[derive(Clone)]
@@ -553,6 +572,68 @@ pub unsafe extern "C" fn cass_cluster_set_load_balance_dc_aware_n(
553572
)
554573
}
555574

575+
#[no_mangle]
576+
pub unsafe extern "C" fn cass_cluster_set_load_balance_rack_aware(
577+
cluster_raw: *mut CassCluster,
578+
local_dc_raw: *const c_char,
579+
local_rack_raw: *const c_char,
580+
) -> CassError {
581+
cass_cluster_set_load_balance_rack_aware_n(
582+
cluster_raw,
583+
local_dc_raw,
584+
strlen(local_dc_raw),
585+
local_rack_raw,
586+
strlen(local_rack_raw),
587+
)
588+
}
589+
590+
#[no_mangle]
591+
pub unsafe extern "C" fn cass_cluster_set_load_balance_rack_aware_n(
592+
cluster_raw: *mut CassCluster,
593+
local_dc_raw: *const c_char,
594+
local_dc_length: size_t,
595+
local_rack_raw: *const c_char,
596+
local_rack_length: size_t,
597+
) -> CassError {
598+
let cluster = ptr_to_ref_mut(cluster_raw);
599+
600+
set_load_balance_rack_aware_n(
601+
&mut cluster.load_balancing_config,
602+
local_dc_raw,
603+
local_dc_length,
604+
local_rack_raw,
605+
local_rack_length,
606+
)
607+
}
608+
609+
unsafe fn set_load_balance_rack_aware_n(
610+
load_balancing_config: &mut LoadBalancingConfig,
611+
local_dc_raw: *const c_char,
612+
local_dc_length: size_t,
613+
local_rack_raw: *const c_char,
614+
local_rack_length: size_t,
615+
) -> CassError {
616+
let (local_dc, local_rack) = match (
617+
ptr_to_cstr_n(local_dc_raw, local_dc_length),
618+
ptr_to_cstr_n(local_rack_raw, local_rack_length),
619+
) {
620+
(Some(local_dc_str), Some(local_rack_str))
621+
if local_dc_length > 0 && local_rack_length > 0 =>
622+
{
623+
(local_dc_str.to_owned(), local_rack_str.to_owned())
624+
}
625+
// One of them either is a null pointer, is an empty string or is not a proper utf-8.
626+
_ => return CassError::CASS_ERROR_LIB_BAD_PARAMS,
627+
};
628+
629+
load_balancing_config.load_balancing_kind = Some(LoadBalancingKind::RackAware {
630+
local_dc,
631+
local_rack,
632+
});
633+
634+
CassError::CASS_OK
635+
}
636+
556637
#[no_mangle]
557638
pub unsafe extern "C" fn cass_cluster_set_cloud_secure_connection_bundle_n(
558639
_cluster_raw: *mut CassCluster,

0 commit comments

Comments
 (0)