Skip to content

Commit 1205554

Browse files
Upgrade init_tensor API to return a ggml_status
To prepare for an 'abort-free' ggml (ggml not to abort on ooms but return a oom status), as agreeed with Diego in the ggml repo, upgrade the init_tensor() APIs to return a ggml_status.
1 parent 63ac128 commit 1205554

File tree

14 files changed

+44
-23
lines changed

14 files changed

+44
-23
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ lcov-report/
4545
tags
4646
.build/
4747
build*
48+
release
49+
debug
4850
!build-info.cmake
4951
!build-info.cpp.in
5052
!build-info.sh

ggml/include/ggml-backend.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ extern "C" {
5656
GGML_API void ggml_backend_buffer_free (ggml_backend_buffer_t buffer);
5757
GGML_API void * ggml_backend_buffer_get_base (ggml_backend_buffer_t buffer);
5858
GGML_API size_t ggml_backend_buffer_get_size (ggml_backend_buffer_t buffer);
59-
GGML_API void ggml_backend_buffer_init_tensor (ggml_backend_buffer_t buffer, struct ggml_tensor * tensor);
59+
GGML_API enum ggml_status ggml_backend_buffer_init_tensor (ggml_backend_buffer_t buffer, struct ggml_tensor * tensor);
6060
GGML_API size_t ggml_backend_buffer_get_alignment (ggml_backend_buffer_t buffer);
6161
GGML_API size_t ggml_backend_buffer_get_max_size (ggml_backend_buffer_t buffer);
6262
GGML_API size_t ggml_backend_buffer_get_alloc_size(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor);
@@ -342,7 +342,7 @@ extern "C" {
342342
GGML_API bool ggml_backend_compare_graph_backend(ggml_backend_t backend1, ggml_backend_t backend2, struct ggml_cgraph * graph, ggml_backend_eval_callback callback, void * user_data);
343343

344344
// Tensor initialization
345-
GGML_API void ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr);
345+
GGML_API enum ggml_status ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr);
346346
GGML_API void ggml_backend_view_init(struct ggml_tensor * tensor);
347347

348348
// CPU buffer types are always available

ggml/src/ggml-backend-impl.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ extern "C" {
4444
// base address of the buffer
4545
void * (*get_base) (ggml_backend_buffer_t buffer);
4646
// (optional) initialize a tensor in the buffer (eg. add tensor extras)
47-
void (*init_tensor) (ggml_backend_buffer_t buffer, struct ggml_tensor * tensor);
47+
enum ggml_status (*init_tensor) (ggml_backend_buffer_t buffer, struct ggml_tensor * tensor);
4848
// tensor data access
4949
void (*memset_tensor)(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, uint8_t value, size_t offset, size_t size);
5050
void (*set_tensor) (ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, const void * data, size_t offset, size_t size);

ggml/src/ggml-backend.cpp

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,13 @@ void * ggml_backend_buffer_get_base(ggml_backend_buffer_t buffer) {
126126
return base;
127127
}
128128

129-
void ggml_backend_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
129+
// Check with reviewers: any cons for that method to return a ggml_status?
130+
enum ggml_status ggml_backend_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
130131
// init_tensor is optional
131132
if (buffer->iface.init_tensor) {
132-
buffer->iface.init_tensor(buffer, tensor);
133+
return buffer->iface.init_tensor(buffer, tensor);
133134
}
135+
return GGML_STATUS_SUCCESS; // check with reviewers. Should we add a GGML_STATUS_SKIP ...
134136
}
135137

