Differential D20096 Diff 55539 src/ioslaves/file/file.cpp

Changeset View

Standalone View

View Options

src/ioslaves/file/file.cpp

Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Line(s)
60#include <kconfiggroup.h> 60​#include <kconfiggroup.h>
61#include <kshell.h> 61​#include <kshell.h>
62#include <kmountpoint.h> 62​#include <kmountpoint.h>
63#include <klocalizedstring.h> 63​#include <klocalizedstring.h>
64#include <QMimeDatabase> 64​#include <QMimeDatabase>
65#include <QStandardPaths> 65​#include <QStandardPaths>
66#include <QDataStream> 66​#include <QDataStream>
67 67​
68​#ifdef Q_OS_LINUX
pinoUnsubmitted
Done

no need for the Q_OS_LINUX check here

pino: no need for the Q_OS_LINUX check here
69​#include <sys/stat.h>
70​
71​// We use statx function only under glibc
fvogtUnsubmitted
Done

This won't work as expected, USE_STATX is unconditionally defined.

fvogt: This won't work as expected, `USE_STATX` is unconditionally defined.
mevenAuthorUnsubmitted
Done

Thanks

meven: Thanks
72​#if defined(STATX_BASIC_STATS) && defined(__GLIBC__)
73​ #define USE_STATX
74​#endif
pinoUnsubmitted
Done

TBH, instead of this static define, I'd do a proper cmake check (see ConfigureChecks.cmake, and config-kioslave-file.h.cmake in src/ioslaves/file).

pino: TBH, instead of this static define, I'd do a proper cmake check (see ConfigureChecks.cmake, and…
mevenAuthorUnsubmitted
Done

It was not too easy to do.

meven: It was not too easy to do.
75​
76​#endif
77​
68#if HAVE_VOLMGT 78​#if HAVE_VOLMGT
69#include <volmgt.h> 79​#include <volmgt.h>
70#include <sys/mnttab.h> 80​#include <sys/mnttab.h>
71#endif 81​#endif
72 82​
73#include <kdirnotify.h> 83​#include <kdirnotify.h>
74#include <ioslave_defaults.h> 84​#include <ioslave_defaults.h>
75 85​
▲ Show 20 Lines • Show All 757 Lines • ▼ Show 20 Line(s)840 if (it == mGroupcache.end()) {
833 if (name.isEmpty()) { 843​ if (name.isEmpty()) {
834 name = gid.toString(); 844​ name = gid.toString();
835 } 845​ }
836 it = mGroupcache.insert(gid, name); 846​ it = mGroupcache.insert(gid, name);
837 } 847​ }
838 return *it; 848​ return *it;
839} 849​}
840 850​
851​#ifdef USE_STATX
852​// statx syscall is available
853​inline int STAT(const char* path, struct statx * buff) {
854​ return statx(AT_FDCWD, path, AT_SYMLINK_NOFOLLOW, STATX_BASIC_STATS | STATX_BTIME, buff);
855​}
856​inline static uint16_t stat_mode(struct statx buf) { return buf.stx_mode; }
857​inline static uint32_t stat_dev(struct statx buf) { return buf.stx_dev_major; }
858​inline static uint64_t stat_ino(struct statx buf) { return buf.stx_ino; }
859​inline static uint64_t stat_size(struct statx buf) { return buf.stx_size; }
860​inline static uint32_t stat_uid(struct statx buf) { return buf.stx_uid; }
861​inline static uint32_t stat_gid(struct statx buf) { return buf.stx_gid; }
862​inline static uint64_t stat_atime(struct statx buf) { return buf.stx_atime.tv_sec; }
863​inline static uint64_t stat_mtime(struct statx buf) { return buf.stx_mtime.tv_sec; }
864​#else
865​// regular stat struct
866​inline int STAT(const char* path, QT_STATBUF * buff) {
867​ return QT_LSTAT(path, buff);
868​}
869​inline static mode_t stat_mode(QT_STATBUF buf) { return buf.st_mode; }
870​inline static dev_t stat_dev(QT_STATBUF buf) { return buf.st_dev; }
871​inline static ino_t stat_ino(QT_STATBUF buf) { return buf.st_ino; }
872​inline static off_t stat_size(QT_STATBUF buf) { return buf.st_size; }
873​inline static uid_t stat_uid(QT_STATBUF buf) { return buf.st_uid; }
874​inline static gid_t stat_gid(QT_STATBUF buf) { return buf.st_gid; }
875​inline static time_t stat_atime(QT_STATBUF buf) { return buf.st_atime; }
876​inline static time_t stat_mtime(QT_STATBUF buf) { return buf.st_mtime; }
anthonyfieroniUnsubmitted
Done

