Native containers are value types, which means that when they’re assigned to a variable, Unity copies the NativeContainer
structure, which contains pointers to where the native container’s data is stored, including its AtomicSafetyHandle
. It doesn’t copy the entire contents of the NativeContainer
.
This scenario means that there might be multiple copies of a NativeContainer
structure which all reference the same region of memory, and all contain AtomicSafetyHandle
objects which reference the same central record.
The above diagram shows three different copies of a NativeArray
structure that all represent the same actual container. Each copy points to the same stored data, and the same safety data as the original NativeArray
. However, each copy of the NativeArray
has different flags that indicate what a job is allowed to do with that copy. The pointer to the safety data, combined with the flags, make up the AtomicSafetyHandle
.
If a NativeContainer
is disposed of, all the copies of the NativeContainer
structure must recognize that the original NativeContainer
is invalid. Disposing of the original NativeContainer
means that the block of memory that used to hold the data for the NativeContainer
has been deallocated. In this situation, the pointer to the data which is stored in each copy of the NativeContainer
is invalid, and might cause access violations if you use it.
The AtomicSafetyHandle
also points at a central record which becomes invalid for the NativeContainer
instances. However, the safety system never deallocates the memory for the central record, so it avoids the risk of access violations.
Instead, each record contains a version number. A copy of the version number is stored inside each AtomicSafetyHandle
that references that record. When a NativeContainer is disposed of, Unity calls Release()
, which increments the version number on the central record. After this, the record can be reused for other NativeContainer
instances.
Each remaining AtomicSafetyHandle
compares its stored version number against the version number in the central record to test whether the NativeContainer
has been disposed of. Unity performs this test automatically as part of calls to methods such as CheckReadAndThrow
, and CheckWriteAndThrow
.
A dynamic native container is one which has a variable size that you can continue to add elements to, such as NativeList<T>
(which is available in the Collections package). This is in contrast to a static native container like NativeArray<T>
, which has a fixed size that you can’t change.
When you use a dynamic native container, you can also directly access its data through another interface, called a view. A view allows you to alias a NativeContainer
object’s data without copying or taking ownership of the data. Examples of views include enumerator objects, which you can use to access the data in a native container element-by-element, and methods such as NativeList<T>.AsArray
, which you can use to treat a NativeList
as if it were a NativeArray
.
Views aren’t typically thread safe if the size of the dynamic native container changes. This is because when the size of the native container changes, Unity relocates where the data is stored in memory, which causes any pointers that a view stores to become invalid.
To support situations when the size of the dynamic native container changes, the safety system includes a secondary version number in an AtomicSafetyHandle
. This mechanism is similar to the versioning mechanism, but uses a second version number stored in the central record which can be incremented independently of the first version number.
To use a secondary version number, you can use UseSecondaryVersion
to configure the views into the data stored in a NativeContainer
. For operations that change the size of the native container, or otherwise make existing views invalid, use CheckWriteAndBumpSecondaryVersion
instead of CheckWriteAndThrow
. You also need to set SetBumpSecondaryVersionOnScheduleWrite
on the NativeContainer
to automatically invalidate views whenever a job is scheduled that writes to the native container.
When you create a view and copy the AtomicSafetyHandle
to it, use CheckGetSecondaryDataPointerAndThrow
to confirm that it’s safe to copy the pointer to the native container’s memory into the view.
There are two special handles, which you can use when working with temporary native containers:
GetTempMemoryHandle
: Returns an AtomicSafetyHandle
which you can use in native containers which are allocated with Allocator.Temp
. Unity automatically invalidates this handle when the current temporary memory scope exits, so you don’t need to release it yourself. To test whether a particular AtomicSafetyHandle
is the handle returned by GetTempMemoryHandle
, use IsTempMemoryHandle
.GetTempUnsafePtrSliceHandle
: Returns a global handle you can use for temporary native containers which are backed by unsafe memory. For example, a NativeSlice
constructed from stack memory. You can’t pass containers that use this handle into jobs.Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.