← Back to branch summary

~ubuntu-branches/ubuntu/vivid/slurm-llnl/vivid

« back to all changes in this revision

Viewing changes to src/common/slurm_protocol_api.h

  • Committer: Bazaar Package Importer
  • Author(s): Gennaro Oliva
  • Date: 2009-09-24 23:28:15 UTC
  • mfrom: (1.3.4 upstream)
  • mto: (16.1.1 maverick)
  • mto: This revision was merged to the branch mainline in revision 14.
  • Revision ID: james.westby@ubuntu.com-20090924232815-uu5ku2gqk7appy26
Tags: upstream-2.0.5
Import upstream version 2.0.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/common/slurm_protocol_api.h
3
3
 *      definitions
4
4
 *****************************************************************************
5
5
 *  Copyright (C) 2002-2006 The Regents of the University of California.
6
 
 *  Copyright (C) 2008 Lawrence Livermore National Security.
 
6
 *  Copyright (C) 2008-2009 Lawrence Livermore National Security.
7
7
 *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
8
8
 *  Written by Kevin Tew <tew1@llnl.gov>, et. al.
9
 
 *  LLNL-CODE-402394.
 
9
 *  CODE-OCEC-09-009. All rights reserved.
10
10
 *  
11
11
 *  This file is part of SLURM, a resource management program.
12
 
 *  For details, see <http://www.llnl.gov/linux/slurm/>.
 
12
 *  For details, see <https://computing.llnl.gov/linux/slurm/>.
 
13
 *  Please also read the included file: DISCLAIMER.
13
14
 *  
14
15
 *  SLURM is free software; you can redistribute it and/or modify it under
15
16
 *  the terms of the GNU General Public License as published by the Free
102
103
 */
103
104
uint16_t slurm_get_batch_start_timeout(void);
104
105
 
 
106
/* slurm_get_resume_timeout
 
107
 * RET ResumeTimeout value from slurm.conf
 
108
 */
 
109
uint16_t slurm_get_resume_timeout(void);
 
110
 
 
111
/* slurm_get_complete_wait
 
112
 * RET CompleteWait value from slurm.conf
 
113
 */
 
114
uint16_t slurm_get_complete_wait(void);
 
115
 
 
116
/* slurm_get_debug_flags
 
117
 * RET DebugFlags value from slurm.conf
 
118
 */
 
119
uint32_t slurm_get_debug_flags(void);
 
120
 
105
121
/* slurm_get_def_mem_per_task
106
122
 * RET DefMemPerTask value from slurm.conf
107
123
 */
108
124
uint32_t slurm_get_def_mem_per_task(void);
109
125
 
 
126
/* slurm_get_kill_on_bad_exit
 
127
 * RET KillOnBadExit value from slurm.conf
 
128
 */
 
129
uint16_t slurm_get_kill_on_bad_exit(void);
 
130
 
110
131
/* slurm_get_max_mem_per_task
111
132
 * RET MaxMemPerTask value from slurm.conf
112
133
 */
128
149
 */
129
150
char *slurm_get_mpi_default(void);
130
151
 
 
152
/* slurm_get_mpi_params
 
153
 * get mpi parameters value from slurmctld_conf object
 
154
 * RET char *   - mpi default value from slurm.conf,  MUST be xfreed by caller
 
155
 */
 
156
char *slurm_get_mpi_params(void);
 
157
 
131
158
/* slurm_get_msg_timeout
132
159
 * get default message timeout value from slurmctld_conf object
133
160
 */
156
183
 */
157
184
char *slurm_get_health_check_program(void);
158
185
 
159
 
/* slurm_get_slurmdbd_addr
160
 
 * get slurm_dbd_addr from slurmctld_conf object from slurmctld_conf object
161
 
 * RET char *   - slurmdbd_addr, MUST be xfreed by caller
162
 
 */
163
 
char *slurm_get_slurmdbd_addr(void);
164
 
 
165
 
/* slurm_get_slurmdbd_port
166
 
 * get slurm_dbd_port from slurmctld_conf object from slurmctld_conf object
167
 
 * RET uint16_t   - dbd_port
168
 
 */
