Add JGF reader support

resource/readers/resource_reader_base.cpp

@@ -0,0 +1,101 @@
+/*****************************************************************************\
+ *  Copyright (c) 2019 Lawrence Livermore National Security, LLC.  Produced at
+ *  the Lawrence Livermore National Laboratory (cf, AUTHORS, DISCLAIMER.LLNS).
+ *  LLNL-CODE-658032 All rights reserved.
+ *
+ *  This file is part of the Flux resource manager framework.
+ *  For details, see https://github.com/flux-framework.
+ *
+ *  This program 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.
+ *
+ *  Flux 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 terms and conditions of the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along
+ *  with this program; if not, write to the Free Software Foundation, Inc.,
+ *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ *  See also:  http://www.gnu.org/licenses/
+ \*****************************************************************************/
+
+#include "resource/readers/resource_reader_base.hpp"
+#include "resource/store/resource_graph_store.hpp"
+
+extern "C" {
+#if HAVE_CONFIG_H
+#include "config.h"
+#endif
+}
+
+using namespace std;
+using namespace Flux::resource_model;
+
+
+/********************************************************************************
+ *                                                                              *
+ *                         Private Base Reader API                              *
+ *                                                                              *
+ ********************************************************************************/
+
+bool resource_reader_base_t::in_whitelist (const std::string &resource)
+{
+    return whitelist.empty ()
+           || (whitelist.find (resource) != whitelist.end ());
+}
+
+
+/********************************************************************************
+ *                                                                              *
+ *                         Public Base Reader API                               *
+ *                                                                              *
+ ********************************************************************************/
+
+int resource_reader_base_t::set_whitelist (const std::string &csl)
+{
+    if (csl == "")
+        return 0;
+
+    int rc = -1;
+    size_t pos = 0;
+    std::string csl_copy = csl;
+    std::string sep = ",";
+
+    try {
+        while ((pos = csl_copy.find (sep)) != std::string::npos) {
+            std::string resource = csl_copy.substr (0, pos);
+            if (resource != "")
+                whitelist.insert (resource);
+            csl_copy.erase (0, pos + sep.length ());
+        }
+        if (csl_copy != "")
+            whitelist.insert (csl_copy);
+        errno = EINVAL;
+        rc = whitelist.empty ()? -1 : 0;
+    } catch (std::out_of_range &e) {
+        errno = EINVAL;
+        rc = -1;
+    } catch (std::bad_alloc &e) {
+        errno = ENOMEM;
+        rc = -1;
+    }
+
+    return rc;
+}
+
+const std::string &resource_reader_base_t::err_message () const
+{
+    return m_err_msg;
+}
+
+void resource_reader_base_t::clear_err_message ()
+{
+    m_err_msg = "";
+}
+
+/*
+ * vi:tabstop=4 shiftwidth=4 expandtab
+ */

resource/readers/resource_reader_base.hpp

@@ -0,0 +1,102 @@
+/*****************************************************************************\
+ *  Copyright (c) 2019 Lawrence Livermore National Security, LLC.  Produced at
+ *  the Lawrence Livermore National Laboratory (cf, AUTHORS, DISCLAIMER.LLNS).
+ *  LLNL-CODE-658032 All rights reserved.
+ *
+ *  This file is part of the Flux resource manager framework.
+ *  For details, see https://github.com/flux-framework.
+ *
+ *  This program 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.
+ *
+ *  Flux 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 terms and conditions of the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along
+ *  with this program; if not, write to the Free Software Foundation, Inc.,
+ *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ *  See also:  http://www.gnu.org/licenses/
+ \*****************************************************************************/
+
+#ifndef RESOURCE_READER_BASE_HPP
+#define RESOURCE_READER_BASE_HPP
+
+#include <set>
+#include <string>
+#include <cerrno>
+#include "resource/schema/resource_graph.hpp"
+#include "resource/store/resource_graph_store.hpp"
+
+namespace Flux {
+namespace resource_model {
+
+
+/*!  Base resource reader class.
+ */
+class resource_reader_base_t {
+public:
+    /*! Unpack str into a resource graph.
+     *
+     * \param g      resource graph
+     * \param m      resource graph meta data
+     * \param str    resource set string
+     * \param rank   assign rank to all of the newly created resource vertices
+     * \return       0 on success; non-zero integer on an error
+     */
+    virtual int unpack (resource_graph_t &g, resource_graph_metadata_t &m,
+                        const std::string &str, int rank = -1) = 0;
+
+    /*! Unpack str into a resource graph and graft
+     *  the top-level vertices to vtx.
+     *
+     * \param g      resource graph
+     * \param m      resource graph meta data
+     * \param vtx    parent vtx at which to graft the deserialized graph
+     * \param str    resource set string
+     * \param rank   assign rank to all of the newly created resource vertices
+     * \return       0 on success; non-zero integer on an error
+     */
+    virtual int unpack_at (resource_graph_t &g, resource_graph_metadata_t &m,
+                           vtx_t &vtx, const std::string &str, int rank = -1) = 0;
+
+    /*! Set the whitelist: only resources that are part of this whitelist
+     *  will be unpacked into the graph.
+     *
+     * \param csl    comma separated whitelist string
+     * \return       0 on success; non-zero integer on an error
+     */
+    int set_whitelist (const std::string &csl);
+
+    /*! Is the selected reader format support whitelist
+     *
+     * \return       true when supported
+     */
+    virtual bool is_whitelist_supported () = 0;
+
+    /*! Return the error message string.
+     */
+    const std::string &err_message () const;
+
+    /*! Clear the error message string.
+     */
+    void clear_err_message ();
+
+protected:
+    bool in_whitelist (const std::string &resource);
+    std::set<std::string> whitelist;
+    std::string m_err_msg = "";
+};
+
+} // namesapce resource_model
+} // namespace Flux
+
+
+#endif // RESOURCE_READER_BASE_HPP
+
+/*
+ * vi:tabstop=4 shiftwidth=4 expandtab
+ */

