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