136138
void ggml_backend_buffer_clear(ggml_backend_buffer_t buffer, uint8_t value) {
@@ -1641,6 +1643,7 @@ ggml_backend_t ggml_backend_sched_get_tensor_backend(ggml_backend_sched_t sched,
16411643

16421644
// utils
16431645

1646+
// Check with reviewers: should we return a ggml_status?
16441647
void ggml_backend_view_init(struct ggml_tensor * tensor) {
16451648
GGML_ASSERT(tensor->buffer == NULL);
16461649
GGML_ASSERT(tensor->view_src != NULL);
@@ -1649,10 +1652,12 @@ void ggml_backend_view_init(struct ggml_tensor * tensor) {
16491652

16501653
tensor->buffer = tensor->view_src->buffer;
16511654
tensor->data = (char *)tensor->view_src->data + tensor->view_offs;
1652-
ggml_backend_buffer_init_tensor(tensor->buffer, tensor);
1655+
ggml_status status = ggml_backend_buffer_init_tensor(tensor->buffer, tensor);
1656+
if (status != GGML_STATUS_SUCCESS)
1657+
GGML_LOG_WARN("init tensor failed: status = %d\n", status);
16531658
}
16541659

1655-
void ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr) {
1660+
enum ggml_status ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor, void * addr) {
16561661
GGML_ASSERT(tensor->buffer == NULL);
16571662
GGML_ASSERT(tensor->data == NULL);
16581663
GGML_ASSERT(tensor->view_src == NULL);
@@ -1662,7 +1667,7 @@ void ggml_backend_tensor_alloc(ggml_backend_buffer_t buffer, struct ggml_tensor
16621667

16631668
tensor->buffer = buffer;
16641669
tensor->data = addr;
1665-
ggml_backend_buffer_init_tensor(buffer, tensor);
1670+
return ggml_backend_buffer_init_tensor(buffer, tensor);
16661671
}
16671672

16681673
static struct ggml_tensor * graph_copy_dup_tensor(struct ggml_hash_set hash_set, struct ggml_tensor ** node_copies,

ggml/src/ggml-cann/ggml-cann.cpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -796,11 +796,11 @@ static bool need_transform(ggml_type type) {
796796
* @param buffer The CANN buffer from which to initialize the tensor.
797797
* @param tensor Pointer to the tensor to be initialized.
798798
*/
799-
static void ggml_backend_cann_buffer_init_tensor(
799+
static enum ggml_status ggml_backend_cann_buffer_init_tensor(
800800
ggml_backend_buffer_t buffer, ggml_tensor* tensor) {
801801
if (tensor->view_src != NULL && tensor->view_offs == 0) {
802802
GGML_ASSERT(tensor->view_src->buffer->buft == buffer->buft);
803-
return;
803+
return GGML_STATUS_SUCCESS;
804804
}
805805

806806
// TODO: can backend doesn't support quantized yet. Just leave the code
@@ -817,6 +817,7 @@ static void ggml_backend_cann_buffer_init_tensor(
817817
memset_size, 0, memset_size));
818818
}
819819
}
820+
return GGML_STATUS_SUCCESS;
820821
}
821822

822823
// TODO: need handle tensor which has paddings.

ggml/src/ggml-cpu/amx/amx.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ static void * ggml_backend_amx_buffer_get_base(ggml_backend_buffer_t buffer) {
5050
return (void *) (buffer->context);
5151
}
5252

53-
static void ggml_backend_amx_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
53+
static enum ggml_status ggml_backend_amx_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
5454
tensor->extra = (void *) ggml::cpu::amx::get_tensor_traits(buffer, tensor);
5555

5656
GGML_UNUSED(buffer);
57+
return GGML_STATUS_SUCCESS;
5758
}
5859

5960
static void ggml_backend_amx_buffer_memset_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor,

ggml/src/ggml-cpu/ggml-cpu-aarch64.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4135,10 +4135,11 @@ static const ggml::cpu::tensor_traits * ggml_aarch64_get_optimal_repack_type(con
41354135
return nullptr;
41364136
}
41374137

4138-
static void ggml_backend_cpu_aarch64_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
4138+
static enum ggml_status ggml_backend_cpu_aarch64_buffer_init_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor) {
41394139
tensor->extra = (void *) const_cast<ggml::cpu::tensor_traits *>(ggml_aarch64_get_optimal_repack_type(tensor));
41404140

41414141
GGML_UNUSED(buffer);
4142+
return GGML_STATUS_SUCCESS;
41424143
}
41434144

41444145
static void ggml_backend_cpu_aarch64_buffer_set_tensor(ggml_backend_buffer_t buffer, struct ggml_tensor * tensor,

ggml/src/ggml-cuda/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.18) # for CMAKE_CUDA_ARCHITECTURES
33
find_package(CUDAToolkit)
44

55
if (CUDAToolkit_FOUND)
6-
message(STATUS "CUDA Toolkit found")
6+
message(STATUS "CUDA Toolkit found: ${CUDAToolkit_VERSION}")
77

88
if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
99
# native == GPUs available at build time

ggml/src/ggml-cuda/ggml-cuda.cu

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -534,12 +534,12 @@ static void * ggml_backend_cuda_buffer_get_base(ggml_backend_buffer_t buffer) {
534534
return ctx->dev_ptr;
535535
}
536536

537-
static void ggml_backend_cuda_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
537+
static enum ggml_status ggml_backend_cuda_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
538538
ggml_backend_cuda_buffer_context * ctx = (ggml_backend_cuda_buffer_context *)buffer->context;
539539

540540
if (tensor->view_src != NULL) {
541541
assert(tensor->view_src->buffer->buft == buffer->buft);
542-
return;
542+
return GGML_STATUS_SUCCESS;
543543
}
544544

545545
if (ggml_is_quantized(tensor->type) && tensor->view_src == nullptr && ggml_backend_buffer_get_usage(buffer) != GGML_BACKEND_BUFFER_USAGE_COMPUTE) {
@@ -552,6 +552,7 @@ static void ggml_backend_cuda_buffer_init_tensor(ggml_backend_buffer_t buffer, g
552552
CUDA_CHECK(cudaMemset((char *)tensor->data + original_size, 0, padded_size - original_size));
553553
}
554554
}
555+
return GGML_STATUS_SUCCESS;
555556
}
556557

