LLVM OpenMP* Runtime Library
kmp_environment.h
1 /*
2  * kmp_environment.h -- Handle environment varoiables OS-independently.
3  */
4 
5 
6 //===----------------------------------------------------------------------===//
7 //
8 // The LLVM Compiler Infrastructure
9 //
10 // This file is dual licensed under the MIT and the University of Illinois Open
11 // Source Licenses. See LICENSE.txt for details.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 
16 #ifndef KMP_ENVIRONMENT_H
17 #define KMP_ENVIRONMENT_H
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 // Return a copy of the value of environment variable or NULL if the variable does not exist.
24 // *Note*: Returned pointed *must* be freed after use with __kmp_env_free().
25 char * __kmp_env_get( char const * name );
26 void __kmp_env_free( char const * * value );
27 
28 // Return 1 if the environment variable exists or 0 if does not exist.
29 int __kmp_env_exists( char const * name );
30 
31 // Set the environment variable.
32 void __kmp_env_set( char const * name, char const * value, int overwrite );
33 
34 // Unset (remove) environment variable.
35 void __kmp_env_unset( char const * name );
36 
37 
38 // -------------------------------------------------------------------------------------------------
39 // Working with environment blocks.
40 // -------------------------------------------------------------------------------------------------
41 
42 /*
43  kmp_env_blk_t is read-only collection of environment variables (or environment-like). Usage:
44 
45  kmp_env_blk_t block;
46  __kmp_env_blk_init( & block, NULL ); // Initialize block from process environment.
47  // or
48  __kmp_env_blk_init( & block, "KMP_WARNING=1|KMP_AFFINITY=none" ); // from string.
49  __kmp_env_blk_sort( & block ); // Optionally, sort list.
50  for ( i = 0; i < block.count; ++ i ) {
51  // Process block.vars[ i ].name and block.vars[ i ].value...
52  }; // for i
53  __kmp_env_block_free( & block );
54 */
55 
56 struct __kmp_env_var {
57  char const * name;
58  char const * value;
59 };
60 typedef struct __kmp_env_var kmp_env_var_t;
61 
62 struct __kmp_env_blk {
63  char const * bulk;
64  kmp_env_var_t const * vars;
65  int count;
66 };
67 typedef struct __kmp_env_blk kmp_env_blk_t;
68 
69 void __kmp_env_blk_init( kmp_env_blk_t * block, char const * bulk );
70 void __kmp_env_blk_free( kmp_env_blk_t * block );
71 void __kmp_env_blk_sort( kmp_env_blk_t * block );
72 char const * __kmp_env_blk_var( kmp_env_blk_t * block, char const * name );
73 
74 #ifdef __cplusplus
75 }
76 #endif
77 
78 #endif // KMP_ENVIRONMENT_H
79 
80 // end of file //
81