Katana_mirror/kdelibs
1
0
Fork 0
mirror of https://bitbucket.org/smil3y/kdelibs.git synced 2025-02-24 02:42:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

kio: remove unused KIO::Scheduler methods

Browse source 
I expect some race-conditions to manifest from such changes

Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
This commit is contained in:
Ivailo Monev 2022-06-02 16:19:17 +03:00
parent 8035a87caf
commit 41babc2d25
5 changed files with 20 additions and 325 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

213
kio/kio/scheduler.cpp
View file

@ -254,147 +254,6 @@ QList<Slave *> HostQueue::allSlaves() const
return ret; return ret;
} }
ConnectedSlaveQueue::ConnectedSlaveQueue()
{
m_startJobsTimer.setSingleShot(true);
connect (&m_startJobsTimer, SIGNAL(timeout()), SLOT(startRunnableJobs()));
}
bool ConnectedSlaveQueue::queueJob(SimpleJob *job, Slave *slave)
{
QHash<Slave *, PerSlaveQueue>::Iterator it = m_connectedSlaves.find(slave);
if (it == m_connectedSlaves.end()) {
return false;
}
SimpleJobPrivate::get(job)->m_slave = slave;
PerSlaveQueue &jobs = it.value();
jobs.waitingList.append(job);
if (!jobs.runningJob) {
// idle slave now has a job to run
m_runnableSlaves.insert(slave);
m_startJobsTimer.start();
}
return true;
}
bool ConnectedSlaveQueue::removeJob(SimpleJob *job)
{
Slave *slave = jobSlave(job);
Q_ASSERT(slave);
QHash<Slave *, PerSlaveQueue>::Iterator it = m_connectedSlaves.find(slave);
if (it == m_connectedSlaves.end()) {
return false;
}
PerSlaveQueue &jobs = it.value();
if (jobs.runningJob || jobs.waitingList.isEmpty()) {
// a slave that was busy running a job was not runnable.
// a slave that has no waiting job(s) was not runnable either.
Q_ASSERT(!m_runnableSlaves.contains(slave));
}
const bool removedRunning = jobs.runningJob == job;
const bool removedWaiting = jobs.waitingList.removeAll(job) != 0;
if (removedRunning) {
jobs.runningJob = 0;
Q_ASSERT(!removedWaiting);
}
const bool removedTheJob = removedRunning || removedWaiting;
if (!slave->isAlive()) {
removeSlave(slave);
return removedTheJob;
}
if (removedRunning && jobs.waitingList.count()) {
m_runnableSlaves.insert(slave);
m_startJobsTimer.start();
}
if (removedWaiting && jobs.waitingList.isEmpty()) {
m_runnableSlaves.remove(slave);
}
return removedTheJob;
}
void ConnectedSlaveQueue::addSlave(Slave *slave)
{
Q_ASSERT(slave);
if (!m_connectedSlaves.contains(slave)) {
m_connectedSlaves.insert(slave, PerSlaveQueue());
}
}
bool ConnectedSlaveQueue::removeSlave(Slave *slave)
{
QHash<Slave *, PerSlaveQueue>::Iterator it = m_connectedSlaves.find(slave);
if (it == m_connectedSlaves.end()) {
return false;
}
PerSlaveQueue &jobs = it.value();
Q_FOREACH (SimpleJob *job, jobs.waitingList) {
// ### for compatibility with the old scheduler we don't touch the running job, if any.
// make sure that the job doesn't call back into Scheduler::cancelJob(); this would
// a) crash and b) be unnecessary because we clean up just fine.
SimpleJobPrivate::get(job)->m_schedSerial = 0;
job->kill();
}
m_connectedSlaves.erase(it);
m_runnableSlaves.remove(slave);
slave->kill();
return true;
}
// KDE5: only one caller, for doubtful reasons. remove this if possible.
bool ConnectedSlaveQueue::isIdle(Slave *slave)
{
QHash<Slave *, PerSlaveQueue>::Iterator it = m_connectedSlaves.find(slave);
if (it == m_connectedSlaves.end()) {
return false;
}
return it.value().runningJob == 0;
}
//private slot
void ConnectedSlaveQueue::startRunnableJobs()
{
QSet<Slave *>::Iterator it = m_runnableSlaves.begin();
while (it != m_runnableSlaves.end()) {
Slave *slave = *it;
if (!slave->isConnected()) {
// this polling is somewhat inefficient...
m_startJobsTimer.start();
++it;
continue;
}
it = m_runnableSlaves.erase(it);
PerSlaveQueue &jobs = m_connectedSlaves[slave];
SimpleJob *job = jobs.waitingList.takeFirst();
Q_ASSERT(!jobs.runningJob);
jobs.runningJob = job;
const KUrl url = job->url();
// no port is -1 in QUrl, but in kde3 we used 0 and the kioslaves assume that.
const int port = url.port() == -1 ? 0 : url.port();
if (slave->host() == "<reset>") {
MetaData configData = SlaveConfig::self()->configData(url.protocol(), url.host());
slave->setConfig(configData);
slave->setProtocol(url.protocol());
slave->setHost(url.host(), port, url.user(), url.pass());
}
Q_ASSERT(slave->protocol() == url.protocol());
Q_ASSERT(slave->host() == url.host());
Q_ASSERT(slave->port() == port);
startJob(job, slave);
}
}
static void ensureNoDuplicates(QMap<int, HostQueue *> *queuesBySerial) static void ensureNoDuplicates(QMap<int, HostQueue *> *queuesBySerial)
{ {
Q_UNUSED(queuesBySerial); Q_UNUSED(queuesBySerial);
@ -561,9 +420,7 @@ void ProtoQueue::removeJob(SimpleJob *job)
// should be a connected slave // should be a connected slave
// if the assertion fails the job has probably changed the host part of its URL while // if the assertion fails the job has probably changed the host part of its URL while
// running, so we can't find it by hostname. don't do this. // running, so we can't find it by hostname. don't do this.
const bool removed = m_connectedSlaveQueue.removeJob(job); Q_ASSERT(false);
Q_UNUSED(removed);
Q_ASSERT(removed);
} }
ensureNoDuplicates(&m_queuesBySerial); ensureNoDuplicates(&m_queuesBySerial);
@ -590,10 +447,9 @@ Slave *ProtoQueue::createSlave(const QString &protocol, SimpleJob *job, const KU
bool ProtoQueue::removeSlave (KIO::Slave *slave) bool ProtoQueue::removeSlave (KIO::Slave *slave)
{ {
const bool removedConnected = m_connectedSlaveQueue.removeSlave(slave);
const bool removedUnconnected = m_slaveKeeper.removeSlave(slave); const bool removedUnconnected = m_slaveKeeper.removeSlave(slave);
Q_ASSERT(!(removedConnected && removedUnconnected)); Q_ASSERT(!removedUnconnected);
return removedConnected || removedUnconnected; return removedUnconnected;
} }
QList<Slave *> ProtoQueue::allSlaves() const QList<Slave *> ProtoQueue::allSlaves() const
@ -602,7 +458,6 @@ QList<Slave *> ProtoQueue::allSlaves() const
Q_FOREACH (const HostQueue &hq, m_queuesByHostname) { Q_FOREACH (const HostQueue &hq, m_queuesByHostname) {
ret.append(hq.allSlaves()); ret.append(hq.allSlaves());
} }
ret.append(m_connectedSlaveQueue.allSlaves());
return ret; return ret;
} }
@ -728,9 +583,6 @@ public:
void jobFinished(KIO::SimpleJob *job, KIO::Slave *slave); void jobFinished(KIO::SimpleJob *job, KIO::Slave *slave);
void putSlaveOnHold(KIO::SimpleJob *job, const KUrl &url); void putSlaveOnHold(KIO::SimpleJob *job, const KUrl &url);
void removeSlaveOnHold(); void removeSlaveOnHold();
Slave *getConnectedSlave(const KUrl &url, const KIO::MetaData &metaData);
bool assignJobToSlave(KIO::Slave *slave, KIO::SimpleJob *job);
bool disconnectSlave(KIO::Slave *slave);
void checkSlaveOnHold(bool b); void checkSlaveOnHold(bool b);
void publishSlaveOnHold(); void publishSlaveOnHold();
Slave *heldSlaveForJob(KIO::SimpleJob *job); Slave *heldSlaveForJob(KIO::SimpleJob *job);
@ -871,22 +723,6 @@ void Scheduler::updateInternalMetaData(SimpleJob* job)
schedulerPrivate->updateInternalMetaData(job); schedulerPrivate->updateInternalMetaData(job);
} }
KIO::Slave *Scheduler::getConnectedSlave(const KUrl &url,
const KIO::MetaData &config )
{
return schedulerPrivate->getConnectedSlave(url, config);
}
bool Scheduler::assignJobToSlave(KIO::Slave *slave, KIO::SimpleJob *job)
{
return schedulerPrivate->assignJobToSlave(slave, job);
}
bool Scheduler::disconnectSlave(KIO::Slave *slave)
{
return schedulerPrivate->disconnectSlave(slave);
}
void Scheduler::registerWindow(QWidget *wid) void Scheduler::registerWindow(QWidget *wid)
{ {
schedulerPrivate->registerWindow(wid); schedulerPrivate->registerWindow(wid);
@ -1230,28 +1066,6 @@ void SchedulerPrivate::removeSlaveOnHold()
m_urlOnHold.clear(); m_urlOnHold.clear();
} }
Slave *SchedulerPrivate::getConnectedSlave(const KUrl &url, const KIO::MetaData &config)
{
QStringList proxyList;
const QString protocol = KProtocolManager::slaveProtocol(url, proxyList);
ProtoQueue *pq = protoQ(protocol, url.host());
Slave *slave = pq->createSlave(protocol, /* job */0, url);
if (slave) {
setupSlave(slave, url, protocol, proxyList, true, &config);
pq->m_connectedSlaveQueue.addSlave(slave);
slave->send( CMD_CONNECT );
q->connect(slave, SIGNAL(connected()),
SLOT(slotSlaveConnected()));
q->connect(slave, SIGNAL(error(int,QString)),
SLOT(slotSlaveError(int,QString)));
}
kDebug(7006) << url << slave;
return slave;
}
void SchedulerPrivate::slotSlaveConnected() void SchedulerPrivate::slotSlaveConnected()
{ {
kDebug(7006); kDebug(7006);
@ -1266,32 +1080,13 @@ void SchedulerPrivate::slotSlaveError(int errorNr, const QString &errorMsg)
Slave *slave = static_cast<Slave *>(q->sender()); Slave *slave = static_cast<Slave *>(q->sender());
kDebug(7006) << slave << errorNr << errorMsg; kDebug(7006) << slave << errorNr << errorMsg;
ProtoQueue *pq = protoQ(slave->protocol(), slave->host()); ProtoQueue *pq = protoQ(slave->protocol(), slave->host());
if (!slave->isConnected() || pq->m_connectedSlaveQueue.isIdle(slave)) { if (!slave->isConnected()) {
// Only forward to application if slave is idle or still connecting. // Only forward to application if slave is idle or still connecting.
// ### KDE5: can we remove this apparently arbitrary behavior and just always emit SlaveError? // ### KDE5: can we remove this apparently arbitrary behavior and just always emit SlaveError?
emit q->slaveError(slave, errorNr, errorMsg); emit q->slaveError(slave, errorNr, errorMsg);
} }
} }
bool SchedulerPrivate::assignJobToSlave(KIO::Slave *slave, SimpleJob *job)
{
kDebug(7006) << slave << job;
// KDE5: queueing of jobs can probably be removed, it provides very little benefit
ProtoQueue *pq = m_protocols.value(slave->protocol());
if (pq) {
pq->removeJob(job);
return pq->m_connectedSlaveQueue.queueJob(job, slave);
}
return false;
}
bool SchedulerPrivate::disconnectSlave(KIO::Slave *slave)
{
kDebug(7006) << slave;
ProtoQueue *pq = m_protocols.value(slave->protocol());
return (pq ? pq->m_connectedSlaveQueue.removeSlave(slave) : false);
}
void SchedulerPrivate::checkSlaveOnHold(bool b) void SchedulerPrivate::checkSlaveOnHold(bool b)
{ {
kDebug(7006) << b; kDebug(7006) << b;

75
kio/kio/scheduler.h
View file

@ -78,28 +78,11 @@ namespace KIO {
* *
* Example: * Example:
* \code * \code
* Slave *slave = KIO::Scheduler::getConnectedSlave(
* KUrl("pop3://bastian:password@mail.kde.org"));
* TransferJob *job1 = KIO::get( * TransferJob *job1 = KIO::get(
* KUrl("pop3://bastian:password@mail.kde.org/msg1")); * KUrl("pop3://bastian:password@mail.kde.org/msg1"));
* KIO::Scheduler::assignJobToSlave(slave, job1); * KIO::Scheduler::doJob(job1);
* TransferJob *job2 = KIO::get(
* KUrl("pop3://bastian:password@mail.kde.org/msg2"));
* KIO::Scheduler::assignJobToSlave(slave, job2);
* TransferJob *job3 = KIO::get(
* KUrl("pop3://bastian:password@mail.kde.org/msg3"));
* KIO::Scheduler::assignJobToSlave(slave, job3);
* *
* // ... Wait for jobs to finish... * // ... Wait for jobs to finish...
*
* KIO::Scheduler::disconnectSlave(slave);
* \endcode
*
* Note that you need to explicitly disconnect the slave when the
* connection goes down, so your error handler should contain:
* \code
* if (error == KIO::ERR_CONNECTION_BROKEN)
* KIO::Scheduler::disconnectSlave(slave);
* \endcode * \endcode
* *
* @see KIO::Slave * @see KIO::Slave
@ -117,7 +100,7 @@ namespace KIO {
* is available. This can be changed by calling setJobPriority. * is available. This can be changed by calling setJobPriority.
* @param job the job to register * @param job the job to register
*/ */
static void doJob(SimpleJob *job); static void doJob(KIO::SimpleJob *job);
/** /**
* Changes the priority of @p job; jobs of the same priority run in the order in which * Changes the priority of @p job; jobs of the same priority run in the order in which
@ -127,13 +110,13 @@ namespace KIO {
* @param job the job to change * @param job the job to change
* @param priority new priority of @p job, lower runs earlier * @param priority new priority of @p job, lower runs earlier
*/ */
static void setJobPriority(SimpleJob *job, int priority); static void setJobPriority(KIO::SimpleJob *job, int priority);
/** /**
* Stop the execution of a job. * Stop the execution of a job.
* @param job the job to cancel * @param job the job to cancel
*/ */
static void cancelJob(SimpleJob *job); static void cancelJob(KIO::SimpleJob *job);
/** /**
* Called when a job is done. * Called when a job is done.
@ -168,52 +151,6 @@ namespace KIO {
*/ */
static void publishSlaveOnHold(); static void publishSlaveOnHold();
/**
* Requests a slave for use in connection-oriented mode.
*
* @param url This defines the username,password,host & port to
* connect with.
* @param config Configuration data for the slave.
*
* @return A pointer to a connected slave or 0 if an error occurred.
* @see assignJobToSlave()
* @see disconnectSlave()
*/
static KIO::Slave *getConnectedSlave(const KUrl &url,
const KIO::MetaData &config = MetaData() );
/**
* Uses @p slave to do @p job.
* This function should be called immediately after creating a Job.
*
* @param slave The slave to use. The slave must have been obtained
* with a call to getConnectedSlave and must not
* be currently assigned to any other job.
* @param job The job to do.
*
* @return true is successful, false otherwise.
*
* @see getConnectedSlave()
* @see disconnectSlave()
* @see slaveConnected()
* @see slaveError()
*/
static bool assignJobToSlave(KIO::Slave *slave, KIO::SimpleJob *job);
/**
* Disconnects @p slave.
*
* @param slave The slave to disconnect. The slave must have been
* obtained with a call to getConnectedSlave
* and must not be assigned to any job.
*
* @return true is successful, false otherwise.
*
* @see getConnectedSlave
* @see assignJobToSlave
*/
static bool disconnectSlave(KIO::Slave *slave);
/** /**
* Register the mainwindow @p wid with the KIO subsystem * Register the mainwindow @p wid with the KIO subsystem
* Do not call this, it is called automatically from * Do not call this, it is called automatically from
@ -251,6 +188,8 @@ namespace KIO {
*/ */
static void updateInternalMetaData(SimpleJob* job); static void updateInternalMetaData(SimpleJob* job);
static Scheduler *self();
Q_SIGNALS: Q_SIGNALS:
void slaveConnected(KIO::Slave *slave); void slaveConnected(KIO::Slave *slave);
void slaveError(KIO::Slave *slave, int error, const QString &errorMsg); void slaveError(KIO::Slave *slave, int error, const QString &errorMsg);
@ -264,8 +203,6 @@ namespace KIO {
Scheduler(); Scheduler();
~Scheduler(); ~Scheduler();
static Scheduler *self();
Q_PRIVATE_SLOT(d_func(), void slotSlaveDied(KIO::Slave *slave)) Q_PRIVATE_SLOT(d_func(), void slotSlaveDied(KIO::Slave *slave))
Q_PRIVATE_SLOT(d_func(), void slotSlaveStatus(pid_t pid, const QByteArray &protocol, Q_PRIVATE_SLOT(d_func(), void slotSlaveStatus(pid_t pid, const QByteArray &protocol,
const QString &host, bool connected)) const QString &host, bool connected))

35
kio/kio/scheduler_p.h
View file

@ -87,40 +87,6 @@ private:
QSet<KIO::SimpleJob *> m_runningJobs; QSet<KIO::SimpleJob *> m_runningJobs;
}; };
struct PerSlaveQueue
{
PerSlaveQueue() : runningJob(0) {}
QList <SimpleJob *> waitingList;
SimpleJob *runningJob;
};
class ConnectedSlaveQueue : public QObject
{
Q_OBJECT
public:
ConnectedSlaveQueue();
bool queueJob(KIO::SimpleJob *job, KIO::Slave *slave);
bool removeJob(KIO::SimpleJob *job);
void addSlave(KIO::Slave *slave);
bool removeSlave(KIO::Slave *slave);
// KDE5: only one caller, for doubtful reasons. remove this if possible.
bool isIdle(KIO::Slave *slave);
bool isEmpty() const { return m_connectedSlaves.isEmpty(); }
QList<KIO::Slave *> allSlaves() const { return m_connectedSlaves.keys(); }
private slots:
void startRunnableJobs();
private:
// note that connected slaves stay here when idle, they are not returned to SlaveKeeper
QHash<KIO::Slave *, PerSlaveQueue> m_connectedSlaves;
QSet<KIO::Slave *> m_runnableSlaves;
QTimer m_startJobsTimer;
};
class SerialPicker class SerialPicker
{ {
public: public:
@ -159,7 +125,6 @@ public:
KIO::Slave *createSlave(const QString &protocol, KIO::SimpleJob *job, const KUrl &url); KIO::Slave *createSlave(const QString &protocol, KIO::SimpleJob *job, const KUrl &url);
bool removeSlave (KIO::Slave *slave); bool removeSlave (KIO::Slave *slave);
QList<KIO::Slave *> allSlaves() const; QList<KIO::Slave *> allSlaves() const;
ConnectedSlaveQueue m_connectedSlaveQueue;
private slots: private slots:
// start max one (non-connected) job and return // start max one (non-connected) job and return

19
kio/tests/kioslavetest.cpp
View file

@ -172,12 +172,15 @@ KioslaveTest::KioslaveTest( QString src, QString dest, uint op, uint pr )
main_widget->setMinimumSize( main_widget->sizeHint() ); main_widget->setMinimumSize( main_widget->sizeHint() );
setCentralWidget( main_widget ); setCentralWidget( main_widget );
slave = 0; connect(
// slave = KIO::Scheduler::getConnectedSlave(KUrl("ftp://ftp.gnu.org/")); KIO::Scheduler::self(),
KIO::Scheduler::connect(SIGNAL(slaveConnected(KIO::Slave*)), SIGNAL(slaveConnected(KIO::Slave*)),
this, SLOT(slotSlaveConnected())); this, SLOT(slotSlaveConnected())
KIO::Scheduler::connect(SIGNAL(slaveError(KIO::Slave*,int,QString)), );
this, SLOT(slotSlaveError())); connect(
KIO::Scheduler::self(), SIGNAL(slaveError(KIO::Slave*,int,QString)),
this, SLOT(slotSlaveError())
);
} }
void KioslaveTest::slotQuit(){ void KioslaveTest::slotQuit(){
@ -291,9 +294,8 @@ void KioslaveTest::startJob() {
} }
if (myJob) if (myJob)
{ {
if (slave)
KIO::Scheduler::assignJobToSlave(slave, myJob);
job = myJob; job = myJob;
KIO::Scheduler::doJob(myJob);
} }
statusBar()->addWidget( statusTracker->widget(job), 0 ); statusBar()->addWidget( statusTracker->widget(job), 0 );
@ -345,7 +347,6 @@ void KioslaveTest::slotSlaveConnected()
void KioslaveTest::slotSlaveError() void KioslaveTest::slotSlaveError()
{ {
kDebug() << "Error connected."; kDebug() << "Error connected.";
slave = 0;
} }
void KioslaveTest::printUDSEntry( const KIO::UDSEntry & entry ) void KioslaveTest::printUDSEntry( const KIO::UDSEntry & entry )

3
kio/tests/kioslavetest.h
View file

@ -36,8 +36,6 @@ public:
if ( job ) { if ( job ) {
job->kill( KJob::Quietly ); // kill the job quietly job->kill( KJob::Quietly ); // kill the job quietly
} }
if (slave)
KIO::Scheduler::disconnectSlave(slave);
} }
enum Operations { List = 0, ListRecursive, Stat, Get, Put, Copy, Move, Delete, Mkdir, Mimetype }; enum Operations { List = 0, ListRecursive, Stat, Get, Put, Copy, Move, Delete, Mkdir, Mimetype };
@ -105,7 +103,6 @@ private:
int selectedOperation; int selectedOperation;
int progressMode; int progressMode;
int putBuffer; int putBuffer;
KIO::Slave *slave;
}; };
#endif // KIOSLAVETEST_H #endif // KIOSLAVETEST_H