On Fri, Feb 04, 2022 at 23:11:29 +0100, Jakub Wilk wrote:
> https://www.sourceware.org/ml/libc-alpha/2018-09/msg00270.html hints that
> you can use poll() to query for open fds. That should be efficient, portable
> and async-signal-safe.

I just saw this report, and happened to have some code to do that.  I am
attaching it for reference.  Compared to closefrom_procfs(), there would
be no efficient way to see file descriptors above the limit.  With Linux
having added close_range() a while ago, this may all be moot.

With poll(), a fall-back is needed, to deal with the "Unable to allocate
memory for kernel data structures" case, and the bizarre "The nfds value
exceeds the RLIMIT_NOFILE value".  A system call to return the next open
descriptor, equal to or greater than a specified value, would be useful;
ConnectServerInfo() can do this on QNX.

I wonder whether anything is known to depend on this async-signal-safety
or large-descriptor-handling.  Hypothetically, libbsd's non-preservation
of errno could also cause a portability problem.

(Regarding the referenced mailing list discussion, it would be better to
have multi-threaded processes never call fork(); they should have forked
while still single-threaded, creating a "fork server" to call fork() and
exec() as necessary.  Firefox does this.  It avoids problems relating to
signals, memory [over-]commitments, and the file descriptor table.)

-- Michael
/* Permission is hereby granted, irrevocably and free of charge, to any
 * person obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * In addition to the above license, the author(s) have dedicated
 * all copyright and related and neighboring rights to this work
 * to the public domain worldwide, to the extent possible under law.
 * For details: git cat-file blob 0e259d42c996742e9e3cba14c677129b2c1b6311
 * or see: https://creativecommons.org/publicdomain/zero/1.0/legalcode
 */
#ifndef HDRINCL_UTIL_FD_ITER_H
#define HDRINCL_UTIL_FD_ITER_H 20241002

#include <errno.h>
#include <fcntl.h>
#include <poll.h>
#include <stdint.h>

struct fd_iter {
        unsigned iter_next, iter_end, map_end;
        uint8_t map[32];
};


static _Bool
fd_is_valid(int fd)
{
        int flags;
        do {
                flags = fcntl(fd, F_GETFD);
        } while ((-1 == flags) && (EINTR == errno));
        return -1 != flags;
}

static inline void
fd_iter_init(struct fd_iter *iter, int low_fd, int high_fd)
{
        *iter = (struct fd_iter){0};
        iter->iter_next = (low_fd >= 0) ? (unsigned)low_fd : -1u;
        if (high_fd > low_fd) {
                iter->iter_end = 1 + (unsigned)high_fd;
        }
}

static inline _Bool
X_fd_iter_refresh_map(struct fd_iter *iter)
{
        struct pollfd poll_fds[8 * sizeof iter->map] = {{.events=0}};

        if (iter->map_end > -256u) {
                // avoid poll() till the counter wraps to 0
                if (++iter->map_end) {
                        return 0;
                }
        }

        // use poll() to look for valid file descriptors
        {
                nfds_t nfds = 0;
                int rv;

                while (nfds < 8 * sizeof iter->map) {
                        unsigned ufd = iter->iter_next + (unsigned)nfds;
                        if (ufd >= iter->iter_end) {
                                break;
                        }
                        poll_fds[nfds++].fd = (int)ufd;
                }

                rv = poll(&poll_fds[0], nfds, 0 /*timeout*/);
                if (rv < 0) {
                        // avoid using poll() for the next several calls
                        iter->map_end = -4u;
                        return 0;
                }
        }

        // store the poll() results in iter->map
        {
                unsigned u;
                uint8_t mask = 1;

                for (u = 0; u < sizeof iter->map; ++u) {
                        iter->map[u] = 0;
                }
                for (u = 0; u < 8 * sizeof iter->map; ++u) {
                        if (0 == (poll_fds[u].revents & POLLNVAL)) {
                                iter->map[u / 8] |= mask;
                        }

                        // rotate mask left
                        if (mask & 0x80) {
                                mask = 1;
                        } else {
                                mask <<= 1;
                        }
                }
                iter->map_end = iter->iter_next + u;
        }
        return 1;
}

