drmaa_submit(3)                Grid Engine DRMAA               drmaa_submit(3)



NNAAMMEE
       drmaa_run_job,        drmaa_run_bulk_jobs,       drmaa_get_next_job_id,
       drmaa_get_num_job_ids, drmaa_release_job_ids - Job submission


SSYYNNOOPPSSIISS
       ##iinncclluuddee ""ddrrmmaaaa..hh""

       iinntt ddrrmmaaaa__rruunn__jjoobb((
              cchhaarr **jjoobb__iidd,,
              ssiizzee__tt jjoobb__iidd__lleenn,,
              ddrrmmaaaa__jjoobb__tteemmppllaattee__tt **jjtt,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;

       iinntt ddrrmmaaaa__rruunn__bbuullkk__jjoobbss((
              ddrrmmaaaa__jjoobb__iiddss__tt ****jjoobbiiddss,,
              ddrrmmaaaa__jjoobb__tteemmppllaattee__tt **jjtt,,
              iinntt ssttaarrtt,,
              iinntt eenndd,,
              iinntt iinnccrr,,
              cchhaarr **eerrrroorr__ddiiaaggnnoossiiss,,
              ssiizzee__tt eerrrroorr__ddiiaagg__lleenn
       ));;

       iinntt ddrrmmaaaa__ggeett__nneexxtt__jjoobb__iidd((
              ddrrmmaaaa__jjoobb__iiddss__tt** vvaalluueess,,
              cchhaarr **vvaalluuee,,
              iinntt vvaalluuee__lleenn
       ));;

       iinntt ddrrmmaaaa__ggeett__nnuumm__jjoobb__iiddss((
              ddrrmmaaaa__jjoobb__iiddss__tt** vvaalluueess,,
              iinntt **ssiizzee
       ));;

       vvooiidd ddrrmmaaaa__rreelleeaassee__jjoobb__iiddss((
              ddrrmmaaaa__jjoobb__iiddss__tt** vvaalluueess
       ));;


DDEESSCCRRIIPPTTIIOONN
       drmaa_run_job() submits an Grid Engine job with attributes  defined  in
       the  DRMAA  job  template, _j_t. On success up to _j_o_b___i_d___l_e_n bytes of the
       job identifier are returned into the buffer, _j_o_b___i_d.

   ddrrmmaaaa__rruunn__bbuullkk__jjoobbss(())
       The drmaa_run_bulk_jobs() submits a Grid Engine array job very much  as
       if  the _q_s_u_b(1) option `-t _s_t_a_r_t-_e_n_d:_i_n_c_r' had been used along with the
       additional attributes defined in the DRMAA job template, _j_t.  The  same
       constraints  regarding  value ranges are also in effect for the parame-
       ters _s_t_a_r_t, _e_n_d, and _i_n_c_r as for _q_s_u_b(5) -t. On success a DRMAA job  id
       string  vector  containing  job  identifiers for each array job task is
       returned into _j_o_b_i_d_s.  The job identifiers in the job id string  vector
       can be extracted using _d_r_m_a_a___g_e_t___n_e_x_t___j_o_b___i_d(3).  The number of identi-
       fiers  in  the  job  id  string  vector   can   be   determined   using
       _d_r_m_a_a___g_e_t___n_u_m___j_o_b___i_d_s(3).  Note that this function is only available in
       the 1.0 implementation.  In order to use the  DRMAA  1.0  library,  you
       must  define the DRMAA_10 macro, either in your application directly or
       through a compiler flag, such as -DDRMAA_10.  The caller is responsible
       for  releasing  the  job  id  string  vector returned into _j_o_b_i_d_s using
       _d_r_m_a_a___r_e_l_e_a_s_e___j_o_b___i_d_s(3).


   ddrrmmaaaa__ggeett__nneexxtt__jjoobb__iidd(())
       Each time drmaa_get_next_job_id() is called it returns into the buffer,
       _v_a_l_u_e,  up to _v_a_l_u_e___l_e_n bytes of the next entry stored in the DRMAA job
       id string vector, _v_a_l_u_e_s.  With the DRMAA 0.95 library,  once  the  job
       ids  list  has  been  exhausted, DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is
       returned.  With the DRMAA 1.0 library, once the job ids list  has  been
       exhausted,  DRMAA_ERRNO_NO_MORE_ELEMENTS  is returned.  In order to use
       the DRMAA 1.0 library, you must define the DRMAA_10  macro,  either  in
       your  application  directly  or  through a compiler flag, such as -DDR-
       MAA_10.


   ddrrmmaaaa__ggeett__nnuumm__jjoobb__iiddss(())
       The drmaa_get_num_job_ids() returns into _s_i_z_e the number of entries  in
       the  DRMAA  job  ids string vector.  This function is only available in
       the 1.0 implementation.  In order to use the  DRMAA  1.0  library,  you
       must  define the DRMAA_10 macro, either in your application directly or
       through a compiler flag, such as -DDRMAA_10.


   ddrrmmaaaa__rreelleeaassee__jjoobb__iiddss(())
       The drmaa_release_attr_job_id() function releases all resources associ-
       ated with the DRMAA job id string vector, _v_a_l_u_e_s. This operation has no
       effect on the actual Grid Engine array job tasks.


EENNVVIIRROONNMMEENNTTAALL VVAARRIIAABBLLEESS
       SSGGEE__RROOOOTT       Specifies the location of the Grid Engine standard  con-
                      figuration files.

       SSGGEE__CCEELLLL       If  set,  specifies  the  default Grid Engine cell to be
                      used. To address a Grid Engine cell Grid Engine uses (in
                      the order of precedence):

                             The name of the cell specified in the environment
                             variable SGE_CELL, if it is set.

                             The name of the default cell, i.e. ddeeffaauulltt.


       SSGGEE__DDEEBBUUGG__LLEEVVEELL
                      If set, specifies that debug information should be writ-
                      ten  to stderr. In addition the level of detail in which
                      debug information is generated is defined.

       SSGGEE__QQMMAASSTTEERR__PPOORRTT
                      If set, specifies the tcp port on  which  _s_g_e___q_m_a_s_t_e_r(8)
                      is  expected to listen for communication requests.  Most
                      installations will use a services map entry  instead  to
                      define that port.

RREETTUURRNN VVAALLUUEESS
       Upon successful completion, drmaa_run_job(), drmaa_run_bulk_jobs(), and
       drmaa_get_next_job_id() return DRMAA_ERRNO_SUCCESS. Other values  indi-
       cate  an error.  Up to _e_r_r_o_r___d_i_a_g___l_e_n characters of error related diag-
       nosis information is then provided in the buffer _e_r_r_o_r___d_i_a_g_n_o_s_i_s.


EERRRROORRSS
       The drmaa_run_job(), drmaa_run_bulk_jobs(), and drmaa_get_next_job_id()
       will fail if:

   DDRRMMAAAA__EERRRRNNOO__IINNTTEERRNNAALL__EERRRROORR
       Unexpected or internal DRMAA error, like system call failure, etc.

   DDRRMMAAAA__EERRRRNNOO__DDRRMM__CCOOMMMMUUNNIICCAATTIIOONN__FFAAIILLUURREE
       Could not contact DRM system for this request.

   DDRRMMAAAA__EERRRRNNOO__AAUUTTHH__FFAAIILLUURREE
       The  specified  request is not processed successfully due to authoriza-
       tion failure.

   DDRRMMAAAA__EERRRRNNOO__IINNVVAALLIIDD__AARRGGUUMMEENNTT
       The input value for an argument is invalid.

   DDRRMMAAAA__EERRRRNNOO__NNOO__AACCTTIIVVEE__SSEESSSSIIOONN
       Failed because there is no active session.

   DDRRMMAAAA__EERRRRNNOO__NNOO__MMEEMMOORRYY
       Failed allocating memory.

       The drmaa_run_job() and drmaa_run_bulk_jobs() functions will fail if:

   DDRRMMAAAA__EERRRRNNOO__TTRRYY__LLAATTEERR
       The DRM system indicated that it is too busy to accept the job. A retry
       may succeed, however.

   DDRRMMAAAA__EERRRRNNOO__DDEENNIIEEDD__BBYY__DDRRMM
       The  DRM system rejected the job. The job will never be accepted due to
       DRM configuration or job template settings.

       The drmaa_get_next_job_id() will fail if:

   DDRRMMAAAA__EERRRRNNOO__IINNVVAALLIIDD__AATTTTRRIIBBUUTTEE__VVAALLUUEE
       When there are no more entries in the vector.


SSEEEE AALLSSOO
       _d_r_m_a_a___a_t_t_r_i_b_u_t_e_s(3), _d_r_m_a_a___j_o_b_t_e_m_p_l_a_t_e(3).



GE 6.0                   $Date: 2006/10/02 21:17:57 $          drmaa_submit(3)
