summaryrefslogtreecommitdiffstats
path: root/src/H5AS.c
blob: e5db0d95b1b890988b91da2b668d496faa55a33e (plain)
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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Purpose: Analysis shipping for local enumeration of data on remote storage.
 */

/****************/
/* Module Setup */
/****************/

/* Interface initialization */
//#define H5_INTERFACE_INIT_FUNC  H5AS_init_interface

/***********/
/* Headers */
/***********/
#include "H5private.h"      /* Generic Functions */
#include "H5ASprivate.h"    /* Analysis shipping */
#include "H5Eprivate.h"     /* Error handling */
#include "H5Iprivate.h"     /* IDs */
#include "H5MMprivate.h"    /* Memory management */
#include "H5Pprivate.h"
#include "H5ESprivate.h"    /* Event Stacks */

#include "H5VLiod_client.h"

/****************/
/* Local Macros */
/****************/

/******************/
/* Local Typedefs */
/******************/

/********************/
/* Local Prototypes */
/********************/

/*********************/
/* Package Variables */
/*********************/

/*****************************/
/* Library Private Variables */
/*****************************/

/*******************/
/* Local Variables */
/*******************/


/*-------------------------------------------------------------------------
 * Function:    H5ASinvoke
 *
 * Purpose: Invoke the query on file_name/obj_name, run split_script
 * on the query result, combine the results and run combine_script.
 *
 * Return:  Non-negative on success/Negative on failure
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5ASinvoke(const char *file_name, hid_t query_id, const char *split_script, 
           const char *combine_script, const char *integrate_script, hid_t estack_id)
{
    herr_t ret_value;

    FUNC_ENTER_API(FAIL)
    H5TRACE6("e", "*si*s*s*si", file_name, query_id, split_script, combine_script,
             integrate_script, estack_id);

    /* Check argument and retrieve object */
    if(file_name == NULL)
        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "NULL file name")

    /* It is allowed to have split_script and combine_script to be NULL */

    /* H5AS_invoke */
    if((ret_value = H5AS_invoke(file_name, query_id, split_script,
                                combine_script, integrate_script, estack_id)) < 0)
        HGOTO_ERROR(H5E_QUERY, H5E_CANTENCODE, FAIL, "can't start analysis"
                "shipping execution")

done:
    FUNC_LEAVE_API(ret_value)
} /* end H5ASinvoke() */

/*-------------------------------------------------------------------------
 * Function:    H5AS_invoke
 *
 * Purpose: Private routine for H5ASinvoke.
 *
 * Return:  Non-negative on success/Negative on failure
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5AS_invoke(const char *file_name, hid_t query_id, const char *split_script, 
            const char *combine_script, const char *integrate_script, hid_t estack_id)
{
    H5_priv_request_t  *request = NULL; /* private request struct inserted in event queue */
    void    **req = NULL; /* pointer to plugin generate requests (Stays NULL if plugin does not support async */
    herr_t ret_value = SUCCEED; /* Return value */

    FUNC_ENTER_NOAPI_NOINIT

    HDassert(file_name);

    if(estack_id != H5_EVENT_STACK_NULL) {
        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "works only synchronously for now");
    }

    /* Get the data through the IOD VOL */
    if((ret_value = H5VL_iod_analysis_invoke(file_name, query_id, split_script, 
                                             combine_script, integrate_script, req)) < 0)
        HGOTO_ERROR(H5E_SYM, H5E_CANTGET, FAIL,
                "can't start iod analysis shipping execution")

    if(request && *req) {
        if(H5ES_insert(estack_id, request) < 0)
            HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL,
                    "failed to insert request in event stack");
    }

done:

    FUNC_LEAVE_NOAPI(ret_value)
} /* end H5AS_invoke */