1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2020 Dmitry Kozlyuk
5 #ifndef _EAL_WINDOWS_H_
6 #define _EAL_WINDOWS_H_
9 * @file Facilities private to Windows EAL
12 #include <rte_errno.h>
13 #include <rte_windows.h>
16 * Log current function as not implemented and set rte_errno.
18 #define EAL_LOG_NOT_IMPLEMENTED() \
20 RTE_LOG(DEBUG, EAL, "%s() is not implemented\n", __func__); \
21 rte_errno = ENOTSUP; \
25 * Log current function as a stub.
27 #define EAL_LOG_STUB() \
28 RTE_LOG(DEBUG, EAL, "Windows: %s() is a stub\n", __func__)
31 * Create a map of processors and cores on the system.
34 * 0 on success, (-1) on failure and rte_errno is set.
36 int eal_create_cpu_map(void);
42 * The location to store the thread id if successful.
44 * 0 for success, -1 if the thread is not created.
46 int eal_thread_create(pthread_t *thread);
49 * Get system NUMA node number for a socket ID.
52 * Valid EAL socket ID.
54 * NUMA node number to use with Win32 API.
56 unsigned int eal_socket_numa_node(unsigned int socket_id);
59 * Schedule code for execution in the interrupt thread.
64 * Argument to the called function.
66 * 0 on success, negative error code on failure.
68 int eal_intr_thread_schedule(void (*func)(void *arg), void *arg);
71 * Request interrupt thread to stop and wait its termination.
73 void eal_intr_thread_cancel(void);
76 * Open virt2phys driver interface device.
78 * @return 0 on success, (-1) on failure.
80 int eal_mem_virt2iova_init(void);
83 * Cleanup resources used for virtual to physical address translation.
85 void eal_mem_virt2iova_cleanup(void);
88 * Locate Win32 memory management routines in system libraries.
90 * @return 0 on success, (-1) on failure.
92 int eal_mem_win32api_init(void);
95 * Allocate new memory in hugepages on the specified NUMA node.
98 * Number of bytes to allocate. Must be a multiple of huge page size.
102 * Address of the memory allocated on success or NULL on failure.
104 void *eal_mem_alloc_socket(size_t size, int socket_id);
107 * Commit memory previously reserved with eal_mem_reserve()
108 * or decommitted from hugepages by eal_mem_decommit().
110 * @param requested_addr
111 * Address within a reserved region. Must not be NULL.
113 * Number of bytes to commit. Must be a multiple of page size.
115 * Socket ID to allocate on. Can be SOCKET_ID_ANY.
117 * On success, address of the committed memory, that is, requested_addr.
118 * On failure, NULL and rte_errno is set.
120 void *eal_mem_commit(void *requested_addr, size_t size, int socket_id);
123 * Put allocated or committed memory back into reserved state.
126 * Address of the region to decommit.
128 * Number of bytes to decommit, must be the size of a page
129 * (hugepage or regular one).
131 * The *addr* and *size* must match location and size
132 * of a previously allocated or committed region.
135 * 0 on success, (-1) on failure.
137 int eal_mem_decommit(void *addr, size_t size);
139 #endif /* _EAL_WINDOWS_H_ */