File: sge_hgroup_HGRP_L.h

package info (click to toggle)
gridengine 8.1.9%2Bdfsg-10
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 56,880 kB
  • sloc: ansic: 432,689; java: 87,068; cpp: 31,958; sh: 29,429; jsp: 7,757; perl: 6,336; xml: 5,828; makefile: 4,701; csh: 3,928; ruby: 2,221; tcl: 1,676; lisp: 669; yacc: 519; python: 503; lex: 361; javascript: 200
file content (152 lines) | stat: -rw-r--r-- 5,474 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
#ifndef __SGE_HROUPL_H
#define __SGE_HROUPL_H

/*___INFO__MARK_BEGIN__*/
/*************************************************************************
 * 
 *  The Contents of this file are made available subject to the terms of
 *  the Sun Industry Standards Source License Version 1.2
 * 
 *  Sun Microsystems Inc., March, 2001
 * 
 * 
 *  Sun Industry Standards Source License Version 1.2
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.2 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
 * 
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 * 
 *   The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 * 
 *   Copyright: 2001 by Sun Microsystems, Inc.
 * 
 *   All Rights Reserved.
 * 
 ************************************************************************/
/*___INFO__MARK_END__*/

#include "sgeobj/sge_boundaries.h"
#include "cull/cull.h"

#ifdef  __cplusplus
extern "C" {
#endif

/* *INDENT-OFF* */

/****** sgeobj/hgroup/--HGRP_Type *********************************************
*  NAME
*     HGRP_Type - CULL hostgroup element
*
*  ELEMENTS
*     SGE_HOST(HGRP_name)
*        Name of the hostgroup
*
*     SGE_LIST(HGRP_host_list)
*        List of hostnames and/or hostgroup names
*     
*  FUNCTION 
*
*     HGRP_Type elements are used to define groups of hosts. Each group
*     will be identified by a unique name.
*     Each hostgroup might refer to none, one or multiple hosts and/or
*     hostgroups. This object makes it possible to define a network of
*     hostgroups and hosts.
*
*     
*                       --------------                                 
*                       |            |
*                       V            | 0:x
*                 ------------- -----| 
*                 | HGRP_Type |               ------------
*                 ------------- ------------> | hostname |
*                                    0:x      ------------
*     
*     Example
*
*        Following diagram shows a network of 9 hostgroups (A; B; C; 
*        D; E; G; H; I). Each of those groups references one host 
*        (A -> a; B -> b; C -> c; ...). Additionally some of those 
*        hostgroups refer to one (A -> C; B -> C; C -> E; ...) or two 
*        hostgroups (E -> F,G; F -> H,I) The connections are all 
*        uni-directional, you have to read the diagram from the left
*        to the right.
*
*                 -----                           -----
*                 | A | -- a                      | H | -- h
*                 ----- \                       / -----
*                         -----           -----
*                         | C | -- c      | F | -- f
*                         -----         / -----
*                 ----- /       \ -----         \ -----
*                 | B | -- b      | E | -- e      | I | -- i
*                 -----           -----           -----
*                         ----- /       \ -----
*                         | D | -- d      | G | -- g
*                         -----           -----
*
*     Several functions exist to create such networks and to find
*     certain sets of hosts and hostgroups within such a network:
*
*     hgroup_find_references("E", &answer, master_list, &hosts, &groups)
*        hosts -> e 
*        groups -> F, G
* 
*     hgroup_find_all_references("E", &answer, master_list, &hosts, &groups)
*        hosts -> e, f, g, h, i
*        groups -> F, G, H, I
*
*     hgroup_find_referencees("E", &answer, master_list, &groups)
*        groups -> C, D
*
*     hgroup_find_all_referencees("E", &answer, master_list, &groups)
*        groups -> A, B, C, D
*
*  SEE ALSO
*     sgeobj/hgroup/hgroup_list_get_master_list()
*     sgeobj/hgroup/hgroup_list_locate()
*     sgeobj/hgroup/hgroup_create()
*     sgeobj/hgroup/hgroup_add_references()
*     sgeobj/hgroup/hgroup_find_all_references()
*     sgeobj/hgroup/hgroup_find_references()
*     sgeobj/hgroup/hgroup_find_all_referencees()
*     sgeobj/hgroup/hgroup_find_referencees()
*     sgeobj/hgroup/hgroup_list_exists()
*******************************************************************************/
enum {
   HGRP_name = HGRP_LOWERBOUND,
   HGRP_host_list,
   HGRP_cqueue_list
};

LISTDEF(HGRP_Type)
   JGDI_ROOT_OBJ(Hostgroup, SGE_HGRP_LIST, ADD | MODIFY | DELETE | GET | GET_LIST)
   JGDI_EVENT_OBJ(ADD(sgeE_HGROUP_ADD) | MODIFY(sgeE_HGROUP_MOD) | DELETE(sgeE_HGROUP_DEL) | GET_LIST(sgeE_HGROUP_LIST))
   SGE_HOST_D(HGRP_name, CULL_PRIMARY_KEY | CULL_HASH | CULL_UNIQUE | CULL_SPOOL | CULL_JGDI_CONF, "@template")
   SGE_LIST(HGRP_host_list, HR_Type, CULL_SPOOL | CULL_JGDI_CONF) 
   SGE_LIST(HGRP_cqueue_list, CQ_Type, CULL_DEFAULT | CULL_JGDI_HIDDEN) 
LISTEND

NAMEDEF(HGRPN)
   NAME("HGRP_name")
   NAME("HGRP_host_list")
   NAME("HGRP_cqueue_list")
NAMEEND

#define HGRPS sizeof(HGRPN)/sizeof(char*)

/* *INDENT-ON* */

#ifdef  __cplusplus
}
#endif

#endif /* __SGE_HGROUPL_H */