libio_

   1# This file was automatically generated by SWIG (https://www.swig.org).
   2# Version 4.2.1
   3#
   4# Do not make changes to this file unless you know what you are doing - modify
   5# the SWIG interface file instead.
   6
   7from sys import version_info as _swig_python_version_info
   8from mock_rtems import _libio_ as _libio_
   9
  10try:
  11    import builtins as __builtin__
  12except ImportError:
  13    import __builtin__
  14
  15def _swig_repr(self):
  16    try:
  17        strthis = "proxy of " + self.this.__repr__()
  18    except __builtin__.Exception:
  19        strthis = ""
  20    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
  21
  22
  23def _swig_setattr_nondynamic_instance_variable(set):
  24    def set_instance_attr(self, name, value):
  25        if name == "this":
  26            set(self, name, value)
  27        elif name == "thisown":
  28            self.this.own(value)
  29        elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
  30            set(self, name, value)
  31        else:
  32            raise AttributeError("You cannot add instance attributes to %s" % self)
  33    return set_instance_attr
  34
  35
  36def _swig_setattr_nondynamic_class_variable(set):
  37    def set_class_attr(cls, name, value):
  38        if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
  39            set(cls, name, value)
  40        else:
  41            raise AttributeError("You cannot add class attributes to %s" % cls)
  42    return set_class_attr
  43
  44
  45def _swig_add_metaclass(metaclass):
  46    """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
  47    def wrapper(cls):
  48        return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
  49    return wrapper
  50
  51
  52class _SwigNonDynamicMeta(type):
  53    """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
  54    __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
  55
  56
  57RTEMS_FILESYSTEM_SYMLOOP_MAX = _libio_.RTEMS_FILESYSTEM_SYMLOOP_MAX
  58r"""*"""
  59F_DUP2FD = _libio_.F_DUP2FD
  60
  61
  62def rtems_libio_iop_flags_set(iop, set):
  63    r"""
  64    Sets the specified flags in the iop.
  65
  66    :type iop: rtems_libio_t, in
  67    :param iop: The iop.
  68    :type set: int, in
  69    :param set: The flags to set.
  70
  71    :rtype: int
  72    :return: The previous flags.
  73    """
  74    return _libio_.rtems_libio_iop_flags_set(iop, set)
  75
  76def rtems_libio_iop_flags_clear(iop, clear):
  77    r"""
  78    Clears the specified flags in the iop.
  79
  80    :type iop: rtems_libio_t, in
  81    :param iop: The iop.
  82    :type clear: int, in
  83    :param clear: The flags to clear.
  84
  85    :rtype: int
  86    :return: The previous flags.
  87    """
  88    return _libio_.rtems_libio_iop_flags_clear(iop, clear)
  89
  90def rtems_libio_iop(fd):
  91    r"""
  92    Maps a file descriptor to the iop.
  93
  94    The file descriptor must be a valid index into the iop table.
  95
  96    :type fd: int, in
  97    :param fd: The file descriptor.
  98
  99    :rtype: rtems_libio_t
 100    :return: The iop corresponding to the specified file descriptor.
 101    """
 102    return _libio_.rtems_libio_iop(fd)
 103
 104def rtems_libio_iop_hold(iop):
 105    r"""
 106    Holds a refernece to the iop.
 107
 108    :type iop: rtems_libio_t, in
 109    :param iop: The iop.
 110
 111    :rtype: int
 112    :return: The flags corresponding to the specified iop.
 113    """
 114    return _libio_.rtems_libio_iop_hold(iop)
 115
 116def rtems_libio_iop_drop(iop):
 117    r"""
 118    Drops a refernece to the iop.
 119
 120    :type iop: rtems_libio_t, in
 121    :param iop: The iop.
 122    """
 123    return _libio_.rtems_libio_iop_drop(iop)
 124
 125def rtems_filesystem_location_clone(clone, master):
 126    r"""
 127    Macro to get the iop for the specified file descriptor.
 128
 129    Checks that the file descriptor is in the valid range and open.
 130
 131    Macro to get the iop for the specified file descriptor with access
 132    flags and error.
 133
 134    Checks that the file descriptor is in the valid range and open.
 135
 136    Clones a node.
 137
 138    The caller must hold the file system instance lock.
 139
 140    :type clone: rtems_filesystem_location_info_t, out
 141    :param clone: The cloned location.
 142    :type master: rtems_filesystem_location_info_t, in
 143    :param master: The master location.
 144
 145    See also: rtems_filesystem_instance_lock().
 146    """
 147    return _libio_.rtems_filesystem_location_clone(clone, master)
 148
 149def rtems_filesystem_location_free(loc):
 150    r"""
 151    Releases all resources of a location.
 152
 153    This function may block on a mutex and may complete an unmount process.
 154
 155    :type loc: rtems_filesystem_location_info_t, in
 156    :param loc: The location to free.
 157
 158    Notes: The file system root location is released by the file system
 159    instance destruction handler (see 'rtems_filesystem_fsunmount_me_t)'.
 160
 161    See also: rtems_filesystem_freenode_t.
 162    """
 163    return _libio_.rtems_filesystem_location_free(loc)
 164
 165def rtems_libio_lock():
 166    r"""rtems_libio_lock()"""
 167    return _libio_.rtems_libio_lock()
 168
 169def rtems_libio_unlock():
 170    r"""rtems_libio_unlock()"""
 171    return _libio_.rtems_libio_unlock()
 172
 173def rtems_filesystem_mt_lock():
 174    r"""rtems_filesystem_mt_lock()"""
 175    return _libio_.rtems_filesystem_mt_lock()
 176
 177def rtems_filesystem_mt_unlock():
 178    r"""rtems_filesystem_mt_unlock()"""
 179    return _libio_.rtems_filesystem_mt_unlock()
 180
 181def rtems_filesystem_instance_lock(loc):
 182    r"""
 183    rtems_filesystem_instance_lock(rtems_filesystem_location_info_t const * loc)
 184
 185    Parameters
 186    ----------
 187    loc: rtems_filesystem_location_info_t const *
 188
 189    """
 190    return _libio_.rtems_filesystem_instance_lock(loc)
 191
 192def rtems_filesystem_instance_unlock(loc):
 193    r"""
 194    rtems_filesystem_instance_unlock(rtems_filesystem_location_info_t const * loc)
 195
 196    Parameters
 197    ----------
 198    loc: rtems_filesystem_location_info_t const *
 199
 200    """
 201    return _libio_.rtems_filesystem_instance_unlock(loc)
 202
 203def rtems_filesystem_utime_tv_nsec_valid(time):
 204    r"""
 205    Checks the tv_nsec member of a timespec struct
 206
 207    This function is used with utimensat() and futimens() only. This ensures
 208    that the value in the tv_nsec member is equal to either UTIME_NOW,
 209    UTIME_OMIT, or a value greater-than or equal to zero and less than a
 210    billion.
 211
 212    :type time: struct timespec, in
 213    :param time: The timespec struct to be validated
 214    """
 215    return _libio_.rtems_filesystem_utime_tv_nsec_valid(time)
 216
 217def rtems_filesystem_utime_check_permissions(currentloc, times):
 218    r"""
 219    Checks for errors and if the process has write permissions to the file.
 220
 221    This function is only used with utimensat() and futimens().It checks for
 222    EACCES and EPERM errors depending on what values are in *times* and if the
 223    process has write permissions to the file.
 224
 225    :type currentloc: rtems_filesystem_location_info_t, in
 226    :param currentloc: The current location to a file
 227    :type times: struct timespec, in
 228    :param times: The timespecs used to check for errors. The timespec at
 229                         index 0 is the access time, and the timespec at index 1 is
 230                         the modification time.
 231    """
 232    return _libio_.rtems_filesystem_utime_check_permissions(currentloc, times)
 233
 234def rtems_filesystem_utime_update(times, new_times):
 235    r"""
 236    Checks *times* and fills *new_times* with the time to be written
 237
 238    This function is only used with utimensat() and futimens(). *times* contains
 239    the constant values passed into utimensat/futimens. *new_times* contains the
 240    values that will be written to the file. These values depend on *times*. If
 241    *times* is NULL, or either of its elements' tv_nsec members are UTIME_NOW,
 242    the current elapsed time in nanoseconds will be saved in the corresponding
 243    location in *new_times*.
 244
 245    For each of the arguments, the timespec at index 0 is the access time, and
 246    the timespec at index 1 is the modification time.
 247
 248    :type times: struct timespec, in
 249    :param times: The timespecs to be checked
 250    :type new_times: struct timespec, out
 251    :param new_times: The timespecs containing the time to be written
 252    """
 253    return _libio_.rtems_filesystem_utime_update(times, new_times)
 254
 255def rtems_libio_allocate():
 256    r"""
 257    This routine searches the IOP Table for an unused entry.  If it
 258    finds one, it returns it.  Otherwise, it returns NULL.
 259    """
 260    return _libio_.rtems_libio_allocate()
 261
 262def rtems_libio_fcntl_flags(fcntl_flags):
 263    r"""Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand"""
 264    return _libio_.rtems_libio_fcntl_flags(fcntl_flags)
 265
 266def rtems_libio_to_fcntl_flags(flags):
 267    r"""Convert RTEMS internal flags to UNIX fnctl(2) flags"""
 268    return _libio_.rtems_libio_to_fcntl_flags(flags)
 269
 270def rtems_libio_free(iop):
 271    r"""
 272    This routine frees the resources associated with an IOP (file descriptor)
 273    and clears the slot in the IOP Table.
 274    """
 275    return _libio_.rtems_libio_free(iop)
 276
 277def rtems_libio_count_open_iops():
 278    r"""Return the number of open iop descriptors"""
 279    return _libio_.rtems_libio_count_open_iops()
 280
 281def rtems_filesystem_eval_path_start(ctx, path, eval_flags):
 282    r"""
 283    rtems_filesystem_eval_path_start(rtems_filesystem_eval_path_context_t * ctx, char const * path, int eval_flags) -> rtems_filesystem_location_info_t *
 284
 285    Parameters
 286    ----------
 287    ctx: rtems_filesystem_eval_path_context_t *
 288    path: char const *
 289    eval_flags: int
 290
 291    """
 292    return _libio_.rtems_filesystem_eval_path_start(ctx, path, eval_flags)
 293
 294def rtems_filesystem_eval_path_start_with_parent(ctx, path, eval_flags, parentloc, parent_eval_flags):
 295    r"""
 296    rtems_filesystem_eval_path_start_with_parent(rtems_filesystem_eval_path_context_t * ctx, char const * path, int eval_flags, rtems_filesystem_location_info_t * parentloc, int parent_eval_flags) -> rtems_filesystem_location_info_t *
 297
 298    Parameters
 299    ----------
 300    ctx: rtems_filesystem_eval_path_context_t *
 301    path: char const *
 302    eval_flags: int
 303    parentloc: rtems_filesystem_location_info_t *
 304    parent_eval_flags: int
 305
 306    """
 307    return _libio_.rtems_filesystem_eval_path_start_with_parent(ctx, path, eval_flags, parentloc, parent_eval_flags)
 308
 309def rtems_filesystem_eval_path_start_with_root_and_current(ctx, path, pathlen, eval_flags, global_root_ptr, global_current_ptr):
 310    r"""
 311    rtems_filesystem_eval_path_start_with_root_and_current(rtems_filesystem_eval_path_context_t * ctx, char const * path, size_t pathlen, int eval_flags, rtems_filesystem_global_location_t *const * global_root_ptr, rtems_filesystem_global_location_t *const * global_current_ptr) -> rtems_filesystem_location_info_t *
 312
 313    Parameters
 314    ----------
 315    ctx: rtems_filesystem_eval_path_context_t *
 316    path: char const *
 317    pathlen: size_t
 318    eval_flags: int
 319    global_root_ptr: rtems_filesystem_global_location_t *const *
 320    global_current_ptr: rtems_filesystem_global_location_t *const *
 321
 322    """
 323    return _libio_.rtems_filesystem_eval_path_start_with_root_and_current(ctx, path, pathlen, eval_flags, global_root_ptr, global_current_ptr)
 324
 325def rtems_filesystem_eval_path_continue(ctx):
 326    r"""
 327    rtems_filesystem_eval_path_continue(rtems_filesystem_eval_path_context_t * ctx)
 328
 329    Parameters
 330    ----------
 331    ctx: rtems_filesystem_eval_path_context_t *
 332
 333    """
 334    return _libio_.rtems_filesystem_eval_path_continue(ctx)
 335
 336def rtems_filesystem_eval_path_cleanup(ctx):
 337    r"""
 338    rtems_filesystem_eval_path_cleanup(rtems_filesystem_eval_path_context_t * ctx)
 339
 340    Parameters
 341    ----------
 342    ctx: rtems_filesystem_eval_path_context_t *
 343
 344    """
 345    return _libio_.rtems_filesystem_eval_path_cleanup(ctx)
 346
 347def rtems_filesystem_eval_path_recursive(ctx, path, pathlen):
 348    r"""
 349    rtems_filesystem_eval_path_recursive(rtems_filesystem_eval_path_context_t * ctx, char const * path, size_t pathlen)
 350
 351    Parameters
 352    ----------
 353    ctx: rtems_filesystem_eval_path_context_t *
 354    path: char const *
 355    pathlen: size_t
 356
 357    """
 358    return _libio_.rtems_filesystem_eval_path_recursive(ctx, path, pathlen)
 359
 360def rtems_filesystem_eval_path_cleanup_with_parent(ctx, parentloc):
 361    r"""
 362    rtems_filesystem_eval_path_cleanup_with_parent(rtems_filesystem_eval_path_context_t * ctx, rtems_filesystem_location_info_t * parentloc)
 363
 364    Parameters
 365    ----------
 366    ctx: rtems_filesystem_eval_path_context_t *
 367    parentloc: rtems_filesystem_location_info_t *
 368
 369    """
 370    return _libio_.rtems_filesystem_eval_path_cleanup_with_parent(ctx, parentloc)
 371
 372def rtems_filesystem_eval_path_restart(ctx, newstartloc_ptr):
 373    r"""
 374    Requests a path evaluation restart.
 375
 376    Sets the start and current location to the new start location.  The caller
 377    must terminate its current evaluation process.  The path evaluation
 378    continues in the next loop iteration within
 379    rtems_filesystem_eval_path_continue().  This avoids recursive invocations.
 380    The function obtains the new start location and clones it to set the new
 381    current location.  The previous start and current locations are released.
 382
 383    :param out]: ctx The path evaluation context.
 384    :param out]: newstartloc_ptr Pointer to the new start location.
 385    """
 386    return _libio_.rtems_filesystem_eval_path_restart(ctx, newstartloc_ptr)
 387RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_CONTINUE = _libio_.RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_CONTINUE
 388
 389RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_DONE = _libio_.RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_DONE
 390
 391RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_NO_ENTRY = _libio_.RTEMS_FILESYSTEM_EVAL_PATH_GENERIC_NO_ENTRY
 392
 393class rtems_filesystem_eval_path_generic_config(object):
 394    r"""Proxy of C rtems_filesystem_eval_path_generic_config struct."""
 395
 396    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 397    __repr__ = _swig_repr
 398    is_directory = property(_libio_.rtems_filesystem_eval_path_generic_config_is_directory_get, _libio_.rtems_filesystem_eval_path_generic_config_is_directory_set, doc=r"""is_directory : rtems_filesystem_eval_path_is_directory""")
 399    eval_token = property(_libio_.rtems_filesystem_eval_path_generic_config_eval_token_get, _libio_.rtems_filesystem_eval_path_generic_config_eval_token_set, doc=r"""eval_token : rtems_filesystem_eval_path_eval_token""")
 400
 401    def __init__(self):
 402        r"""__init__(rtems_filesystem_eval_path_generic_config self) -> rtems_filesystem_eval_path_generic_config"""
 403        _libio_.rtems_filesystem_eval_path_generic_config_swiginit(self, _libio_.new_rtems_filesystem_eval_path_generic_config())
 404    __swig_destroy__ = _libio_.delete_rtems_filesystem_eval_path_generic_config
 405
 406# Register rtems_filesystem_eval_path_generic_config in _libio_:
 407_libio_.rtems_filesystem_eval_path_generic_config_swigregister(rtems_filesystem_eval_path_generic_config)
 408cvar = _libio_.cvar
 409rtems_libio_number_iops = cvar.rtems_libio_number_iops
 410rtems_filesystem_null_handlers = cvar.rtems_filesystem_null_handlers
 411
 412
 413def rtems_filesystem_eval_path_generic(ctx, arg, config):
 414    r"""
 415    rtems_filesystem_eval_path_generic(rtems_filesystem_eval_path_context_t * ctx, void * arg, rtems_filesystem_eval_path_generic_config config)
 416
 417    Parameters
 418    ----------
 419    ctx: rtems_filesystem_eval_path_context_t *
 420    arg: void *
 421    config: rtems_filesystem_eval_path_generic_config const *
 422
 423    """
 424    return _libio_.rtems_filesystem_eval_path_generic(ctx, arg, config)
 425
 426def rtems_filesystem_initialize():
 427    r"""rtems_filesystem_initialize()"""
 428    return _libio_.rtems_filesystem_initialize()
 429
 430def rtems_filesystem_location_copy(dst, src):
 431    r"""
 432    Copies a location.
 433
 434    A bitwise copy is performed.  The destination location will be added to the
 435    corresponding mount entry.
 436
 437    :type dst: rtems_filesystem_location_info_t, out
 438    :param dst: The destination location.
 439    :type src: rtems_filesystem_location_info_t, in
 440    :param src: The  source location.
 441
 442    See also: rtems_filesystem_location_clone().
 443    """
 444    return _libio_.rtems_filesystem_location_copy(dst, src)
 445
 446def rtems_filesystem_location_initialize_to_null(loc):
 447    r"""
 448    rtems_filesystem_location_initialize_to_null(rtems_filesystem_location_info_t * loc) -> rtems_filesystem_location_info_t *
 449
 450    Parameters
 451    ----------
 452    loc: rtems_filesystem_location_info_t *
 453
 454    """
 455    return _libio_.rtems_filesystem_location_initialize_to_null(loc)
 456
 457def rtems_filesystem_location_transform_to_global(loc):
 458    r"""
 459    rtems_filesystem_location_transform_to_global(rtems_filesystem_location_info_t * loc) -> rtems_filesystem_global_location_t *
 460
 461    Parameters
 462    ----------
 463    loc: rtems_filesystem_location_info_t *
 464
 465    """
 466    return _libio_.rtems_filesystem_location_transform_to_global(loc)
 467
 468def rtems_filesystem_global_location_assign(lhs_global_loc_ptr, rhs_global_loc):
 469    r"""
 470    Assigns a global file system location.
 471
 472    :param out]: lhs_global_loc_ptr Pointer to the global left hand side file
 473        system location.  The current left hand side location will be released.
 474    :type rhs_global_loc: rtems_filesystem_global_location_t, in
 475    :param rhs_global_loc: The global right hand side file system location.
 476    """
 477    return _libio_.rtems_filesystem_global_location_assign(lhs_global_loc_ptr, rhs_global_loc)
 478
 479def rtems_filesystem_global_location_obtain(global_loc_ptr):
 480    r"""
 481    Obtains a global file system location.
 482
 483    Deferred releases will be processed in this function.
 484
 485    This function must be called from normal thread context and may block on a
 486    mutex.  Thread dispatching is disabled to protect some critical sections.
 487
 488    :type global_loc_ptr: rtems_filesystem_global_location_t, in
 489    :param global_loc_ptr: Pointer to the global file system location.
 490
 491    :rtype: rtems_filesystem_global_location_t
 492    :return: A global file system location.  It returns always a valid object.
 493        In case of an error, the global null location will be returned.  Each
 494        operation or handler of the null location returns an error status.  The
 495        errno indicates the error.  The NULL pointer is never returned.
 496
 497    See also: rtems_filesystem_location_transform_to_global(),
 498    rtems_filesystem_global_location_obtain_null(), and
 499    rtems_filesystem_global_location_release().
 500    """
 501    return _libio_.rtems_filesystem_global_location_obtain(global_loc_ptr)
 502
 503def rtems_filesystem_global_location_release(global_loc, deferred):
 504    r"""
 505    Releases a global file system location.
 506
 507    In case the reference count reaches zero, all associated resources will be
 508    released.  This may include the complete unmount of the corresponding file
 509    system instance.
 510
 511    This function may block on a mutex.  It may be called within critical
 512    sections of the operating system.  In this case the release will be
 513    deferred.  The next obtain call will do the actual release.
 514
 515    :type global_loc: rtems_filesystem_global_location_t, in
 516    :param global_loc: The global file system location.  It must not be NULL.
 517    :type deferred: boolean, in
 518    :param deferred: If true, then do a deferred release, otherwise release
 519          it immediately.
 520
 521    See also: rtems_filesystem_global_location_obtain().
 522    """
 523    return _libio_.rtems_filesystem_global_location_release(global_loc, deferred)
 524
 525def rtems_filesystem_location_detach(detach):
 526    r"""
 527    rtems_filesystem_location_detach(rtems_filesystem_location_info_t * detach)
 528
 529    Parameters
 530    ----------
 531    detach: rtems_filesystem_location_info_t *
 532
 533    """
 534    return _libio_.rtems_filesystem_location_detach(detach)
 535
 536def rtems_filesystem_location_copy_and_detach(copy, detach):
 537    r"""
 538    rtems_filesystem_location_copy_and_detach(rtems_filesystem_location_info_t * copy, rtems_filesystem_location_info_t * detach)
 539
 540    Parameters
 541    ----------
 542    copy: rtems_filesystem_location_info_t *
 543    detach: rtems_filesystem_location_info_t *
 544
 545    """
 546    return _libio_.rtems_filesystem_location_copy_and_detach(copy, detach)
 547
 548def rtems_filesystem_global_location_obtain_null():
 549    r"""rtems_filesystem_global_location_obtain_null() -> rtems_filesystem_global_location_t *"""
 550    return _libio_.rtems_filesystem_global_location_obtain_null()
 551
 552def rtems_filesystem_location_is_null(loc):
 553    r"""
 554    rtems_filesystem_location_is_null(rtems_filesystem_location_info_t const * loc) -> bool
 555
 556    Parameters
 557    ----------
 558    loc: rtems_filesystem_location_info_t const *
 559
 560    """
 561    return _libio_.rtems_filesystem_location_is_null(loc)
 562
 563def rtems_filesystem_global_location_is_null(global_loc):
 564    r"""
 565    rtems_filesystem_global_location_is_null(rtems_filesystem_global_location_t const * global_loc) -> bool
 566
 567    Parameters
 568    ----------
 569    global_loc: rtems_filesystem_global_location_t const *
 570
 571    """
 572    return _libio_.rtems_filesystem_global_location_is_null(global_loc)
 573
 574def rtems_filesystem_location_error(loc, eno):
 575    r"""
 576    rtems_filesystem_location_error(rtems_filesystem_location_info_t const * loc, int eno)
 577
 578    Parameters
 579    ----------
 580    loc: rtems_filesystem_location_info_t const *
 581    eno: int
 582
 583    """
 584    return _libio_.rtems_filesystem_location_error(loc, eno)
 585
 586def rtems_filesystem_mknod(parentloc, name, namelen, mode, dev):
 587    r"""
 588    rtems_filesystem_mknod(rtems_filesystem_location_info_t const * parentloc, char const * name, size_t namelen, mode_t mode, dev_t dev) -> int
 589
 590    Parameters
 591    ----------
 592    parentloc: rtems_filesystem_location_info_t const *
 593    name: char const *
 594    namelen: size_t
 595    mode: mode_t
 596    dev: dev_t
 597
 598    """
 599    return _libio_.rtems_filesystem_mknod(parentloc, name, namelen, mode, dev)
 600
 601def rtems_filesystem_chdir(loc):
 602    r"""
 603    rtems_filesystem_chdir(rtems_filesystem_location_info_t * loc) -> int
 604
 605    Parameters
 606    ----------
 607    loc: rtems_filesystem_location_info_t *
 608
 609    """
 610    return _libio_.rtems_filesystem_chdir(loc)
 611
 612def rtems_filesystem_chmod(loc, mode):
 613    r"""
 614    rtems_filesystem_chmod(rtems_filesystem_location_info_t const * loc, mode_t mode) -> int
 615
 616    Parameters
 617    ----------
 618    loc: rtems_filesystem_location_info_t const *
 619    mode: mode_t
 620
 621    """
 622    return _libio_.rtems_filesystem_chmod(loc, mode)
 623
 624def rtems_filesystem_chown(loc, owner, group):
 625    r"""
 626    rtems_filesystem_chown(rtems_filesystem_location_info_t const * loc, uid_t owner, gid_t group) -> int
 627
 628    Parameters
 629    ----------
 630    loc: rtems_filesystem_location_info_t const *
 631    owner: uid_t
 632    group: gid_t
 633
 634    """
 635    return _libio_.rtems_filesystem_chown(loc, owner, group)
 636
 637def rtems_filesystem_is_ready_for_unmount(mt_entry):
 638    r"""
 639    rtems_filesystem_is_ready_for_unmount(rtems_filesystem_mount_table_entry_t * mt_entry) -> bool
 640
 641    Parameters
 642    ----------
 643    mt_entry: rtems_filesystem_mount_table_entry_t *
 644
 645    """
 646    return _libio_.rtems_filesystem_is_ready_for_unmount(mt_entry)
 647
 648def rtems_filesystem_location_add_to_mt_entry(loc):
 649    r"""
 650    rtems_filesystem_location_add_to_mt_entry(rtems_filesystem_location_info_t * loc)
 651
 652    Parameters
 653    ----------
 654    loc: rtems_filesystem_location_info_t *
 655
 656    """
 657    return _libio_.rtems_filesystem_location_add_to_mt_entry(loc)
 658
 659def rtems_filesystem_location_remove_from_mt_entry(loc):
 660    r"""
 661    rtems_filesystem_location_remove_from_mt_entry(rtems_filesystem_location_info_t * loc)
 662
 663    Parameters
 664    ----------
 665    loc: rtems_filesystem_location_info_t *
 666
 667    """
 668    return _libio_.rtems_filesystem_location_remove_from_mt_entry(loc)
 669
 670def rtems_filesystem_do_unmount(mt_entry):
 671    r"""
 672    rtems_filesystem_do_unmount(rtems_filesystem_mount_table_entry_t * mt_entry)
 673
 674    Parameters
 675    ----------
 676    mt_entry: rtems_filesystem_mount_table_entry_t *
 677
 678    """
 679    return _libio_.rtems_filesystem_do_unmount(mt_entry)
 680
 681def rtems_filesystem_location_is_instance_root(loc):
 682    r"""
 683    rtems_filesystem_location_is_instance_root(rtems_filesystem_location_info_t const * loc) -> bool
 684
 685    Parameters
 686    ----------
 687    loc: rtems_filesystem_location_info_t const *
 688
 689    """
 690    return _libio_.rtems_filesystem_location_is_instance_root(loc)
 691
 692def rtems_filesystem_eval_path_get_path(ctx):
 693    r"""
 694    rtems_filesystem_eval_path_get_path(rtems_filesystem_eval_path_context_t const * ctx) -> char const *
 695
 696    Parameters
 697    ----------
 698    ctx: rtems_filesystem_eval_path_context_t const *
 699
 700    """
 701    return _libio_.rtems_filesystem_eval_path_get_path(ctx)
 702
 703def rtems_filesystem_eval_path_get_pathlen(ctx):
 704    r"""
 705    rtems_filesystem_eval_path_get_pathlen(rtems_filesystem_eval_path_context_t const * ctx) -> size_t
 706
 707    Parameters
 708    ----------
 709    ctx: rtems_filesystem_eval_path_context_t const *
 710
 711    """
 712    return _libio_.rtems_filesystem_eval_path_get_pathlen(ctx)
 713
 714def rtems_filesystem_eval_path_set_path(ctx, path, pathlen):
 715    r"""
 716    rtems_filesystem_eval_path_set_path(rtems_filesystem_eval_path_context_t * ctx, char const * path, size_t pathlen)
 717
 718    Parameters
 719    ----------
 720    ctx: rtems_filesystem_eval_path_context_t *
 721    path: char const *
 722    pathlen: size_t
 723
 724    """
 725    return _libio_.rtems_filesystem_eval_path_set_path(ctx, path, pathlen)
 726
 727def rtems_filesystem_eval_path_clear_path(ctx):
 728    r"""
 729    rtems_filesystem_eval_path_clear_path(rtems_filesystem_eval_path_context_t * ctx)
 730
 731    Parameters
 732    ----------
 733    ctx: rtems_filesystem_eval_path_context_t *
 734
 735    """
 736    return _libio_.rtems_filesystem_eval_path_clear_path(ctx)
 737
 738def rtems_filesystem_eval_path_get_token(ctx):
 739    r"""
 740    rtems_filesystem_eval_path_get_token(rtems_filesystem_eval_path_context_t const * ctx) -> char const *
 741
 742    Parameters
 743    ----------
 744    ctx: rtems_filesystem_eval_path_context_t const *
 745
 746    """
 747    return _libio_.rtems_filesystem_eval_path_get_token(ctx)
 748
 749def rtems_filesystem_eval_path_get_tokenlen(ctx):
 750    r"""
 751    rtems_filesystem_eval_path_get_tokenlen(rtems_filesystem_eval_path_context_t const * ctx) -> size_t
 752
 753    Parameters
 754    ----------
 755    ctx: rtems_filesystem_eval_path_context_t const *
 756
 757    """
 758    return _libio_.rtems_filesystem_eval_path_get_tokenlen(ctx)
 759
 760def rtems_filesystem_eval_path_set_token(ctx, token, tokenlen):
 761    r"""
 762    rtems_filesystem_eval_path_set_token(rtems_filesystem_eval_path_context_t * ctx, char const * token, size_t tokenlen)
 763
 764    Parameters
 765    ----------
 766    ctx: rtems_filesystem_eval_path_context_t *
 767    token: char const *
 768    tokenlen: size_t
 769
 770    """
 771    return _libio_.rtems_filesystem_eval_path_set_token(ctx, token, tokenlen)
 772
 773def rtems_filesystem_eval_path_clear_token(ctx):
 774    r"""
 775    rtems_filesystem_eval_path_clear_token(rtems_filesystem_eval_path_context_t * ctx)
 776
 777    Parameters
 778    ----------
 779    ctx: rtems_filesystem_eval_path_context_t *
 780
 781    """
 782    return _libio_.rtems_filesystem_eval_path_clear_token(ctx)
 783
 784def rtems_filesystem_eval_path_put_back_token(ctx):
 785    r"""
 786    rtems_filesystem_eval_path_put_back_token(rtems_filesystem_eval_path_context_t * ctx)
 787
 788    Parameters
 789    ----------
 790    ctx: rtems_filesystem_eval_path_context_t *
 791
 792    """
 793    return _libio_.rtems_filesystem_eval_path_put_back_token(ctx)
 794
 795def rtems_filesystem_eval_path_eat_delimiter(ctx):
 796    r"""
 797    rtems_filesystem_eval_path_eat_delimiter(rtems_filesystem_eval_path_context_t * ctx)
 798
 799    Parameters
 800    ----------
 801    ctx: rtems_filesystem_eval_path_context_t *
 802
 803    """
 804    return _libio_.rtems_filesystem_eval_path_eat_delimiter(ctx)
 805
 806def rtems_filesystem_eval_path_next_token(ctx):
 807    r"""
 808    rtems_filesystem_eval_path_next_token(rtems_filesystem_eval_path_context_t * ctx)
 809
 810    Parameters
 811    ----------
 812    ctx: rtems_filesystem_eval_path_context_t *
 813
 814    """
 815    return _libio_.rtems_filesystem_eval_path_next_token(ctx)
 816
 817def rtems_filesystem_eval_path_get_next_token(ctx, token, tokenlen):
 818    r"""
 819    rtems_filesystem_eval_path_get_next_token(rtems_filesystem_eval_path_context_t * ctx, char const ** token, size_t * tokenlen)
 820
 821    Parameters
 822    ----------
 823    ctx: rtems_filesystem_eval_path_context_t *
 824    token: char const **
 825    tokenlen: size_t *
 826
 827    """
 828    return _libio_.rtems_filesystem_eval_path_get_next_token(ctx, token, tokenlen)
 829
 830def rtems_filesystem_eval_path_get_currentloc(ctx):
 831    r"""
 832    rtems_filesystem_eval_path_get_currentloc(rtems_filesystem_eval_path_context_t * ctx) -> rtems_filesystem_location_info_t *
 833
 834    Parameters
 835    ----------
 836    ctx: rtems_filesystem_eval_path_context_t *
 837
 838    """
 839    return _libio_.rtems_filesystem_eval_path_get_currentloc(ctx)
 840
 841def rtems_filesystem_eval_path_has_path(ctx):
 842    r"""
 843    rtems_filesystem_eval_path_has_path(rtems_filesystem_eval_path_context_t const * ctx) -> bool
 844
 845    Parameters
 846    ----------
 847    ctx: rtems_filesystem_eval_path_context_t const *
 848
 849    """
 850    return _libio_.rtems_filesystem_eval_path_has_path(ctx)
 851
 852def rtems_filesystem_eval_path_has_token(ctx):
 853    r"""
 854    rtems_filesystem_eval_path_has_token(rtems_filesystem_eval_path_context_t const * ctx) -> bool
 855
 856    Parameters
 857    ----------
 858    ctx: rtems_filesystem_eval_path_context_t const *
 859
 860    """
 861    return _libio_.rtems_filesystem_eval_path_has_token(ctx)
 862
 863def rtems_filesystem_eval_path_get_flags(ctx):
 864    r"""
 865    rtems_filesystem_eval_path_get_flags(rtems_filesystem_eval_path_context_t const * ctx) -> int
 866
 867    Parameters
 868    ----------
 869    ctx: rtems_filesystem_eval_path_context_t const *
 870
 871    """
 872    return _libio_.rtems_filesystem_eval_path_get_flags(ctx)
 873
 874def rtems_filesystem_eval_path_set_flags(ctx, flags):
 875    r"""
 876    rtems_filesystem_eval_path_set_flags(rtems_filesystem_eval_path_context_t * ctx, int flags)
 877
 878    Parameters
 879    ----------
 880    ctx: rtems_filesystem_eval_path_context_t *
 881    flags: int
 882
 883    """
 884    return _libio_.rtems_filesystem_eval_path_set_flags(ctx, flags)
 885
 886def rtems_filesystem_eval_path_clear_and_set_flags(ctx, clear, set):
 887    r"""
 888    rtems_filesystem_eval_path_clear_and_set_flags(rtems_filesystem_eval_path_context_t * ctx, int clear, int set)
 889
 890    Parameters
 891    ----------
 892    ctx: rtems_filesystem_eval_path_context_t *
 893    clear: int
 894    set: int
 895
 896    """
 897    return _libio_.rtems_filesystem_eval_path_clear_and_set_flags(ctx, clear, set)
 898
 899def rtems_filesystem_eval_path_extract_currentloc(ctx, get):
 900    r"""
 901    rtems_filesystem_eval_path_extract_currentloc(rtems_filesystem_eval_path_context_t * ctx, rtems_filesystem_location_info_t * get)
 902
 903    Parameters
 904    ----------
 905    ctx: rtems_filesystem_eval_path_context_t *
 906    get: rtems_filesystem_location_info_t *
 907
 908    """
 909    return _libio_.rtems_filesystem_eval_path_extract_currentloc(ctx, get)
 910
 911def rtems_filesystem_eval_path_error(ctx, eno):
 912    r"""
 913    rtems_filesystem_eval_path_error(rtems_filesystem_eval_path_context_t * ctx, int eno)
 914
 915    Parameters
 916    ----------
 917    ctx: rtems_filesystem_eval_path_context_t *
 918    eno: int
 919
 920    """
 921    return _libio_.rtems_filesystem_eval_path_error(ctx, eno)
 922
 923def rtems_filesystem_location_exists_in_same_instance_as(a, b):
 924    r"""Checks that the locations exist in the same file system instance."""
 925    return _libio_.rtems_filesystem_location_exists_in_same_instance_as(a, b)
 926
 927def rtems_filesystem_check_access(flags, object_mode, object_uid, object_gid):
 928    r"""
 929    Checks if access to an object is allowed for the current user.
 930
 931    If the effective UID is zero or equals the UID of the object, then the user
 932    permission flags of the object will be used.  Otherwise if the effective GID
 933    is zero or equals the GID of the object or one of the supplementary group
 934    IDs is equal to the GID of the object, then the group permission flags of
 935    the object will be used.  Otherwise the other permission flags of the object
 936    will be used.
 937
 938    :type flags: int, in
 939    :param flags: The flags determining the access type.  It can be
 940          RTEMS_FS_PERMS_READ, RTEMS_FS_PERMS_WRITE or RTEMS_FS_PERMS_EXEC.
 941    :type object_mode: mode_t, in
 942    :param object_mode: The mode of the object specifying the permission flags.
 943    :type object_uid: uid_t, in
 944    :param object_uid: The UID of the object.
 945    :type object_gid: gid_t, in
 946    :param object_gid: The GID of the object.
 947    """
 948    return _libio_.rtems_filesystem_check_access(flags, object_mode, object_uid, object_gid)
 949
 950def rtems_filesystem_eval_path_check_access(ctx, eval_flags, node_mode, node_uid, node_gid):
 951    r"""
 952    rtems_filesystem_eval_path_check_access(rtems_filesystem_eval_path_context_t * ctx, int eval_flags, mode_t node_mode, uid_t node_uid, gid_t node_gid) -> bool
 953
 954    Parameters
 955    ----------
 956    ctx: rtems_filesystem_eval_path_context_t *
 957    eval_flags: int
 958    node_mode: mode_t
 959    node_uid: uid_t
 960    node_gid: gid_t
 961
 962    """
 963    return _libio_.rtems_filesystem_eval_path_check_access(ctx, eval_flags, node_mode, node_uid, node_gid)
 964
 965def rtems_filesystem_is_delimiter(c):
 966    r"""
 967    rtems_filesystem_is_delimiter(char c) -> bool
 968
 969    Parameters
 970    ----------
 971    c: char
 972
 973    """
 974    return _libio_.rtems_filesystem_is_delimiter(c)
 975
 976def rtems_filesystem_is_current_directory(token, tokenlen):
 977    r"""
 978    rtems_filesystem_is_current_directory(char const * token, size_t tokenlen) -> bool
 979
 980    Parameters
 981    ----------
 982    token: char const *
 983    tokenlen: size_t
 984
 985    """
 986    return _libio_.rtems_filesystem_is_current_directory(token, tokenlen)
 987
 988def rtems_filesystem_is_parent_directory(token, tokenlen):
 989    r"""
 990    rtems_filesystem_is_parent_directory(char const * token, size_t tokenlen) -> bool
 991
 992    Parameters
 993    ----------
 994    token: char const *
 995    tokenlen: size_t
 996
 997    """
 998    return _libio_.rtems_filesystem_is_parent_directory(token, tokenlen)
 999
1000def rtems_libio_iovec_eval(fd, iov, iovcnt, flags, adapter):
1001    r"""
1002    rtems_libio_iovec_eval(int fd, struct iovec const * iov, int iovcnt, unsigned int flags, rtems_libio_iovec_adapter adapter) -> ssize_t
1003
1004    Parameters
1005    ----------
1006    fd: int
1007    iov: struct iovec const *
1008    iovcnt: int
1009    flags: unsigned int
1010    adapter: rtems_libio_iovec_adapter
1011
1012    """
1013    return _libio_.rtems_libio_iovec_eval(fd, iov, iovcnt, flags, adapter)
1014
1015def rtems_filesystem_location_type(loc):
1016    r"""
1017    Returns the file type of the file referenced by the filesystem
1018    location.
1019
1020    loc The filesystem location.
1021
1022    :rtype: mode_t
1023    :return: The type of the file or an invalid file type in case of an error.
1024    """
1025    return _libio_.rtems_filesystem_location_type(loc)