Added function for returning the recommended max bandwidth for the cr… (

#520) Co-authored-by: Waqar Ahmed Khan <[email protected]> Co-authored-by: Michael Graeb <[email protected]>
awslabs · Nov 9, 2023 · 2762245 · 2762245
1 parent 16e6492
commit 2762245
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 8 deletions.
diff --git a/awscrt/s3.py b/awscrt/s3.py
@@ -178,7 +178,8 @@ class S3Client(NativeResource):
 
         throughput_target_gbps (Optional[float]): Throughput target in
             Gigabits per second (Gbps) that we are trying to reach.
-            (10.0 Gbps by default)
+            You can also use `get_recommended_throughput_target_gbps()` to get recommended value for your system.
+            10.0 Gbps by default (may change in future)
     """
 
     __slots__ = ('shutdown_event', '_region')
@@ -586,3 +587,19 @@ def is_optimized_for_system():
             for the current system.
     """
     return _awscrt.s3_is_crt_s3_optimized_for_system()
+
+
+def get_recommended_throughput_target_gbps() -> Optional[float]:
+    """
+    Returns:
+        Recommended throughput, in gigabits per second, based on detected system configuration.
+        If the best throughput configuration is unknown, returns None.
+        Use this as the S3Client's `throughput_target_gbps`.
+    """
+    # Currently the CRT returns 0 if it was unable to make a good guess on configuration. Pre-known configs, have this value set.
+    # Eventually, the CRT will make a full calculation based on NIC and CPU configuration, but until then handle 0.
+    max_value = _awscrt.s3_get_recommended_throughput_target_gbps()
+    if max_value > 0:
+        return max_value
+    else:
+        return None
diff --git a/crt/aws-c-auth b/crt/aws-c-auth
diff --git a/crt/aws-c-cal b/crt/aws-c-cal
diff --git a/crt/aws-c-common b/crt/aws-c-common
diff --git a/crt/aws-c-http b/crt/aws-c-http
diff --git a/crt/aws-c-s3 b/crt/aws-c-s3
diff --git a/crt/aws-lc b/crt/aws-lc
diff --git a/crt/s2n b/crt/s2n
diff --git a/source/module.c b/source/module.c
@@ -801,6 +801,7 @@ static PyMethodDef s_module_methods[] = {
     AWS_PY_METHOD_DEF(s3_meta_request_cancel, METH_VARARGS),
     AWS_PY_METHOD_DEF(s3_get_ec2_instance_type, METH_NOARGS),
     AWS_PY_METHOD_DEF(s3_is_crt_s3_optimized_for_system, METH_NOARGS),
+    AWS_PY_METHOD_DEF(s3_get_recommended_throughput_target_gbps, METH_NOARGS),
     AWS_PY_METHOD_DEF(s3_cross_process_lock_new, METH_VARARGS),
     AWS_PY_METHOD_DEF(s3_cross_process_lock_acquire, METH_VARARGS),
     AWS_PY_METHOD_DEF(s3_cross_process_lock_release, METH_VARARGS),

diff --git a/source/s3.h b/source/s3.h
@@ -9,6 +9,7 @@
 
 PyObject *aws_py_s3_get_ec2_instance_type(PyObject *self, PyObject *args);
 PyObject *aws_py_s3_is_crt_s3_optimized_for_system(PyObject *self, PyObject *args);
+PyObject *aws_py_s3_get_recommended_throughput_target_gbps(PyObject *self, PyObject *args);
 
 PyObject *aws_py_s3_client_new(PyObject *self, PyObject *args);
 PyObject *aws_py_s3_client_make_meta_request(PyObject *self, PyObject *args);

diff --git a/source/s3_client.c b/source/s3_client.c
@@ -39,6 +39,15 @@ PyObject *aws_py_s3_is_crt_s3_optimized_for_system(PyObject *self, PyObject *arg
     Py_RETURN_FALSE;
 }
 
+PyObject *aws_py_s3_get_recommended_throughput_target_gbps(PyObject *self, PyObject *args) {
+    (void)self;
+    (void)args;
+
+    const struct aws_s3_platform_info *platform_info = aws_s3_get_current_platform_info();
+
+    return PyFloat_FromDouble(platform_info->max_throughput_gbps);
+}
+
 struct cross_process_lock_binding {
     struct aws_cross_process_lock *lock;
     struct aws_string *name;
+1 −0		include/aws/auth/auth.h
+2 −0		include/aws/auth/private/credentials_utils.h
+3 −1		source/auth.c
+123 −56		source/aws_imds_client.c
+1 −0		source/credentials_utils.c
+2 −0		tests/CMakeLists.txt
+136 −22		tests/aws_imds_client_test.c
+16 −18		tests/credentials_provider_imds_tests.c
+9 −0		include/aws/http/connection.h
+1 −0		include/aws/http/http.h
+5 −4		include/aws/http/private/connection_impl.h
+10 −18		include/aws/http/private/connection_manager_system_vtable.h
+5 −1		include/aws/http/private/proxy_impl.h
+5 −0		include/aws/http/private/request_response_impl.h
+10 −0		include/aws/http/request_response.h
+5 −2		source/connection.c
+22 −21		source/connection_manager.c
+102 −17		source/h1_connection.c
+1 −0		source/h1_stream.c
+3 −0		source/http.c
+2 −2		source/proxy_connection.c
+2 −0		tests/CMakeLists.txt
+18 −18		tests/test_connection_manager.c
+111 −1		tests/test_h1_client.c
+2 −2		tests/test_proxy.c
+2 −2		tests/test_stream_manager.c
+0 −10		source/s3_meta_request.c
+0 −1		tests/CMakeLists.txt
+0 −27		tests/s3_data_plane_tests.c