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 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
|
#!/bin/sh
#
#___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: 2008 by Sun Microsystems, Inc.
#
# All Rights Reserved.
#
##########################################################################
#___INFO__MARK_END__
###########################################################################
#
# example for a job verification script
#
# Be careful: Job verification scripts are started with sgeadmin
# permissions if they are executed within the master process
#
PATH=/bin:/usr/bin
ARCH=`$SGE_ROOT/util/arch`
__jsv_logging_enabled="false" # is logging enabled?
__jsv_logfile="/tmp/jsv_$$.log" # logfile
# Current state of the script
# Might be "initialized", "started" or "verifying"
__jsv_state="initialized"
# Following strings are switch names of command line clients (qsub, qrsh, ...)
# and these strings will also be used as variable suffixes in this script
__jsv_cli_params="a ar A b ckpt cwd C display dl e hard h hold_jid\
hold_jid_ad i inherit j js m M masterq notify\
now N noshell nostdin o ot P p pty R r shell sync S t\
tc terse u w wd"
# These names are the suffixes of variable names which will contain
# the information of following submit client switches:
# ac: summarized job context information (-sc -ac -dc)
# l_hard: hard resource request (-hard -l ...)
# l_soft: soft resource requests (-soft -l ...)
# q_hard: hard queue resource request (-hard -q ...)
# q_soft: soft queue resource request (-soft -q ...)
# pe_min: minimum of pe range (-pe <pe_name> <pe_min>-<pe_max>)
# pe_max: maximum of pe range (-pe <pe_name> <pe_min>-<pe_max>)
# pe_name: pe name (-pe <pe_name> <pe_min>-<pe_max>)
# binding_strategy: binding strategy (-binding [<type>] <strategy>:<amount>:<socket>:<core>)
# binding_type: binding type name (-binding [<type>] <strategy>:<amount>:<socket>:<core>)
# binding_amount: binding amount (-binding [<type>] <strategy>:<amount>:<socket>:<core>)
# binding_socket: binding socket (-binding [<type>] <strategy>:<amount>:<socket>:<core>)
# binding_core: binding core (-binding [<type>] <strategy>:<amount>:<socket>:<core>)
# binding_step: binding step (-binding [<type>] "striding":<amount>:<step>)
# binding_exp_n: length of explicit list (-binding [<type>] "explisit":<socket0>,<core0>:...)
__jsv_mod_params="ac l_hard l_soft q_hard q_soft pe_min pe_max pe_name\
binding_strategy binding_type binding_amount binding_socket\
binding_core binding_step binding_exp_n"
# Here are the suffixes of variable names which do not directly appear
# as named switches in a client.
# CLIENT: submit client which was used
# CONTEXT: in which context is this script executed
# ...
__jsv_add_params="CLIENT CONTEXT GROUP VERSION JOB_ID SCRIPT CMDARGS USER"
# Values specified with the list below will be available in this script
# as variables with the name "jsv_param_<name>". If a corresponding value
# was specified during submission then this variable will have the
# same value. Find more information in jsv(5) and submit(1) man page.
__jsv_all_params="$__jsv_add_params $__jsv_cli_params $__jsv_mod_params"
# This is a space separated list of environment variable names which
# will built up during runtime, when this script receives the job env.
__jsv_all_envs=""
__jsv_undef="variable_is_undefined"
__jsv_quit="false"
__jsv_saved_ifs="$IFS"
###### jsv/jsv_clear_params() ##################################################
# NAME
# jsv_clear_params() -- Clears all received job parameters.
#
# SYNOPSIS
# jsv_clear_params()
#
# FUNCTION
# This function clears all received job parameters that were stored
# during the last job verification process.
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_clear_envs()
# jsv/jsv_show_params()
################################################################################
jsv_clear_params()
{
for __jsv_i in $__jsv_all_params; do
__jsv_name="jsv_param_${__jsv_i}"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
unset $__jsv_name
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
done
}
###### jsv/jsv_clear_envs() ##################################################
# NAME
# jsv_clear_envs() -- Clears all received job environment variables.
#
# SYNOPSIS
# jsv_clear_envs()
#
# FUNCTION
# This function clears all received job environment variables that
# were stored during the last job verification process.
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_clear_params()
# jsv/jsv_show_envs()
################################################################################
jsv_clear_envs()
{
for __jsv_i in $__jsv_all_envs; do
__jsv_name="jsv_env_$__jsv_i"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
unset $__jsv_name
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
done
__jsv_all_envs=""
}
###### jsv/jsv_show_params() ##################################################
# NAME
# jsv_show_params() -- Prints all job parameters.
#
# SYNOPSIS
# jsv_show_params()
#
# FUNCTION
# A call of this function reports all known job parameters to the
# counterpart of this script (client or master daemon thread). This
# parameters will be reported as info messages and appear
# either in the stdout stream of the client or in the message file of
# the master process.
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_clear_params()
# jsv/jsv_show_envs()
################################################################################
jsv_show_params()
{
for __jsv_i in $__jsv_all_params; do
__jsv_name="jsv_param_$__jsv_i"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "echo LOG INFO got param $__jsv_i=\${$__jsv_name}"
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
done
}
###### jsv/jsv_show_envs() ##################################################
# NAME
# jsv_show_envs() -- Prints all job environment variables.
#
# SYNOPSIS
# jsv_show_envs()
#
# FUNCTION
# A call of this function reports all known job environment variables
# to the counterpart of this script (client or master daemon thread).
# They will be reported as info messages and appear in the stdout
# stream of the client or in the message file of the master process.
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_clear_params()
# jsv/jsv_clear_envs()
################################################################################
jsv_show_envs()
{
for __jsv_i in $__jsv_all_envs; do
__jsv_name="jsv_env_$__jsv_i"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "echo LOG INFO got env $__jsv_i=\${$__jsv_name}"
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
done
}
###### jsv/jsv_is_env() ######################################################
# NAME
# jsv_is_env() -- Returns whether or not a specific job environment
# variable exists in the job currently beeing verified.
#
# SYNOPSIS
# jsv_is_env(variable_name)
#
# FUNCTION
# If the function returns "true", then the job environment variable with
# the name "variable_name" exists in the job currently being verified and
# jsv_get_env() can be used to retrieve the value of that variable.
#
# If the function returns "false", then the job environment variable with
# the name "variable_name" does not exist.
#
# INPUTS
# varibale_name - e.g "HOME", "LD_LIBRARAY_PATH" ...
#
# RESULT
# "true" or "false" as string
#
# SEE ALSO
# jsv/jsv_clear_params()
# jsv/jsv_show_envs()
# jsv/jsv_get_env()
################################################################################
jsv_is_env()
{
__jsv_name="jsv_env_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
echo true
else
echo false
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_get_env() #####################################################
# NAME
# jsv_get_env() -- Returns the value of a job environment variable.
#
# SYNOPSIS
# jsv_get_env(variable_name)
#
# FUNCTION
# This function returns the value of a job environment variable
# ("variable_name").
#
# This variable has to be passed with the commandline switch
# -v or -V and it has to be enabled that environment variable data is
# passed to JSV scripts. Environment variable data is passed when the
# function jsv_send_env() is called in the callback function
# jsv_on_start().
#
# If the variable does not exist or if environment variable
# information is not available then an empty string will be returned.
#
# INPUTS
# variable_name - e.g "HOME", "LD_LIBRARAY_PATH" ...
#
# RESULT
# value of the variable as string
#
# SEE ALSO
# jsv/jsv_show_envs()
# jsv/jsv_is_env()
# jsv/jsv_add_env()
# jsv/jsv_mod_env()
# jsv/jsv_del_env()
# jsv/jsv_on_start()
################################################################################
jsv_get_env()
{
__jsv_name="jsv_env_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "echo \${$__jsv_name}"
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_add_env() #####################################################
# NAME
# jsv_add_env() -- Adds a job environment variable.
#
# SYNOPSIS
# jsv_add_env(variable_name, variable_value)
#
# FUNCTION
# This function adds an additional environment variable to the set
# of variables that will exported to the job, when it is started.
# As a result the "variable_name" and "variable_value" become
# available, as if the -v or -V was specified during job submission.
#
# "variable_value" is optional. If there is an empty string passed
# then the variable is defined without value.
#
# If "variable_name" already exists in the set of job environment
# variables, then the corresponding value will be replaced by
# "variable_value", as if the function jsv_mod_env() was used.
# If an emty string is passed then the old value will be deleted.
#
# To delete a environment variable the function jsv_del_env()
# has to be used.
#
# INPUTS
# variable_name - e.g "HOME", "LD_LIBRARAY_PATH" ...
# variable_value - e.g "/home/user", "", ...
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_show_envs()
# jsv/jsv_is_env()
# jsv/jsv_get_env()
# jsv/jsv_mod_env()
# jsv/jsv_del_env()
# jsv/jsv_on_start()
################################################################################
jsv_add_env()
{
__jsv_name="jsv_env_$1"
eval "$__jsv_name=$2"
jsv_send_command ENV ADD "$1" "$2"
unset __jsv_name
}
###### jsv/jsv_mod_env() #####################################################
# NAME
# jsv_mod_env() -- Modifies the value of a environment variable.
#
# SYNOPSIS
# jsv_mod_env(variable_name, variable_value)
#
# FUNCTION
# This function modifies an existing environment variable that is
# in the set of variables which will exported to the job, when it
# is started.
# As a result, the "variable_name" and "variable_value" will be
# available as if the -v or -V was specified during job submission.
#
# "variable_value" is optional. If there is an empty string passed
# then the variable is defined without value.
#
# If "variable_name" does not already exist in the set of job
# environment variables, then the corresponding name and value will
# be added as if the function jsv_add_env() was used.
#
# To delete a environment variable, use the function jsv_del_env().
#
# INPUTS
# varibale_name - e.g "HOME", "LD_LIBRARAY_PATH" ...
# variable_value - e.g. "/home/user", "" ...
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_show_envs()
# jsv/jsv_is_env()
# jsv/jsv_get_env()
# jsv/jsv_add_env()
# jsv/jsv_get_env()
# jsv/jsv_del_env()
# jsv/jsv_on_start()
################################################################################
jsv_mod_env()
{
__jsv_name="jsv_env_$1"
eval "$__jsv_name=$2"
jsv_send_command ENV MOD "$1" "$2"
unset __jsv_name
}
###### jsv/jsv_del_env() #####################################################
# NAME
# jsv_del_env() -- Deletes a job environment variable.
#
# SYNOPSIS
# jsv_del_env(variable_name)
#
# FUNCTION
# This function removes a job environment variable ("variable_name")
# from the set of variables that will be exported
# to the job, when it is started.
#
# If "variable_name" does not already exists in the set of job
# environment variables then the command is ignored.
#
# To change the value of a variable use the function jsv_mod_env()
# to add a new value, call the function jsv_add_env().
#
# INPUTS
# variable_name - e.g "HOME", "LD_LIBRARAY_PATH" ...
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_show_envs()
# jsv/jsv_is_env()
# jsv/jsv_get_env()
# jsv/jsv_add_env()
# jsv/jsv_mod_env()
# jsv/jsv_on_start()
################################################################################
jsv_del_env()
{
__jsv_name="jsv_env_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "unset $__jsv_name"
jsv_send_command ENV DEL "$1"
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_is_param() #####################################################
# NAME
# jsv_is_param() -- Returns whether or not a specific job parameters
# exists in the job currently being verified.
#
# SYNOPSIS
# jsv_is_param(param_name)
#
# FUNCTION
# This function returns whether or not a specific job parameters is
# available for the job which is currently being verified. Either the
# string "true" or "false" will be returned. The availability/absence
# of a job parameter does not mean that the corresponding commandline
# switch was used/not used.
#
# INPUTS
# param_name - The following values are allowed. Corresponding
# qsub/qrsh/qsh/... switches are mentioned in parenthesis
# next to the parameter name if they are different.
# Find additional information in qsub(1) man page where
# addtional notes can be found describing the availability
# and value format.
# Job parameters written in capital letters
# are pseudo parameters. These parameters describe
# either the context where this JSV is executed or
# additional values describing the job submission
# context.
#
# name switch/description
# -------------- -------------------------------------------
# a
# ac (combination of -ac, -sc, -dc)
# ar
# A
# b
# c
# ckpt
# cwd
# display
# dl
# e
# h
# hold_jid
# hold_jid_ad
# i
# l_hard (-hard followed by -l)
# l_soft (-soft followed by -l)
# j
# js
# m
# M
# masterq
# N
# notify
# now
# N
# o
# ot
# P
# pe
# q_hard (-hard followed by -q)
# q_soft (-soft followed by -q)
# R
# r
# shell
# S
# t
# w
# wd
# CLIENT name of the submit client (e.g qsub, qmon, ...)
# CONTEXT "client" or "server"
# GROUP unix group of the job submitter
# VERSION 1.0
# JOB_ID 0 in client context or job id of the job in
# server context
# SCRIPT script path
# CMDARGS number of additional job arguments
# CMDARG<i> parameter <i>
# USER unix user of the person which submitted the job
#
# RESULT
# "true" or "false"
#
# SEE ALSO
# jsv/jsv_show_params()
# jsv/jsv_is_param()
# jsv/jsv_get_param()
# jsv/jsv_add_param()
# jsv/jsv_mod_param()
# jsv/jsv_on_start()
################################################################################
jsv_is_param()
{
__jsv_name="jsv_param_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
echo true
else
echo false
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_get_param() #####################################################
# NAME
# jsv_get_param() -- Returns the value of a job parameter.
#
# SYNOPSIS
# jsv_get_param(param_name)
#
# FUNCTION
# This function returns the value of a specific job parameter
# ("param_name").
#
# This value is only available if the function jsv_is_param()
# returns "true". Otherwise an empty string is returned.
#
# INPUTS
# param_name - Find a list of allowed parameter names in the
# documentation section for the function jsv_is_param().
#
# RESULT
# value of the variable as string
#
# SEE ALSO
# jsv/jsv_show_param()
# jsv/jsv_is_param()
# jsv/jsv_set_param()
# jsv/jsv_del_param()
################################################################################
jsv_get_param()
{
__jsv_name="jsv_param_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "echo \${$__jsv_name}"
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_set_param() #####################################################
# NAME
# jsv_set_param() -- Changes the value of a job environment variable.
#
# SYNOPSIS
# jsv_set_param(param_name, param_value)
#
# FUNCTION
# This function changes the job parameter with the name "param_name"
# to the value "param_value".
#
# If "param_name" is an empty string then the corresponding
# job parameter will be deleted.
#
# INPUTS
# param_name - Find a list of allowed parameter names in the
# documentation section for the function jsv_is_param().
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_show_param()
# jsv/jsv_is_param()
# jsv/jsv_set_param()
# jsv/jsv_del_param()
################################################################################
jsv_set_param()
{
__jsv_name="jsv_param_$1"
eval "$__jsv_name=$2"
jsv_send_command PARAM "$1" "$2"
unset __jsv_name
}
###### jsv/jsv_del_param() #####################################################
# NAME
# jsv_del_param() -- Deletes a job parameter.
#
# SYNOPSIS
# jsv_del_param(param_name)
#
# FUNCTION
# This function deletes the job parameter with the name "param_name".
#
# INPUTS
# param_name - Find a list of allowed parameter names in the
# documentation section for the function jsv_is_param().
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_show_param()
# jsv/jsv_is_param()
# jsv/jsv_set_param()
# jsv/jsv_del_param()
################################################################################
jsv_del_param()
{
__jsv_name="jsv_param_$1"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_isdef=`eval "echo $__jsv_command"`
if [ "$__jsv_isdef" != "$__jsv_undef" ]; then
eval "unset \${$__jsv_name}"
jsv_send_command PARAM "$1" ""
fi
unset __jsv_name
unset __jsv_command
unset __jsv_isdef
}
###### jsv/jsv_sub_is_param() ##################################################
# NAME
# jsv_sub_is_param() -- Returns whether or not a job parameter list
# contains a variable.
#
# SYNOPSIS
# jsv_sub_is_param(param_name, variable_name)
#
# FUNCTION
# Some job parameters are lists that can contain multiple variables with
# an optional value.
#
# This function returns "true" if a job parameters list contains a
# variable and "false" otherwise. "false" might also indicate that
# the parameter list itself is not available.
#
# INPUTS
# param_name - The following parameters are list parameters
#
# name switch/description
# -------------- -------------------------------------------
# ac (combination of -ac, -sc, -dc)
# hold_jid
# l_hard (-hard followed by -l)
# l_soft (-soft followed by -l)
# M
# masterq
# q_hard (-hard followed by -q)
# q_soft (-soft followed by -q)
#
# variable_name - String value
#
# The value depends on the "param_name". For "ac" the
# "variable_name" has to be a variable name. "l_hard", "l_soft"
# require a resource name (e.g "h_vmem"). "masterq", "q_hard",
# "q_soft" require a cluster queue name or a queue instance
# name.
#
# RESULT
# "true" or "false"
#
# EXAMPLE
#
# Assume that the following job is submitted:
#
# qsub -ac a=1,b,d=7 -l h_vmem=5G,lic=1 -M user@domain script.sh
#
# For this jon, the following function calls will return the
# following values:
#
# function call value
# ----------------------------------------- ---------
# jsv_sub_is_param("ac", "a") true
# jsv_sub_is_param("ac", "c") false
# jsv_sub_is_param("l_hard", "h_vmem") true
# jsv_sub_is_param("l_soft", "h_vmem") false
# jsv_sub_is_param("M", "user@domain") true
# jsv_sub_is_param("M", "unknown@domain") false
#
# SEE ALSO
# jsv/jsv_show_params()
# jsv/jsv_is_param()
# jsv/jsv_get_param()
# jsv/jsv_add_param()
# jsv/jsv_mod_param()
# jsv/jsv_on_start()
################################################################################
jsv_sub_is_param() {
__jsv_ret="false"
__jsv_name="jsv_param_$1"
__jsv_sub_name="$2"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_list=`eval "echo $__jsv_command"`
if [ "$__jsv_list" != "$__jsv_undef" ]; then
IFS=","
for __jsv_i in $__jsv_list; do
IFS="="
for __jsv_j in $__jsv_i; do
IFS="$__jsv_saved_ifs"
if [ "$__jsv_j" = "$__jsv_sub_name" ]; then
__jsv_ret="true"
break
else
break
fi
IFS="="
done
IFS="$__jsv_saved_ifs"
if [ "$__jsv_ret" = "true" ]; then
break
fi
IFS=","
done
IFS="$__jsv_saved_ifs"
fi
unset __jsv_name
unset __jsv_sub_name
unset __jsv_command
unset __jsv_list
echo $__jsv_ret
return
}
###### jsv/jsv_sub_del_param() ################################################
# NAME
# jsv_sub_del_param() -- Deletes a variable from a sublist.
#
# SYNOPSIS
# jsv_sub_del_param(param_name, variable_name)
#
# FUNCTION
# Some job parameters are lists which can contain muliple variables with
# an optional value.
#
# This function deletes a variable with the name "variable_name" and
# if available the corresponding value. If "variable_name" is not
# available then the command will be ignored.
#
# INPUTS
# param_name - Find a list of list parameter names in the
# documentation for the function jsv_sub_is_param().
#
# variable_name - Find more information in the documentation
# section for jsv_sub_is_param().
#
# RESULT
# none
#
# EXAMPLE
#
# Assume that the following job is submitted:
#
# qsub -ac a=1,b,d=7 -l h_vmem=5G,lic=1 -M user@domain script.sh
#
# Assume the following commands in jsv_on_verify()
#
# jsv_sub_del_parm("ac", "b");
# jsv_sub_del_parm("ac", "d");
# jsv_sub_del_parm("l_hard", "lic");
# jsv_sub_del_parm("M", "lic");
# jsv_correct();
#
# In that case the job will be modified as if the following qsub
# command was used:
#
# qsub -ac a=1 -l h_vmem=5G script.sh
#
# SEE ALSO
# jsv/jsv_show_params()
# jsv/jsv_sub_is_param()
# jsv/jsv_sub_get_param()
# jsv/jsv_sub_add_param()
# jsv/jsv_on_verify()
################################################################################
jsv_sub_del_param()
{
__jsv_param_name="$1"
__jsv_name="jsv_param_$__jsv_param_name"
__jsv_sub_name="$2"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_list=`eval "echo $__jsv_command"`
__jsv_new_param=""
if [ "$__jsv_list" != "$__jsv_undef" ]; then
# split token between ',' character
IFS=","
for __jsv_i in $__jsv_list; do
__jsv_found="false"
# split the first string before '=' character
# This is the variable name and if it is the
# one which should be deleted then set "found"
# to "true"
IFS="="
for __jsv_j in $__jsv_i; do
IFS="$__jsv_saved_ifs"
if [ "$__jsv_j" = "$__jsv_sub_name" ]; then
__jsv_found="true"
break
else
break
fi
IFS="="
done
IFS="$__jsv_saved_ifs"
# append all entries to new_param
# skip only the entry which should be deleted
if [ "$__jsv_found" != "true" ]; then
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="$__jsv_i"
else
__jsv_new_param="${__jsv_new_param},$__jsv_i"
fi
fi
IFS=","
done
IFS="$__jsv_saved_ifs"
# set local variable and send modification to client/master
eval "$__jsv_name=\"\$__jsv_new_param\""
jsv_send_command PARAM $__jsv_param_name "$__jsv_new_param"
fi
unset __jsv_new_param
unset __jsv_list
unset __jsv_command
unset __jsv_name
unset __jsv_sub_name
unset __jsv_param_name
return
}
###### jsv/jsv_sub_get_param() ################################################
# NAME
# jsv_sub_get_param() -- Returns the value of the variable
# ("variable_name") in a sublist.
#
# SYNOPSIS
# jsv_sub_get_param(param_name, variable_name)
#
# FUNCTION
# Some job parameters are lists that can contain multiple variables
# with an optional value.
#
# This function returns the value of the variable ("variable_name").
# For sub list elements that have no value an empty string will be
# returned.
#
# INPUTS
# param_name - Find a list of list parameter names in the
# documentation for the function jsv_sub_is_param().
#
# variable_name - Find more information in the documentation
# section for jsv_sub_is_param().
#
# RESULT
# String representation of the value or an empty string if there
# is no value available.
#
# EXAMPLE
#
# Assume that the following job is submitted:
#
# qsub -ac a=1,b,d=7 -l h_vmem=5G,lic=1 -M user@domain script.sh
#
# For the above job, the following function calls will return following values:
#
# function call value
# ----------------------------------------- ---------
# jsv_sub_get_param("ac", "a") "1"
# jsv_sub_get_param("ac", "b") ""
# jsv_sub_get_param("l_hard", "h_vmem") "5G"
# jsv_sub_get_param("l_soft", "h_vmem") ""
# jsv_sub_get_param("M", "user@domain") ""
# jsv_sub_get_param("M", "unknown@domain") ""
#
# SEE ALSO
# jsv/jsv_show_params()
# jsv/jsv_sub_is_param()
# jsv/jsv_sub_get_param()
# jsv/jsv_sub_add_param()
# jsv/jsv_on_verify()
################################################################################
jsv_sub_get_param()
{
__jsv_param_name="$1"
__jsv_name="jsv_param_$__jsv_param_name"
__jsv_sub_name="$2"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_list=`eval "echo $__jsv_command"`
if [ "$__jsv_list" != "$__jsv_undef" ]; then
# split token between ',' character
IFS=","
for __jsv_i in $__jsv_list; do
__jsv_found="false"
# split the first string before '=' character
# This is the variable name and if it is the
# one which should be deleted then set "found"
# to "true"
IFS="="
for __jsv_j in $__jsv_i; do
IFS="$__jsv_saved_ifs"
if [ "$__jsv_found" = "true" ]; then
echo "$__jsv_j"
else
if [ "$__jsv_j" = "$__jsv_sub_name" ]; then
__jsv_found="true"
fi
fi
IFS="="
done
IFS="$__jsv_saved_ifs"
if [ "$__jsv_found" = "true" ]; then
break;
fi
IFS=","
done
IFS="$__jsv_saved_ifs"
fi
unset __jsv_list
unset __jsv_command
unset __jsv_name
unset __jsv_sub_name
unset __jsv_param_name
return
}
###### jsv/jsv_sub_add_param() ################################################
# NAME
# jsv_sub_add_param() -- Adds a new variable with a new value or
# it modifies an existing variable that is
# already in the sublist.
#
# SYNOPSIS
# jsv_sub_add_param(param_name, variable_name, variable_value)
#
# FUNCTION
# Some job parameters are list that can contain muliple variables
# with an optional value.
#
# This function either adds a new variable with a new value or it
# modifies the value if the variable is already in the list parameter.
# "variable_value" is optional. In that case, the variable has no value.
#
# INPUTS
# param_name - Find a list of list parameter names in the
# documentation for the function jsv_sub_is_param().
#
# variable_name - Find more information in the documentation
# section for jsv_sub_is_param().
#
# RESULT
# none
#
# EXAMPLE
#
# Assume that the following job is submitted:
#
# qsub -ac a=1,d=7 -l h_vmem=5G,lic=1 -M user@domain script.sh
#
# and the following commands in jsv_on_verify():
#
# jsv_sub_add_parm("ac", "b", "");
# jsv_sub_add_parm("ac", "c", "5");
# jsv_sub_add_parm("ac", "d", "99");
# jsv_sub_add_parm("l_hard", "lic", "2");
# jsv_sub_add_parm("M", "user2@domain", "");
# jsv_correct();
#
# In the above case, the job will be modified as if the following qsub
# command was used.
#
# qsub -ac a=1,d=99,b,c=5 -l h_vmem=5G,lic=2 -M user@domain,user2@domain script.sh
#
# SEE ALSO
# jsv/jsv_show_params()
# jsv/jsv_sub_is_param()
# jsv/jsv_sub_get_param()
# jsv/jsv_sub_add_param()
# jsv/jsv_on_verify()
################################################################################
jsv_sub_add_param()
{
__jsv_param_name="$1"
__jsv_name="jsv_param_$__jsv_param_name"
__jsv_sub_name="$2"
__jsv_value="$3"
__jsv_command=`eval "echo \$\{$__jsv_name\:\-$__jsv_undef\}"`
__jsv_list=`eval "echo $__jsv_command"`
__jsv_new_param=""
if [ "$__jsv_list" = "$__jsv_undef" ]; then
__jsv_list=""
fi
__jsv_found="false"
# split token between ',' character
IFS=","
for __jsv_i in $__jsv_list; do
# split the first string before '=' character
# This is the variable name and if it is the
# one which should be deleted then set "found"
# to "true"
IFS="="
for __jsv_j in $__jsv_i; do
IFS="$__jsv_saved_ifs"
if [ "$__jsv_j" = "$__jsv_sub_name" ]; then
__jsv_found="true"
if [ "$__jsv_value" = "" ]; then
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="$__jsv_j"
else
__jsv_new_param="${__jsv_new_param},$__jsv_j"
fi
else
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="${__jsv_j}=${__jsv_value}"
else
__jsv_new_param="${__jsv_new_param},${__jsv_j}=${__jsv_value}"
fi
fi
else
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="$__jsv_i"
else
__jsv_new_param="${__jsv_new_param},$__jsv_i"
fi
fi
IFS="="
break;
done
IFS="$__jsv_saved_ifs"
done
if [ "$__jsv_found" = "false" ]; then
if [ "$__jsv_value" = "" ]; then
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="$__jsv_sub_name"
else
__jsv_new_param="${__jsv_new_param},$__jsv_sub_name"
fi
else
if [ "$__jsv_new_param" = "" ]; then
__jsv_new_param="${__jsv_sub_name}=$__jsv_value"
else
__jsv_new_param="${__jsv_new_param},${__jsv_sub_name}=$__jsv_value"
fi
fi
fi
IFS="$__jsv_saved_ifs"
# set local variable and send modification to client/master
eval "$__jsv_name=\"\$__jsv_new_param\""
jsv_send_command PARAM "$__jsv_param_name" "$__jsv_new_param"
unset __jsv_new_param
unset __jsv_list
unset __jsv_command
unset __jsv_name
unset __jsv_sub_name
unset __jsv_param_name
return
}
###### jsv/jsv_send_env() #####################################################
# NAME
# jsv_send_env() -- Requests the job environment for the next job
#
# SYNOPSIS
# jsv_send_env()
#
# FUNCTION
# This function can only be used in jsv_on_start(). If it is used
# there, then the job environment information will be available
# in jsv_on_verify() for the next job that is scheduled to be
# verified.
#
# This function must be called for the functions jsv_show_envs(),
# jsv_is_env(), jsv_get_env(), jsv_add_env() and jsv_mod_env() to
# behave correctly.
#
# Job environmets might become very big (10K and more). This
# will slow down the executing component (submit client or
# master daemon thread). For this reason, job environment information
# is not passed to JSV scripts by default.
#
# Please note also that the data in the job environment can't be
# verified by Grid Engine and might therefore contain data which
# could be misinterpreted in the script environment
# and cause security issues.
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_on_start()
# jsv/jsv_on_verify()
################################################################################
jsv_send_env()
{
jsv_send_command "SEND ENV"
}
###### jsv/jsv_accept() ########################################################
# NAME
# jsv_accept() -- Accepts a job as it was initially provided.
#
# SYNOPSIS
# jsv_accept(message)
#
# FUNCTION
# This function can only be used in jsv_on_verify(). After it has been
# called, the function jsv_on_verify() has to return immediately.
#
# A call to this function indicates that the job that is
# currently being verified should be accepted as it was initially
# provided. All job modifications that might have been applied
# in jsv_on_verify() before this function was called, are then ignored.
#
# Instead of calling jsv_accept() in jsv_on_verify() also the
# functions jsv_correct(), jsv_reject() or jsv_reject_wait() can
# be called, but only one of these functions can be used at a time.
#
# INPUTS
# message - (optional) if it is provided it will be ignored.
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_on_verify()
# jsv/jsv_correct()
# jsv/jsv_reject()
# jsv/jsv_reject_wait()
################################################################################
jsv_accept()
{
if [ "$__jsv_state" = "verifying" ]; then
jsv_send_command "RESULT STATE ACCEPT $*"
__jsv_state="initialized"
else
jsv_send_command "ERROR JSV script will send RESULT command but is in state $__jsv_state"
fi
}
###### jsv/jsv_correct() #######################################################
# NAME
# jsv_correct() -- Accepts a job after applying all modifications.
#
# SYNOPSIS
# jsv_correct(message)
#
# FUNCTION
# This function can only be used in jsv_on_verify(). After it has been
# called, the function jsv_on_verify() has to return immediately.
#
# A call to this function indicates that the job that is currently being
# verified has to be modified before it can be accepted. All job parameter
# modifications that were previously applied will be committed
# and the job will be accepted. "Accept" in that case means that
# the job will either be passed to the next JSV instance for
# modification or that it is passed to that component in the master
# daemon that adds it to the master data store when the
# last JSV instance has verified the job.
#
# Instead of calling jsv_correct() in jsv_on_verify(), the
# functions jsv_accept(), jsv_reject() or jsv_reject_wait() can
# be called, but only one of these functions can be used.
#
# INPUTS
# message - (optional) if it is provided it will be ignored.
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_on_verify()
# jsv/jsv_accept()
# jsv/jsv_correct()
# jsv/jsv_reject()
# jsv/jsv_reject_wait()
################################################################################
jsv_correct()
{
if [ "$__jsv_state" = "verifying" ]; then
jsv_send_command "RESULT STATE CORRECT $*"
__jsv_state="initialized"
else
jsv_send_command "ERROR JSV script will send RESULT command but is in state $__jsv_state"
fi
}
###### jsv/jsv_reject() #######################################################
# NAME
# jsv_reject() -- Rejects a job.
#
# SYNOPSIS
# jsv_reject(message)
#
# FUNCTION
# This function can only be used in jsv_on_verify(). After it has been
# called the function jsv_on_verify() has to return immediately.
#
# The job that is currently being verified will be rejected. "message"
# will be passed to the client application that tried to submit
# the job. Commandline clients like qsub will print that message
# to stdout to inform the user that the submission has failed.
#
# jsv_reject_wait() should be called if the user may try to submit
# the job again. jsv_reject_wait() indicates ther verification process
# might be successful in the future.
#
# Instead of calling jsv_reject() in jsv_on_verify() also the
# functions jsv_accept(), jsv_correct() or jsv_reject_wait() can
# be also called, but only one of these functions can be used.
#
# INPUTS
# message - error message passed to the submitter of the job.
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_on_verify()
# jsv/jsv_accept()
# jsv/jsv_correct()
# jsv/jsv_reject_wait()
################################################################################
jsv_reject()
{
if [ "$__jsv_state" = "verifying" ]; then
jsv_send_command "RESULT STATE REJECT $*"
__jsv_state="initialized"
else
jsv_send_command "ERROR JSV script will send RESULT command but is in state $__jsv_state"
fi
}
###### jsv/jsv_reject_wait() ##################################################
# NAME
# jsv_reject_wait() -- Reject a job. The job might be submitted later.
#
# SYNOPSIS
# jsv_reject_wait(message)
#
# FUNCTION
# This function can only be used in jsv_on_verify(). After it has been
# called the function jsv_on_verify() has to return immediately.
#
# The job which is currently verified will be rejected. "message"
# will be passed to the client application, that tries to submit
# the job. Commandline clients like qsub will print that message
# to stdout to inform the user that the submission has failed.
#
# This function should be called if the user who tries to submit the
# job might have a chance to submit the job later. jsv_reject()
# indicates that the verified job will also be rejected in future.
#
# Instead of calling jsv_reject() in jsv_on_verify() the
# functions jsv_accept(), jsv_correct() or jsv_reject() can
# be also called, but only one of these functions can be used.
#
# INPUTS
# message - error message passed to the submitter of the job.
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_on_verify()
# jsv/jsv_accept()
# jsv/jsv_correct()
# jsv/jsv_reject()
################################################################################
jsv_reject_wait()
{
if [ "$__jsv_state" = "verifying" ]; then
jsv_send_command "RESULT STATE REJECT_WAIT $*"
__jsv_state="initialized"
else
jsv_send_command "ERROR JSV script will send RESULT command but is in state $__jsv_state"
fi
}
###### jsv/jsv_log_info() ####################################################
# NAME
# jsv_log_info() -- Sends an info message to client.
#
# SYNOPSIS
# jsv_log_info(message)
#
# FUNCTION
# This function sends an info message to the client or
# master daemon instance that started the JSV script.
#
# For client JSVs, this means that the commandline client will get
# the information and print it to the stdout stream. Server JSVs
# will print that message as an info message to the master daemon
# message file.
#
# INPUTS
# message - string message
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_log_waring()
# jsv/jsv_log_error()
################################################################################
jsv_log_info()
{
jsv_send_command "LOG INFO $*"
}
###### jsv/jsv_log_warning() ###################################################
# NAME
# jsv_log_warning() -- Sends a warning message to the client.
#
# SYNOPSIS
# jsv_log_warning(message)
#
# FUNCTION
# This function sends a warning message to the client or
# master daemon instance that started the JSV script.
#
# For client JSVs, this means that the commandline client will get
# the information and print it to the stdout stream. Server JSVs
# will print that message as a warning message to the master daemon
# message file.
#
# INPUTS
# message - string message
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_log_info()
# jsv/jsv_log_error()
################################################################################
jsv_log_warning()
{
jsv_send_command "LOG WARNING $*"
}
###### jsv/jsv_log_error() #####################################################
# NAME
# jsv_log_error() -- Sends error message to the client
#
# SYNOPSIS
# jsv_log_error(message)
#
# FUNCTION
# This function sends an error message to the client or
# master daemon instance that started the JSV script.
#
# For client JSVs, this means that the commandline client will get
# the error message and print it to the stdout stream. Server JSVs
# will print that message as an error message to the master daemon
# message file.
#
# INPUTS
# message - string message
#
# RESULT
# none
#
# SEE ALSO
# jsv/jsv_log_info()
# jsv/jsv_log_waring()
################################################################################
jsv_log_error()
{
jsv_send_command "LOG ERROR $*"
}
# private function
jsv_handle_start_command()
{
if [ "$__jsv_state" = "initialized" ]; then
jsv_on_start
jsv_send_command "STARTED"
__jsv_state="started"
else
jsv_send_command "ERROR JSV script got START command but is in state $__jsv_state"
fi
}
# private function
jsv_handle_begin_command()
{
if [ "$__jsv_state" = "started" ]; then
__jsv_state="verifying"
jsv_on_verify
jsv_clear_params
jsv_clear_envs
else
jsv_send_command "ERROR JSV script got BEGIN command but is in state $__jsv_state"
fi
}
# private function
jsv_handle_param_command()
{
if [ "$__jsv_state" = "started" ]; then
__jsv_param="$1"
__jsv_value="$2"
eval "jsv_param_$__jsv_param=\"\${__jsv_value}\""
unset __jsv_param
unset __jsv_value
else
jsv_send_command "ERROR JSV script got PARAM command but is in state $__jsv_state"
fi
}
# private function
jsv_handle_env_command()
{
if [ "$__jsv_state" = "started" ]; then
__jsv_action="$1"
__jsv_name="$2"
__jsv_data="$3"
if [ "$__jsv_action" = "ADD" ]; then
__jsv_all_envs="$__jsv_all_envs $__jsv_name"
eval "jsv_env_${__jsv_name}=\"\${__jsv_data}\""
fi
unset __jsv_action
unset __jsv_name
unset __jsv_data
else
jsv_send_command "ERROR JSV script got ENV command but is in state $__jsv_state"
fi
}
# private function
jsv_send_command()
{
echo "$@"
jsv_script_log "<<< $@"
}
# private function
jsv_script_log()
{
if [ $__jsv_logging_enabled = true ]; then
echo "$@" >>$__jsv_logfile
fi
}
###### jsv/jsv_main() #########################################################
# NAME
# jsv_main() -- JSV main function.
#
# SYNOPSIS
# jsv_main()
#
# FUNCTION
# This function has to be called in JSV scripts. It implements
# the JSV protocol and performs the communication with client and server
# components which might start JSV scripts.
#
# This function does not return immediately. It returns only when
# the "QUIT" command is send by the client or server component.
#
# During the communication with client and server components, this
# function triggers two callback functions for each job that
# should be verified. First jsv_on_start() and later on jsv_on_verify().
#
# jsv_on_start() can be used to initialize certain things that might
# be needed for the verification process. jsv_on_verify() does the
# verification process itself.
#
# The function jsv_send_env() can be called in jsv_on_start() so that
# the job environment is available in jsv_on_verify().
#
# The following function can only be used in jsv_on_verify().
# Simple job parameters can be accessed/modified with:
#
# jsv_is_param()
# jsv_get_param()
# jsv_add_param()
# jsv_mod_param()
# jsv_del_param()
#
# List based job parameters can be accessed with:
#
# jsv_sub_is_param()
# jsv_sub_get_param()
# jsv_sub_add_param()
# jsv_sub_del_param()
#
# If the environment was requested with jsv_send_env() in jsv_on_start()
# then the environment can be accessed/modified with the following
# commands:
#
# jsv_is_env()
# jsv_get_env()
# jsv_add_env()
# jsv_mod_env()
# jsv_del_env()
#
# Jobs can be accepted/rejected with the following:
#
# jsv_accept()
# jsv_correct()
# jsv_reject()
# jsv_reject_wait()
#
# The following functions send messages to the calling component of a JSV
# that will either appear on the stdout stream of the client or in the
# master message file. This is especially usefull when new JSV scripts
# should be tested
#
# jsv_show_params()
# jsv_show_envs()
# jsv_log_info()
# jsv_log_warning()
# jsv_log_error()
#
# INPUTS
# none
#
# RESULT
# none
#
# SEE ALSO
################################################################################
jsv_main()
{
jsv_script_log "$0 started on `date`"
jsv_script_log ""
jsv_script_log "This file contains logging output from a GE JSV script. Lines beginning"
jsv_script_log "with >>> contain the data which was send by a command line client or"
jsv_script_log "sge_qmaster to the JSV script. Lines beginning with <<< contain data"
jsv_script_log "which is send for this JSV script to the client or sge_qmaster"
jsv_script_log ""
while [ $__jsv_quit = false ]; do
# simple read can't be used here because it does backslash escaping
# read -r (raw mode) is not available on all platforms
# therefore we have to use our own implementation
if [ "$ARCH" = "darwin-x86" ]; then
read -r __jsv_input
else
__jsv_input=`$SGE_ROOT/utilbin/$ARCH/read_raw`
fi
__jsv_result=$?
if [ $__jsv_result != 0 ]; then
__jsv_quit=true
else
if [ "$__jsv_input" != "" ]; then
jsv_script_log ">>> $__jsv_input"
__jsv_first=`$SGE_ROOT/utilbin/$ARCH/echo_raw $__jsv_input | cut -d' ' -f 1`
__jsv_second=`$SGE_ROOT/utilbin/$ARCH/echo_raw $__jsv_input | cut -d' ' -f 2`
__jsv_remaining=`$SGE_ROOT/utilbin/$ARCH/echo_raw $__jsv_input | cut -d' ' -f 3-`
if [ "$__jsv_first" = "QUIT" ]; then
__jsv_quit=true
elif [ "$__jsv_first" = "PARAM" ]; then
jsv_handle_param_command "$__jsv_second" "$__jsv_remaining"
elif [ "$__jsv_first" = "ENV" ]; then
__jsv_third=`$SGE_ROOT/utilbin/$ARCH/echo_raw $__jsv_input | cut -d' ' -f 3`
__jsv_len=`$SGE_ROOT/utilbin/$ARCH/echo_raw "$__jsv_first $__jsv_second $__jsv_third " | wc -c`
__jsv_data=`$SGE_ROOT/utilbin/$ARCH/echo_raw $__jsv_input | cut -c ${__jsv_len}-`
jsv_handle_env_command "$__jsv_second" "$__jsv_third" "$__jsv_data"
elif [ "$__jsv_first" = "START" ]; then
jsv_handle_start_command
elif [ "$__jsv_first" = "BEGIN" ]; then
jsv_handle_begin_command
elif [ "$__jsv_first" = "SHOW" ]; then
jsv_show_params
jsv_show_envs
else
jsv_send_command "ERROR JSV script got unknown command \"$__jsv_first\""
fi
fi
fi
unset __jsv_result
done
jsv_script_log "$0 is terminating on `date`"
}
|