org.bytedeco.tensorrt.nvinfer

Class IPluginV2

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorrt.nvinfer.IPluginV2

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

IPluginV2Ext

Deprecated.

Deprecated in TensorRT 8.5. Implement IPluginV2DynamicExt or IPluginV2IOExt depending on your requirement.

@Namespace(value="nvinfer1")
 @Properties(inherit=nvinfer.class)
public class IPluginV2
extends Pointer

\class IPluginV2 \brief Plugin class for user-implemented layers. Plugins are a mechanism for applications to implement custom layers. When combined with IPluginCreator it provides a mechanism to register plugins and look up the Plugin Registry during de-serialization.

See Also:

IPluginCreator, IPluginRegistry

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
IPluginV2(Pointer p) Deprecated. Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
IPluginV2	clone() Deprecated. \brief Clone the plugin object.
void	configureWithFormat(Dims64 inputDims, int nbInputs, Dims64 outputDims, int nbOutputs, int type, int format, int maxBatchSize) Deprecated.
void	configureWithFormat(Dims64 inputDims, int nbInputs, Dims64 outputDims, int nbOutputs, nvinfer.DataType type, nvinfer.TensorFormat format, int maxBatchSize) Deprecated. \brief Configure the layer.
void	destroy() Deprecated. \brief Destroy the plugin object.
int	enqueue(int batchSize, Pointer inputs, Pointer outputs, Pointer workspace, org.bytedeco.cuda.cudart.CUstream_st stream) Deprecated.
int	enqueue(int batchSize, PointerPointer inputs, PointerPointer outputs, Pointer workspace, org.bytedeco.cuda.cudart.CUstream_st stream) Deprecated. \brief Execute the layer.
int	getNbOutputs() Deprecated. \brief Get the number of outputs from the layer.
Dims64	getOutputDimensions(int index, Dims64 inputs, int nbInputDims) Deprecated. \brief Get the dimension of an output tensor.
String	getPluginNamespace() Deprecated. \brief Return the namespace of the plugin object.
String	getPluginType() Deprecated. \brief Return the plugin type.
String	getPluginVersion() Deprecated. \brief Return the plugin version.
long	getSerializationSize() Deprecated. \brief Find the size of the serialization buffer required to store the plugin configuration in a binary file.
int	getTensorRTVersion() Deprecated. \brief Return the API version with which this plugin was built.
long	getWorkspaceSize(int maxBatchSize) Deprecated. \brief Find the workspace size required by the layer.
int	initialize() Deprecated. \brief Initialize the layer for execution.
void	serialize(Pointer buffer) Deprecated. \brief Serialize the layer.
void	setPluginNamespace(BytePointer pluginNamespace) Deprecated.
void	setPluginNamespace(String pluginNamespace) Deprecated. \brief Set the namespace that this plugin object belongs to.
boolean	supportsFormat(int type, int format) Deprecated.
boolean	supportsFormat(nvinfer.DataType type, nvinfer.TensorFormat format) Deprecated. \brief Check format support.
void	terminate() Deprecated. \brief Release resources acquired during plugin layer initialization.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IPluginV2

public IPluginV2(Pointer p)

Deprecated.

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

getTensorRTVersion

@NoException(value=true)
public int getTensorRTVersion()

Deprecated.

\brief Return the API version with which this plugin was built. Do not override this method as it is used by the TensorRT library to maintain backwards-compatibility with plugins.

Returns:

The TensorRT version in the format (major * 100 + minor) * 100 + patch. \usage - Allowed context for the API call - Thread-safe: Yes, the implementation provided here is safe to call from any thread.

getPluginType

@NoException(value=true)
public String getPluginType()

Deprecated.

\brief Return the plugin type. Should match the plugin name returned by the corresponding plugin creator

See Also:

\warning The string returned must be NULL-terminated and have a length of 1024 bytes or less including the NULL terminator. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

getPluginVersion

@NoException(value=true)
public String getPluginVersion()

Deprecated.

\brief Return the plugin version. Should match the plugin version returned by the corresponding plugin creator

See Also:

\warning The string returned must be NULL-terminated and have a length of 1024 bytes or less including the NULL terminator. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

getNbOutputs

@NoException(value=true)
public int getNbOutputs()

Deprecated.

\brief Get the number of outputs from the layer.

Returns:

The number of outputs, which is a positive integer. This function is called by the implementations of INetworkDefinition and IBuilder. In particular, it is called prior to any call to initialize(). \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

getOutputDimensions

@ByVal
 @Cast(value="nvinfer1::Dims*")
 @NoException(value=true)
public Dims64 getOutputDimensions(int index,
                                                                                                      @Cast(value="const nvinfer1::Dims*")
                                                                                                      Dims64 inputs,
                                                                                                      int nbInputDims)