557558
static void ggml_backend_cuda_buffer_memset_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor, uint8_t value, size_t offset, size_t size) {
@@ -786,7 +787,7 @@ static void * ggml_backend_cuda_split_buffer_get_base(ggml_backend_buffer_t buff
786787
GGML_UNUSED(buffer);
787788
}
788789

789-
static void ggml_backend_cuda_split_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
790+
static enum ggml_status ggml_backend_cuda_split_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
790791
GGML_ASSERT(tensor->view_src == nullptr); // views of split tensors are not supported
791792

792793
ggml_backend_cuda_split_buffer_context * ctx = (ggml_backend_cuda_split_buffer_context *)buffer->context;
@@ -832,6 +833,7 @@ static void ggml_backend_cuda_split_buffer_init_tensor(ggml_backend_buffer_t buf
832833
}
833834
}
834835
tensor->extra = extra;
836+
return GGML_STATUS_SUCCESS;
835837
}
836838

837839
static void ggml_backend_cuda_split_buffer_set_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor, const void * data, size_t offset, size_t size) {

ggml/src/ggml-opencl/ggml-opencl.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1222,7 +1222,7 @@ static void * ggml_backend_opencl_buffer_get_base(ggml_backend_buffer_t buffer)
12221222
GGML_UNUSED(buffer);
12231223
}
12241224

1225-
static void ggml_backend_opencl_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
1225+
static enum ggml_status ggml_backend_opencl_buffer_init_tensor(ggml_backend_buffer_t buffer, ggml_tensor * tensor) {
12261226
ggml_backend_opencl_buffer_context * ctx = (ggml_backend_opencl_buffer_context *) buffer->context;
12271227

12281228
ggml_cl2_init(buffer->buft->device);
@@ -1262,6 +1262,7 @@ static void ggml_backend_opencl_buffer_init_tensor(ggml_backend_buffer_t buffer,
12621262
tensor->extra = extra;
12631263
}
12641264
}
1265+
return GGML_STATUS_SUCCESS;
12651266
}
12661267

12671268
// The optimized gemm and gemv kernels are used for large matrices without batch.

0 commit comments

Comments
 (0)