Yeppp!  0.9
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
yepLibrary.h
1 /*
2  * Copyright (c) 2010-2012 Marat Dukhan
3  * Copyright (c) 2012 Georgia Institute of Technology
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are those
27  * of the authors and should not be interpreted as representing official policies,
28  * either expressed or implied, of the Yeppp! Project.
29  */
30 
31 #pragma once
32 
33 #include <yepTypes.h>
34 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
48  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_Init();
56  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_Release();
62  YEP_PUBLIC_SYMBOL const struct YepLibraryVersion *yepLibrary_GetVersion();
75  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetString(const enum YepEnumeration *enumerationType, const Yep32u *enumerationValue, void *buffer, YepSize *length);
84  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuIsaFeatures(Yep64u *isaFeatures);
93  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuSimdFeatures(Yep64u *simdFeatures);
102  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuSystemFeatures(Yep64u *systemFeatures);
110  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuVendor(enum YepCpuVendor *vendor);
118  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuArchitecture(enum YepCpuArchitecture *architecture);
126  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuMicroarchitecture(enum YepCpuMicroarchitecture *microarchitecture);
127  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuDataCacheSize(Yep32u level, Yep32u *cacheSize);
128  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuInstructionCacheSize(Yep32u level, Yep32u *cacheSize);
129  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetLogicalCoresCount(Yep32u *logicalCoresCount);
149  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuCyclesAcquire(Yep64u *state);
166  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetCpuCyclesRelease(Yep64u *state, Yep64u *cycles);
176  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetTimerTicks(Yep64u *ticks);
185  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetTimerFrequency(Yep64u *frequency);
194  YEP_PUBLIC_SYMBOL enum YepStatus yepLibrary_GetTimerAccuracy(Yep64u *accuracy);
195 
196 #ifdef __cplusplus
197 }
198 #endif