169
 
uint16_t slurm_get_slurmdbd_port(void);
170
 
 
171
186
/* slurm_get_plugin_dir
172
187
 * get plugin directory from slurmctld_conf object from slurmctld_conf object 
173
188
 * RET char *   - plugin directory, MUST be xfreed by caller
174
189
 */
175
190
char *slurm_get_plugin_dir(void);
176
191
 
 
192
/* slurm_get_priority_decay_hl
 
193
 * returns the priority decay half life in seconds from slurmctld_conf object
 
194
 * RET uint32_t - decay_hl in secs.
 
195
 */
 
196
uint32_t slurm_get_priority_decay_hl(void);
 
197
 
 
198
/* slurm_get_priority_favor_small
 
199
 * returns weither or not we are favoring small jobs from slurmctld_conf object
 
200
 * RET bool - true if favor small, false else.
 
201
 */
 
202
bool slurm_get_priority_favor_small(void);
 
203
 
 
204
/* slurm_get_priority_max_age
 
205
 * returns the priority age max in seconds from slurmctld_conf object
 
206
 * RET uint32_t - max_age in secs.
 
207
 */
 
208
uint32_t slurm_get_priority_max_age(void);
 
209
 
 
210
/* slurm_get_priority_reset_period
 
211
 * returns the priority usage reset period in seconds from slurmctld_conf object
 
212
 * RET uint16_t - flag, see PRIORITY_RESET_* in slurm/slurm.h.
 
213
 */
 
214
uint16_t slurm_get_priority_reset_period(void);
 
215
 
 
216
/* slurm_get_priority_type
 
217
 * returns the priority type from slurmctld_conf object
 
218
 * RET char *    - priority type, MUST be xfreed by caller
 
219
 */
 
220
char *slurm_get_priority_type(void);
 
221
 
 
222
/* slurm_get_priority_weight_age
 
223
 * returns the priority weight for age from slurmctld_conf object
 
224
 * RET uint32_t - factor weight.
 
225
 */
 
226
uint32_t slurm_get_priority_weight_age(void);
 
227
 
 
228
/* slurm_get_priority_weight_fairshare
 
229
 * returns the priority weight for fairshare from slurmctld_conf object
 
230
 * RET uint32_t - factor weight.
 
231
 */
 
232
uint32_t slurm_get_priority_weight_fairshare(void);
 
233
 
 
234
/* slurm_get_priority_weight_job_size
 
235
 * returns the priority weight for job size from slurmctld_conf object
 
236
 * RET uint32_t - factor weight.
 
237
 */
 
238
uint32_t slurm_get_priority_weight_job_size(void);
 
239
 
 
240
/* slurm_get_priority_weight_partition
 
241
 * returns the priority weight for partitions from slurmctld_conf object
 
242
 * RET uint32_t - factor weight.
 
243
 */
 
244
uint32_t slurm_get_priority_weight_partition(void);
 
245
 
 
246
/* slurm_get_priority_weight_qos
 
247
 * returns the priority weight for QOS from slurmctld_conf object
 
248
 * RET uint32_t - factor weight.
 
249
 */
 
250
uint32_t slurm_get_priority_weight_qos(void);
 
251
 
177
252
/* slurm_get_private_data
178
253
 * get private data from slurmctld_conf object
179
254
 * RET uint16_t   - private_data
227
302
 */
228
303
extern uint16_t slurm_get_track_wckey(void);
229
304
 
 
305
/* slurm_get_topology_plugin
 
306
 * returns the value of topology_plugin in slurmctld_conf object
 
307
 * RET char *    - topology type, MUST be xfreed by caller
 
308
 */
 
309
extern char * slurm_get_topology_plugin(void);
 
310
 
230
311
/* slurm_set_tree_width
231
312
 * sets the value of tree_width in slurmctld_conf object
232
313
 * RET 0 or error code
233
314
 */
234
315
extern int slurm_set_tree_width(uint16_t tree_width);
 
316
 
235
317
/* slurm_get_tree_width
236
318
 * returns the value of tree_width in slurmctld_conf object
237
319
 */
249
331
 */