resource/store/resource_graph_store.cpp

@@ -0,0 +1,52 @@
+/*****************************************************************************\
+ *  Copyright (c) 2019 Lawrence Livermore National Security, LLC.  Produced at
+ *  the Lawrence Livermore National Laboratory (cf, AUTHORS, DISCLAIMER.LLNS).
+ *  LLNL-CODE-658032 All rights reserved.
+ *
+ *  This file is part of the Flux resource manager framework.
+ *  For details, see https://github.com/flux-framework.
+ *
+ *  This program 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.
+ *
+ *  Flux 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 terms and conditions of the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along
+ *  with this program; if not, write to the Free Software Foundation, Inc.,
+ *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ *  See also:  http://www.gnu.org/licenses/
+ \*****************************************************************************/
+
+#include "resource/store/resource_graph_store.hpp"
+#include "resource/readers/resource_reader_base.hpp"
+
+using namespace Flux;
+using namespace Flux::resource_model;
+
+bool resource_graph_db_t::known_subsystem (const std::string &s)
+{
+    return (metadata.roots.find (s) != metadata.roots.end ())? true : false;
+}
+
+int resource_graph_db_t::load (const std::string &str,
+                               std::shared_ptr<resource_reader_base_t> &reader,
+                               int rank)
+{
+    return reader->unpack (resource_graph, metadata, str, rank);
+};
+
+int resource_graph_db_t::load (const std::string &str,
+                               std::shared_ptr<resource_reader_base_t> &reader,
+                               vtx_t &vtx_at, int rank)
+{
+    return reader->unpack_at (resource_graph, metadata, vtx_at, str, rank);
+};
+
+/*
+ * vi:tabstop=4 shiftwidth=4 expandtab
+ */

resource/store/resource_graph_store.hpp

@@ -0,0 +1,97 @@
+/*****************************************************************************\
+ *  Copyright (c) 2019 Lawrence Livermore National Security, LLC.  Produced at
+ *  the Lawrence Livermore National Laboratory (cf, AUTHORS, DISCLAIMER.LLNS).
+ *  LLNL-CODE-658032 All rights reserved.
+ *
+ *  This file is part of the Flux resource manager framework.
+ *  For details, see https://github.com/flux-framework.
+ *
+ *  This program 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.
+ *
+ *  Flux 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 terms and conditions of the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License along
+ *  with this program; if not, write to the Free Software Foundation, Inc.,
+ *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ *  See also:  http://www.gnu.org/licenses/
+ \*****************************************************************************/
+
+#ifndef RESOURCE_GRAPH_STORE_HPP
+#define RESOURCE_GRAPH_STORE_HPP
+
+#include <string>
+#include <memory>
+#include "resource/schema/resource_graph.hpp"
+
+namespace Flux {
+namespace resource_model {
+
+class resource_reader_base_t;
+
+/*! Resource graph data metadata.
+ *  Adjacency_list graph, roots of this graph and various indexing.
+ */
+struct resource_graph_metadata_t {
+    std::map<subsystem_t, vtx_t> roots;
+    std::map<std::string, std::vector <vtx_t>> by_type;
+    std::map<std::string, std::vector <vtx_t>> by_name;
+    std::map<std::string, std::vector <vtx_t>> by_path;
+};
+
+/*! Resource graph data store.
+ *  Adjacency_list graph, roots of this graph and various indexing.
+ */
+struct resource_graph_db_t {
+    resource_graph_t resource_graph;
+    resource_graph_metadata_t metadata;
+
+    /*! Return true if s is known subsystem
+     */
+    bool known_subsystem (const std::string &s);
+
+    /*! Load str into the resource graph
+     *
+     * \param str    string containing a GRUG specification
+     * \param reader resource reader base class object
+     * \param rank   assign this rank to all the newly created resource vertices
+     * \return       0 on success; non-zero integer on an error
+     *                   ENOMEM: out of memory
+     *                   EINVAL: invalid input or operation (e.g. 
+     *                               hwloc version or json string load error)
+     *                   EPROTO: str violates the schema
+     */
+    int load (const std::string &str,
+              std::shared_ptr<resource_reader_base_t> &reader,
+              int rank = -1);
+
+    /*! Load str into the resource graph and graft the top-level
+     *  vertices to vtx_at.
+     * \param str    string containing a GRUG specification
+     * \param reader resource reader base class object
+     * \param vtx_at parent vtx at which to graft the deserialized graph
+     * \param rank   assign this rank to all the newly created resource vertices
+     * \return       0 on success; non-zero integer on an error
+     *                   ENOMEM: out of memory
+     *                   EINVAL: invalid input or operation (e.g. 
+     *                               hwloc version or json string load error)
+     *                   EPROTO: str violates the schema
+     */
+    int load (const std::string &str,
+              std::shared_ptr<resource_reader_base_t> &reader,
+              vtx_t &vtx_at, int rank = -1);
+};
+
+}
+}
+
+#endif // RESOURCE_GRAPH_STORE_HPP
+
+/*
+ * vi:tabstop=4 shiftwidth=4 expandtab
+ */