Loading...
Searching...
No Matches
threadLimits.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_BASE_WORK_THREAD_LIMITS_H
25#define PXR_BASE_WORK_THREAD_LIMITS_H
26
27#include "pxr/pxr.h"
28#include "pxr/base/work/api.h"
29
30PXR_NAMESPACE_OPEN_SCOPE
31
33
48WORK_API unsigned WorkGetConcurrencyLimit();
49
54WORK_API bool WorkHasConcurrency();
55
61
73WORK_API void WorkSetConcurrencyLimit(unsigned n);
74
92
100
101PXR_NAMESPACE_CLOSE_SCOPE
102
103#endif
WORK_API void WorkSetConcurrencyLimitArgument(int n)
Sanitize n as described below and set the concurrency limit accordingly.
WORK_API unsigned WorkGetPhysicalConcurrencyLimit()
Return the number of physical execution cores available to the program.
WORK_API void WorkSetMaximumConcurrencyLimit()
Set the concurrency limit to be the maximum recommended for the hardware on which it's running.
WORK_API unsigned WorkGetConcurrencyLimit()
Return the current concurrency limit, always >= 1.
WORK_API void WorkSetConcurrencyLimit(unsigned n)
Set the concurrency limit to n, if n is a non-zero value.
WORK_API bool WorkHasConcurrency()
Return true if WorkGetPhysicalConcurrencyLimit() returns a number greater than 1 and PXR_WORK_THREAD_...