/usr/include/slurm/slurmdb.h is in libslurmdb-dev 2.6.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 | /*****************************************************************************\
* slurmdb.h - Interface codes and functions for slurm
******************************************************************************
* Copyright (C) 2010 Lawrence Livermore National Security.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
* Written by Danny Auble da@llnl.gov, et. al.
* CODE-OCEC-09-009. All rights reserved.
*
* This file is part of SLURM, a resource management program.
* For details, see <http://slurm.schedmd.com/>.
* Please also read the included file: DISCLAIMER.
*
* SLURM is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* In addition, as a special exception, the copyright holders give permission
* to link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two. You must obey the GNU
* General Public License in all respects for all of the code used other than
* OpenSSL. If you modify file(s) with this exception, you may extend this
* exception to your version of the file(s), but you are not obligated to do
* so. If you do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source files in
* the program, then also delete it here.
*
* SLURM is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along
* with SLURM; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
\*****************************************************************************/
#ifndef _SLURMDB_H
#define _SLURMDB_H
/* BEGIN_C_DECLS should be used at the beginning of your declarations,
so that C++ compilers don't mangle their names. Use END_C_DECLS at
the end of C declarations. */
#undef BEGIN_C_DECLS
#undef END_C_DECLS
#ifdef __cplusplus
# define BEGIN_C_DECLS extern "C" {
# define END_C_DECLS }
#else
# define BEGIN_C_DECLS /* empty */
# define END_C_DECLS /* empty */
#endif
/* PARAMS is a macro used to wrap function prototypes, so that compilers
that don't understand ANSI C prototypes still work, and ANSI C
compilers can issue warnings about type mismatches. */
#undef PARAMS
#if defined (__STDC__) || defined (_AIX) \
|| (defined (__mips) && defined (_SYSTYPE_SVR4)) \
|| defined(WIN32) || defined(__cplusplus)
# define PARAMS(protos) protos
#else
# define PARAMS(protos) ()
#endif
BEGIN_C_DECLS
#include <slurm/slurm.h>
typedef enum {
SLURMDB_ADMIN_NOTSET,
SLURMDB_ADMIN_NONE,
SLURMDB_ADMIN_OPERATOR,
SLURMDB_ADMIN_SUPER_USER
} slurmdb_admin_level_t;
typedef enum {
SLURMDB_CLASS_NONE, /* no class given */
SLURMDB_CLASS_CAPABILITY, /* capability cluster */
SLURMDB_CLASS_CAPACITY, /* capacity cluster */
SLURMDB_CLASS_CAPAPACITY, /* a cluster that is both capability
* and capacity */
} slurmdb_classification_type_t;
typedef enum {
SLURMDB_EVENT_ALL,
SLURMDB_EVENT_CLUSTER,
SLURMDB_EVENT_NODE
} slurmdb_event_type_t;
typedef enum {
SLURMDB_PROBLEM_NOT_SET,
SLURMDB_PROBLEM_ACCT_NO_ASSOC,
SLURMDB_PROBLEM_ACCT_NO_USERS,
SLURMDB_PROBLEM_USER_NO_ASSOC,
SLURMDB_PROBLEM_USER_NO_UID,
} slurmdb_problem_type_t;
typedef enum {
SLURMDB_REPORT_SORT_TIME,
SLURMDB_REPORT_SORT_NAME
} slurmdb_report_sort_t;
typedef enum {
SLURMDB_REPORT_TIME_SECS,
SLURMDB_REPORT_TIME_MINS,
SLURMDB_REPORT_TIME_HOURS,
SLURMDB_REPORT_TIME_PERCENT,
SLURMDB_REPORT_TIME_SECS_PER,
SLURMDB_REPORT_TIME_MINS_PER,
SLURMDB_REPORT_TIME_HOURS_PER,
} slurmdb_report_time_format_t;
typedef enum {
SLURMDB_UPDATE_NOTSET,
SLURMDB_ADD_USER,
SLURMDB_ADD_ASSOC,
SLURMDB_ADD_COORD,
SLURMDB_MODIFY_USER,
SLURMDB_MODIFY_ASSOC,
SLURMDB_REMOVE_USER,
SLURMDB_REMOVE_ASSOC,
SLURMDB_REMOVE_COORD,
SLURMDB_ADD_QOS,
SLURMDB_REMOVE_QOS,
SLURMDB_MODIFY_QOS,
SLURMDB_ADD_WCKEY,
SLURMDB_REMOVE_WCKEY,
SLURMDB_MODIFY_WCKEY,
SLURMDB_ADD_CLUSTER,
SLURMDB_REMOVE_CLUSTER,
SLURMDB_REMOVE_ASSOC_USAGE,
} slurmdb_update_type_t;
/* Define QOS flags */
#define QOS_FLAG_NOTSET 0x10000000
#define QOS_FLAG_ADD 0x20000000
#define QOS_FLAG_REMOVE 0x40000000
#define QOS_FLAG_PART_MIN_NODE 0x00000001
#define QOS_FLAG_PART_MAX_NODE 0x00000002
#define QOS_FLAG_PART_TIME_LIMIT 0x00000004
#define QOS_FLAG_ENFORCE_USAGE_THRES 0x00000008
#define QOS_FLAG_NO_RESERVE 0x00000010
#define QOS_FLAG_REQ_RESV 0x00000020
#define QOS_FLAG_DENY_LIMIT 0x00000040
/* Archive / Purge time flags */
#define SLURMDB_PURGE_BASE 0x0000ffff /* Apply to get the number
* of units */
#define SLURMDB_PURGE_FLAGS 0xffff0000 /* apply to get the flags */
#define SLURMDB_PURGE_HOURS 0x00010000 /* Purge units are in hours */
#define SLURMDB_PURGE_DAYS 0x00020000 /* Purge units are in days */
#define SLURMDB_PURGE_MONTHS 0x00040000 /* Purge units are in months,
* the default */
#define SLURMDB_PURGE_ARCHIVE 0x00080000 /* Archive before purge */
/* Parent account should be used when calculating FairShare */
#define SLURMDB_FS_USE_PARENT 0x7FFFFFFF
#define SLURMDB_CLASSIFIED_FLAG 0x0100
#define SLURMDB_CLASS_BASE 0x00ff
/* Cluster flags */
#define CLUSTER_FLAG_BG 0x00000001 /* This is a bluegene cluster */
#define CLUSTER_FLAG_BGL 0x00000002 /* This is a bluegene/l cluster */
#define CLUSTER_FLAG_BGP 0x00000004 /* This is a bluegene/p cluster */
#define CLUSTER_FLAG_BGQ 0x00000008 /* This is a bluegene/q cluster */
#define CLUSTER_FLAG_SC 0x00000010 /* This is a sun constellation cluster */
#define CLUSTER_FLAG_XCPU 0x00000020 /* This has xcpu */
#define CLUSTER_FLAG_AIX 0x00000040 /* This is an aix cluster */
#define CLUSTER_FLAG_MULTSD 0x00000080 /* This cluster is multiple slurmd */
#define CLUSTER_FLAG_CRAYXT 0x00000100 /* This cluster is a cray XT */
#define CLUSTER_FLAG_FE 0x00000200 /* This cluster is a front end system */
/* Define assoc_mgr_association_usage_t below to avoid including
* extraneous slurmdb headers */
#ifndef __assoc_mgr_association_usage_t_defined
# define __assoc_mgr_association_usage_t_defined
/* opaque data type */
typedef struct assoc_mgr_association_usage assoc_mgr_association_usage_t;
#endif
/* Define assoc_mgr_qos_usage_t below to avoid including
* extraneous slurmdb headers */
#ifndef __assoc_mgr_qos_usage_t_defined
# define __assoc_mgr_qos_usage_t_defined
/* opaque data type */
typedef struct assoc_mgr_qos_usage assoc_mgr_qos_usage_t;
#endif
/********************************************/
/* Association conditions used for queries of the database */
/* slurmdb_association_cond_t is used in other structures below so
* this needs to be declared first.
*/
typedef struct {
List acct_list; /* list of char * */
List cluster_list; /* list of char * */
List def_qos_id_list; /* list of char * */
List fairshare_list; /* fairshare number */
List grp_cpu_mins_list; /* list of char * */
List grp_cpu_run_mins_list; /* list of char * */
List grp_cpus_list; /* list of char * */
List grp_jobs_list; /* list of char * */
List grp_mem_list; /* list of char * */
List grp_nodes_list; /* list of char * */
List grp_submit_jobs_list; /* list of char * */
List grp_wall_list; /* list of char * */
List id_list; /* list of char */
List max_cpu_mins_pj_list; /* list of char * */
List max_cpu_run_mins_list; /* list of char * */
List max_cpus_pj_list; /* list of char * */
List max_jobs_list; /* list of char * */
List max_nodes_pj_list; /* list of char * */
List max_submit_jobs_list; /* list of char * */
List max_wall_pj_list; /* list of char * */
uint16_t only_defs; /* only send back defaults */
List parent_acct_list; /* name of parent account */
List partition_list; /* list of char * */
List qos_list; /* list of char * */
time_t usage_end;
time_t usage_start;
List user_list; /* list of char * */
uint16_t with_usage; /* fill in usage */
uint16_t with_deleted; /* return deleted associations */
uint16_t with_raw_qos; /* return a raw qos or delta_qos */
uint16_t with_sub_accts; /* return sub acct information also */
uint16_t without_parent_info; /* don't give me parent id/name */
uint16_t without_parent_limits; /* don't give me limits from
* parents */
} slurmdb_association_cond_t;
/* slurmdb_job_cond_t is used by slurmdb_archive_cond_t so it needs to
* be defined before hand.
*/
typedef struct {
List acct_list; /* list of char * */
List associd_list; /* list of char */
List cluster_list; /* list of char * */
uint32_t cpus_max; /* number of cpus high range */
uint32_t cpus_min; /* number of cpus low range */
uint16_t duplicates; /* report duplicate job entries */
int32_t exitcode; /* exit code of job */
List groupid_list; /* list of char * */
List jobname_list; /* list of char * */
uint32_t nodes_max; /* number of nodes high range */
uint32_t nodes_min; /* number of nodes low range */
List partition_list; /* list of char * */
List qos_list; /* list of char * */
List resv_list; /* list of char * */
List resvid_list; /* list of char * */
List state_list; /* list of char * */
List step_list; /* list of jobacct_selected_step_t */
uint32_t timelimit_max; /* max timelimit */
uint32_t timelimit_min; /* min timelimit */
time_t usage_end;
time_t usage_start;
char *used_nodes; /* a ranged node string where jobs ran */
List userid_list; /* list of char * */
List wckey_list; /* list of char * */
uint16_t without_steps; /* don't give me step info */
uint16_t without_usage_truncation; /* give me the information
* without truncating the
* time to the usage_start
* and usage_end */
} slurmdb_job_cond_t;
/* slurmdb_stats_t needs to be defined before slurmdb_job_rec_t and
* slurmdb_step_rec_t.
*/
typedef struct {
double act_cpufreq; /* contains actual average cpu frequency */
double cpu_ave;
double consumed_energy; /* contains energy consumption in joules */
uint32_t cpu_min;
uint32_t cpu_min_nodeid; /* contains which node number it was on */
uint32_t cpu_min_taskid; /* contains which task number it was on */
double disk_read_ave; /* average amount of disk read data, in mb */
double disk_read_max; /* maximum amount of disk read data, in mb */
uint32_t disk_read_max_nodeid; /* contains node number max was on */
uint32_t disk_read_max_taskid;/* contains task number max was on */
double disk_write_ave; /* average amount of disk write data, in mb */
double disk_write_max; /* maximum amount of disk write data, in mb */
uint32_t disk_write_max_nodeid; /* contains node number max was on */
uint32_t disk_write_max_taskid;/* contains task number max was on */
double pages_ave;
uint32_t pages_max;
uint32_t pages_max_nodeid; /* contains which node number it was on */
uint32_t pages_max_taskid; /* contains which task number it was on */
double rss_ave;
uint32_t rss_max;
uint32_t rss_max_nodeid; /* contains which node number it was on */
uint32_t rss_max_taskid; /* contains which task number it was on */
double vsize_ave;
uint32_t vsize_max;
uint32_t vsize_max_nodeid; /* contains which node number it was on */
uint32_t vsize_max_taskid; /* contains which task number it was on */
} slurmdb_stats_t;
/************** alphabetical order of structures **************/
typedef struct {
slurmdb_association_cond_t *assoc_cond;/* use acct_list here for
names */
List description_list; /* list of char * */
List organization_list; /* list of char * */
uint16_t with_assocs;
uint16_t with_coords;
uint16_t with_deleted;
} slurmdb_account_cond_t;
typedef struct {
List assoc_list; /* list of slurmdb_association_rec_t *'s */
List coordinators; /* list of slurmdb_coord_rec_t *'s */
char *description;
char *name;
char *organization;
} slurmdb_account_rec_t;
typedef struct {
uint64_t alloc_secs; /* number of cpu seconds allocated */
uint32_t id; /* association/wckey ID */
time_t period_start; /* when this record was started */
} slurmdb_accounting_rec_t;
typedef struct {
char *archive_dir; /* location to place archive file */
char *archive_script; /* script to run instead of default
actions */
slurmdb_job_cond_t *job_cond; /* conditions for the jobs to archive */
uint32_t purge_event; /* purge events older than this in
* months by default set the
* SLURMDB_PURGE_ARCHIVE bit for
* archiving */
uint32_t purge_job; /* purge jobs older than this in months
* by default set the
* SLURMDB_PURGE_ARCHIVE bit for
* archiving */
uint32_t purge_resv; /* purge reservations older than this in months
* by default set the
* SLURMDB_PURGE_ARCHIVE bit for
* archiving */
uint32_t purge_step; /* purge steps older than this in months
* by default set the
* SLURMDB_PURGE_ARCHIVE bit for
* archiving */
uint32_t purge_suspend; /* purge suspend data older than this
* in months by default set the
* SLURMDB_PURGE_ARCHIVE bit for
* archiving */
} slurmdb_archive_cond_t;
typedef struct {
char *archive_file; /* archive file containing data that was
once flushed from the database */
char *insert; /* an sql statement to be ran containing the
insert of jobs since past */
} slurmdb_archive_rec_t;
/* slurmdb_association_cond_t is defined above alphabetical */
typedef struct {
List accounting_list; /* list of slurmdb_accounting_rec_t *'s */
char *acct; /* account/project associated to
* association */
char *cluster; /* cluster associated to association */
uint32_t def_qos_id; /* Which QOS id is this
* associations default */
uint64_t grp_cpu_mins; /* max number of cpu minutes the
* underlying group of
* associations can run for */
uint64_t grp_cpu_run_mins; /* max number of cpu minutes the
* underlying group of
* assoiciations can
* having running at one time */
uint32_t grp_cpus; /* max number of cpus the
* underlying group of
* associations can allocate at one time */
uint32_t grp_jobs; /* max number of jobs the
* underlying group of associations can run
* at one time */
uint32_t grp_mem; /* max amount of memory the
* underlying group of
* associations can allocate at once */
uint32_t grp_nodes; /* max number of nodes the
* underlying group of
* associations can allocate at once */
uint32_t grp_submit_jobs; /* max number of jobs the
* underlying group of
* associations can submit at
* one time */
uint32_t grp_wall; /* total time in hours the
* underlying group of
* associations can run for */
uint32_t id; /* id identifing a combination of
* user-account-cluster(-partition) */
uint16_t is_def; /* Is this the users default assoc/acct */
uint32_t lft; /* lft used for grouping sub
* associations and jobs as a left
* most container used with rgt */
uint64_t max_cpu_mins_pj; /* max number of cpu seconds this
* association can have per job */
uint64_t max_cpu_run_mins; /* max number of cpu minutes this
* assoiciation can
* having running at one time */
uint32_t max_cpus_pj; /* max number of cpus this
* association can allocate per job */
uint32_t max_jobs; /* max number of jobs this
* association can run at one time */
uint32_t max_nodes_pj; /* max number of nodes this
* association can allocate per job */
uint32_t max_submit_jobs; /* max number of jobs that can be
submitted by association */
uint32_t max_wall_pj; /* longest time this
* association can run a job */
char *parent_acct; /* name of parent account */
uint32_t parent_id; /* id of parent account */
char *partition; /* optional partition in a cluster
* associated to association */
List qos_list; /* list of char * */
uint32_t rgt; /* rgt used for grouping sub
* associations and jobs as a right
* most container used with lft */
uint32_t shares_raw; /* number of shares allocated to
* association */
uint32_t uid; /* user ID */
assoc_mgr_association_usage_t *usage;
char *user; /* user associated to association */
} slurmdb_association_rec_t;
typedef struct {
uint16_t classification; /* how this machine is classified */
List cluster_list; /* list of char * */
uint32_t flags;
List plugin_id_select_list; /* list of char * */
List rpc_version_list; /* list of char * */
time_t usage_end;
time_t usage_start;
uint16_t with_deleted;
uint16_t with_usage;
} slurmdb_cluster_cond_t;
typedef struct {
List accounting_list; /* list of slurmdb_cluster_accounting_rec_t *'s */
uint16_t classification; /* how this machine is classified */
slurm_addr_t control_addr; /* For convenience only.
* DOESN'T GET PACKED */
char *control_host;
uint32_t control_port;
uint32_t cpu_count;
uint16_t dimensions; /* number of dimensions this cluster is */
int *dim_size; /* For convenience only.
* Size of each dimension For now only on
* a bluegene cluster. DOESN'T GET
* PACKED, is set up in slurmdb_get_info_cluster */
uint32_t flags; /* set of CLUSTER_FLAG_* */
char *name;
char *nodes;
uint32_t plugin_id_select; /* id of the select plugin */
slurmdb_association_rec_t *root_assoc; /* root association for
* cluster */
uint16_t rpc_version; /* version of rpc this cluter is running */
} slurmdb_cluster_rec_t;
typedef struct {
uint64_t alloc_secs; /* number of cpu seconds allocated */
uint32_t cpu_count; /* number of cpus during time period */
uint64_t down_secs; /* number of cpu seconds down */
uint64_t idle_secs; /* number of cpu seconds idle */
uint64_t over_secs; /* number of cpu seconds overcommitted */
uint64_t pdown_secs; /* number of cpu seconds planned down */
time_t period_start; /* when this record was started */
uint64_t resv_secs; /* number of cpu seconds reserved */
} slurmdb_cluster_accounting_rec_t;
typedef struct {
char *name;
uint16_t direct;
} slurmdb_coord_rec_t;
typedef struct {
List cluster_list; /* list of char * */
uint32_t cpus_max; /* number of cpus high range */
uint32_t cpus_min; /* number of cpus low range */
uint16_t event_type; /* type of events (slurmdb_event_type_t),
* default is all */
List node_list; /* list of char * */
time_t period_end; /* period end of events */
time_t period_start; /* period start of events */
List reason_list; /* list of char * */
List reason_uid_list; /* list of char * */
List state_list; /* list of char * */
} slurmdb_event_cond_t;
typedef struct {
char *cluster; /* Name of associated cluster */
char *cluster_nodes; /* node list in cluster during time
* period (only set in a cluster event) */
uint32_t cpu_count; /* Number of CPUs effected by event */
uint16_t event_type; /* type of event (slurmdb_event_type_t) */
char *node_name; /* Name of node (only set in a node event) */
time_t period_end; /* End of period */
time_t period_start; /* Start of period */
char *reason; /* reason node is in state during time
period (only set in a node event) */
uint32_t reason_uid; /* uid of that who set the reason */
uint16_t state; /* State of node during time
period (only set in a node event) */
} slurmdb_event_rec_t;
/* slurmdb_job_cond_t is defined above alphabetical */
typedef struct {
char *cluster;
uint32_t job_id;
} slurmdb_job_modify_cond_t;
typedef struct {
uint32_t alloc_cpus;
uint32_t alloc_nodes;
char *account;
uint32_t associd;
char *blockid;
char *cluster;
uint32_t derived_ec;
char *derived_es; /* aka "comment" */
uint32_t elapsed;
time_t eligible;
time_t end;
uint32_t exitcode;
void *first_step_ptr;
uint32_t gid;
uint32_t jobid;
char *jobname;
uint32_t lft;
char *partition;
char *nodes;
uint32_t priority;
uint32_t qosid;
uint32_t req_cpus;
uint32_t req_mem;
uint32_t requid;
uint32_t resvid;
uint32_t show_full;
time_t start;
uint16_t state;
slurmdb_stats_t stats;
List steps; /* list of slurmdb_step_rec_t *'s */
time_t submit;
uint32_t suspended;
uint32_t sys_cpu_sec;
uint32_t sys_cpu_usec;
uint32_t timelimit;
uint32_t tot_cpu_sec;
uint32_t tot_cpu_usec;
uint16_t track_steps;
uint32_t uid;
char *user;
uint32_t user_cpu_sec;
uint32_t user_cpu_usec;
char *wckey;
uint32_t wckeyid;
} slurmdb_job_rec_t;
typedef struct {
char *description;
uint32_t id;
uint32_t flags; /* flags for various things to enforce or
override other limits */
uint32_t grace_time; /* preemption grace time */
uint64_t grp_cpu_mins; /* max number of cpu minutes all jobs
* running under this qos can run for */
uint64_t grp_cpu_run_mins; /* max number of cpu minutes all jobs
* running under this qos can
* having running at one time */
uint32_t grp_cpus; /* max number of cpus this qos
can allocate at one time */
uint32_t grp_jobs; /* max number of jobs this qos can run
* at one time */
uint32_t grp_mem; /* max amount of memory this qos
can allocate at one time */
uint32_t grp_nodes; /* max number of nodes this qos
can allocate at once */
uint32_t grp_submit_jobs; /* max number of jobs this qos can submit at
* one time */
uint32_t grp_wall; /* total time in hours this qos can run for */
uint64_t max_cpu_mins_pj; /* max number of cpu mins a job can
* use with this qos */
uint64_t max_cpu_run_mins_pu; /* max number of cpu mins a user can
* allocate at a given time when
* using this qos (Not yet valid option) */
uint32_t max_cpus_pj; /* max number of cpus a job can
* allocate with this qos */
uint32_t max_cpus_pu; /* max number of cpus a user can
* allocate with this qos at one time */
uint32_t max_jobs_pu; /* max number of jobs a user can
* run with this qos at one time */
uint32_t max_nodes_pj; /* max number of nodes a job can
* allocate with this qos at one time */
uint32_t max_nodes_pu; /* max number of nodes a user can
* allocate with this qos at one time */
uint32_t max_submit_jobs_pu; /* max number of jobs a user can
submit with this qos at once */
uint32_t max_wall_pj; /* longest time this
* qos can run a job */
char *name;
bitstr_t *preempt_bitstr; /* other qos' this qos can preempt */
List preempt_list; /* list of char *'s only used to add or
* change the other qos' this can preempt,
* when doing a get use the preempt_bitstr */
uint16_t preempt_mode; /* See PREEMPT_MODE_* in slurm/slurm.h */
uint32_t priority; /* ranged int needs to be a unint for
* heterogeneous systems */
assoc_mgr_qos_usage_t *usage; /* For internal use only, DON'T PACK */
double usage_factor; /* factor to apply to usage in this qos */
double usage_thres; /* percent of effective usage of an
association when breached will deny
pending and new jobs */
} slurmdb_qos_rec_t;
typedef struct {
List description_list; /* list of char * */
List id_list; /* list of char * */
List name_list; /* list of char * */
uint16_t preempt_mode; /* See PREEMPT_MODE_* in slurm/slurm.h */
uint16_t with_deleted;
} slurmdb_qos_cond_t;
typedef struct {
List cluster_list; /* cluster reservations are on list of
* char * */
uint16_t flags; /* flags for reservation. */
List id_list; /* ids of reservations. list of char * */
List name_list; /* name of reservations. list of char * */
char *nodes; /* list of nodes in reservation */
time_t time_end; /* end time of reservation */
time_t time_start; /* start time of reservation */
uint16_t with_usage; /* send usage for reservation */
} slurmdb_reservation_cond_t;
typedef struct {
uint64_t alloc_secs; /* number of cpu seconds allocated */
char *assocs; /* comma separated list of associations */
char *cluster; /* cluster reservation is for */
uint32_t cpus; /* how many cpus are in reservation */
uint64_t down_secs; /* number of cpu seconds down */
uint16_t flags; /* flags for reservation. */
uint32_t id; /* id of reservation. */
char *name; /* name of reservation */
char *nodes; /* list of nodes in reservation */
char *node_inx; /* node index of nodes in reservation */
time_t time_end; /* end time of reservation */
time_t time_start; /* start time of reservation */
time_t time_start_prev; /* If start time was changed this is
* the pervious start time. Needed
* for accounting */
} slurmdb_reservation_rec_t;
typedef struct {
uint32_t jobid;
uint32_t stepid;
} slurmdb_selected_step_t;
typedef struct {
uint32_t elapsed;
time_t end;
int32_t exitcode;
slurmdb_job_rec_t *job_ptr;
uint32_t ncpus;
uint32_t nnodes;
char *nodes;
uint32_t ntasks;
char *pid_str;
uint32_t req_cpufreq;
uint32_t requid;
time_t start;
enum job_states state;
slurmdb_stats_t stats;
uint32_t stepid; /* job's step number */
char *stepname;
uint32_t suspended;
uint32_t sys_cpu_sec;
uint32_t sys_cpu_usec;
uint16_t task_dist;
uint32_t tot_cpu_sec;
uint32_t tot_cpu_usec;
uint32_t user_cpu_sec;
uint32_t user_cpu_usec;
} slurmdb_step_rec_t;
/* slurmdb_stats_t defined above alphabetical */
typedef struct {
List acct_list; /* list of char * */
List action_list; /* list of char * */
List actor_list; /* list of char * */
List cluster_list; /* list of char * */
List id_list; /* list of char * */
List info_list; /* list of char * */
List name_list; /* list of char * */
time_t time_end;
time_t time_start;
List user_list; /* list of char * */
uint16_t with_assoc_info;
} slurmdb_txn_cond_t;
typedef struct {
char *accts;
uint16_t action;
char *actor_name;
char *clusters;
uint32_t id;
char *set_info;
time_t timestamp;
char *users;
char *where_query;
} slurmdb_txn_rec_t;
/* Right now this is used in the slurmdb_qos_rec_t structure. In the
* user_limit_list. */
typedef struct {
uint64_t cpu_run_mins; /* how many cpu mins are allocated
* currently */
uint32_t cpus; /* count of CPUs allocated */
uint32_t jobs; /* count of active jobs */
uint32_t nodes; /* count of nodes allocated */
uint32_t submit_jobs; /* count of jobs pending or running */
uint32_t uid;
} slurmdb_used_limits_t;
typedef struct {
uint16_t admin_level; /* really slurmdb_admin_level_t but for
packing purposes needs to be uint16_t */
slurmdb_association_cond_t *assoc_cond; /* use user_list here for
names and acct_list for
default accounts */
List def_acct_list; /* list of char * (We can't really use
* the assoc_cond->acct_list for this
* because then it is impossible for us
* to tell which accounts are defaults
* and which ones aren't, especially when
* dealing with other versions.)*/
List def_wckey_list; /* list of char * */
uint16_t with_assocs;
uint16_t with_coords;
uint16_t with_deleted;
uint16_t with_wckeys;
uint16_t without_defaults;
} slurmdb_user_cond_t;
typedef struct {
uint16_t admin_level; /* really slurmdb_admin_level_t but for
packing purposes needs to be uint16_t */
List assoc_list; /* list of slurmdb_association_rec_t *'s */
List coord_accts; /* list of slurmdb_coord_rec_t *'s */
char *default_acct;
char *default_wckey;
char *name;
char *old_name;
uint32_t uid;
List wckey_list; /* list of slurmdb_wckey_rec_t *'s */
} slurmdb_user_rec_t;
typedef struct {
List objects; /* depending on type */
uint16_t type; /* really slurmdb_update_type_t but for
* packing purposes needs to be a
* uint16_t */
} slurmdb_update_object_t;
typedef struct {
List cluster_list; /* list of char * */
List id_list; /* list of char * */
List name_list; /* list of char * */
uint16_t only_defs; /* only give me the defaults */
time_t usage_end;
time_t usage_start;
List user_list; /* list of char * */
uint16_t with_usage; /* fill in usage */
uint16_t with_deleted; /* return deleted associations */
} slurmdb_wckey_cond_t;
typedef struct {
List accounting_list; /* list of slurmdb_accounting_rec_t *'s */
char *cluster; /* cluster associated */
uint32_t id; /* id identifing a combination of
* user-wckey-cluster */
uint16_t is_def; /* Is this the users default wckey */
char *name; /* wckey name */
uint32_t uid; /* user ID */
char *user; /* user associated */
} slurmdb_wckey_rec_t;
typedef struct {
char *name;
char *print_name;
char *spaces;
uint16_t user; /* set to 1 if it is a user i.e. if name[0] is
* '|' */
} slurmdb_print_tree_t;
typedef struct {
slurmdb_association_rec_t *assoc;
char *sort_name;
List childern;
} slurmdb_hierarchical_rec_t;
/************** report specific structures **************/
typedef struct {
char *acct;
char *cluster;
uint64_t cpu_secs;
char *parent_acct;
char *user;
} slurmdb_report_assoc_rec_t;
typedef struct {
char *acct;
List acct_list; /* list of char *'s */
List assoc_list; /* list of slurmdb_report_assoc_rec_t's */
uint64_t cpu_secs;
char *name;
uid_t uid;
} slurmdb_report_user_rec_t;
typedef struct {
List assoc_list; /* list of slurmdb_report_assoc_rec_t *'s */
uint32_t cpu_count;
uint64_t cpu_secs;
char *name;
List user_list; /* list of slurmdb_report_user_rec_t *'s */
} slurmdb_report_cluster_rec_t;
typedef struct {
List jobs; /* This should be a NULL destroy since we are just
* putting a pointer to a slurmdb_job_rec_t here
* not allocating any new memory */
uint32_t min_size; /* smallest size of job in cpus here 0 if first */
uint32_t max_size; /* largest size of job in cpus here INFINITE if
* last */
uint32_t count; /* count of jobs */
uint64_t cpu_secs; /* how many cpus secs taken up by this
* grouping */
} slurmdb_report_job_grouping_t;
typedef struct {
char *acct; /*account name */
uint32_t count; /* total count of jobs taken up by this acct */
uint64_t cpu_secs; /* how many cpus secs taken up by this
* acct */
List groups; /* containing slurmdb_report_job_grouping_t's*/
uint32_t lft;
uint32_t rgt;
} slurmdb_report_acct_grouping_t;
typedef struct {
char *cluster; /*cluster name */
uint32_t count; /* total count of jobs taken up by this cluster */
uint64_t cpu_secs; /* how many cpus secs taken up by this
* cluster */
List acct_list; /* containing slurmdb_report_acct_grouping_t's */
} slurmdb_report_cluster_grouping_t;
/* global variable for cross cluster communication */
extern slurmdb_cluster_rec_t *working_cluster_rec;
/************** account functions **************/
/*
* add accounts to accounting system
* IN: account_list List of slurmdb_account_rec_t *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_accounts_add(void *db_conn, List acct_list);
/*
* get info from the storage
* IN: slurmdb_account_cond_t *
* IN: params void *
* returns List of slurmdb_account_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_accounts_get(void *db_conn,
slurmdb_account_cond_t *acct_cond);
/*
* modify existing accounts in the accounting system
* IN: slurmdb_acct_cond_t *acct_cond
* IN: slurmdb_account_rec_t *acct
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_accounts_modify(void *db_conn,
slurmdb_account_cond_t *acct_cond,
slurmdb_account_rec_t *acct);
/*
* remove accounts from accounting system
* IN: slurmdb_account_cond_t *acct_cond
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_accounts_remove(void *db_conn,
slurmdb_account_cond_t *acct_cond);
/************** archive functions **************/
/*
* expire old info from the storage
*/
extern int slurmdb_archive(void *db_conn, slurmdb_archive_cond_t *arch_cond);
/*
* expire old info from the storage
*/
extern int slurmdb_archive_load(void *db_conn,
slurmdb_archive_rec_t *arch_rec);
/************** association functions **************/
/*
* add associations to accounting system
* IN: association_list List of slurmdb_association_rec_t *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_associations_add(void *db_conn, List assoc_list);
/*
* get info from the storage
* IN: slurmdb_association_cond_t *
* RET: List of slurmdb_association_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_associations_get(void *db_conn,
slurmdb_association_cond_t *assoc_cond);
/*
* modify existing associations in the accounting system
* IN: slurmdb_association_cond_t *assoc_cond
* IN: slurmdb_association_rec_t *assoc
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_associations_modify(void *db_conn,
slurmdb_association_cond_t *assoc_cond,
slurmdb_association_rec_t *assoc);
/*
* remove associations from accounting system
* IN: slurmdb_association_cond_t *assoc_cond
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_associations_remove(
void *db_conn, slurmdb_association_cond_t *assoc_cond);
/************** cluster functions **************/
/*
* add clusters to accounting system
* IN: cluster_list List of slurmdb_cluster_rec_t *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_clusters_add(void *db_conn, List cluster_list);
/*
* get info from the storage
* IN: slurmdb_cluster_cond_t *
* IN: params void *
* returns List of slurmdb_cluster_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_clusters_get(void *db_conn,
slurmdb_cluster_cond_t *cluster_cond);
/*
* modify existing clusters in the accounting system
* IN: slurmdb_cluster_cond_t *cluster_cond
* IN: slurmdb_cluster_rec_t *cluster
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_clusters_modify(void *db_conn,
slurmdb_cluster_cond_t *cluster_cond,
slurmdb_cluster_rec_t *cluster);
/*
* remove clusters from accounting system
* IN: slurmdb_cluster_cond_t *cluster_cond
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_clusters_remove(void *db_conn,
slurmdb_cluster_cond_t *cluster_cond);
/************** cluster report functions **************/
/* report for clusters of account per user
* IN: slurmdb_association_cond_t *assoc_cond
* RET: List containing (slurmdb_report_cluster_rec_t *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_report_cluster_account_by_user(void *db_conn,
slurmdb_association_cond_t *assoc_cond);
/* report for clusters of users per account
* IN: slurmdb_association_cond_t *assoc_cond
* RET: List containing (slurmdb_report_cluster_rec_t *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_report_cluster_user_by_account(void *db_conn,
slurmdb_association_cond_t *assoc_cond);
/* report for clusters of wckey per user
* IN: slurmdb_wckey_cond_t *wckey_cond
* RET: List containing (slurmdb_report_cluster_rec_t *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_report_cluster_wckey_by_user(void *db_conn,
slurmdb_wckey_cond_t *wckey_cond);
/* report for clusters of users per wckey
* IN: slurmdb_wckey_cond_t *wckey_cond
* RET: List containing (slurmdb_report_cluster_rec_t *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_report_cluster_user_by_wckey(void *db_conn,
slurmdb_wckey_cond_t *wckey_cond);
extern List slurmdb_report_job_sizes_grouped_by_top_account(void *db_conn,
slurmdb_job_cond_t *job_cond, List grouping_list, bool flat_view);
extern List slurmdb_report_job_sizes_grouped_by_wckey(void *db_conn,
slurmdb_job_cond_t *job_cond, List grouping_list);
extern List slurmdb_report_job_sizes_grouped_by_top_account_then_wckey(
void *db_conn, slurmdb_job_cond_t *job_cond,
List grouping_list, bool flat_view);
/* report on users with top usage
* IN: slurmdb_user_cond_t *user_cond
* IN: group_accounts - Whether or not to group all accounts together
* for each user. If 0 a separate entry for each
* user and account reference is displayed.
* RET: List containing (slurmdb_report_cluster_rec_t *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_report_user_top_usage(void *db_conn,
slurmdb_user_cond_t *user_cond,
bool group_accounts);
/************** connection functions **************/
/*
* get a new connection to the slurmdb
* RET: pointer used to access db
*/
extern void *slurmdb_connection_get();
/*
* release connection to the storage unit
* IN/OUT: void ** pointer returned from
* slurmdb_connection_get() which will be freed.
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_connection_close(void **db_conn);
/************** coordinator functions **************/
/*
* add users as account coordinators
* IN: acct_list list of char *'s of names of accounts
* IN: slurmdb_user_cond_t *user_cond
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_coord_add(void *db_conn, List acct_list,
slurmdb_user_cond_t *user_cond);
/*
* remove users from being a coordinator of an account
* IN: acct_list list of char *'s of names of accounts
* IN: slurmdb_user_cond_t *user_cond
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_coord_remove(void *db_conn, List acct_list,
slurmdb_user_cond_t *user_cond);
/************** extra get functions **************/
/*
* get info from the storage
* RET: List of config_key_pair_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_config_get(void *db_conn);
/*
* get info from the storage
* IN: slurmdb_event_cond_t *
* RET: List of slurmdb_event_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_events_get(void *db_conn,
slurmdb_event_cond_t *event_cond);
/*
* get info from the storage
* returns List of slurmdb_job_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_jobs_get(void *db_conn, slurmdb_job_cond_t *job_cond);
/*
* get info from the storage
* IN: slurmdb_association_cond_t *
* RET: List of slurmdb_association_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_problems_get(void *db_conn,
slurmdb_association_cond_t *assoc_cond);
/*
* get info from the storage
* IN: slurmdb_reservation_cond_t *
* RET: List of slurmdb_reservation_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_reservations_get(void *db_conn,
slurmdb_reservation_cond_t *resv_cond);
/*
* get info from the storage
* IN: slurmdb_txn_cond_t *
* RET: List of slurmdb_txn_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_txn_get(void *db_conn, slurmdb_txn_cond_t *txn_cond);
/************** helper functions **************/
extern void slurmdb_init_association_rec(slurmdb_association_rec_t *assoc,
bool free_it);
extern void slurmdb_init_cluster_rec(slurmdb_cluster_rec_t *cluster,
bool free_it);
extern void slurmdb_init_qos_rec(slurmdb_qos_rec_t *qos,
bool free_it);
extern void slurmdb_init_wckey_rec(slurmdb_wckey_rec_t *wckey,
bool free_it);
extern void slurmdb_init_cluster_cond(slurmdb_cluster_cond_t *cluster,
bool free_it);
/* The next two functions have pointers to assoc_list so do not
* destroy assoc_list before using the list returned from this function.
*/
extern List slurmdb_get_hierarchical_sorted_assoc_list(List assoc_list);
extern List slurmdb_get_acct_hierarchical_rec_list(List assoc_list);
/* IN/OUT: tree_list a list of slurmdb_print_tree_t's */
extern char *slurmdb_tree_name_get(char *name, char *parent, List tree_list);
/************** job report functions **************/
/************** qos functions **************/
/*
* add qos's to accounting system
* IN: qos_list List of char *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_qos_add(void *db_conn, uint32_t uid, List qos_list);
/*
* get info from the storage
* IN: slurmdb_qos_cond_t *
* RET: List of slurmdb_qos_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_qos_get(void *db_conn, slurmdb_qos_cond_t *qos_cond);
/*
* modify existing qos in the accounting system
* IN: slurmdb_qos_cond_t *qos_cond
* IN: slurmdb_qos_rec_t *qos
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_qos_modify(void *db_conn,
slurmdb_qos_cond_t *qos_cond,
slurmdb_qos_rec_t *qos);
/*
* remove qos from accounting system
* IN: slurmdb_qos_cond_t *assoc_qos
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_qos_remove(void *db_conn, slurmdb_qos_cond_t *qos_cond);
/************** usage functions **************/
/*
* get info from the storage
* IN/OUT: in void * (slurmdb_association_rec_t *) or
* (slurmdb_wckey_rec_t *) of (slurmdb_cluster_rec_t *) with
* the id, and cluster set.
* IN: type what type is 'in'
* IN: start time stamp for records >=
* IN: end time stamp for records <=
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_usage_get(void *db_conn, void *in, int type,
time_t start, time_t end);
/*
* roll up data in the storage
* IN: sent_start (option time to do a re-roll or start from this point)
* IN: sent_end (option time to do a re-roll or end at this point)
* IN: archive_data (if 0 old data is not archived in a monthly rollup)
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_usage_roll(void *db_conn,
time_t sent_start, time_t sent_end,
uint16_t archive_data);
/************** user functions **************/
/*
* add users to accounting system
* IN: user_list List of slurmdb_user_rec_t *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_users_add(void *db_conn, List user_list);
/*
* get info from the storage
* IN: slurmdb_user_cond_t *
* IN: params void *
* returns List of slurmdb_user_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_users_get(void *db_conn, slurmdb_user_cond_t *user_cond);
/*
* modify existing users in the accounting system
* IN: slurmdb_user_cond_t *user_cond
* IN: slurmdb_user_rec_t *user
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_users_modify(void *db_conn,
slurmdb_user_cond_t *user_cond,
slurmdb_user_rec_t *user);
/*
* remove users from accounting system
* IN: slurmdb_user_cond_t *user_cond
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_users_remove(void *db_conn,
slurmdb_user_cond_t *user_cond);
/************** user report functions **************/
/************** wckey functions **************/
/*
* add wckey's to accounting system
* IN: wckey_list List of slurmdb_wckey_rec_t *
* RET: SLURM_SUCCESS on success SLURM_ERROR else
*/
extern int slurmdb_wckeys_add(void *db_conn, List wckey_list);
/*
* get info from the storage
* IN: slurmdb_wckey_cond_t *
* RET: List of slurmdb_wckey_rec_t *
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_wckeys_get(void *db_conn,
slurmdb_wckey_cond_t *wckey_cond);
/*
* modify existing wckey in the accounting system
* IN: slurmdb_wckey_cond_t *wckey_cond
* IN: slurmdb_wckey_rec_t *wckey
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_wckeys_modify(void *db_conn,
slurmdb_wckey_cond_t *wckey_cond,
slurmdb_wckey_rec_t *wckey);
/*
* remove wckey from accounting system
* IN: slurmdb_wckey_cond_t *assoc_wckey
* RET: List containing (char *'s) else NULL on error
* note List needs to be freed with slurm_list_destroy() when called
*/
extern List slurmdb_wckeys_remove(void *db_conn,
slurmdb_wckey_cond_t *wckey_cond);
END_C_DECLS
#endif /* !_SLURMDB_H */
|