250
332
char *slurm_get_accounting_storage_user(void);
251
333
 
 
334
/* slurm_set_accounting_storage_user
 
335
 * IN: char *user (name of file or database)
 
336
 * RET 0 or error code
 
337
 */
 
338
int slurm_set_accounting_storage_user(char *user);
 
339
 
 
340
/* slurm_get_accounting_storage_backup_host
 
341
 * returns the storage host from slurmctld_conf object
 
342
 * RET char *    - storage backup host,  MUST be xfreed by caller
 
343
 */
 
344
char *slurm_get_accounting_storage_backup_host(void);
 
345
 
252
346
/* slurm_get_accounting_storage_host
253
347
 * returns the storage host from slurmctld_conf object
254
348
 * RET char *    - storage host,  MUST be xfreed by caller
255
349
 */
256
350
char *slurm_get_accounting_storage_host(void);
257
351
 
 
352
/* slurm_set_accounting_storage_host
 
353
 * IN: char *host (name of file or database)
 
354
 * RET 0 or error code
 
355
 */
 
356
int slurm_set_accounting_storage_host(char *host);
 
357
 
258
358
/* slurm_get_accounting_storage_enforce
259
359
 * returns what level to enforce associations at
260
360
 */
365
465
 * RET uint16_t  - Value of SchedulerRootFilter */
366
466
extern uint16_t slurm_get_root_filter(void);
367
467
 
 
468
/* slurm_get_sched_params
 
469
 * RET char * - Value of SchedulerParameters, MUST be xfreed by caller */
 
470
extern char *slurm_get_sched_params(void);
 
471
 
368
472
/* slurm_get_sched_port
369
473
 * RET uint16_t  - Value of SchedulerPort */
370
474
extern uint16_t slurm_get_sched_port(void);
376
480
uint16_t inline slurm_get_slurmd_port(void);
377
481
 
378
482
/* slurm_get_slurm_user_id
379
 
 * returns slurmd uid from slurmctld_conf object 
 
483
 * returns slurm uid from slurmctld_conf object 
380
484
 * RET uint32_t - slurm user id
381
485
 */
382
486
uint32_t slurm_get_slurm_user_id(void);
383
487
 
 
488
/* slurm_get_slurmd_user_id
 
489
 * returns slurmd uid from slurmctld_conf object 
 
490
 * RET uint32_t - slurmd user id
 
491
 */
 
492
uint32_t slurm_get_slurmd_user_id(void);
 
493
 
384
494
/* slurm_get_sched_type
385
495
 * get sched type from slurmctld_conf object
386
496
 * RET char *   - sched type, MUST be xfreed by caller
393
503
 */
394
504
char *slurm_get_select_type(void);
395
505
 
 
506
/* slurm_get_srun_io_timeout
 
507
 * get default srun I/O task timeout value from slurmctld_conf object
 
508
 */
 
509
uint16_t slurm_get_srun_io_timeout(void);
 
510
 
396
511
/* slurm_get_switch_type
397
512
 * get switch type from slurmctld_conf object
398
513
 * RET char *   - switch type, MUST be xfreed by caller
438
553
 
439
554
/* In the socket implementation it creates a socket, binds to it, and 
440
555
 *      listens for connections.
 
556
 *
441
557
 * IN port              - port to bind the msg server to
442
558
 * RET slurm_fd         - file descriptor of the connection created
443
559
 */
445
561
 
446
562
/* In the socket implementation it creates a socket, binds to it, and 
447
563
 *      listens for connections.
 
564
 *
 
565
 * IN  addr_name        - address to bind the msg server to (NULL means any)
 
566
 * IN port              - port to bind the msg server to
 
567
 * RET slurm_fd         - file descriptor of the connection created
 
568
 */
 
569
slurm_fd inline slurm_init_msg_engine_addrname_port(char *addr_name,
 
570
                                                    uint16_t port);
 
571
 
 
572
/* In the socket implementation it creates a socket, binds to it, and 
 
573
 *      listens for connections.
448
574
 * IN slurm_address     - slurm_addr to bind the msg server to 
449
575
 * RET slurm_fd         - file descriptor of the connection created
450
576
 */