We can get all stat_xxx functions buf as reference, struct is not needed when you use C++.

anthonyfieroni: We can get all stat_xxx functions buf as reference, struct is not needed when you use C++.
mevenAuthorUnsubmitted
Done

Do you mean the struct keyword in the argument in "inline static uint16_t stat_mode(struct statx buf) { return buf.stx_mode; } " for instance ?

meven: Do you mean the struct keyword in the argument in "inline static uint16_t stat_mode(struct…
mevenAuthorUnsubmitted
Done

Unfortunately this is not possible here : statx is also a function, the compiler gets messed up when removing the struct keyword interpreting it as a function call.

/file/file.cpp:850:34: warning: inline variables are only available with -std=c++17 or -std=gnu++17

377   │  inline static uint16_t stat_mode(statx buf) { return buf.stx_mode; }
meven: Unfortunately this is not possible here : statx is also a function, the compiler gets messed up…
pinoUnsubmitted
Done

No, he means using a const& for the argument, e.g:

inline static uint16_t stat_mode(struct statx &buf) { return buf.stx_mode; }
pino: No, he means using a const& for the argument, e.g: ```lang=c++ inline static uint16_t stat_mode…
mevenAuthorUnsubmitted
Done

Thanks

meven: Thanks
mevenAuthorUnsubmitted
Done

@pino
No, he means using a const& for the argument, e.g:

I think he meant both.

meven: > @pino > No, he means using a const& for the argument, e.g: I think he meant both.
877​#endif
878​
841bool FileProtocol::createUDSEntry(const QString &filename, const QByteArray &path, UDSEntry &entry, 879​bool FileProtocol::createUDSEntry(const QString &filename, const QByteArray &path, UDSEntry &entry,
842 short int details) 880​ short int details)
843{ 881​{
844 assert(entry.count() == 0); // by contract :-) 882​ assert(entry.count() == 0); // by contract :-)
845 entry.reserve(8); 883​ switch (details) {
brunsUnsubmitted
Done

This can be up to 12 now, if I counted correctly. Conditionalize this on details.

bruns: This can be up to 12 now, if I counted correctly. Conditionalize this on details.
mevenAuthorUnsubmitted
Done

This code was just copied, but I will be happy to take care of this along the way.

meven: This code was just copied, but I will be happy to take care of this along the way.
846 884​ case 1:
885​ // uid, gid, atime, mtime, btime
886​ entry.reserve(10);
887​ break;
888​ case 2:
889​ // acl data
890​ entry.reserve(13);
891​ break;
892​ case 3:
893​ // dev, inode
894​ entry.reserve(15);
895​ break;
896​ default: // case 0:
brunsUnsubmitted
Done

This is wrong in case someone uses details > 3, should be case 0: reserve(5), case 3: default: reserve(15) .
all checks below do e.g if (details > 2), so handle 5 the same as 3.

bruns: This is wrong in case someone uses details > 3, should be `case 0: reserve(5)`, `case 3…
mevenAuthorUnsubmitted
Done

Thanks

meven: Thanks
897​ // filename, access, type, size, linkdest
898​ entry.reserve(5);
899​ break;
900​ }
brunsUnsubmitted
Done

switch (details) { ...}

bruns: `switch (details) { ...}`
brunsUnsubmitted
Done

You are off by 1 for dev/inode, these are only added with details >= 3.

details >= 2 is ACL data. As the ACL are commonly empty, add +0.

Handle 0 explicitly, and make 3 (>=3) the default, to match the remaining code.

bruns: You are off by 1 for dev/inode, these are only added with details >= 3. details >= 2 is ACL…
847 entry.fastInsert(KIO::UDSEntry::UDS_NAME, filename); 901​ entry.fastInsert(KIO::UDSEntry::UDS_NAME, filename);
848 902​
849 mode_t type; 903​ mode_t type;
850 mode_t access; 904​ mode_t access;
851 bool isBrokenSymLink = false; 905​ bool isBrokenSymLink = false;
brunsUnsubmitted
Done

You should start with a more sensible size for lowerLimit, e.g. 256, maybe more - the scope is local, i.e. any excess size is hardly relevant, and allocating 1 and 256 byte cost the same.

