← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/sge_gdi_host_scaling.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/htmlman/htmlman3/sge_gdi_host_scaling.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     sge_gdi_host_attribute, sge_gdi_host_scaling,
 
7
     sge_gdi_host_nslots, sge_gdi_myhost_attribute,
 
8
     sge_gdi_myhost_scaling, sge_gdi_myhost_nslots
 
9
     - Grid Engine/TRM GDI calls
 
10
 
 
11
SYNOPSIS
 
12
     #include "sge_gdi_attributes.h"
 
13
 
 
14
     char *sge_gdi_host_attribute(
 
15
          char *hostname,
 
16
          char *attr_name
 
17
     );
 
18
 
 
19
     double sge_gdi_host_scaling(
 
20
          char *hostname,
 
21
          char *attr_name
 
22
     );
 
23
 
 
24
     int sge_gdi_host_nslots(
 
25
          char *hostname,
 
26
          u_long32 jobid
 
27
     );
 
28
 
 
29
     char *sge_gdi_myhost_attribute(
 
30
          char *attr_name
 
31
     );
 
32
 
 
33
     double sge_gdi_myhost_scaling(
 
34
          char *attr_name
 
35
     );
 
36
 
 
37
     int sge_gdi_myhost_nslots(
 
38
          u_long32 jobid
 
39
     );
 
40
 
 
41
DESCRIPTION
 
42
     The Transparent Resource Manager (TRM) extension to the Grid
 
43
     Engine  Database  Interface  (GDI) of Grid Engine simplifies
 
44
     integration of (parallel)  applications  with  Grid  Engine.
 
45
     Access  is  provided to information which describes the run-
 
46
     time environment of a Grid Engine job.  In many  cases  this
 
47
     information   can   be   used   to   optimize   runtime   of
 
48
     jobs/applications  by  adapting  its  behavior  to   runtime
 
49
     environment or load situation.
 
50
 
 
51
     The following is a description of the basic functionality of
 
52
     all Grid Engine TRM GDI functions:
 
53
 
 
54
  sge_gdi_host_attribute
 
55
     Returns value  of  the  requested  attribute  at  the  host.
 
56
     Depending  on  the  attribute  this  can  be a load value, a
 
57
     statically configured value or  a  consumable  resource.  On
 
58
     error  NULL  is  returned.  Otherwise  a pointer is returned
 
59
     which  points  to  a  static  address.  Please   note   that
 
60
     <I>sge</I>_<I>gdi</I>_<I>host</I>_<I>attribute</I>  will fail if the Grid Engine GDI was
 
61
     not successfully initialized by use of <B><A HREF="../htmlman3/sge_gdi_setup.html">sge_gdi_setup(3)</A></B>.
 
62
 
 
63
  sge_gdi_host_scaling
 
64
     Returns the scaling factor which is used to scale the  given
 
65
     load  value from the host. The scaling values for a host can
 
66
     be modified using the <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B> command.  If  no  scaling  is
 
67
     active for the attribute a value of 1 is returned.  On error
 
68
     -1 is returned. Please note that  <I>sge</I>_<I>gdi</I>_<I>host</I>_<I>scaling</I>  will
 
69
     fail if the Grid Engine GDI was not successfully initialized
 
70
     by use of <B><A HREF="../htmlman3/sge_gdi_setup.html">sge_gdi_setup(3)</A></B>.
 
71
 
 
72
  sge_gdi_host_nslots
 
73
     Returns the number of slots the job got from the Grid Engine
 
74
     scheduler  for  the given host. This number can be important
 
75
     in case of  multithreaded  parallel  applications.   If  the
 
76
     jobid  is  0  the  value  of  the JOB_ID environment is used
 
77
     instead.   On  error  0  is  returned.  Please   note   that
 
78
     <I>sge</I>_<I>gdi</I>_<I>host</I>_<I>nslots</I> will fail if the Grid Engine GDI was not
 
79
     successfully initialized by use of <B><A HREF="../htmlman3/sge_gdi_setup.html">sge_gdi_setup(3)</A></B>.
 
80
 
 
81
  sge_gdi_myhost_attribute
 
82
     Returns the value of the requested attribute  at  the  local
 
83
     host.   Depending on the attribute this can be a load value,
 
84
     a statically configured value or a consumable  resource.  On
 
85
     error  NULL  is  returned.  Otherwise  a pointer is returned
 
86
     which points to  a  static  address.  <I>sge</I>_<I>gdi</I>_<I>host</I>_<I>attribute</I>
 
87
     should  be  called  without  setting  up the Grid Engine GDI
 
88
     since this is done inside of this function.
 
89
 
 
90
  sge_gdi_myhost_scaling
 
91
     Returns the scaling factor which is used to scale the  given
 
92
     load  value  from  the  local host. The scaling values for a
 
93
     host can be modified using the <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B> command. If no scal-
 
94
     ing  is  active  for the attribute a value of 1 is returned.
 
95
     On error -1 is returned.  <I>sge</I>_<I>gdi</I>_<I>myhost</I>_<I>scaling</I>  should  be
 
96
     called  without setting up the Grid Engine GDI since this is
 
97
     done inside of this function.
 
98
 
 
99
  sge_gdi_myhost_nslots
 
100
     Returns the number of slots the job got from the Grid Engine
 
101
     scheduler  for  the local host. This number can be important
 
102
     in case of  multithreaded  parallel  applications.   If  the
 
103
     jobid  is  0  the  value  of  the JOB_ID environment is used
 
104
     instead.  On  error  0  is  returned.  <I>sge</I>_<I>gdi</I>_<I>myhost</I>_<I>nslots</I>
 
105
     should  be  called  without  setting  up the Grid Engine GDI
 
106
     since this is done inside of this function.
 
107
 
 
108
 
 
109
SEE ALSO
 
110
     <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B>, <B><A HREF="../htmlman3/sge_gdi_setup.html">sge_gdi_setup(3)</A></B>.  <B><A HREF="../htmlman1/qconf.html">qconf(1)</A></B>
 
111
 
 
112
COPYRIGHT
 
113
     See <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B> for a full statement of rights and  permis-
 
114
     sions.
 
115
 
 
116
 
 
117
 
 
118
 
 
119
 
 
120
 
 
121
 
 
122
 
 
123
 
 
124
 
 
125
 
 
126
 
 
127
 
 
128
 
 
129
 
 
130
 
 
131
 
 
132
 
 
133
 
 
134
 
 
135
 
 
136
 
 
137
 
 
138
 
 
139
 
 
140
 
 
141
 
 
142
 
 
143
 
 
144
 
 
145
 
 
146
 
 
147
 
 
148
 
 
149
 
 
150
 
 
151
 
 
152
 
 
153
 
 
154
 
 
155
 
 
156
 
 
157
 
 
158
 
 
159
 
 
160
 
 
161
</PRE>
 
162
<HR>
 
163
<ADDRESS>
 
164
Man(1) output converted with
 
165
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
166
</ADDRESS>
 
167
</BODY>
 
168
</HTML>