mirror of
https://github.com/TREX-CoE/trexio.git
synced 2024-12-25 13:53:55 +01:00
1571 lines
85 KiB
HTML
1571 lines
85 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<!-- 2022-01-10 Mon 09:28 -->
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>TEXT back end</title>
|
|
<meta name="generator" content="Org mode" />
|
|
<meta name="author" content="TREX-CoE" />
|
|
<style type="text/css">
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
.title { text-align: center;
|
|
margin-bottom: .2em; }
|
|
.subtitle { text-align: center;
|
|
font-size: medium;
|
|
font-weight: bold;
|
|
margin-top:0; }
|
|
.todo { font-family: monospace; color: red; }
|
|
.done { font-family: monospace; color: green; }
|
|
.priority { font-family: monospace; color: orange; }
|
|
.tag { background-color: #eee; font-family: monospace;
|
|
padding: 2px; font-size: 80%; font-weight: normal; }
|
|
.timestamp { color: #bebebe; }
|
|
.timestamp-kwd { color: #5f9ea0; }
|
|
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
|
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
|
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
|
.underline { text-decoration: underline; }
|
|
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
|
p.verse { margin-left: 3%; }
|
|
pre {
|
|
border: 1px solid #ccc;
|
|
box-shadow: 3px 3px 3px #eee;
|
|
padding: 8pt;
|
|
font-family: monospace;
|
|
overflow: auto;
|
|
margin: 1.2em;
|
|
}
|
|
pre.src {
|
|
position: relative;
|
|
overflow: visible;
|
|
padding-top: 1.2em;
|
|
}
|
|
pre.src:before {
|
|
display: none;
|
|
position: absolute;
|
|
background-color: white;
|
|
top: -10px;
|
|
right: 10px;
|
|
padding: 3px;
|
|
border: 1px solid black;
|
|
}
|
|
pre.src:hover:before { display: inline;}
|
|
/* Languages per Org manual */
|
|
pre.src-asymptote:before { content: 'Asymptote'; }
|
|
pre.src-awk:before { content: 'Awk'; }
|
|
pre.src-C:before { content: 'C'; }
|
|
/* pre.src-C++ doesn't work in CSS */
|
|
pre.src-clojure:before { content: 'Clojure'; }
|
|
pre.src-css:before { content: 'CSS'; }
|
|
pre.src-D:before { content: 'D'; }
|
|
pre.src-ditaa:before { content: 'ditaa'; }
|
|
pre.src-dot:before { content: 'Graphviz'; }
|
|
pre.src-calc:before { content: 'Emacs Calc'; }
|
|
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
|
pre.src-fortran:before { content: 'Fortran'; }
|
|
pre.src-gnuplot:before { content: 'gnuplot'; }
|
|
pre.src-haskell:before { content: 'Haskell'; }
|
|
pre.src-hledger:before { content: 'hledger'; }
|
|
pre.src-java:before { content: 'Java'; }
|
|
pre.src-js:before { content: 'Javascript'; }
|
|
pre.src-latex:before { content: 'LaTeX'; }
|
|
pre.src-ledger:before { content: 'Ledger'; }
|
|
pre.src-lisp:before { content: 'Lisp'; }
|
|
pre.src-lilypond:before { content: 'Lilypond'; }
|
|
pre.src-lua:before { content: 'Lua'; }
|
|
pre.src-matlab:before { content: 'MATLAB'; }
|
|
pre.src-mscgen:before { content: 'Mscgen'; }
|
|
pre.src-ocaml:before { content: 'Objective Caml'; }
|
|
pre.src-octave:before { content: 'Octave'; }
|
|
pre.src-org:before { content: 'Org mode'; }
|
|
pre.src-oz:before { content: 'OZ'; }
|
|
pre.src-plantuml:before { content: 'Plantuml'; }
|
|
pre.src-processing:before { content: 'Processing.js'; }
|
|
pre.src-python:before { content: 'Python'; }
|
|
pre.src-R:before { content: 'R'; }
|
|
pre.src-ruby:before { content: 'Ruby'; }
|
|
pre.src-sass:before { content: 'Sass'; }
|
|
pre.src-scheme:before { content: 'Scheme'; }
|
|
pre.src-screen:before { content: 'Gnu Screen'; }
|
|
pre.src-sed:before { content: 'Sed'; }
|
|
pre.src-sh:before { content: 'shell'; }
|
|
pre.src-sql:before { content: 'SQL'; }
|
|
pre.src-sqlite:before { content: 'SQLite'; }
|
|
/* additional languages in org.el's org-babel-load-languages alist */
|
|
pre.src-forth:before { content: 'Forth'; }
|
|
pre.src-io:before { content: 'IO'; }
|
|
pre.src-J:before { content: 'J'; }
|
|
pre.src-makefile:before { content: 'Makefile'; }
|
|
pre.src-maxima:before { content: 'Maxima'; }
|
|
pre.src-perl:before { content: 'Perl'; }
|
|
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
|
pre.src-scala:before { content: 'Scala'; }
|
|
pre.src-shell:before { content: 'Shell Script'; }
|
|
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
|
/* additional language identifiers per "defun org-babel-execute"
|
|
in ob-*.el */
|
|
pre.src-cpp:before { content: 'C++'; }
|
|
pre.src-abc:before { content: 'ABC'; }
|
|
pre.src-coq:before { content: 'Coq'; }
|
|
pre.src-groovy:before { content: 'Groovy'; }
|
|
/* additional language identifiers from org-babel-shell-names in
|
|
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
|
the execution function name together. */
|
|
pre.src-bash:before { content: 'bash'; }
|
|
pre.src-csh:before { content: 'csh'; }
|
|
pre.src-ash:before { content: 'ash'; }
|
|
pre.src-dash:before { content: 'dash'; }
|
|
pre.src-ksh:before { content: 'ksh'; }
|
|
pre.src-mksh:before { content: 'mksh'; }
|
|
pre.src-posh:before { content: 'posh'; }
|
|
/* Additional Emacs modes also supported by the LaTeX listings package */
|
|
pre.src-ada:before { content: 'Ada'; }
|
|
pre.src-asm:before { content: 'Assembler'; }
|
|
pre.src-caml:before { content: 'Caml'; }
|
|
pre.src-delphi:before { content: 'Delphi'; }
|
|
pre.src-html:before { content: 'HTML'; }
|
|
pre.src-idl:before { content: 'IDL'; }
|
|
pre.src-mercury:before { content: 'Mercury'; }
|
|
pre.src-metapost:before { content: 'MetaPost'; }
|
|
pre.src-modula-2:before { content: 'Modula-2'; }
|
|
pre.src-pascal:before { content: 'Pascal'; }
|
|
pre.src-ps:before { content: 'PostScript'; }
|
|
pre.src-prolog:before { content: 'Prolog'; }
|
|
pre.src-simula:before { content: 'Simula'; }
|
|
pre.src-tcl:before { content: 'tcl'; }
|
|
pre.src-tex:before { content: 'TeX'; }
|
|
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
|
pre.src-verilog:before { content: 'Verilog'; }
|
|
pre.src-vhdl:before { content: 'VHDL'; }
|
|
pre.src-xml:before { content: 'XML'; }
|
|
pre.src-nxml:before { content: 'XML'; }
|
|
/* add a generic configuration mode; LaTeX export needs an additional
|
|
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
|
pre.src-conf:before { content: 'Configuration File'; }
|
|
|
|
table { border-collapse:collapse; }
|
|
caption.t-above { caption-side: top; }
|
|
caption.t-bottom { caption-side: bottom; }
|
|
td, th { vertical-align:top; }
|
|
th.org-right { text-align: center; }
|
|
th.org-left { text-align: center; }
|
|
th.org-center { text-align: center; }
|
|
td.org-right { text-align: right; }
|
|
td.org-left { text-align: left; }
|
|
td.org-center { text-align: center; }
|
|
dt { font-weight: bold; }
|
|
.footpara { display: inline; }
|
|
.footdef { margin-bottom: 1em; }
|
|
.figure { padding: 1em; }
|
|
.figure p { text-align: center; }
|
|
.inlinetask {
|
|
padding: 10px;
|
|
border: 2px solid gray;
|
|
margin: 10px;
|
|
background: #ffffcc;
|
|
}
|
|
#org-div-home-and-up
|
|
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
|
textarea { overflow-x: auto; }
|
|
.linenr { font-size: smaller }
|
|
.code-highlighted { background-color: #ffff00; }
|
|
.org-info-js_info-navigation { border-style: none; }
|
|
#org-info-js_console-label
|
|
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
|
.org-info-js_search-highlight
|
|
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
|
.org-svg { width: 90%; }
|
|
/*]]>*/-->
|
|
</style>
|
|
<link rel="stylesheet" title="Standard" href="trexio.css" type="text/css" />
|
|
|
|
<script type="text/javascript" src="org-info.js">
|
|
/**
|
|
*
|
|
* @source: org-info.js
|
|
*
|
|
* @licstart The following is the entire license notice for the
|
|
* JavaScript code in org-info.js.
|
|
*
|
|
* Copyright (C) 2012-2019 Free Software Foundation, Inc.
|
|
*
|
|
*
|
|
* The JavaScript code in this tag is free software: you can
|
|
* redistribute it and/or modify it under the terms of the GNU
|
|
* General Public License (GNU GPL) as published by the Free Software
|
|
* Foundation, either version 3 of the License, or (at your option)
|
|
* any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
* without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
*
|
|
* As additional permission under GNU GPL version 3 section 7, you
|
|
* may distribute non-source (e.g., minimized or compacted) forms of
|
|
* that code without the copy of the GNU GPL normally required by
|
|
* section 4, provided you include this license notice and a URL
|
|
* through which recipients can access the Corresponding Source.
|
|
*
|
|
* @licend The above is the entire license notice
|
|
* for the JavaScript code in org-info.js.
|
|
*
|
|
*/
|
|
</script>
|
|
|
|
<script type="text/javascript">
|
|
|
|
/*
|
|
@licstart The following is the entire license notice for the
|
|
JavaScript code in this tag.
|
|
|
|
Copyright (C) 2012-2019 Free Software Foundation, Inc.
|
|
|
|
The JavaScript code in this tag is free software: you can
|
|
redistribute it and/or modify it under the terms of the GNU
|
|
General Public License (GNU GPL) as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option)
|
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
|
|
As additional permission under GNU GPL version 3 section 7, you
|
|
may distribute non-source (e.g., minimized or compacted) forms of
|
|
that code without the copy of the GNU GPL normally required by
|
|
section 4, provided you include this license notice and a URL
|
|
through which recipients can access the Corresponding Source.
|
|
|
|
|
|
@licend The above is the entire license notice
|
|
for the JavaScript code in this tag.
|
|
*/
|
|
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
org_html_manager.set("TOC_DEPTH", "4");
|
|
org_html_manager.set("LINK_HOME", "index.html");
|
|
org_html_manager.set("LINK_UP", "");
|
|
org_html_manager.set("LOCAL_TOC", "1");
|
|
org_html_manager.set("VIEW_BUTTONS", "0");
|
|
org_html_manager.set("MOUSE_HINT", "underline");
|
|
org_html_manager.set("FIXED_TOC", "0");
|
|
org_html_manager.set("TOC", "1");
|
|
org_html_manager.set("VIEW", "info");
|
|
org_html_manager.setup(); // activate after the parameters are set
|
|
/*]]>*///-->
|
|
</script>
|
|
<script type="text/javascript">
|
|
/*
|
|
@licstart The following is the entire license notice for the
|
|
JavaScript code in this tag.
|
|
|
|
Copyright (C) 2012-2019 Free Software Foundation, Inc.
|
|
|
|
The JavaScript code in this tag is free software: you can
|
|
redistribute it and/or modify it under the terms of the GNU
|
|
General Public License (GNU GPL) as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option)
|
|
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
|
without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
|
|
|
As additional permission under GNU GPL version 3 section 7, you
|
|
may distribute non-source (e.g., minimized or compacted) forms of
|
|
that code without the copy of the GNU GPL normally required by
|
|
section 4, provided you include this license notice and a URL
|
|
through which recipients can access the Corresponding Source.
|
|
|
|
|
|
@licend The above is the entire license notice
|
|
for the JavaScript code in this tag.
|
|
*/
|
|
<!--/*--><![CDATA[/*><!--*/
|
|
function CodeHighlightOn(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(null != target) {
|
|
elem.cacheClassElem = elem.className;
|
|
elem.cacheClassTarget = target.className;
|
|
target.className = "code-highlighted";
|
|
elem.className = "code-highlighted";
|
|
}
|
|
}
|
|
function CodeHighlightOff(elem, id)
|
|
{
|
|
var target = document.getElementById(id);
|
|
if(elem.cacheClassElem)
|
|
elem.className = elem.cacheClassElem;
|
|
if(elem.cacheClassTarget)
|
|
target.className = elem.cacheClassTarget;
|
|
}
|
|
/*]]>*///-->
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="org-div-home-and-up">
|
|
<a accesskey="h" href=""> UP </a>
|
|
|
|
|
<a accesskey="H" href="index.html"> HOME </a>
|
|
</div><div id="content">
|
|
<h1 class="title">TEXT back end</h1>
|
|
<div id="table-of-contents">
|
|
<h2>Table of Contents</h2>
|
|
<div id="text-table-of-contents">
|
|
<ul>
|
|
<li><a href="#org97516b0">1. TEXT back end</a>
|
|
<ul>
|
|
<li><a href="#org86003ba">1.1. Template for group-related structures in text back end</a></li>
|
|
<li><a href="#orgd04e4a7">1.2. Template for general structure in text back end</a></li>
|
|
<li><a href="#orge0557c8">1.3. Initialize function (constant part)</a></li>
|
|
<li><a href="#org79de0eb">1.4. Deinitialize function (templated part)</a></li>
|
|
<li><a href="#org624784d">1.5. Template for text read struct</a></li>
|
|
<li><a href="#org315f36b">1.6. Template for text flush struct</a></li>
|
|
<li><a href="#orgd4e9f64">1.7. Template for text free memory</a></li>
|
|
<li><a href="#org9cec566">1.8. Template for has/read/write the numerical attribute</a></li>
|
|
<li><a href="#org7d78a0e">1.9. Template for has/read/write the dataset of numerical data</a></li>
|
|
<li><a href="#org48c90d0">1.10. Template for has/read/write the dataset of strings</a></li>
|
|
<li><a href="#org73cced3">1.11. Template for has/read/write the string attribute</a></li>
|
|
<li><a href="#org563b98f">1.12. Template for has/read/write the dataset of sparse data</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org97516b0" class="outline-2">
|
|
<h2 id="org97516b0"><span class="section-number-2">1</span> TEXT back end</h2>
|
|
<div class="outline-text-2" id="text-1">
|
|
<p>
|
|
The "file" produced by the text back end is a directory with one
|
|
file per group.
|
|
</p>
|
|
|
|
<p>
|
|
When the file is open, it is locked by the current process. No other
|
|
process can read/write the same file. This guarantees that the
|
|
representation in memory is consistent with the file and avoid
|
|
re-reading the file before writing.
|
|
To lock the file, we lock the <code>.lock</code> file which is present in the
|
|
directory.
|
|
</p>
|
|
|
|
<p>
|
|
The file is written when closed, or when the flush function is called.
|
|
</p>
|
|
</div>
|
|
|
|
<div id="outline-container-org86003ba" class="outline-3">
|
|
<h3 id="org86003ba"><span class="section-number-3">1.1</span> Template for group-related structures in text back end</h3>
|
|
<div class="outline-text-3" id="text-1-1">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> $group$_s {
|
|
$group_num_dtype_double$ $group_num$;
|
|
bool $group_num$_isSet;
|
|
$group_dset_dtype$* $group_dset$;
|
|
<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">rank_$group_dset$</span>;
|
|
<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">to_flush</span>;
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">dims_$group_dset$</span>[16];
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">len_$group_str$</span>;
|
|
<span style="color: #228b22;">char</span>* $group_str$;
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_name</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
} $group$_t;
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orgd04e4a7" class="outline-3">
|
|
<h3 id="orgd04e4a7"><span class="section-number-3">1.2</span> Template for general structure in text back end</h3>
|
|
<div class="outline-text-3" id="text-1-2">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #a020f0;">typedef</span> <span style="color: #a020f0;">struct</span> <span style="color: #228b22;">trexio_text_s</span> {
|
|
<span style="color: #228b22;">trexio_t</span> <span style="color: #a0522d;">parent</span> ;
|
|
$group$_t* $group$;
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">lock_file</span>;
|
|
} <span style="color: #228b22;">trexio_text_t</span>;
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orge0557c8" class="outline-3">
|
|
<h3 id="orge0557c8"><span class="section-number-3">1.3</span> Initialize function (constant part)</h3>
|
|
<div class="outline-text-3" id="text-1-3">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_init</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">f</span> = (<span style="color: #228b22;">trexio_text_t</span>*) file;
|
|
|
|
/* <span style="color: #b22222;">Put all pointers to NULL but leave parent untouched </span>*/
|
|
memset(&(f->parent)+1,0,<span style="color: #a020f0;">sizeof</span>(trexio_text_t)-<span style="color: #a020f0;">sizeof</span>(trexio_t));
|
|
|
|
/* <span style="color: #b22222;">If directory doesn't exist, create it in write mode </span>*/
|
|
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">stat</span> <span style="color: #a0522d;">st</span>;
|
|
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span> = stat(file->file_name, &st);
|
|
|
|
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">file_exists</span> = rc == 0;
|
|
|
|
<span style="color: #a020f0;">if</span> (file_exists) {
|
|
|
|
<span style="color: #228b22;">bool</span> <span style="color: #a0522d;">is_a_directory</span> = st.st_mode & S_IFDIR;
|
|
<span style="color: #a020f0;">if</span> (!is_a_directory) {
|
|
<span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
}
|
|
|
|
} <span style="color: #a020f0;">else</span> {
|
|
|
|
<span style="color: #a020f0;">if</span> (file->mode == <span style="color: #8b2252;">'r'</span>) {
|
|
<span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
}
|
|
|
|
rc = mkdir(file->file_name, 0777);
|
|
<span style="color: #a020f0;">if</span> (rc != 0) {
|
|
<span style="color: #a020f0;">return</span> TREXIO_ERRNO;
|
|
}
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Create the lock file in the directory </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* <span style="color: #a0522d;">lock_file_name</span> = <span style="color: #8b2252;">"/.lock"</span>;
|
|
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_name</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
|
|
strncpy (file_name, file->file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
strncat (file_name, lock_file_name, TREXIO_MAX_FILENAME_LENGTH-strlen(lock_file_name));
|
|
|
|
<span style="color: #a020f0;">if</span> (file_name[TREXIO_MAX_FILENAME_LENGTH-1] != <span style="color: #8b2252;">'\0'</span>) {
|
|
<span style="color: #a020f0;">return</span> TREXIO_LOCK_ERROR;
|
|
}
|
|
|
|
f->lock_file = open(file_name,O_WRONLY|O_CREAT|O_TRUNC, 0644);
|
|
|
|
<span style="color: #a020f0;">if</span> (f->lock_file <= 0) {
|
|
<span style="color: #a020f0;">if</span> (file->mode != <span style="color: #8b2252;">'r'</span>) {
|
|
<span style="color: #a020f0;">return</span> TREXIO_ERRNO;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">if</span> (errno == EACCES) {
|
|
/* <span style="color: #b22222;">The directory is read-only and the lock file can't be written.</span>
|
|
<span style="color: #b22222;"> Create a dummy temporary file for dummy locking.</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">dirname</span>[TREXIO_MAX_FILENAME_LENGTH] = <span style="color: #8b2252;">"/tmp/trexio.XXXXXX"</span>;
|
|
<span style="color: #a020f0;">if</span> (mkdtemp(dirname) == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_ERRNO;
|
|
strncpy (file_name, dirname, TREXIO_MAX_FILENAME_LENGTH);
|
|
strncat (file_name, lock_file_name, TREXIO_MAX_FILENAME_LENGTH-strlen(lock_file_name));
|
|
f->lock_file = open(file_name,O_WRONLY|O_CREAT|O_TRUNC, 0644);
|
|
remove(file_name);
|
|
rmdir(dirname);
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_ERRNO;
|
|
}
|
|
}
|
|
}
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_lock</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>) {
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">f</span> = (<span style="color: #228b22;">trexio_text_t</span>*) file;
|
|
|
|
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">flock</span> <span style="color: #a0522d;">fl</span>;
|
|
|
|
fl.l_type = F_WRLCK;
|
|
fl.l_whence = SEEK_SET;
|
|
fl.l_start = 0;
|
|
fl.l_len = 0;
|
|
fl.l_pid = getpid();
|
|
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span> = fcntl(f->lock_file, F_SETLKW, &fl);
|
|
<span style="color: #a020f0;">if</span> (rc == -1) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_unlock</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">f</span> = (<span style="color: #228b22;">trexio_text_t</span>*) file;
|
|
|
|
<span style="color: #a020f0;">struct</span> <span style="color: #228b22;">flock</span> <span style="color: #a0522d;">fl</span>;
|
|
|
|
fl.l_type = F_UNLCK;
|
|
fl.l_whence = SEEK_SET;
|
|
fl.l_start = 0;
|
|
fl.l_len = 0;
|
|
fl.l_pid = getpid();
|
|
fcntl(f->lock_file, F_SETLK, &fl);
|
|
|
|
close(f->lock_file);
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org79de0eb" class="outline-3">
|
|
<h3 id="org79de0eb"><span class="section-number-3">1.4</span> Deinitialize function (templated part)</h3>
|
|
<div class="outline-text-3" id="text-1-4">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_deinit</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span>;
|
|
|
|
/* <span style="color: #b22222;">Error handling for this call is added by the generator </span>*/
|
|
rc = trexio_text_free_$group$( (<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org624784d" class="outline-3">
|
|
<h3 id="org624784d"><span class="section-number-3">1.5</span> Template for text read struct</h3>
|
|
<div class="outline-text-3" id="text-1-5">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c">$group$_t*
|
|
trexio_text_read_$group$ (<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
|
|
/* <span style="color: #b22222;">If the data structure exists, return it </span>*/
|
|
<span style="color: #a020f0;">if</span> (file->$group$ != <span style="color: #008b8b;">NULL</span>) {
|
|
<span style="color: #a020f0;">return</span> file->$group$;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Allocate the data structure </span>*/
|
|
$group$_t* $group$ = MALLOC($group$_t);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
|
|
memset($group$,0,<span style="color: #a020f0;">sizeof</span>($group$_t));
|
|
|
|
/* <span style="color: #b22222;">Build the file name </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>* $group$_file_name = <span style="color: #8b2252;">"/$group$.txt"</span>;
|
|
|
|
strncpy ($group$->file_name, file->parent.file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
strncat ($group$->file_name, $group$_file_name,
|
|
TREXIO_MAX_FILENAME_LENGTH-strlen($group$_file_name));
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->file_name[TREXIO_MAX_FILENAME_LENGTH-1] != <span style="color: #8b2252;">'\0'</span>) {
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">If the file exists, read it </span>*/
|
|
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen($group$->file_name,<span style="color: #8b2252;">"r"</span>);
|
|
<span style="color: #a020f0;">if</span> (f != <span style="color: #008b8b;">NULL</span>) {
|
|
|
|
/* <span style="color: #b22222;">Find size of file to allocate the max size of the string buffer </span>*/
|
|
fseek(f, 0L, SEEK_END);
|
|
<span style="color: #228b22;">size_t</span> <span style="color: #a0522d;">sz</span> = ftell(f);
|
|
fseek(f, 0L, SEEK_SET);
|
|
|
|
sz = (sz < 1024) ? (1024) : (sz);
|
|
<span style="color: #228b22;">char</span>* <span style="color: #a0522d;">buffer</span> = CALLOC(sz, <span style="color: #228b22;">char</span>);
|
|
<span style="color: #a020f0;">if</span> (buffer == <span style="color: #008b8b;">NULL</span>) {
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Read the dimensioning variables </span>*/
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span> = 0;
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_ALL</span>
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"rank_$group_dset$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%u"</span>, &($group$->rank_$group_dset$));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">workaround for the case of missing blocks in the file </span>*/
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">size_$group_dset$</span> = 0;
|
|
<span style="color: #a020f0;">if</span> ($group$->rank_$group_dset$ != 0) size_$group_dset$ = 1;
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">i</span>=0; i<$group$->rank_$group_dset$; ++i){
|
|
|
|
<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">j</span>=0;
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s %u"</span>, buffer, &j);
|
|
<span style="color: #a020f0;">if</span> ((rc != 2) || (strcmp(buffer, <span style="color: #8b2252;">"dims_$group_dset$"</span>) != 0) || (j!=i)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%"</span> SCNu64 <span style="color: #8b2252;">"\n"</span>, &($group$->dims_$group_dset$[i]));
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
size_$group_dset$ *= $group$->dims_$group_dset$[i];
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_ALL</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_NUM</span>
|
|
/* <span style="color: #b22222;">Read data </span>*/
|
|
<span style="color: #228b22;">unsigned</span> <span style="color: #228b22;">int</span> $group_num$_isSet;
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_num$_isSet"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_num$_isSet"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">additional parameter $group_num$_isSet is needed to suppress warning when fscanf into bool variable using %u or %d </span>*/
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%u"</span>, &($group_num$_isSet));
|
|
$group$->$group_num$_isSet = (bool) $group_num$_isSet;
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_num$_isSet == <span style="color: #008b8b;">true</span>) {
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_num$"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_num$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%$group_num_format_scanf$"</span>, &($group$->$group_num$));
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_NUM</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_ATTR_STR</span>
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"len_$group_str$"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"len_$group_str$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%"</span> SCNu64 <span style="color: #8b2252;">""</span>, &($group$->len_$group_str$));
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_str$"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_str$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_str$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->len_$group_str$ != 0) {
|
|
|
|
$group$->$group_str$ = CALLOC($group$->len_$group_str$, <span style="color: #228b22;">char</span>);
|
|
assert (!($group$->$group_str$ == <span style="color: #008b8b;">NULL</span>));
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_str$ == <span style="color: #008b8b;">NULL</span>) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_str$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">" %1023[^\n]"</span>, $group$->$group_str$);
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_str$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_ATTR_STR</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_NUM</span>
|
|
/* <span style="color: #b22222;">Allocate arrays </span>*/
|
|
$group$->$group_dset$ = CALLOC(size_$group_dset$, $group_dset_dtype$);
|
|
assert (!($group$->$group_dset$ == <span style="color: #008b8b;">NULL</span>));
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ == <span style="color: #008b8b;">NULL</span>) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_dset$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_dset$"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_dset$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_dset$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<size_$group_dset$ ; ++i) {
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%$group_dset_format_scanf$"</span>, &($group$->$group_dset$[i]));
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_dset$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_NUM</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_STR</span>
|
|
rc = fscanf(f, <span style="color: #8b2252;">"%1023s"</span>, buffer);
|
|
assert(!((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_dset$"</span>) != 0)));
|
|
<span style="color: #a020f0;">if</span> ((rc != 1) || (strcmp(buffer, <span style="color: #8b2252;">"$group_dset$"</span>) != 0)) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Allocate arrays </span>*/
|
|
<span style="color: #a020f0;">if</span>(size_$group_dset$ != 0) {
|
|
$group$->$group_dset$ = CALLOC(size_$group_dset$, $group_dset_dtype$);
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ == <span style="color: #008b8b;">NULL</span>) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_dset$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">WARNING: this tmp array allows to avoid allocation of space for each element of array of string</span>
|
|
<span style="color: #b22222;"> BUT it's size has to be number_of_str*max_len_str where max_len_str is somewhat arbitrary, e.g. 32.</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #228b22;">char</span>* <span style="color: #a0522d;">tmp_$group_dset$</span>;
|
|
tmp_$group_dset$ = CALLOC(size_$group_dset$*32, <span style="color: #228b22;">char</span>);
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<size_$group_dset$ ; ++i) {
|
|
$group$->$group_dset$[i] = tmp_$group_dset$;
|
|
/* <span style="color: #b22222;">conventional fcanf with "%s" only return the string before the first space character</span>
|
|
<span style="color: #b22222;"> * to read string with spaces use "%[^\n]" possible with space before or after, i.e. " %[^\n]"</span>
|
|
<span style="color: #b22222;"> * Q: depending on what ? </span>*/
|
|
rc = fscanf(f, <span style="color: #8b2252;">" %1023[^\n]"</span>, tmp_$group_dset$);
|
|
assert(!(rc != 1));
|
|
<span style="color: #a020f0;">if</span> (rc != 1) {
|
|
FREE(buffer);
|
|
fclose(f);
|
|
FREE($group$->$group_dset$);
|
|
FREE($group$);
|
|
<span style="color: #a020f0;">return</span> <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
<span style="color: #228b22;">size_t</span> <span style="color: #a0522d;">tmp_$group_dset$_len</span> = strlen($group$->$group_dset$[i]);
|
|
tmp_$group_dset$ += tmp_$group_dset$_len + 1;
|
|
}
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_STR</span>
|
|
|
|
FREE(buffer);
|
|
fclose(f);
|
|
f = <span style="color: #008b8b;">NULL</span>;
|
|
}
|
|
|
|
file->$group$ = $group$;
|
|
<span style="color: #a020f0;">return</span> $group$;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org315f36b" class="outline-3">
|
|
<h3 id="org315f36b"><span class="section-number-3">1.6</span> Template for text flush struct</h3>
|
|
<div class="outline-text-3" id="text-1-6">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_flush_$group$</span> (<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #a020f0;">if</span> (file->parent.mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
|
|
$group$_t* $group$ = file->$group$;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->to_flush == 0) <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
assert (file->parent.mode == <span style="color: #8b2252;">'w'</span>);
|
|
|
|
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen($group$->file_name, <span style="color: #8b2252;">"w"</span>);
|
|
<span style="color: #a020f0;">if</span> (f == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
/* <span style="color: #b22222;">Write the dimensioning variables </span>*/
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_ALL</span>
|
|
fprintf(f, <span style="color: #8b2252;">"rank_$group_dset$ %u\n"</span>, $group$->rank_$group_dset$);
|
|
// <span style="color: #b22222;">workaround for the case of missing blocks in the file</span>
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">size_$group_dset$</span> = 0;
|
|
<span style="color: #a020f0;">if</span> ($group$->rank_$group_dset$ != 0) size_$group_dset$ = 1;
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">unsigned</span> <span style="color: #228b22;">int</span> <span style="color: #a0522d;">i</span>=0; i<$group$->rank_$group_dset$; ++i){
|
|
fprintf(f, <span style="color: #8b2252;">"dims_$group_dset$ %u %"</span> PRIu64 <span style="color: #8b2252;">"\n"</span>, i, $group$->dims_$group_dset$[i]);
|
|
size_$group_dset$ *= $group$->dims_$group_dset$[i];
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_ALL</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_NUM</span>
|
|
fprintf(f, <span style="color: #8b2252;">"$group_num$_isSet %u \n"</span>, $group$->$group_num$_isSet);
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_num$_isSet == <span style="color: #008b8b;">true</span>) fprintf(f, <span style="color: #8b2252;">"$group_num$ %$group_num_format_printf$ \n"</span>, $group$->$group_num$);
|
|
// <span style="color: #b22222;">END REPEAT GROUP_NUM</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_ATTR_STR</span>
|
|
fprintf(f, <span style="color: #8b2252;">"len_$group_str$ %"</span> PRIu64 <span style="color: #8b2252;">"\n"</span>, $group$->len_$group_str$);
|
|
fprintf(f, <span style="color: #8b2252;">"$group_str$\n"</span>);
|
|
<span style="color: #a020f0;">if</span> ($group$->len_$group_str$ != 0) fprintf(f, <span style="color: #8b2252;">"%s\n"</span>, $group$->$group_str$);
|
|
// <span style="color: #b22222;">END REPEAT GROUP_ATTR_STR</span>
|
|
|
|
/* <span style="color: #b22222;">Write arrays </span>*/
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_ALL</span>
|
|
|
|
fprintf(f, <span style="color: #8b2252;">"$group_dset$\n"</span>);
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<size_$group_dset$ ; ++i) {
|
|
fprintf(f, <span style="color: #8b2252;">"%$group_dset_format_printf$\n"</span>, $group$->$group_dset$[i]);
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_ALL</span>
|
|
|
|
fclose(f);
|
|
$group$->to_flush = 0;
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-orgd4e9f64" class="outline-3">
|
|
<h3 id="orgd4e9f64"><span class="section-number-3">1.7</span> Template for text free memory</h3>
|
|
<div class="outline-text-3" id="text-1-7">
|
|
<p>
|
|
Memory is allocated when reading. The following function frees memory.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_free_$group$</span> (<span style="color: #228b22;">trexio_text_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
<span style="color: #a020f0;">if</span> (file->parent.mode != <span style="color: #8b2252;">'r'</span>) {
|
|
<span style="color: #228b22;">trexio_exit_code</span> <span style="color: #a0522d;">rc</span> = trexio_text_flush_$group$(file);
|
|
<span style="color: #a020f0;">if</span> (rc != TREXIO_SUCCESS) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
}
|
|
|
|
$group$_t* $group$ = file->$group$;
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_NUM</span>
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ != <span style="color: #008b8b;">NULL</span>) FREE ($group$->$group_dset$);
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_NUM</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_DSET_STR</span>
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ != <span style="color: #008b8b;">NULL</span>) {
|
|
<span style="color: #a020f0;">if</span>($group$->rank_$group_dset$ != 0) FREE ($group$->$group_dset$[0]);
|
|
FREE ($group$->$group_dset$);
|
|
}
|
|
// <span style="color: #b22222;">END REPEAT GROUP_DSET_STR</span>
|
|
|
|
// <span style="color: #b22222;">START REPEAT GROUP_ATTR_STR</span>
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_str$ != <span style="color: #008b8b;">NULL</span>) FREE ($group$->$group_str$);
|
|
// <span style="color: #b22222;">END REPEAT GROUP_ATTR_STR</span>
|
|
|
|
FREE ($group$);
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org9cec566" class="outline-3">
|
|
<h3 id="org9cec566"><span class="section-number-3">1.8</span> Template for has/read/write the numerical attribute</h3>
|
|
<div class="outline-text-3" id="text-1-8">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_read_$group_num$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, $group_num_dtype_double$* <span style="color: #a020f0;">const</span> num)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (num == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
$group$_t* $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
*num = $group$->$group_num$;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_write_$group_num$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #a020f0;">const</span> $group_num_dtype_double$ num)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (file->mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
|
|
$group$_t* $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
$group$->$group_num$ = num;
|
|
$group$->$group_num$_isSet = <span style="color: #008b8b;">true</span>;
|
|
$group$->to_flush = 1;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_has_$group_num$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
$group$_t* $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_num$_isSet == <span style="color: #008b8b;">true</span>){
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_HAS_NOT;
|
|
}
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="outline-container-org7d78a0e" class="outline-3">
|
|
<h3 id="org7d78a0e"><span class="section-number-3">1.9</span> Template for has/read/write the dataset of numerical data</h3>
|
|
<div class="outline-text-3" id="text-1-9">
|
|
<p>
|
|
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_read_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, $group_dset_dtype$* <span style="color: #a020f0;">const</span> $group_dset$,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">rank</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">dims</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> ($group_dset$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> (rank != $group$->rank_$group_dset$) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_3;
|
|
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">dim_size</span> = 1;
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">i</span>=0; i<rank; ++i){
|
|
<span style="color: #a020f0;">if</span> (dims[i] != $group$->dims_$group_dset$[i]) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_4;
|
|
dim_size *= dims[i];
|
|
}
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<dim_size ; ++i) {
|
|
$group_dset$[i] = $group$->$group_dset$[i];
|
|
}
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_write_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #a020f0;">const</span> $group_dset_dtype$* $group_dset$,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">rank</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">dims</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> ($group_dset$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
<span style="color: #a020f0;">if</span> (file->mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ != <span style="color: #008b8b;">NULL</span>) {
|
|
FREE($group$->$group_dset$);
|
|
}
|
|
|
|
$group$->rank_$group_dset$ = rank;
|
|
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">dim_size</span> = 1;
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">i</span>=0; i<$group$->rank_$group_dset$; ++i){
|
|
$group$->dims_$group_dset$[i] = dims[i];
|
|
dim_size *= dims[i];
|
|
}
|
|
|
|
$group$->$group_dset$ = CALLOC(dim_size, $group_dset_dtype$);
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<dim_size ; ++i) {
|
|
$group$->$group_dset$[i] = $group_dset$[i];
|
|
}
|
|
|
|
$group$->to_flush = 1;
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_has_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->rank_$group_dset$ > 0){
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_HAS_NOT;
|
|
}
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org48c90d0" class="outline-3">
|
|
<h3 id="org48c90d0"><span class="section-number-3">1.10</span> Template for has/read/write the dataset of strings</h3>
|
|
<div class="outline-text-3" id="text-1-10">
|
|
<p>
|
|
The <code>group_dset</code> array is assumed allocated with the appropriate size.
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_read_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #228b22;">char</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">dset</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">rank</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">dims</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">max_str_len</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (dset == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> (rank != $group$->rank_$group_dset$) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_3;
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">i</span>=0 ; i<rank ; ++i) {
|
|
<span style="color: #a020f0;">if</span> (dims[i] != $group$->dims_$group_dset$[i]) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_4;
|
|
}
|
|
|
|
strcpy(dset, <span style="color: #8b2252;">""</span>);
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<dims[0] ; ++i) {
|
|
strncat(dset, $group$->$group_dset$[i], max_str_len);
|
|
strcat(dset, TREXIO_DELIM);
|
|
}
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_write_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span>** <span style="color: #a0522d;">dset</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">rank</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint64_t</span>* <span style="color: #a0522d;">dims</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (dset == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
<span style="color: #a020f0;">if</span> (file->mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ != <span style="color: #008b8b;">NULL</span>) {
|
|
<span style="color: #a020f0;">if</span> ($group$->rank_$group_dset$ != 0) FREE($group$->$group_dset$[0]);
|
|
FREE($group$->$group_dset$);
|
|
}
|
|
|
|
$group$->rank_$group_dset$ = rank;
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">i</span>=0; i<$group$->rank_$group_dset$; ++i){
|
|
$group$->dims_$group_dset$[i] = dims[i];
|
|
}
|
|
|
|
$group$->$group_dset$ = CALLOC(dims[0], <span style="color: #228b22;">char</span>*);
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_dset$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_ALLOCATION_FAILED;
|
|
|
|
<span style="color: #228b22;">char</span>* <span style="color: #a0522d;">tmp_str</span> = CALLOC(dims[0]*32 + 1, <span style="color: #228b22;">char</span>);
|
|
<span style="color: #a020f0;">if</span> (tmp_str == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_ALLOCATION_FAILED;
|
|
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0 ; i<dims[0] ; ++i) {
|
|
<span style="color: #228b22;">size_t</span> <span style="color: #a0522d;">tmp_len</span> = strlen(dset[i]);
|
|
$group$->$group_dset$[i] = tmp_str;
|
|
strncpy(tmp_str, dset[i], tmp_len);
|
|
tmp_str += tmp_len + 1;
|
|
}
|
|
|
|
$group$->to_flush = 1;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_has_$group_dset$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->rank_$group_dset$ > 0){
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_HAS_NOT;
|
|
}
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org73cced3" class="outline-3">
|
|
<h3 id="org73cced3"><span class="section-number-3">1.11</span> Template for has/read/write the string attribute</h3>
|
|
<div class="outline-text-3" id="text-1-11">
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_read_$group_str$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #228b22;">char</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">str</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">uint32_t</span> <span style="color: #a0522d;">max_str_len</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (str == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
strncpy(str, $group$->$group_str$, max_str_len);
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_write_$group_str$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> *<span style="color: #a0522d;">str</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (str == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_2;
|
|
|
|
<span style="color: #a020f0;">if</span> (file->mode == <span style="color: #8b2252;">'r'</span>) <span style="color: #a020f0;">return</span> TREXIO_READONLY;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_str$ != <span style="color: #008b8b;">NULL</span>) FREE($group$->$group_str$);
|
|
|
|
<span style="color: #228b22;">size_t</span> <span style="color: #a0522d;">tmp_len</span> = strlen(str);
|
|
|
|
$group$->$group_str$ = CALLOC(tmp_len + 1, <span style="color: #228b22;">char</span>);
|
|
<span style="color: #a020f0;">if</span> ($group$->$group_str$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_ALLOCATION_FAILED;
|
|
|
|
$group$->len_$group_str$ = tmp_len + 1;
|
|
|
|
strncpy($group$->$group_str$, str, tmp_len + 1);
|
|
|
|
$group$->to_flush = 1;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span>
|
|
<span style="color: #0000ff;">trexio_text_has_$group_str$</span> (<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
$group$_t* <span style="color: #a020f0;">const</span> $group$ = trexio_text_read_$group$((<span style="color: #228b22;">trexio_text_t</span>*) file);
|
|
<span style="color: #a020f0;">if</span> ($group$ == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
|
|
<span style="color: #a020f0;">if</span> ($group$->len_$group_str$ > 0){
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_HAS_NOT;
|
|
}
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-org563b98f" class="outline-3">
|
|
<h3 id="org563b98f"><span class="section-number-3">1.12</span> Template for has/read/write the dataset of sparse data</h3>
|
|
<div class="outline-text-3" id="text-1-12">
|
|
<p>
|
|
Each sparse array is stored in a separate <code>.txt</code> file due to the fact that sparse I/O has to be decoupled
|
|
from conventional write/read/flush behaviour of the TEXT back end. Chunks are used to read/write sparse data
|
|
to prevent memory overflow. Chunks have a given <code>int64_t size</code>
|
|
(size specifies the number of sparse data items, e.g. integrals).
|
|
</p>
|
|
|
|
<p>
|
|
User provides indices and values of the sparse array as two separate variables.
|
|
</p>
|
|
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_write_$group_dset$</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">offset_file</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_start</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int32_t</span>* <span style="color: #a0522d;">index_sparse</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">double</span>* <span style="color: #a0522d;">value_sparse</span>)
|
|
{
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
/* <span style="color: #b22222;">Build the name of the file with sparse data</span>*/
|
|
/* <span style="color: #b22222;">The $group_dset$.txt is limited to 256 symbols for the moment. What are the chances that it will exceed? </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> $group_dset$_file_name[256] = <span style="color: #8b2252;">"/$group_dset$.txt"</span>;
|
|
/* <span style="color: #b22222;">The full path to the destination TXT file with sparse data. This will include TREXIO directory name. </span>*/
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_full_path</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
|
|
/* <span style="color: #b22222;">Copy directory name in file_full_path </span>*/
|
|
strncpy (file_full_path, file->file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
/* <span style="color: #b22222;">Append name of the file with sparse data </span>*/
|
|
strncat (file_full_path, $group_dset$_file_name,
|
|
TREXIO_MAX_FILENAME_LENGTH-strlen($group_dset$_file_name));
|
|
|
|
/* <span style="color: #b22222;">Open the file in "a" (append) mode to guarantee that no truncation happens upon consecutive writes </span>*/
|
|
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen(file_full_path, <span style="color: #8b2252;">"a"</span>);
|
|
<span style="color: #a020f0;">if</span>(f == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
|
|
/* <span style="color: #b22222;">Specify the line length in order to offset properly. For example, for 4-index quantities</span>
|
|
<span style="color: #b22222;"> the line_length is 69 because 10 per index + 4 spaces + 24 for floating point value + 1 for the new line char.</span>
|
|
<span style="color: #b22222;"> CURRENTLY NO OFFSET IS USED WHEN WRITING !</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">line_length</span> = 0L;
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">format_str</span>[256];
|
|
|
|
/* <span style="color: #b22222;">Determine the optimal type for storing indices depending on the size_max (usually mo_num or ao_num) </span>*/
|
|
<span style="color: #a020f0;">if</span> (size_max < UINT8_MAX) {
|
|
line_length = $sparse_line_length_8$; // <span style="color: #b22222;">41 for 4 indices</span>
|
|
strncpy(format_str, $sparse_format_printf_8$, 256);
|
|
} <span style="color: #a020f0;">else</span> <span style="color: #a020f0;">if</span> (size_max < UINT16_MAX) {
|
|
line_length = $sparse_line_length_16$; // <span style="color: #b22222;">49 for 4 indices</span>
|
|
strncpy(format_str, $sparse_format_printf_16$, 256);
|
|
} <span style="color: #a020f0;">else</span> {
|
|
line_length = $sparse_line_length_32$; //<span style="color: #b22222;">69 for 4 indices</span>
|
|
strncpy(format_str, $sparse_format_printf_32$, 256);
|
|
}
|
|
strncat(format_str, <span style="color: #8b2252;">"\n"</span>, 2);
|
|
|
|
/* <span style="color: #b22222;">Get the starting position of the IO stream to be written in the .size file.</span>
|
|
<span style="color: #b22222;"> This is error-prone due to the fact that for large files (>2 GB) in 32-bit systems ftell will fail.</span>
|
|
<span style="color: #b22222;"> One can use ftello function which is adapted for large files.</span>
|
|
<span style="color: #b22222;"> For now, we can use front-end-provided size_start, which has been checked for INT64_MAX overflow.</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">io_start_pos</span> = size_start * line_length;
|
|
|
|
/* <span style="color: #b22222;">Write the data in the file and check the return code of fprintf to verify that > 0 bytes have been written </span>*/
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span>;
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0UL; i < (<span style="color: #228b22;">uint64_t</span>) size; ++i) {
|
|
rc = fprintf(f, format_str,
|
|
$group_dset_sparse_indices_printf$,
|
|
*(value_sparse + i));
|
|
<span style="color: #a020f0;">if</span>(rc <= 0) {
|
|
fclose(f);
|
|
<span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
}
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Close the TXT file </span>*/
|
|
rc = fclose(f);
|
|
<span style="color: #a020f0;">if</span> (rc != 0) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
/* <span style="color: #b22222;">Append .size to the file_full_path in order to write additional info about the written buffer of data </span>*/
|
|
strncat(file_full_path, <span style="color: #8b2252;">".size"</span>, 6);
|
|
|
|
/* <span style="color: #b22222;">Open the new file in "a" (append) mode to append info about the buffer that has been just written </span>*/
|
|
<span style="color: #228b22;">FILE</span> *<span style="color: #a0522d;">f_wSize</span> = fopen(file_full_path, <span style="color: #8b2252;">"a"</span>);
|
|
<span style="color: #a020f0;">if</span> (f_wSize == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
/* <span style="color: #b22222;">Write the buffer_size </span>*/
|
|
rc = fprintf(f_wSize, <span style="color: #8b2252;">"%"</span> PRId64 <span style="color: #8b2252;">" %"</span> PRId64 <span style="color: #8b2252;">"\n"</span>, size, io_start_pos);
|
|
<span style="color: #a020f0;">if</span> (rc <= 0) {
|
|
fclose(f_wSize);
|
|
<span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Close the TXT file </span>*/
|
|
rc = fclose(f_wSize);
|
|
<span style="color: #a020f0;">if</span> (rc != 0) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
/* <span style="color: #b22222;">Exit upon success </span>*/
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_read_$group_dset$</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">offset_file</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size</span>,
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_max</span>,
|
|
<span style="color: #228b22;">int64_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">eof_read_size</span>,
|
|
<span style="color: #228b22;">int32_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">index_sparse</span>,
|
|
<span style="color: #228b22;">double</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">value_sparse</span>)
|
|
{
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
<span style="color: #a020f0;">if</span> (eof_read_size == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_5;
|
|
|
|
/* <span style="color: #b22222;">Build the name of the file with sparse data.</span>
|
|
<span style="color: #b22222;"> The $group_dset$.txt is limited to 256 symbols for the moment. What are the chances that it will exceed?</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> $group_dset$_file_name[256] = <span style="color: #8b2252;">"/$group_dset$.txt"</span>;
|
|
/* <span style="color: #b22222;">The full path to the destination TXT file with sparse data. This will include TREXIO directory name. </span>*/
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_full_path</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
|
|
/* <span style="color: #b22222;">Copy directory name in file_full_path </span>*/
|
|
strncpy (file_full_path, file->file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
/* <span style="color: #b22222;">Append name of the file with sparse data </span>*/
|
|
strncat (file_full_path, $group_dset$_file_name,
|
|
TREXIO_MAX_FILENAME_LENGTH-strlen($group_dset$_file_name));
|
|
|
|
/* <span style="color: #b22222;">Open the file in "r" (read) mode to guarantee that no truncation happens upon consecutive reads </span>*/
|
|
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen(file_full_path, <span style="color: #8b2252;">"r"</span>);
|
|
<span style="color: #a020f0;">if</span>(f == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
/* <span style="color: #b22222;">Specify the line length in order to offset properly. For example, for 4-index quantities</span>
|
|
<span style="color: #b22222;"> the line_length is 69 because 10 per index + 4 spaces + 24 for floating point value + 1 for the new line char</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">line_length</span> = 0UL;
|
|
/* <span style="color: #b22222;">Determine the line length depending on the size_max (usually mo_num or ao_num) </span>*/
|
|
<span style="color: #a020f0;">if</span> (size_max < UINT8_MAX) {
|
|
line_length = $sparse_line_length_8$; // <span style="color: #b22222;">41 for 4 indices</span>
|
|
} <span style="color: #a020f0;">else</span> <span style="color: #a020f0;">if</span> (size_max < UINT16_MAX) {
|
|
line_length = $sparse_line_length_16$; // <span style="color: #b22222;">49 for 4 indices</span>
|
|
} <span style="color: #a020f0;">else</span> {
|
|
line_length = $sparse_line_length_32$; //<span style="color: #b22222;">69 for 4 indices</span>
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Offset in the file according to the provided value of offset_file and optimal line_length </span>*/
|
|
fseek(f, (<span style="color: #228b22;">long</span>) <span style="color: #228b22;">offset_file</span> * <span style="color: #a0522d;">line_length</span>, <span style="color: #a0522d;">SEEK_SET</span>);
|
|
|
|
/* <span style="color: #b22222;">Read the data from the file and check the return code of fprintf to verify that > 0 bytes have been read or reached EOF </span>*/
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span>;
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">buffer</span>[1024];
|
|
<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">count</span> = 0UL;
|
|
<span style="color: #a020f0;">for</span> (<span style="color: #228b22;">uint64_t</span> <span style="color: #a0522d;">i</span>=0UL; i < (<span style="color: #228b22;">uint64_t</span>) size; ++i) {
|
|
|
|
memset(buffer, 0, <span style="color: #a020f0;">sizeof</span>(buffer));
|
|
|
|
<span style="color: #a020f0;">if</span>(fgets(buffer, 1023, f) == <span style="color: #008b8b;">NULL</span>){
|
|
|
|
fclose(f);
|
|
*eof_read_size = count;
|
|
<span style="color: #a020f0;">return</span> TREXIO_END;
|
|
|
|
} <span style="color: #a020f0;">else</span> {
|
|
|
|
rc = sscanf(buffer, <span style="color: #8b2252;">"$group_dset_format_scanf$"</span>,
|
|
$group_dset_sparse_indices_scanf$,
|
|
value_sparse + i);
|
|
<span style="color: #a020f0;">if</span>(rc <= 0) {
|
|
fclose(f);
|
|
<span style="color: #a020f0;">return</span> TREXIO_FAILURE;
|
|
}
|
|
count += 1UL;
|
|
|
|
}
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Close the TXT file </span>*/
|
|
rc = fclose(f);
|
|
<span style="color: #a020f0;">if</span>(rc != 0) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_read_$group_dset$_size</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>, <span style="color: #228b22;">int64_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">size_max</span>)
|
|
{
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
/* <span style="color: #b22222;">Build the name of the file with sparse data.</span>
|
|
<span style="color: #b22222;"> The $group_dset$.txt is limited to 256 symbols for the moment. What are the chances that it will exceed?</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> $group_dset$_file_name[256] = <span style="color: #8b2252;">"/$group_dset$.txt.size"</span>;
|
|
/* <span style="color: #b22222;">The full path to the destination TXT file with sparse data. This will include TREXIO directory name. </span>*/
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_full_path</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
|
|
/* <span style="color: #b22222;">Copy directory name in file_full_path </span>*/
|
|
strncpy (file_full_path, file->file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
/* <span style="color: #b22222;">Append name of the file with sparse data </span>*/
|
|
strncat (file_full_path, $group_dset$_file_name,
|
|
TREXIO_MAX_FILENAME_LENGTH-strlen($group_dset$_file_name));
|
|
|
|
/* <span style="color: #b22222;">Open the file in "r" (read) mode to guarantee that no truncation happens upon consecutive reads </span>*/
|
|
<span style="color: #228b22;">FILE</span>* <span style="color: #a0522d;">f</span> = fopen(file_full_path, <span style="color: #8b2252;">"r"</span>);
|
|
<span style="color: #a020f0;">if</span>(f == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
|
|
/* <span style="color: #b22222;">Read the data from the file and check the return code of fprintf to verify that > 0 bytes have been read or reached EOF </span>*/
|
|
<span style="color: #228b22;">int</span> <span style="color: #a0522d;">rc</span>;
|
|
<span style="color: #228b22;">int64_t</span> <span style="color: #a0522d;">size_item</span>, <span style="color: #a0522d;">offset_item</span>, <span style="color: #a0522d;">size_accum</span>=0L;
|
|
|
|
/* <span style="color: #b22222;">Read the values from the file. BEWARE OF POSSIBLE MAX_INT64 OVERFLOW ! </span>*/
|
|
<span style="color: #a020f0;">while</span>(fscanf(f, <span style="color: #8b2252;">"%"</span> SCNd64 <span style="color: #8b2252;">" %"</span> SCNd64 <span style="color: #8b2252;">""</span>, &size_item, &offset_item) != EOF) {
|
|
/* <span style="color: #b22222;">Check that summation will not overflow the int64_t value </span>*/
|
|
<span style="color: #a020f0;">if</span> (INT64_MAX - size_accum > size_item) {
|
|
size_accum += size_item;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
fclose(f);
|
|
*size_max = -1L;
|
|
<span style="color: #a020f0;">return</span> TREXIO_INT_SIZE_OVERFLOW;
|
|
}
|
|
}
|
|
|
|
/* <span style="color: #b22222;">Close the TXT file </span>*/
|
|
rc = fclose(f);
|
|
<span style="color: #a020f0;">if</span>(rc != 0) <span style="color: #a020f0;">return</span> TREXIO_FILE_ERROR;
|
|
|
|
/* <span style="color: #b22222;">Overwrite the value at the input address and return TREXIO_SUCCESS </span>*/
|
|
*size_max = size_accum;
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-c"><span style="color: #228b22;">trexio_exit_code</span> <span style="color: #0000ff;">trexio_text_has_$group_dset$</span>(<span style="color: #228b22;">trexio_t</span>* <span style="color: #a020f0;">const</span> <span style="color: #a0522d;">file</span>)
|
|
{
|
|
<span style="color: #a020f0;">if</span> (file == <span style="color: #008b8b;">NULL</span>) <span style="color: #a020f0;">return</span> TREXIO_INVALID_ARG_1;
|
|
|
|
/* <span style="color: #b22222;">Build the name of the file with sparse data.</span>
|
|
<span style="color: #b22222;"> The $group_dset$.txt is limited to 256 symbols for the moment. What are the chances that it will exceed?</span>
|
|
<span style="color: #b22222;"> </span>*/
|
|
<span style="color: #a020f0;">const</span> <span style="color: #228b22;">char</span> $group_dset$_file_name[256] = <span style="color: #8b2252;">"/$group_dset$.txt"</span>;
|
|
/* <span style="color: #b22222;">The full path to the destination TXT file with sparse data. This will include TREXIO directory name. </span>*/
|
|
<span style="color: #228b22;">char</span> <span style="color: #a0522d;">file_full_path</span>[TREXIO_MAX_FILENAME_LENGTH];
|
|
|
|
/* <span style="color: #b22222;">Copy directory name in file_full_path </span>*/
|
|
strncpy (file_full_path, file->file_name, TREXIO_MAX_FILENAME_LENGTH);
|
|
/* <span style="color: #b22222;">Append name of the file with sparse data </span>*/
|
|
strncat (file_full_path, $group_dset$_file_name,
|
|
TREXIO_MAX_FILENAME_LENGTH-strlen($group_dset$_file_name));
|
|
|
|
/* <span style="color: #b22222;">Check the return code of access function to determine whether the file with sparse data exists or not </span>*/
|
|
<span style="color: #a020f0;">if</span> (access(file_full_path, F_OK) == 0){
|
|
<span style="color: #a020f0;">return</span> TREXIO_SUCCESS;
|
|
} <span style="color: #a020f0;">else</span> {
|
|
<span style="color: #a020f0;">return</span> TREXIO_HAS_NOT;
|
|
}
|
|
}
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="postamble" class="status">
|
|
<p class="author">Author: TREX-CoE</p>
|
|
<p class="date">Created: 2022-01-10 Mon 09:28</p>
|
|
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
|
</div>
|
|
</body>
|
|
</html>
|