lowerLimit is not used below, I think you don't have to name it.

You should use (buff.stx_size + 1), as the size is without trailing null byte.

bruns: You should start with a more sensible size for lowerLimit, e.g. 256, maybe more - the scope is…
mevenAuthorUnsubmitted
Done

I have 256 as I'd rather allocate the minimal size without adding cost here.

meven: I have 256 as I'd rather allocate the minimal size without adding cost here.
852 long long size = 0LL; 906​ long long size = 0LL;
853#if HAVE_POSIX_ACL 907​#if HAVE_POSIX_ACL
854 QByteArray targetPath = path; 908​ QByteArray targetPath = path;
855#endif 909​#endif
910​
911​#ifdef USE_STATX
912​ // statx syscall is available
913​ struct statx buff;
914​#else
856 QT_STATBUF buff; 915​ QT_STATBUF buff;
916​#endif
857 917​
858 if (QT_LSTAT(path.data(), &buff) == 0) { 918​ if (STAT(path.data(), &buff) == 0) {
859 919​
860 if (details > 2) { 920​ if (details > 2) {
861 entry.fastInsert(KIO::UDSEntry::UDS_DEVICE_ID, buff.st_dev); 921​ entry.fastInsert(KIO::UDSEntry::UDS_DEVICE_ID, stat_mode(buff));
862 entry.fastInsert(KIO::UDSEntry::UDS_INODE, buff.st_ino); 922​ entry.fastInsert(KIO::UDSEntry::UDS_INODE, stat_ino(buff));
863 } 923​ }
864 924​
865 if ((buff.st_mode & QT_STAT_MASK) == QT_STAT_LNK) { 925​ if ((stat_mode(buff) & QT_STAT_MASK) == QT_STAT_LNK) {
866 926​
867#ifdef Q_OS_WIN 927​#ifdef Q_OS_WIN
868 const QString linkTarget = QFile::symLinkTarget(QFile::decodeName(path)); 928​ const QString linkTarget = QFile::symLinkTarget(QFile::decodeName(path));
869#else 929​#else
870 // Use readlink on Unix because symLinkTarget turns relative targets into absolute (#352927) 930​ // Use readlink on Unix because symLinkTarget turns relative targets into absolute (#352927)
871 const off_t lowerLimit = 1; 931​ #ifdef USE_STATX
872 const off_t upperLimit = 1024; 932​ size_t lowerBound = 256;
873 size_t bufferSize = qBound(lowerLimit, buff.st_size, upperLimit); 933​ size_t higherBound = 1024;
brunsUnsubmitted
Done

statx.stx_size is __u64, and readlink uses (unsigned) size_t for the buffer size.

bruns: statx.stx_size is __u64, and readlink uses (unsigned) size_t for the buffer size.
mevenAuthorUnsubmitted
Done

Let me know if I have handled this correctly.

meven: Let me know if I have handled this correctly.
934​ uint64_t s = stat_size(buff);
935​ if (s > SIZE_MAX) {
936​ qCWarning(KIO_FILE) << "file size bigger than SIZE_MAX, too big for readlink use!" << path;
937​ return false;
938​ }
939​ size_t size = (size_t) s;
940​ #else
941​ off_t lowerBound = 256;
942​ off_t higherBound = 1024;
943​ off_t size = stat_size(buff);
brunsUnsubmitted
Done

This comment is no longer relevant.

bruns: This comment is no longer relevant.
944​ #endif
945​ auto bufferSize = qBound(lowerBound, size +1, higherBound);
brunsUnsubmitted
Done

stat_size + 1. Otherwise, you will always take the n == bufferSize path below at least once.

bruns: stat_size + 1. Otherwise, you will always take the `n == bufferSize` path below at least once.
brunsUnsubmitted
Not Done

missing space, size + 1

bruns: missing space, `size + 1`
874 QByteArray linkTargetBuffer; 946​ QByteArray linkTargetBuffer;
875 linkTargetBuffer.resize(bufferSize); 947​ linkTargetBuffer.resize(bufferSize);
876 while (true) { 948​ while (true) {
877 ssize_t n = readlink(path.constData(), linkTargetBuffer.data(), bufferSize); 949​ ssize_t n = readlink(path.constData(), linkTargetBuffer.data(), bufferSize);
878 if (n < 0 && errno != ERANGE) { 950​ if (n < 0 && errno != ERANGE) {
879 qCWarning(KIO_FILE) << "readlink failed!" << path; 951​ qCWarning(KIO_FILE) << "readlink failed!" << path;
880 return false; 952​ return false;
881 } else if (n > 0 && static_cast<size_t>(n) != bufferSize) { 953​ } else if (n > 0 && static_cast<size_t>(n) != bufferSize) {
954​ // the buffer was not filled in the last iteration
955​ // we are finished reading, break the loop
882 linkTargetBuffer.truncate(n); 956​ linkTargetBuffer.truncate(n);
883 break; 957​ break;
884 } 958​ }
885 bufferSize *= 2; 959​ bufferSize *= 2;
886 linkTargetBuffer.resize(bufferSize); 960​ linkTargetBuffer.resize(bufferSize);
887 } 961​ }
888 const QString linkTarget = QFile::decodeName(linkTargetBuffer); 962​ const QString linkTarget = QFile::decodeName(linkTargetBuffer);
889#endif 963​#endif
890 entry.fastInsert(KIO::UDSEntry::UDS_LINK_DEST, linkTarget); 964​ entry.fastInsert(KIO::UDSEntry::UDS_LINK_DEST, linkTarget);
891 965​
892 // A symlink -> follow it only if details>1 966​ // A symlink -> follow it only if details>1
893 if (details > 1) { 967​ if (details > 1) {
894 if (QT_STAT(path.constData(), &buff) == -1) { 968​ if (STAT(path.constData(), &buff) == -1) {
895 isBrokenSymLink = true; 969​ isBrokenSymLink = true;
896 } else { 970​ } else {
897#if HAVE_POSIX_ACL 971​#if HAVE_POSIX_ACL
898 // valid symlink, will get the ACLs of the destination 972​ // valid symlink, will get the ACLs of the destination
899 targetPath = linkTargetBuffer; 973​ targetPath = linkTargetBuffer;
900#endif 974​#endif
901 } 975​ }
902 } 976​ }
903 } 977​ }
904 } else { 978​ } else {
905 // qCWarning(KIO_FILE) << "lstat didn't work on " << path.data(); 979​ // qCWarning(KIO_FILE) << "lstat didn't work on " << path.data();
906 return false; 980​ return false;
907 } 981​ }
908 982​
909 if (isBrokenSymLink) { 983​ if (isBrokenSymLink) {
910 // It is a link pointing to nowhere 984​ // It is a link pointing to nowhere
911 type = S_IFMT - 1; 985​ type = S_IFMT - 1;
912 access = S_IRWXU | S_IRWXG | S_IRWXO; 986​ access = S_IRWXU | S_IRWXG | S_IRWXO;
913 size = 0LL; 987​ size = 0LL;
914 } else { 988​ } else {
915 type = buff.st_mode & S_IFMT; // extract file type 989​ type = stat_mode(buff) & S_IFMT; // extract file type
916 access = buff.st_mode & 07777; // extract permissions 990​ access = stat_mode(buff) & 07777; // extract permissions
917 size = buff.st_size; 991​ size = stat_size(buff);
918 } 992​ }
919 993​
920 entry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, type); 994​ entry.fastInsert(KIO::UDSEntry::UDS_FILE_TYPE, type);
921 entry.fastInsert(KIO::UDSEntry::UDS_ACCESS, access); 995​ entry.fastInsert(KIO::UDSEntry::UDS_ACCESS, access);
922 entry.fastInsert(KIO::UDSEntry::UDS_SIZE, size); 996​ entry.fastInsert(KIO::UDSEntry::UDS_SIZE, size);
923 997​
924#if HAVE_POSIX_ACL 998​#if HAVE_POSIX_ACL
925 if (details > 1) { 999​ if (details > 1) {
926 /* Append an atom indicating whether the file has extended acl information 1000​ /* Append an atom indicating whether the file has extended acl information
927 * and if withACL is specified also one with the acl itself. If it's a directory 1001​ * and if withACL is specified also one with the acl itself. If it's a directory
928 * and it has a default ACL, also append that. */ 1002​ * and it has a default ACL, also append that. */
929 appendACLAtoms(targetPath, entry, type); 1003​ appendACLAtoms(targetPath, entry, type);
930 } 1004​ }
931#endif 1005​#endif
932 1006​
933 if (details > 0) { 1007​ if (details > 0) {
934 entry.fastInsert(KIO::UDSEntry::UDS_MODIFICATION_TIME, buff.st_mtime); 1008​ entry.fastInsert(KIO::UDSEntry::UDS_MODIFICATION_TIME, stat_mtime(buff));
1009​ entry.fastInsert(KIO::UDSEntry::UDS_ACCESS_TIME, stat_atime(buff));
935#ifndef Q_OS_WIN 1010​#ifndef Q_OS_WIN
936 entry.fastInsert(KIO::UDSEntry::UDS_USER, getUserName(KUserId(buff.st_uid))); 1011​ entry.fastInsert(KIO::UDSEntry::UDS_USER, getUserName(KUserId(stat_uid(buff))));
937 entry.fastInsert(KIO::UDSEntry::UDS_GROUP, getGroupName(KGroupId(buff.st_gid))); 1012​ entry.fastInsert(KIO::UDSEntry::UDS_GROUP, getGroupName(KGroupId(stat_gid(buff))));
938#else 1013​#else
939#pragma message("TODO: st_uid and st_gid are always zero, use GetSecurityInfo to find the owner") 1014​#pragma message("TODO: st_uid and st_gid are always zero, use GetSecurityInfo to find the owner")
940#endif 1015​#endif
941 entry.fastInsert(KIO::UDSEntry::UDS_ACCESS_TIME, buff.st_atime); 1016​
942#ifdef st_birthtime 1017​#ifdef st_birthtime
943 /* For example FreeBSD's and NetBSD's stat contains a field for 1018​ /* For example FreeBSD's and NetBSD's stat contains a field for
944 * the inode birth time: st_birthtime 1019​ * the inode birth time: st_birthtime
945 * This however only works on UFS and ZFS, and not, on say, NFS. 1020​ * This however only works on UFS and ZFS, and not, on say, NFS.
946 * Instead of setting a bogus fallback like st_mtime, only use 1021​ * Instead of setting a bogus fallback like st_mtime, only use
947 * it if it is greater than 0. */ 1022​ * it if it is greater than 0. */
948 if (buff.st_birthtime > 0) { 1023​ if (buff.st_birthtime > 0) {
949 entry.fastInsert(KIO::UDSEntry::UDS_CREATION_TIME, buff.st_birthtime); 1024​ entry.fastInsert(KIO::UDSEntry::UDS_CREATION_TIME, buff.st_birthtime);
950 } 1025​ }
951#elif defined __st_birthtime 1026​#elif defined __st_birthtime
952 /* As above, but OpenBSD calls it slightly differently. */ 1027​ /* As above, but OpenBSD calls it slightly differently. */
953 if (buff.__st_birthtime > 0) { 1028​ if (buff.__st_birthtime > 0) {
954 entry.fastInsert(KIO::UDSEntry::UDS_CREATION_TIME, buff.__st_birthtime); 1029​ entry.fastInsert(KIO::UDSEntry::UDS_CREATION_TIME, buff.__st_birthtime);
955 } 1030​ }
1031​#elif defined USE_STATX
1032​ /* And linux version using statx syscall */
1033​ if (buff.stx_mask & STATX_BTIME) {
fvogtUnsubmitted
Done

This check seems to be wrong with me - there can be files with legitimate zero tv_nsec.

Use buff.stx_mask & STATX_BTIME instead.

fvogt: This check seems to be wrong with me - there can be files with legitimate zero `tv_nsec`. Use…
mevenAuthorUnsubmitted
Done

Thanks for the feedback, I read about stx_mask after writing this.

meven: Thanks for the feedback, I read about stx_mask after writing this.
1034​ entry.fastInsert(KIO::UDSEntry::UDS_CREATION_TIME, buff.stx_btime.tv_sec);
1035​ }
956#endif 1036​#endif
957 } 1037​ }
958 1038​
959 // Note: buff.st_ctime isn't the creation time ! ​
960 // We made that mistake for KDE 2.0, but it's in fact the ​
961 // "file status" change time, which we don't care about. ​
962 // For FreeBSD and NetBSD, use st_birthtime. For OpenBSD, ​
963 // use __st_birthtime. ​
964 ​
965 return true; 1039​ return true;
966} 1040​}
967 1041​
968void FileProtocol::special(const QByteArray &data) 1042​void FileProtocol::special(const QByteArray &data)
969{ 1043​{
970 int tmp; 1044​ int tmp;
971 QDataStream stream(data); 1045​ QDataStream stream(data);
972 1046​
▲ Show 20 Lines • Show All 499 Lines • Show Last 20 Lines