static inline _Bool
X_fd_iter_advance(int *fd_out, struct fd_iter *iter, _Bool consume)
{
        for (; iter->iter_next < iter->iter_end; ++iter->iter_next) {
                unsigned map_start = iter->map_end - (unsigned)(8 * sizeof 
iter->map);
                unsigned idx = iter->iter_next;

                if ((idx < map_start) || (idx >= iter->map_end)) {
                        if (X_fd_iter_refresh_map(iter)) {
                                map_start = iter->iter_next;
                        } else {
                                if (fd_is_valid((int)iter->iter_next)) {
                                        goto found;
                                }
                                continue;
                        }
                }
                idx -= map_start;
                if (( iter->map[idx / 8] & (1u << (idx & 7)) )) {
                        goto found;
                }
        }
        return 0;

found:
        *fd_out = (int)iter->iter_next;
        if (consume) iter->iter_next += 1;
        return 1;
}

static inline _Bool
fd_iter_peek(int *fd_out, struct fd_iter *iter)
{
        return X_fd_iter_advance(fd_out, iter, 0);
}

static inline _Bool
fd_iter_next(int *fd_out, struct fd_iter *iter)
{
        return X_fd_iter_advance(fd_out, iter, 1);
}

#endif  // !defined HDRINCL_UTIL_FD_ITER_H
// originally written by Michael Gold <[email protected]>
/* Permission is hereby granted, irrevocably and free of charge, to any
 * person obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * In addition to the above license, the author(s) have dedicated
 * all copyright and related and neighboring rights to this work
 * to the public domain worldwide, to the extent possible under law.
 * For details: git cat-file blob 0e259d42c996742e9e3cba14c677129b2c1b6311
 * or see: https://creativecommons.org/publicdomain/zero/1.0/legalcode
 */
#include <stdio.h>
#include "fd_iter.h"

int
main(int argc, char **argv)
{
        int fd;
        struct fd_iter iter;

        fd_iter_init(&iter, 0, 1023);
        while (fd_iter_next(&fd, &iter)) {
                printf("%d\n", fd);
        }
}

// originally written by Michael Gold <[email protected]>
Creative Commons Legal Code

CC0 1.0 Universal

    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
    HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

  i. the right to reproduce, adapt, distribute, perform, display,
     communicate, and translate a Work;
 ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
     likeness depicted in a Work;
 iv. rights protecting against unfair competition in regards to a Work,
     subject to the limitations in paragraph 4(a), below;
  v. rights protecting the extraction, dissemination, use and reuse of data
     in a Work;
 vi. database rights (such as those arising under Directive 96/9/EC of the
     European Parliament and of the Council of 11 March 1996 on the legal
     protection of databases, and under any national implementation
     thereof, including any amended or successor version of such
     directive); and
vii. other similar, equivalent or corresponding rights throughout the
     world based on applicable law or treaty, and any national
     implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

 a. No trademark or patent rights held by Affirmer are waived, abandoned,
    surrendered, licensed or otherwise affected by this document.
 b. Affirmer offers the Work as-is and makes no representations or
    warranties of any kind concerning the Work, express, implied,
    statutory or otherwise, including without limitation warranties of
    title, merchantability, fitness for a particular purpose, non
    infringement, or the absence of latent or other defects, accuracy, or
    the present or absence of errors, whether or not discoverable, all to
    the greatest extent permissible under applicable law.
 c. Affirmer disclaims responsibility for clearing rights of other persons
    that may apply to the Work or any use thereof, including without
    limitation any person's Copyright and Related Rights in the Work.
    Further, Affirmer disclaims responsibility for obtaining any necessary
    consents, permissions or other rights required for any use of the
    Work.
 d. Affirmer understands and acknowledges that Creative Commons is not a
    party to this document and has no duty or obligation with respect to
    this CC0 or use of the Work.

Attachment: signature.asc
Description: PGP signature

Reply via email to