/usr/include/code_saturne/cs_io.h is in code-saturne-include 3.2.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | #ifndef __CS_IO_H__
#define __CS_IO_H__
/*============================================================================
* Low level file I/O utility functions for Preprocessor and restart files
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2013 EDF S.A.
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.
This program 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 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., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_base.h"
#include "cs_file.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*=============================================================================
* Local Macro Definitions
*============================================================================*/
#define CS_IO_NAME_LEN 32 /* Section header name length */
#define CS_IO_ECHO_NONE -2 /* No verbosity at all */
#define CS_IO_ECHO_OPEN_CLOSE -1 /* Echo open or close operations */
#define CS_IO_ECHO_HEADERS 0 /* Echo headers */
/*============================================================================
* Type definitions
*============================================================================*/
/* Input or output mode */
typedef enum {
CS_IO_MODE_READ,
CS_IO_MODE_WRITE
} cs_io_mode_t;
/* Structure associated with opaque pre-processing structure object */
typedef struct _cs_io_t cs_io_t;
/* Structure used to save section header data, so as to simplify
passing this data to various functions */
typedef struct {
const char *sec_name; /* Pointer to section name */
cs_file_off_t n_vals; /* Number of associated values */
size_t location_id; /* Id of associated location, or 0 */
size_t index_id; /* Id of associated index, or 0 */
size_t n_location_vals; /* Number of values per location */
cs_datatype_t elt_type; /* Type if n_elts > 0 */
cs_datatype_t type_read; /* Type in file */
} cs_io_sec_header_t;
/*=============================================================================
* Global variables
*============================================================================*/
/* Default hints for files using this API (for MPI-IO) */
extern int cs_glob_io_hints;
/*============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Initialize a kernel IO file structure.
*
* The magic string may be NULL only in read mode;
*
* If the position of section bodies is already known (after initial
* analysis for example), the file may be opened for reading section bodies
* only by using "seek_read_section_bodies_only" as a magic string. This may
* be used to map another type of file to kernel io files, if header data is
* different but body data is similar (binary, using the same datatypes).
*
* parameters:
* name <-- file name
* magic_string <-- magic string associated with file type
* mode <-- read or write
* method <-- file access method
* echo <-- echo on main output (< 0 if none, header if 0,
* n first and last elements if n > 0)
* hints <-- associated hints for MPI-IO, or MPI_INFO_NULL
* block_comm <-- handle to MPI communicator used for distributed file
* block access (may be a subset of comm if some ranks do
* not directly access distributed data blocks)
* comm <-- handle to main MPI communicator
*
* returns:
* pointer to kernel IO structure
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI)
cs_io_t *
cs_io_initialize(const char *file_name,
const char *magic_string,
cs_io_mode_t mode,
cs_file_access_t method,
long echo,
MPI_Info hints,
MPI_Comm block_comm,
MPI_Comm comm);
#else
cs_io_t *
cs_io_initialize(const char *file_name,
const char *magic_string,
cs_io_mode_t mode,
cs_file_access_t method,
long echo);
#endif /* HAVE_MPI */
/*----------------------------------------------------------------------------
* Initialize a kernel IO file structure in read mode, building an index.
*
* The magic string may be NULL, if we choose to ignore it.
*
* parameters:
* name <-- file name
* magic_string <-- magic string associated with file type
* method <-- file access method
* echo <-- echo on main output (< 0 if none, header if 0,
* n first and last elements if n > 0)
* hints <-- associated hints for MPI-IO, or MPI_INFO_NULL
* block_comm <-- handle to MPI communicator used for distributed file
* block access (may be a subset of comm if some ranks do
* not directly access distributed data blocks)
* comm <-- handle to main MPI communicator
* returns:
* pointer to kernel IO structure
*----------------------------------------------------------------------------*/
#if defined(HAVE_MPI)
cs_io_t *
cs_io_initialize_with_index(const char *file_name,
const char *magic_string,
cs_file_access_t method,
long echo,
MPI_Info hints,
MPI_Comm block_comm,
MPI_Comm comm);
#else
cs_io_t *
cs_io_initialize_with_index(const char *file_name,
const char *magic_string,
cs_file_access_t method,
long echo);
#endif /* HAVE_MPI */
/*----------------------------------------------------------------------------
* Free a preprocessor output file structure, closing the associated file.
*
* parameters:
* pp_io <-> kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_finalize(cs_io_t **pp_io);
/*----------------------------------------------------------------------------
* Return a pointer to a preprocessor IO structure's name.
*
* parameters:
* pp_io <-- kernel IO structure
*----------------------------------------------------------------------------*/
const char *
cs_io_get_name(const cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Return the number of indexed entries in a kernel IO structure.
*
* parameters:
* inp <-- input kernel IO structure
*
* returns:
* size of index if present, 0 otherwise,
*----------------------------------------------------------------------------*/
size_t
cs_io_get_index_size(const cs_io_t *inp);
/*----------------------------------------------------------------------------
* Return the name of an indexed section in a kernel IO structure.
*
* parameters:
* inp <-- input kernel IO structure
* id <-- id of section in index (0 to n-1 numbering)
*
* returns:
* pointer to section name if id in index range, NULL otherwise
*----------------------------------------------------------------------------*/
const char *
cs_io_get_indexed_sec_name(const cs_io_t *inp,
size_t id);
/*----------------------------------------------------------------------------
* Return header data for an indexed section in a kernel IO structure.
*
* parameters:
* inp <-- input kernel IO structure
* id <-- id of section in index (0 to n-1 numbering)
*
* returns:
* section header data (if id not in index range, fields set to zero)
*----------------------------------------------------------------------------*/
cs_io_sec_header_t
cs_io_get_indexed_sec_header(const cs_io_t *inp,
size_t id);
/*----------------------------------------------------------------------------
* Return a kernel IO structure's echo (verbosity) level.
*
* parameters:
* pp_io <-- kernel IO structure
*----------------------------------------------------------------------------*/
size_t
cs_io_get_echo(const cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Read a message header.
*
* parameters:
* pp_io <-- kernel IO structure
* header --> header structure
*
* returns:
* 0 if a header was read, 1 in case of error or end-of-file
*----------------------------------------------------------------------------*/
int
cs_io_read_header(cs_io_t *inp,
cs_io_sec_header_t *header);
/*----------------------------------------------------------------------------
* Set a kernel IO's state so as to be ready to read an indexed section.
*
* The header values and position in the file are set so as to be equivalent
* to those they would have if the corresponding header had just been read.
*
* parameters:
* inp <-> input kernel IO structure
* header --> associated header
* id <-- id of section in index (0 to n-1 numbering)
*
* returns:
* 0 in case of success, 1 in case of error
*----------------------------------------------------------------------------*/
int
cs_io_set_indexed_position(cs_io_t *inp,
cs_io_sec_header_t *header,
size_t id);
/*----------------------------------------------------------------------------
* Set a message's final data type to cs_lnum_t.
*
* It the datatype is not compatible, throw an error.
*
* parameters:
* header <-- header structure
* pp_io --> kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_set_cs_lnum(cs_io_sec_header_t *header,
const cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Set a message's final data type to cs_gnum_t.
*
* It the datatype is not compatible, throw an error.
*
* parameters:
* header <-> header structure
* pp_io <-- kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_set_cs_gnum(cs_io_sec_header_t *header,
const cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Check that a message's final data type corresponds to cs_real_t.
*
* parameters:
* header <-- header structure
* pp_io <-- kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_assert_cs_real(const cs_io_sec_header_t *header,
const cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Read a message body and replicate it to all processors.
*
* If the array intended to receive the data already exists, we pass an
* "elt" pointer to this array; this same pointer is then returned.
* Otherwise, if this pointer is passed as NULL, memory is allocated
* by this function, and the corresponding pointer is returned. It is
* the caller's responsibility to free this array.
*
* parameters:
* header <-- header structure
* elts <-> pointer to data array, or NULL
* pp_io --> kernel IO structure
*
* returns:
* elts if non NULL, or pointer to allocated array otherwise
*----------------------------------------------------------------------------*/
void *
cs_io_read_global(const cs_io_sec_header_t *header,
void *elts,
cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Read a message body, assigning a different block to each processor.
*
* If location_id > 0 and header->n_location_vals > 1, then
* global_num_start and global_num_end will be based on location element
* numbers, so the total number of values read equals
* (global_num_end - global_num_start) * header->n_location_vals.
*
* If the array intended to receive the data already exists, we pass an
* "elt" pointer to this array; this same pointer is then returned.
* Otherwise, if this pointer is passed as NULL, memory is allocated
* by this function, and the corresponding pointer is returned. It is
* the caller's responsibility to free this array.
*
* parameters:
* header <-- header structure
* global_num_start <-- global number of first block item (1 to n numbering)
* global_num_end <-- global number of past-the end block item
* (1 to n numbering)
* elts <-> pointer to data array, or NULL
* pp_io --> kernel IO structure
*
* returns:
* elts if non NULL, or pointer to allocated array otherwise
*----------------------------------------------------------------------------*/
void *
cs_io_read_block(const cs_io_sec_header_t *header,
cs_gnum_t global_num_start,
cs_gnum_t global_num_end,
void *elts,
cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Read a message body, assigning a different block to each processor,
* when the body corresponds to an index.
*
* In serial mode, this function behaves just like cs_io_read_block(),
* except that it allows only unsigned integer values (cs_gnum_t).
*
* In parallel mode, global_num_end should be set to the past-the-end value
* of the base data block, the same as for regular data (and not increased
* by 1 for the last rank, as this will be handled internally).
* On each rank, the buffer size should be:
* global_num_end - global_num_start + 1, as the past-the end index
* for the local block is added automatically.
*
* If the array intended to receive the data already exists, we pass an
* "elt" pointer to this array; this same pointer is then returned.
* Otherwise, if this pointer is passed as NULL, memory is allocated
* by this function, and the corresponding pointer is returned. It is
* the caller's responsibility to free this array.
*
* parameters:
* header <-- header structure
* global_num_start <-- global number of first block item (1 to n numbering)
* global_num_end <-- global number of past-the end block item
* (1 to n numbering)
* elts <-> pointer to data array, or NULL
* pp_io --> kernel IO structure
*
* returns:
* elts if non NULL, or pointer to allocated array otherwise
*----------------------------------------------------------------------------*/
void *
cs_io_read_index_block(cs_io_sec_header_t *header,
cs_gnum_t global_num_start,
cs_gnum_t global_num_end,
cs_gnum_t *elts,
cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Write a global section.
*
* Under MPI, data is only written by the associated communicator's root
* rank. The section data on other ranks is ignored, though the file offset
* is updated (i.e. the call to this function is collective).
*
* parameters:
* section_name <-- section name
* n_vals <-- total number of values
* location_id <-- id of associated location, or 0
* index_id <-- id of associated index, or 0
* n_location_vals <-- number of values per location
* elt_type <-- element type
* elts <-- pointer to element data
* outp <-> output kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_write_global(const char *sec_name,
cs_gnum_t n_vals,
size_t location_id,
size_t index_id,
size_t n_location_vals,
cs_datatype_t elt_type,
const void *elts,
cs_io_t *outp);
/*----------------------------------------------------------------------------
* Write a section to file, each associated process providing a contiguous
* of the section's body.
*
* Each process should provide a (possibly empty) block of the body,
* and we should have:
* global_num_start at rank 0 = 1
* global_num_start at rank i+1 = global_num_end at rank i.
* Otherwise, behavior (especially positioning for future reads) is undefined.
*
* If location_id > 0 and n_location_vals > 1, then global_num_start
* and global_num_end will be based on location element numbers, so the
* total number of values read equals
* (global_num_end - global_num_start) * header->n_location_vals.
*
* This function does not modify the values in its input buffer (notably,
* a copy is used to convert from little-endian to big-endian or vice-versa
* if necessary).
*
* parameters:
* section_name <-- section name
* n_g_elts <-- number of global elements (locations)
* global_num_start <-- global number of first block item (1 to n numbering)
* global_num_end <-- global number of past-the end block item
* location_id <-- id of associated location, or 0
* index_id <-- id of associated index, or 0
* n_location_vals <-- number of values per location
* elt_type <-- element type
* (1 to n numbering)
* elts <-- pointer to element data
* outp <-> output kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_write_block(const char *sec_name,
cs_gnum_t n_g_elts,
cs_gnum_t global_num_start,
cs_gnum_t global_num_end,
size_t location_id,
size_t index_id,
size_t n_location_vals,
cs_datatype_t elt_type,
const void *elts,
cs_io_t *outp);
/*----------------------------------------------------------------------------
* Write a section to file, each associated process providing a contiguous
* of the section's body.
*
* Each process should provide a (possibly empty) block of the body,
* and we should have:
* global_num_start at rank 0 = 1
* global_num_start at rank i+1 = global_num_end at rank i.
* Otherwise, behavior (especially positioning for future reads) is undefined.
*
* If location_id > 0 and n_location_vals > 1, then global_num_start
* and global_num_end will be based on location element numbers, so the
* total number of values read equals
* (global_num_end - global_num_start) * header->n_location_vals.
*
* This function is intended to be used mainly on data that is already of
* copy of original data (such as data that has been redistributed across
* processors just for the sake of output), or that is to be deleted after
* writing, so it may modify the values in its input buffer (notably to
* convert from little-endian to big-endian or vice-versa if necessary).
*
* parameters:
* section_name <-- section name
* n_g_elts <-- number of global elements (locations)
* global_num_start <-- global number of first block item (1 to n numbering)
* global_num_end <-- global number of past-the end block item
* location_id <-- id of associated location, or 0
* index_id <-- id of associated index, or 0
* n_location_vals <-- number of values per location
* elt_type <-- element type
* (1 to n numbering)
* elts <-- pointer to element data
* outp <-> output kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_write_block_buffer(const char *sec_name,
cs_gnum_t n_g_elts,
cs_gnum_t global_num_start,
cs_gnum_t global_num_end,
size_t location_id,
size_t index_id,
size_t n_location_vals,
cs_datatype_t elt_type,
void *elts,
cs_io_t *outp);
/*----------------------------------------------------------------------------
* Skip a message.
*
* parameters:
* header <-- header structure
* pp_io --> kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_skip(const cs_io_sec_header_t *header,
cs_io_t *pp_io);
/*----------------------------------------------------------------------------
* Return the position of the file pointer for an open kernel IO file.
*
* parameters:
* inp <-- input kernel IO structure
*
* returns:
* offset in file
*----------------------------------------------------------------------------*/
cs_file_off_t
cs_io_get_offset(cs_io_t *inp);
/*----------------------------------------------------------------------------
* Set the position of the file pointer for an open kernel IO file.
*
* parameters:
* inp <-- input kernel IO structure
* offset <-- offset in file
*----------------------------------------------------------------------------*/
void
cs_io_set_offset(cs_io_t *inp,
cs_file_off_t offset);
/*----------------------------------------------------------------------------
* Initialize performance logging for cs_io_t structures.
*----------------------------------------------------------------------------*/
void
cs_io_log_initialize(void);
/*----------------------------------------------------------------------------
* Finalize performance logging for cs_io_t structures.
*----------------------------------------------------------------------------*/
void
cs_io_log_finalize(void);
/*----------------------------------------------------------------------------
* Dump a kernel IO file handle's metadata.
*
* parameters:
* cs_io <-- kernel IO structure
*----------------------------------------------------------------------------*/
void
cs_io_dump(const cs_io_t *cs_io);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_IO_H__ */
|