xref: /spdk/lib/env_ocf/ocf_env.c (revision 712a3f69d32632bf6c862f00200f7f437d3f7529)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 #include "ocf/ocf_def.h"
34 #include "ocf_env.h"
35 
36 #include "spdk/crc32.h"
37 #include "spdk/env.h"
38 #include "spdk_internal/log.h"
39 
40 /* Number of buffers for mempool
41  * Need to be power of two - 1 for better memory utilization
42  * It depends on memory usage of OCF which
43  * in itself depends on the workload
44  * It is a big number because OCF uses allocators
45  * for every request it sends and recieves
46  */
47 #define ENV_ALLOCATOR_NBUFS 32767
48 
49 /* Use unique index for env allocators */
50 static env_atomic g_env_allocator_index = 0;
51 
52 void *
53 env_allocator_new(env_allocator *allocator)
54 {
55 	void *mem = spdk_mempool_get(allocator->mempool);
56 
57 	if (spdk_likely(mem)) {
58 		memset(mem, 0, allocator->element_size);
59 	}
60 
61 	return mem;
62 }
63 
64 env_allocator *
65 env_allocator_create(uint32_t size, const char *name)
66 {
67 	env_allocator *allocator;
68 	char qualified_name[128] = {0};
69 
70 	snprintf(qualified_name, 128, "ocf_env_%d", env_atomic_inc_return(&g_env_allocator_index));
71 
72 	allocator = calloc(1, sizeof(*allocator));
73 	if (!allocator) {
74 		return NULL;
75 	}
76 
77 	allocator->mempool = spdk_mempool_create(qualified_name,
78 			     ENV_ALLOCATOR_NBUFS, size,
79 			     SPDK_MEMPOOL_DEFAULT_CACHE_SIZE,
80 			     SPDK_ENV_SOCKET_ID_ANY);
81 
82 	if (!allocator->mempool) {
83 		free(allocator);
84 		return NULL;
85 	}
86 
87 	allocator->element_size = size;
88 
89 	return allocator;
90 }
91 
92 void
93 env_allocator_del(env_allocator *allocator, void *item)
94 {
95 	spdk_mempool_put(allocator->mempool, item);
96 }
97 
98 void
99 env_allocator_destroy(env_allocator *allocator)
100 {
101 	if (allocator) {
102 		if (ENV_ALLOCATOR_NBUFS - spdk_mempool_count(allocator->mempool)) {
103 			SPDK_ERRLOG("Not all objects deallocated\n");
104 			assert(false);
105 		}
106 
107 		spdk_mempool_free(allocator->mempool);
108 		free(allocator);
109 	}
110 }
111 
112 /* *** COMPLETION *** */
113 
114 void
115 env_completion_init(env_completion *completion)
116 {
117 	atomic_set(&completion->atom, 1);
118 }
119 
120 void
121 env_completion_wait(env_completion *completion)
122 {
123 	while (atomic_read(&completion->atom)) {
124 		spdk_pause();
125 	}
126 }
127 
128 void
129 env_completion_complete(env_completion *completion)
130 {
131 	atomic_set(&completion->atom, 0);
132 }
133 
134 /* *** CRC *** */
135 
136 uint32_t
137 env_crc32(uint32_t crc, uint8_t const *message, size_t len)
138 {
139 	return spdk_crc32_ieee_update(message, len, crc);
140 }
141