aclnnInplaceBitwiseAndTensor
Applicable Products
- Ascend 950PR&950DT products: Supported
- Atlas A3 products: Supported
- Atlas A2 products: Supported
- Atlas 200I/500 A2 inference products: Not supported
- Atlas inference products: Not supported
- Atlas training products: Supported
Function
-
Description: When the input is a BOOL-type tensor, performs a logical AND operation; when the input is an INT-type tensor, performs a bitwise AND operation.
-
Formula:
selfRefi=selfRefi&otherselfRef_i = selfRef_i \& other
Function Prototype
Each operator uses the two-phase API. Call the "aclnnInplaceBitwiseAndTensorGetWorkspaceSize" API first to obtain the workspace size required for computation and the executor that contains the computation process. Then call the "aclnnInplaceBitwiseAndTensor" API to execute the computation.
aclnnStatus aclnnInplaceBitwiseAndTensorGetWorkspaceSize(
const aclTensor* selfRef,
const aclTensor* other,
uint64_t* workspaceSize,
aclOpExecutor** executor)
aclnnStatus aclnnInplaceBitwiseAndTensor(
void* workspace,
uint64_t workspaceSize,
aclOpExecutor* executor,
aclrtStream stream)
aclnnInplaceBitwiseAndTensorGetWorkspaceSize
-
Parameters:
Parameter Input/Output Description Instruction Data Type Data Format Dimensions (shape) Non-contiguous Tensor selfRef (aclTensor*) Input/Output Input and output tensor, selfRef in the formula. The data type must comply with the data type deduction rules with other. The shape must comply with the broadcast relationship with other. INT16, UINT16, INT32, INT64, INT8, UINT8, UINT32, UINT64, BOOL ND 0-8 √ other (aclTensor*) Input Input tensor, other in the formula. The data type must satisfy the data type deduction rules with selfRef. The shape must satisfy the broadcast relationship with selfRef. INT16, UINT16, INT32, INT64, INT8, UINT8, UINT32, UINT64, BOOL ND 0-8 √ workspaceSize (uint64_t*) Output Returns the workspace size to be allocated on the Device. - - - - - executor (aclOpExecutor**) Output Returns the op executor that contains the computation process of the operator. - - - - - -
Return value
aclnnStatus: return status code, see aclnn Return Codes.
The first-phase API performs input parameter validation and returns an error in the following scenarios:
Error Code Error Code Description ACLNN_ERR_PARAM_NULLPTR 161001 selfRef, other, or out is a null pointer. ACLNN_ERR_PARAM_INVALID 161002 The data types of selfRef and other are not within the supported range. selfRef and other do not comply with the data type deduction rules. The data type deduced from selfRef and other cannot be converted to the type of the specified output selfRef. The shapes of selfRef and other cannot be broadcast. The dimensions of selfRef or other exceed 8.
aclnnInplaceBitwiseAndTensor
-
Parameters:
Parameter Input/Output Description workspace Input Workspace memory address allocated on the Device. workspaceSize Input Size of the workspace allocated on the Device, obtained by the first-phase API aclnnInplaceBitwiseAndTensorGetWorkspaceSize. executor Input Executor of the op, including the operator computation flow. stream Input Stream for executing tasks. -
Return value
aclnnStatus: return status code. For details, see aclnn Return Codes.
Constraints
- deterministic computation:
- aclnnInplaceBitwiseAndTensor defaults to a deterministic implementation.
Example
The following sample code is for reference only. For details about compilation and execution, see Compile and Run Samples.
#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_bitwise_and_tensor.h"
#define CHECK_RET(cond, return_expr) \
do { \
if (!(cond)) { \
return_expr; \
} \
} while (0)
#define LOG_PRINT(message, ...) \
do { \
printf(message, ##__VA_ARGS__); \
} while (0)
int64_t GetShapeSize(const std::vector<int64_t>& shape) {
int64_t shape_size = 1;
for (auto i : shape) {
shape_size *= i;
}
return shape_size;
}
int Init(int32_t deviceId, aclrtStream* stream) {
// Boilerplate, resource initialization
auto ret = aclInit(nullptr);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
ret = aclrtSetDevice(deviceId);
CHECK_RET(ret == ACL_SUCCESS,
LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); aclFinalize(); return ret);
ret = aclrtCreateStream(stream);
CHECK_RET(ret == ACL_SUCCESS,
LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret);
aclrtResetDevice(deviceId); aclFinalize(); return ret);
return 0;
}
template <typename T>
int CreateAclTensor(const std::vector<T>& hostData, const std::vector<int64_t>& shape, void** deviceAddr,
aclDataType dataType, aclTensor** tensor) {
auto size = GetShapeSize(shape) * sizeof(T);
// Call aclrtMalloc to allocate memory on the device.
auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);
// Call aclrtMemcpy to copy host-side data to device memory.
ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);
// Calculate the strides of the contiguous tensor.
std::vector<int64_t> strides(shape.size(), 1);
for (int64_t i = shape.size() - 2; i >= 0; i--) {
strides[i] = shape[i + 1] * strides[i + 1];
}
// Call the aclCreateTensor API to create an aclTensor.
*tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND,
shape.data(), shape.size(), *deviceAddr);
return 0;
}
int main() {
// 1. (boilerplate) Initialize device/stream. For details, see the ACL public API list.
// Set deviceId based on the actual device.
int32_t deviceId = 0;
aclrtStream stream;
auto ret = Init(deviceId, &stream);
// Handle the check as needed.
CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
// 2. Construct the input and output. Perform custom construction based on the API.
std::vector<int64_t> selfShape = {4, 2};
std::vector<int64_t> otherShape = {4, 2};
void* selfDeviceAddr = nullptr;
void* otherDeviceAddr = nullptr;
aclTensor* self = nullptr;
aclTensor* other = nullptr;
std::vector<int32_t> selfHostData = {0, 1, 2, 3, 4, 5, 6, 7};
std::vector<int32_t> otherHostData = {0, 1, 2, 3, 4, 5, 6, 7};
// Create the self aclTensor.
ret = CreateAclTensor(selfHostData, selfShape, &selfDeviceAddr, aclDataType::ACL_INT32, &self);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// Create the other aclTensor.
ret = CreateAclTensor(otherHostData, otherShape, &otherDeviceAddr, aclDataType::ACL_INT32, &other);
CHECK_RET(ret == ACL_SUCCESS, return ret);
// 3. Call the CANN operator library API. Modify it to the specific API.
uint64_t workspaceSize = 0;
aclOpExecutor* executor;
// Call the aclnnInplaceBitwiseAndTensor first-phase API
ret = aclnnInplaceBitwiseAndTensorGetWorkspaceSize(self, other, &workspaceSize, &executor);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceBitwiseAndTensorGetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
// Allocate device memory based on the workspaceSize calculated by the first-phase API.
void* workspaceAddr = nullptr;
if (workspaceSize > 0) {
ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
}
// Call the aclnnInplaceBitwiseAndTensor second-phase API
ret = aclnnInplaceBitwiseAndTensor(workspaceAddr, workspaceSize, executor, stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnInplaceBitwiseAndTensor failed. ERROR: %d\n", ret); return ret);
// 4. (Boilerplate) Synchronize and wait for the task execution to complete.
ret = aclrtSynchronizeStream(stream);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);
// 5. Obtain the output value, and copy the result from the device side to the host side. Modify it according to the interface definition of the specific API.
auto size = GetShapeSize(selfShape);
std::vector<int32_t> resultData(size, 0);
ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]), selfDeviceAddr, size * sizeof(int32_t),
ACL_MEMCPY_DEVICE_TO_HOST);
CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return ret);
for (int64_t i = 0; i < size; i++) {
LOG_PRINT("result[%ld] is: %d\n", i, resultData[i]);
}
// 6. Release aclTensor and aclScalar. Modify it according to the interface definition of the specific API.
aclDestroyTensor(self);
aclDestroyTensor(other);
// 7. Release device resources.
aclrtFree(selfDeviceAddr);
aclrtFree(otherDeviceAddr);
if (workspaceSize > 0) {
aclrtFree(workspaceAddr);
}
aclrtDestroyStream(stream);
aclrtResetDevice(deviceId);
aclFinalize();
return 0;
}