summaryrefslogtreecommitdiff
path: root/runtime/contrib/heap_trace/tests/src/cl_release_mem_object_interception_test.cc
blob: 49b8fd994fb97fbf5c134ed2d3cdb38c985b75d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "common_test_environment.h"
#include "file_content_manipulations.h"

#include "trace.h"

#include <CL/cl.h>

extern std::unique_ptr<Trace> GlobalTrace;

namespace backstage
{

struct ClReleaseMemObjectStub : public TestEnv
{
  cl_context context;

  ClReleaseMemObjectStub() : TestEnv("./cl_release_mem_object_interception_test.log") {}

  void SetUp() final
  {
    cl_device_id device_id;
    int err = clGetDeviceIDs(NULL, CL_DEVICE_TYPE_GPU, 1, &device_id, NULL);
    context = clCreateContext(0, 1, &device_id, NULL, NULL, &err);

    TestEnv::SetUp();
  }

  void TearDown() final
  {
    TestEnv::TearDown();

    clReleaseContext(context);
  }
};

TEST_F(ClReleaseMemObjectStub, should_work_as_standard_version)
{
  cl_mem mem = clCreateBuffer(context, CL_MEM_READ_WRITE, 1024, NULL, NULL);
  clReleaseMemObject(mem);
  ASSERT_TRUE(mem);
}

TEST_F(ClReleaseMemObjectStub, must_log_deallocation_events_if_trace_is_ready_for_it)
{
  GlobalTrace.reset();
  cl_mem mem1 = clCreateBuffer(context, CL_MEM_READ_WRITE, 1024, NULL, NULL);
  ASSERT_TRUE(mem1);
  clReleaseMemObject(mem1);

  GlobalTrace.reset(new Trace);
  cl_mem mem2 = clCreateBuffer(context, CL_MEM_READ_WRITE, 128, NULL, NULL);
  cl_mem mem3 = clCreateBuffer(context, CL_MEM_READ_WRITE, 64, NULL, NULL);
  ASSERT_TRUE(mem2 && mem3);
  clReleaseMemObject(mem2);
  clReleaseMemObject(mem3);
  GlobalTrace.reset();

  ASSERT_STREQ(getContentOfFile("./cl_release_mem_object_interception_test.log").c_str(),
               "On CPU - Peak heap usage: 0 B, Total allocated: 0 B, Total deallocated: 0 B\nOn "
               "GPU - Peak mem usage: 192 B, Total allocated: 192 B, Total deallocated: 192 B\n");
}

TEST_F(ClReleaseMemObjectStub, must_log_deallocation_event_only_if_reference_counter_equals_to_zero)
{
  cl_mem mem = clCreateBuffer(context, CL_MEM_READ_WRITE, 1024, NULL, NULL);
  clRetainMemObject(mem);
  clReleaseMemObject(mem);
  GlobalTrace.reset();
  ASSERT_STREQ(getContentOfFile("./cl_release_mem_object_interception_test.log").c_str(),
               "On CPU - Peak heap usage: 0 B, Total allocated: 0 B, Total deallocated: 0 B\nOn "
               "GPU - Peak mem usage: 1024 B, Total allocated: 1024 B, Total deallocated: 0 B\n");
  clReleaseMemObject(mem);

  GlobalTrace.reset(new Trace);
  mem = clCreateBuffer(context, CL_MEM_READ_WRITE, 1024, NULL, NULL);
  clRetainMemObject(mem);
  clReleaseMemObject(mem);
  clReleaseMemObject(mem);
  GlobalTrace.reset();
  ASSERT_STREQ(
      getContentOfFile("./cl_release_mem_object_interception_test.log").c_str(),
      "On CPU - Peak heap usage: 0 B, Total allocated: 0 B, Total deallocated: 0 B\nOn "
      "GPU - Peak mem usage: 1024 B, Total allocated: 1024 B, Total deallocated: 1024 B\n");
}

TEST_F(ClReleaseMemObjectStub, must_not_log_deallocation_event_if_original_function_failed)
{
  cl_mem mem;
  ASSERT_NE(clReleaseMemObject(mem), CL_SUCCESS);

  GlobalTrace.reset();

  ASSERT_STREQ(getContentOfFile("./cl_release_mem_object_interception_test.log").c_str(),
               "On CPU - Peak heap usage: 0 B, Total allocated: 0 B, Total deallocated: 0 B\nOn "
               "GPU - Peak mem usage: 0 B, Total allocated: 0 B, Total deallocated: 0 B\n");
}

} // namespace backstage