Deprecated.

\brief Get the dimension of an output tensor.

Parameters:

index - The index of the output tensor. Will lie in the valid range (between 0 and getNbOutputs()-1 inclusive).

inputs - The input tensor dimensions. Will be the start address of a Dims array of length nbInputDims.

nbInputDims - The number of input tensors. Will be a non-negative integer.

Returns:

The output tensor dimensions if the index is in the valid range. An invalid value of Dims{-1, {}} must be returned if the index is not in the valid range. This function is called by the implementations of INetworkDefinition and IBuilder. In particular, it is called prior to any call to initialize(). \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin. \note In any non-IPluginV2DynamicExt plugin, batch size must not be included in the returned dimensions, even if the plugin is expected to be run in a network with explicit batch mode enabled. Please see the TensorRT Developer Guide for more details on how plugin inputs and outputs behave.

supportsFormat

@Cast(value="bool")
 @NoException(value=true)
public boolean supportsFormat(nvinfer.DataType type,
                                                                              @Cast(value="nvinfer1::PluginFormat")
                                                                              nvinfer.TensorFormat format)

Deprecated.

\brief Check format support.

Parameters:

type - DataType requested.

format - PluginFormat requested.

Returns:

true if the plugin supports the type-format combination. This function is called by the implementations of INetworkDefinition, IBuilder, and safe::ICudaEngine/ICudaEngine. In particular, it is called when creating an engine and when deserializing an engine. \warning for the format field, the values PluginFormat::kCHW4, PluginFormat::kCHW16, and PluginFormat::kCHW32 will not be passed in, this is to keep backward compatibility with TensorRT 5.x series. Use PluginV2IOExt or PluginV2DynamicExt for other PluginFormats. \warning DataType:kBOOL and DataType::kUINT8 are not supported. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

supportsFormat

@Cast(value="bool")
 @NoException(value=true)
public boolean supportsFormat(@Cast(value="nvinfer1::DataType")
                                                                              int type,
                                                                              @Cast(value="nvinfer1::PluginFormat")
                                                                              int format)

Deprecated.

configureWithFormat

@NoException(value=true)
public void configureWithFormat(@Cast(value="const nvinfer1::Dims*")
                                                          Dims64 inputDims,
                                                          int nbInputs,
                                                          @Cast(value="const nvinfer1::Dims*")
                                                          Dims64 outputDims,
                                                          int nbOutputs,
                                                          nvinfer.DataType type,
                                                          @Cast(value="nvinfer1::PluginFormat")
                                                          nvinfer.TensorFormat format,
                                                          int maxBatchSize)

Deprecated.

\brief Configure the layer. This function is called by the builder prior to initialize(). It provides an opportunity for the layer to make algorithm choices on the basis of its weights, dimensions, and maximum batch size.

Parameters:

inputDims - The input tensor dimensions. Will be the start address of a Dims array of length nbInputs.

nbInputs - The number of inputs. Will be a non-negative integer.

outputDims - The output tensor dimensions. Will be the start address of a Dims array of length nbOutputs.

nbOutputs - The number of outputs. Will be a positive integer identical to the return value of getNbOutputs().

type - The data type selected for the engine.

format - The format selected for the engine.

maxBatchSize - The maximum batch size. Will be a positive integer. The dimensions passed here do not include the outermost batch size (i.e. for 2-D image networks, they will be 3-dimensional CHW dimensions). \warning for the format field, the values PluginFormat::kCHW4, PluginFormat::kCHW16, and PluginFormat::kCHW32 will not be passed in, this is to keep backward compatibility with TensorRT 5.x series. Use PluginV2IOExt or PluginV2DynamicExt for other PluginFormats. \warning DataType:kBOOL and DataType::kUINT8 are not supported.

See Also:

\usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin. However, TensorRT will not call this method from two threads simultaneously on a given clone of a plugin.

configureWithFormat

@NoException(value=true)
public void configureWithFormat(@Cast(value="const nvinfer1::Dims*")
                                                          Dims64 inputDims,
                                                          int nbInputs,
                                                          @Cast(value="const nvinfer1::Dims*")
                                                          Dims64 outputDims,
                                                          int nbOutputs,
                                                          @Cast(value="nvinfer1::DataType")
                                                          int type,
                                                          @Cast(value="nvinfer1::PluginFormat")
                                                          int format,
                                                          int maxBatchSize)

Deprecated.

initialize

@NoException(value=true)
public int initialize()

Deprecated.

\brief Initialize the layer for execution. This is called when the engine is created.

Returns:

0 for success, else non-zero (which will cause engine termination). \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin or when using multiple execution contexts using this plugin.

terminate

@NoException(value=true)
public void terminate()

Deprecated.

\brief Release resources acquired during plugin layer initialization. This is called when the engine is destroyed.

See Also:

\usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin or when using multiple execution contexts using this plugin. However, TensorRT will not call this method from two threads simultaneously on a given clone of a plugin.

getWorkspaceSize

@Cast(value="size_t")
 @NoException(value=true)
public long getWorkspaceSize(int maxBatchSize)

Deprecated.

\brief Find the workspace size required by the layer. This function is called during engine startup, after initialize(). The workspace size returned must be sufficient for any batch size up to the maximum.

Parameters:

maxBatchSize - The maximum batch size, which will be a positive integer.

Returns:

The workspace size in bytes, i.e. the device memory size that the plugin requires for its internal computations. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin. However, TensorRT will not call this method from two threads simultaneously on a given clone of a plugin.

enqueue

@NoException(value=true)
public int enqueue(int batchSize,
                                             @Cast(value="const void*const*")
                                             PointerPointer inputs,
                                             @Cast(value="void*const*")
                                             PointerPointer outputs,
                                             Pointer workspace,
                                             org.bytedeco.cuda.cudart.CUstream_st stream)

Deprecated.

\brief Execute the layer.

Parameters:

batchSize - The number of inputs in the batch.

inputs - The memory for the input tensors. Will be an array of device addresses corresponding to input tensors of length nbInputs, where nbInputs is the second parameter passed to configureWithFormat(). The i-th input tensor will have the dimensions inputDims[i], where inputDims is the first parameter that was passed to configureWithFormat().

outputs - The memory for the output tensors. Will be an array of device addresses corresponding to output tensors of length getNbOutputs().

workspace - Workspace for execution. Will be the start address of a device buffer whose length will be at least getWorkspaceSize(batchSize).

stream - The stream in which to execute the kernels. This will be a valid CUDA stream.

Returns:

0 for success, else non-zero (which will cause engine termination). \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when multiple execution contexts are used during runtime.

enqueue

@NoException(value=true)
public int enqueue(int batchSize,
                                             @Cast(value="const void*const*") @ByPtrPtr
                                             Pointer inputs,
                                             @Cast(value="void*const*") @ByPtrPtr
                                             Pointer outputs,
                                             Pointer workspace,
                                             org.bytedeco.cuda.cudart.CUstream_st stream)

Deprecated.

getSerializationSize

@Cast(value="size_t")
 @NoException(value=true)
public long getSerializationSize()

Deprecated.

\brief Find the size of the serialization buffer required to store the plugin configuration in a binary file.

Returns:

The size of the serialization buffer in bytes. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

serialize

@NoException(value=true)
public void serialize(Pointer buffer)

Deprecated.

\brief Serialize the layer.

Parameters:

buffer - A pointer to a host buffer to serialize data. Size of buffer will be at least as large as the value returned by getSerializationSize.

See Also:

\usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

destroy

@NoException(value=true)
public void destroy()

Deprecated.

\brief Destroy the plugin object. This will be called when the network, builder or engine is destroyed. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

clone

@NoException(value=true)
public IPluginV2 clone()

Deprecated.

\brief Clone the plugin object. This copies over internal plugin parameters and returns a new plugin object with these parameters. The TensorRT runtime calls clone() to clone the plugin when an execution context is created for an engine, after the engine has been created. The runtime does not call initialize() on the cloned plugin, so the cloned plugin must be created in an initialized state.

Overrides:

clone in class Object

Returns:

A cloned plugin object in an initialized state with the same parameters as the current object. nullptr must be returned if the cloning fails, e.g. because of resource exhaustion. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin or when creating multiple execution contexts.

setPluginNamespace

@NoException(value=true)
public void setPluginNamespace(String pluginNamespace)

Deprecated.

\brief Set the namespace that this plugin object belongs to. Ideally, all plugin objects from the same plugin library must have the same namespace.

Parameters:

pluginNamespace - The namespace for the plugin object. \warning The string pluginNamespace will be NULL-terminated and have a length of 1024 bytes or less including the NULL terminator. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.

setPluginNamespace

@NoException(value=true)
public void setPluginNamespace(@Cast(value="const char*")
                                                         BytePointer pluginNamespace)

Deprecated.

getPluginNamespace

@NoException(value=true)
public String getPluginNamespace()

Deprecated.

\brief Return the namespace of the plugin object.

Returns:

The namespace string that was passed to setPluginNamespace(), possibly after truncation to 1024 bytes if a longer string was passed. An empty string must be returned as default value. \usage - Allowed context for the API call - Thread-safe: Yes, this method is required to be thread-safe and may be called from multiple threads when building networks on multiple devices sharing the same plugin.