├── radeon-profile-daemon
    ├── extra
    │   └── radeon-profile-daemon.service
    ├── main.cpp
    ├── radeon-profile-daemon.pro
    ├── rpdthread.h
    └── rpdthread.cpp
├── .gitignore
├── README.md
└── LICENSE


/radeon-profile-daemon/extra/radeon-profile-daemon.service:
--------------------------------------------------------------------------------
 1 | [Unit]
 2 | Description=radeon-profile daemon
 3 | 
 4 | [Service]
 5 | Type=simple
 6 | ExecStart=/usr/bin/radeon-profile-daemon
 7 | 
 8 | [Install]
 9 | WantedBy=multi-user.target
10 | 


--------------------------------------------------------------------------------
/radeon-profile-daemon/main.cpp:
--------------------------------------------------------------------------------
 1 | #include <QCoreApplication>
 2 | #include "rpdthread.h"
 3 | 
 4 | int main(int argc, char *argv[])
 5 | {
 6 |     QCoreApplication a(argc, argv);
 7 | 
 8 |     rpdThread daemon;
 9 |     daemon.start();
10 | 
11 |     return a.exec();
12 | }
13 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # C++ objects and libs
 2 | 
 3 | *.slo
 4 | *.lo
 5 | *.o
 6 | *.a
 7 | *.la
 8 | *.lai
 9 | *.so
10 | *.dll
11 | *.dylib
12 | 
13 | # Qt-es
14 | 
15 | /.qmake.cache
16 | /.qmake.stash
17 | radeon-profile-daemon/.qmake.stash
18 | *.pro.user
19 | *.pro.user.*
20 | *.qbs.user
21 | *.qbs.user.*
22 | *.moc
23 | moc_*.cpp
24 | moc_*.h
25 | qrc_*.cpp
26 | ui_*.h
27 | Makefile*
28 | *build-*
29 | 
30 | # QtCreator
31 | 
32 | *.autosave
33 | 
34 | #QtCtreator Qml
35 | *.qmlproject.user
36 | *.qmlproject.user.*
37 | 
38 | # Binary
39 | radeon-profile-daemon/radeon-profile-daemon
40 | 


--------------------------------------------------------------------------------
/radeon-profile-daemon/radeon-profile-daemon.pro:
--------------------------------------------------------------------------------
 1 | #-------------------------------------------------
 2 | #
 3 | # Project created by QtCreator 2014-05-10T15:06:55
 4 | #
 5 | #-------------------------------------------------
 6 | 
 7 | QT       += core network
 8 | 
 9 | QT       -= gui
10 | 
11 | TARGET = radeon-profile-daemon
12 | CONFIG   += console
13 | CONFIG   -= app_bundle
14 | 
15 | QMAKE_CXXFLAGS += -std=c++11
16 | 
17 | #   https://forum.qt.io/topic/10178/solved-qdebug-and-debug-release/2
18 | #   http://doc.qt.io/qt-5/qtglobal.html#QtMsgType-enum
19 | #   qDebug will work only when compiled for Debug
20 | #   QtWarning, QtCritical and QtFatal will work also on Release
21 | 
22 | CONFIG(release, debug|release):DEFINES += QT_NO_DEBUG_OUTPUT
23 | 
24 | 
25 | TEMPLATE = app
26 | 
27 | 
28 | SOURCES += main.cpp \
29 |     rpdthread.cpp
30 | 
31 | HEADERS += \
32 |     rpdthread.h
33 | 
34 | DESTDIR= target
35 | 
36 | bin.path = /usr/bin
37 | bin.files = target/radeon-profile-daemon
38 | 
39 | service.path = /usr/lib/systemd/system
40 | service.files = extra/radeon-profile-daemon.service
41 | 
42 | INSTALLS += \
43 | 	bin \
44 | 	service
45 |     


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | System daemon for reading info about Radeon GPU clocks and volts as well as control card power profiles so the GUI [radeon-profile](https://github.com/marazmista/radeon-profile) application can be run as normal user.
 2 | 
 3 | Supprts opensource xf86-video-ati and  xf86-video-amdgpu drivers.
 4 | 
 5 | # Dependencies
 6 | 
 7 | 1. `qt5-base`
 8 | 
 9 | # Build
10 | 
11 | Type:
12 | 
13 | ```
14 | git clone https://github.com/marazmista/radeon-profile-daemon.git &&
15 | cd radeon-profile-daemon/radeon-profile-daemon
16 | qmake &&
17 | make
18 | ``` 
19 | 
20 | # systemd service
21 | 
22 | There is a service file for systemd in radeon-profile-daemon/extra. If installed manually, copy service file to `/etc/systemd/system/`. After that, execute `systemctl enable radeon-profile-daemon.service` and `systemctl start radeon-profile-daemon.service` to make the daemon running.
23 | 
24 | # Links
25 | 
26 | * AUR package: https://aur.archlinux.org/packages/radeon-profile-daemon-git
27 | * radeon-profile: https://github.com/marazmista/radeon-profile
28 | * radeon-profile AUR package: https://aur.archlinux.org/packages/radeon-profile-git
29 | * radeon-profile thread: http://phoronix.com/forums/showthread.php?83602-radeon-profile-tool-for-changing-profiles-and-monitoring-some-GPU-parameters
30 | 


--------------------------------------------------------------------------------
/radeon-profile-daemon/rpdthread.h:
--------------------------------------------------------------------------------
 1 | 
 2 | // copyright marazmista @ 12.05.2014
 3 | 
 4 | /*
 5 | * class for reading stuff about card and communicate with gui
 6 | * Things going this way. Daemon runs and listens for connection to daemonServer. 
 7 | * If connnection is established, then daemon attach itself to sharedmemory where
 8 | * it will put data about the clocks. After, it listens for signals. If signal requests
 9 | * clocks data, it place the info in shared mem where gui can read from.
10 | * Shared mem block is owned and created by gui.
11 | * When signal is about changing profile or power level then daemon sets what gui wants
12 | * and that is it.
13 | */
14 | 
15 | #ifndef RPDTHREAD_H
16 | #define RPDTHREAD_H
17 | 
18 | #include <QThread>
19 | #include <QLocalServer>
20 | #include <QLocalSocket>
21 | #include <QSharedMemory>
22 | #include <QTimer>
23 | 
24 | #define SEPARATOR '#'
25 | #define SIGNAL_CONFIG '0'
26 | #define SIGNAL_READ_CLOCKS '1'
27 | #define SIGNAL_SET_VALUE '2'
28 | #define SIGNAL_TIMER_ON '4'
29 | #define SIGNAL_TIMER_OFF '5'
30 | #define SIGNAL_SHAREDMEM_KEY '6'
31 | #define SIGNAL_ALIVE '7'
32 | 
33 | const QString appVersion = "20190603";
34 | const QString serverSocketPath = "/run/radeon-profile-daemon-server";
35 | 
36 | class rpdThread : public QThread
37 | {
38 |     Q_OBJECT
39 | public:
40 |     explicit rpdThread();
41 |     ~rpdThread() = default;
42 | 
43 | signals:
44 | 
45 | public slots:
46 |     void newConnection();
47 |     void onTimer();
48 |     void disconnected();
49 |     void checkConnection();
50 |     void readSignalAndPerformTask();
51 | 
52 | private:
53 |     QLocalSocket *signalReceiver;
54 |     QLocalServer daemonServer;
55 |     QSharedMemory sharedMem;
56 |     QTimer timer, connectionCheckTimer;
57 |     QString clocksDataPath, fanControlPath;
58 |     bool connectionConfirmed;
59 | 
60 | 
61 |     void readData();
62 |     bool setNewValue(const QString &filePath, const QString &newValue);
63 |     bool configure(const QString &type, const QString &filePath);
64 |     void configureSharedMem(const QString &key);
65 |     bool checkRequiredCommandLength(unsigned required, unsigned currentIndex, unsigned size);
66 |     void createServer();
67 |     void closeConnection();
68 |     void sendMessage(const QString &msg);
69 |     void resetSystemDefaults();
70 |     bool checkPathValidity(const QString &filePath);
71 | };
72 | 
73 | #endif // RPDTHREAD_H
74 | 


--------------------------------------------------------------------------------
/radeon-profile-daemon/rpdthread.cpp:
--------------------------------------------------------------------------------
  1 | 
  2 | // copyright marazmista @ 12.05.2014
  3 | 
  4 | #include "rpdthread.h"
  5 | #include <QFile>
  6 | #include <QFileInfo>
  7 | #include <QDebug>
  8 | #include <QStringList>
  9 | #include <QProcess>
 10 | #include <QDataStream>
 11 | 
 12 | rpdThread::rpdThread() : QThread(),
 13 |     signalReceiver(nullptr),
 14 |     connectionConfirmed(false)
 15 | {
 16 |     qInfo() << "radeon-profile-daemon (v. " + appVersion + ")";
 17 |     qDebug() << "Starting in debug mode";
 18 | 
 19 |     createServer();
 20 |     connect(&daemonServer,SIGNAL(newConnection()),this,SLOT(newConnection()));
 21 |     connect(&timer,SIGNAL(timeout()),this,SLOT(onTimer()));
 22 | 
 23 |     connectionCheckTimer.setInterval(20000);
 24 |     connect(&connectionCheckTimer, SIGNAL(timeout()), this, SLOT(checkConnection()));
 25 | 
 26 | }
 27 | 
 28 | void rpdThread::newConnection() {
 29 |     qInfo() << "Connecting to the client";
 30 |     signalReceiver = daemonServer.nextPendingConnection();
 31 |     connect(signalReceiver,SIGNAL(readyRead()),this,SLOT(readSignalAndPerformTask()));
 32 |     connect(signalReceiver,SIGNAL(disconnected()),this,SLOT(disconnected()));
 33 | 
 34 |     connectionConfirmed = true;
 35 |     connectionCheckTimer.start();
 36 | 
 37 |     // close server, to avoid multiple connections
 38 |     daemonServer.close();
 39 | }
 40 | 
 41 | void rpdThread::createServer()
 42 | {
 43 |     if (daemonServer.isListening())
 44 |         return;
 45 | 
 46 |     qInfo() << "Awaiting connections...";
 47 | 
 48 |     QLocalServer::removeServer(serverSocketPath);
 49 |     daemonServer.listen(serverSocketPath);
 50 |     QFile::setPermissions(serverSocketPath, QFile(serverSocketPath).permissions() | QFile::WriteOther | QFile::ReadOther);
 51 | }
 52 | 
 53 | void rpdThread::closeConnection()
 54 | {
 55 |     timer.stop();
 56 | 
 57 |     if (sharedMem.isAttached())
 58 |         sharedMem.detach();
 59 | 
 60 |     signalReceiver->close();
 61 |     signalReceiver->deleteLater();
 62 | 
 63 |     connectionCheckTimer.stop();
 64 |     connectionConfirmed = false;
 65 | 
 66 |     // create server for new connections
 67 |     createServer();
 68 | }
 69 | 
 70 | void rpdThread::disconnected() {
 71 |     qInfo() << "Client disconnected";
 72 | 
 73 |     closeConnection();
 74 | }
 75 | 
 76 | void rpdThread::sendMessage(const QString &msg)
 77 | {
 78 |     QByteArray feedback;
 79 |     QDataStream out(&feedback, QIODevice::WriteOnly);
 80 |     out.setVersion(QDataStream::Qt_5_7);
 81 | 
 82 |     out << msg;
 83 | 
 84 |     if (signalReceiver != nullptr)
 85 |         signalReceiver->write(feedback);
 86 | }
 87 | 
 88 | void rpdThread::checkConnection() {
 89 |     if (!connectionConfirmed) {
 90 |         qDebug() << "Confirmation not received, closing connection";
 91 | 
 92 |         resetSystemDefaults();
 93 |         closeConnection();
 94 |         return;
 95 |     }
 96 | 
 97 |     qDebug() << "Asking connection confirmation...";
 98 |     connectionConfirmed = false;
 99 | 
100 |     sendMessage("7#1#");
101 | }
102 | 
103 | void rpdThread::onTimer() {
104 |     if (signalReceiver->state() == QLocalSocket::ConnectedState)
105 |         readData();
106 | }
107 | 
108 | // the signal comes in and:
109 | // 0 - config (card index)
110 | // 1 - give me the clocks
111 | // 2 - set value to specified file
112 | //    signal type + new value + # + file path
113 | //
114 | // 4 - start timer with given interval
115 | // 5 - stop timer
116 | // 6 - shared mem key
117 | // 7 - alive msg
118 | void rpdThread::readSignalAndPerformTask() {
119 |     const auto signal = QString(signalReceiver->readAll());
120 |     qDebug() << "Received signal: " << signal;
121 | 
122 |     if (signal.isEmpty()) {
123 |         qWarning() << "Received empty signal";
124 |         return;
125 |     }
126 | 
127 |     // every received signal confirms connection
128 |     if (connectionCheckTimer.isActive()) {
129 |         connectionConfirmed = true;
130 |         connectionCheckTimer.start();
131 |     }
132 | 
133 |     bool setValueSucces = false;
134 |     QString confirmationMsg;
135 | 
136 |     QStringList instructions = signal.split(SEPARATOR);
137 |     instructions.removeLast();
138 | 
139 |     int size = instructions.size();
140 | 
141 |     // Cycle through instructions
142 |     for (int index = 0; index < size; index++) {
143 | 
144 |         // Check the first char (instruction type)
145 |         switch (instructions.at(index)[0].toLatin1()) {
146 | 
147 |                 // SIGNAL_CONFIG + SEPARATOR + CLOCKS_PATH + SEPARATOR
148 |             case SIGNAL_CONFIG: {
149 |                 qDebug() << "Elaborating a CONFIG signal";
150 | 
151 |                 if (!checkRequiredCommandLength(2, index, size)) {
152 |                     qCritical() << "Invalid command! (index out of bounds)";
153 |                     return;
154 |                 }
155 | 
156 |                 const auto type = instructions.at(++index),
157 |                         filePath = instructions.at(++index);
158 | 
159 |                 if (!configure(type, filePath))
160 |                     qWarning() << "Configuration failed.";
161 | 
162 |                 }
163 |                 break;
164 |                 // SIGNAL_READ_CLOCKS + SEPARATOR
165 |             case SIGNAL_READ_CLOCKS:
166 |                 qDebug() << "Elaborating a READ_CLOCKS signal";
167 |                 readData();
168 |                 break;
169 | 
170 |                 // SIGNAL_SET_VALUE + SEPARATOR + VALUE + SEPARATOR + PATH + SEPARATOR
171 |             case SIGNAL_SET_VALUE: {
172 |                 qDebug() << "Elaborating a SET_VALUE signal";
173 | 
174 |                 if (!checkRequiredCommandLength(2, index, size)) {
175 |                     qCritical() << "Invalid command! (index out of bounds)";
176 |                     return;
177 |                 }
178 | 
179 |                 const auto value = instructions.at(++index),
180 |                         path = instructions.at(++index);
181 | 
182 |                 if (setNewValue(path, value)) {
183 |                         setValueSucces = true;
184 |                         confirmationMsg.append(value).append(SEPARATOR);
185 |                 }
186 | 
187 |                 break;
188 |             }
189 | 
190 |                 // SIGNAL_TIMER_ON + SEPARATOR + INTERVAL + SEPARATOR
191 |             case SIGNAL_TIMER_ON: {
192 |                 qDebug() << "Elaborating a TIMER_ON signal";
193 | 
194 |                 if (!checkRequiredCommandLength(1, index, size)) {
195 |                     qCritical() << "Invalid command! (index out of bounds)";
196 |                     return;
197 |                 }
198 | 
199 |                 int inputMillis = instructions.at(++index).toInt(); // Seconds integer
200 | 
201 |                 if (inputMillis < 1) {
202 |                     qCritical() << "Invalid value TIMER_ON value: " << instructions.at(index);
203 |                     break;
204 |                 }
205 | 
206 |                 qDebug() << "Setting up timer with seconds interval: " << inputMillis;
207 |                 timer.start(inputMillis * 1000); // Config and start the timer
208 |                 break;
209 |             }
210 | 
211 |                 // SIGNAL_TIMER_OFF + SEPARATOR
212 |             case SIGNAL_TIMER_OFF:
213 |                 qDebug() << "Elaborating a TIMER_OFF signal";
214 |                 timer.stop();
215 |                 break;
216 | 
217 |             case SIGNAL_SHAREDMEM_KEY: {
218 | 
219 |                 if (!checkRequiredCommandLength(1, index, size)) {
220 |                     qCritical() << "Invalid command! (index out of bounds)";
221 |                     return;
222 |                 }
223 | 
224 |                 const auto key = instructions.at(++index);
225 |                 qDebug() << "Shared memory key: " << key;
226 |                 configureSharedMem(key);
227 |                 break;
228 |             }
229 |             case SIGNAL_ALIVE:
230 |                 qDebug() << "ALIVE signal received";
231 | 
232 |                 if (!checkRequiredCommandLength(1, index, size)) {
233 |                     qCritical() << "Invalid command! (index out of bounds)";
234 |                     return;
235 |                 }
236 | 
237 |                 if (instructions.at(++index) == "0") {
238 |                     qDebug() << "Connection confirmation is disabled";
239 |                     connectionConfirmed = true;
240 |                     connectionCheckTimer.stop();
241 |                 }
242 | 
243 |                 break;
244 |             default:
245 |                 qWarning() << "Unknown signal received: " << signal;
246 |                 break;
247 |         }
248 | 
249 |     }
250 | 
251 |     if (setValueSucces)
252 |         sendMessage(confirmationMsg);
253 | 
254 | }
255 | 
256 | bool rpdThread::checkRequiredCommandLength(unsigned required, unsigned currentIndex, unsigned size) {
257 |     return !(size <= currentIndex + required);
258 | }
259 | 
260 | bool rpdThread::checkPathValidity(const QString &filePath) {
261 |     // The file path is not in whitelisted directories
262 |     // This is a security check to prevent exploiters from reading root files
263 |     if (!filePath.startsWith("/sys/kernel/debug/dri/") && !filePath.startsWith("/sys/class/drm/")) {
264 |         qCritical() << "Illegal path: " << filePath;
265 |         return false;
266 |     }
267 | 
268 |     return true;
269 | }
270 | 
271 | bool rpdThread::configure(const QString &type, const QString &filePath) {
272 |     if (!checkPathValidity(filePath))
273 |         return false;
274 | 
275 |     if (type == "pm_info") {
276 |         QFileInfo clocksFileInfo(filePath);
277 |         if (!clocksFileInfo.exists()) {
278 |             // The indicated clocks file path does not exist
279 |             qCritical() << "Indicated clocks data path does not exist: " << filePath;
280 |             return false;
281 |         }
282 | 
283 |         if (!clocksFileInfo.isFile()) {
284 |             // The path is a directory, not a file
285 |             qCritical() << "Indicated clocks data path is not a valid file: " << filePath;
286 |             return false;
287 |         }
288 | 
289 |         qDebug() << "The new clocks data path is " << filePath;
290 |         clocksDataPath = filePath; // Remember the path for the next readings
291 | 
292 |         // The clocks data file will be copied in /tmp/
293 |         // Let's calculate the destination file path
294 |         QString destination = "/tmp/" + clocksFileInfo.fileName();
295 |         // Example: /sys/kernel/debug/dri/0/radeon_pm_info -> /tmp/radeon_pm_info
296 |         qDebug() << clocksDataPath << " will be copied into " << destination;
297 | 
298 |         system(QString("cp " + clocksDataPath + " " + destination).toStdString().c_str());
299 | 
300 |     } else if (type == "pwm1_enable") {
301 |         qDebug() << "Fan control mode file: " << filePath;
302 | 
303 |         fanControlPath = filePath;
304 |     }
305 | 
306 |     return true;
307 | }
308 | 
309 | void rpdThread::readData() {
310 |     if (!sharedMem.isAttached() && !sharedMem.attach()) {
311 |         qWarning() << "Shared memory is not attached, can't write data: " << sharedMem.errorString();
312 |         return;
313 |     }
314 | 
315 |     QFile f(clocksDataPath);
316 |     QByteArray data;
317 |     if (!f.open(QIODevice::ReadOnly)) {
318 |         qWarning() << "Unable to open file " << clocksDataPath;
319 |         return;
320 |     }
321 | 
322 |     qDebug() << "Reading file: " << clocksDataPath;
323 |     data = f.readAll();
324 |     f.close();
325 | 
326 |     if (data.isEmpty()) {
327 |         qWarning() << "Unable to read file " << clocksDataPath;
328 |         return;
329 |     }
330 | 
331 |     if (!sharedMem.lock()) {
332 |         qWarning() << "Shared memory can't be locked, can't write data: " << sharedMem.errorString();
333 |         return;
334 |     }
335 | 
336 |     char *to = (char*)sharedMem.data();
337 |     if (to == NULL) {
338 |         qWarning() << "Shared memory data pointer is invalid: " << sharedMem.errorString();
339 |         sharedMem.unlock();
340 |         return;
341 |     }
342 | 
343 |     memcpy(sharedMem.data(), data.constData(), sharedMem.size());
344 |     sharedMem.unlock();
345 | }
346 | 
347 | bool rpdThread::setNewValue(const QString &filePath, const QString &newValue) {
348 |     if (filePath.isEmpty()) {
349 |         // The specified file path is invalid
350 |         qWarning() << "The file path indicated to be set is empty. Lost value: " << newValue;
351 |         return false;
352 |     }
353 | 
354 |     if (!checkPathValidity(filePath)) {
355 |         // The file path is not in whitelisted directories
356 |         // This is a security check to prevent exploiters from writing files as root system wide
357 |         qWarning() << "Illegal path to be set: " << filePath;
358 |         return false;
359 |     }
360 | 
361 |     QFileInfo fileInfo(filePath);
362 |     if (!fileInfo.exists()) {
363 |         // The indicated path does not exist
364 |         qWarning() << "The ndicated path to be set does not exist: " << filePath;
365 |         return false;
366 |     }
367 | 
368 |     if (!fileInfo.isFile()) {
369 |         // The path is a directory, not a file
370 |         qWarning() << "Indicated path to be set is not a valid file: " << filePath;
371 |         return false;
372 |     }
373 | 
374 |     QFile file(filePath);
375 |     if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
376 |         // If the file does not open successfully
377 |         qWarning() << "Failed to open the file to be set: " << filePath;
378 |         return false;
379 |     }
380 | 
381 |     qDebug() << newValue << " will be written into " << filePath;
382 |     QTextStream stream(&file);
383 |     stream << newValue + "\n";
384 | 
385 |     if (!file.flush())
386 |         // If writing down the changes fails
387 |         qWarning() << "Failed writing in " << filePath;
388 | 
389 |     file.close();
390 | 
391 |     return true;
392 | }
393 | 
394 | void rpdThread::configureSharedMem(const QString &key) {
395 |     sharedMem.setKey(key);
396 | 
397 |     if (!sharedMem.isAttached()) {
398 |         qDebug() << "Shared memory is not attached, trying to attach";
399 | 
400 |         if (!sharedMem.attach())
401 |             qCritical() << "Unable to attach to shared memory:" << sharedMem.errorString();
402 | 
403 |     }
404 | }
405 | 
406 | void rpdThread::resetSystemDefaults() {
407 |     qWarning() << "Restoring system defaults";
408 | 
409 |     // reset fan control
410 |     if (!fanControlPath.isEmpty()) {
411 |         qWarning() << "Setting fan control mode to auto";
412 |         setNewValue(fanControlPath, "2");
413 |     }
414 | 
415 |     // reset other settings...
416 | }
417 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  5 |  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |                             Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                     GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |                             NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 
280 |                      END OF TERMS AND CONDITIONS
281 | 
282 |             How to Apply These Terms to Your New Programs
283 | 
284 |   If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 | 
288 |   To do so, attach the following notices to the program.  It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 | 
293 |     <one line to give the program's name and a brief idea of what it does.>
294 |     Copyright (C) <year>  <name of author>
295 | 
296 |     This program is free software; you can redistribute it and/or modify
297 |     it under the terms of the GNU General Public License as published by
298 |     the Free Software Foundation; either version 2 of the License, or
299 |     (at your option) any later version.
300 | 
301 |     This program is distributed in the hope that it will be useful,
302 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
303 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
304 |     GNU General Public License for more details.
305 | 
306 |     You should have received a copy of the GNU General Public License along
307 |     with this program; if not, write to the Free Software Foundation, Inc.,
308 |     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 | 
310 | Also add information on how to contact you by electronic and paper mail.
311 | 
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 | 
315 |     Gnomovision version 69, Copyright (C) year name of author
316 |     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 |     This is free software, and you are welcome to redistribute it
318 |     under certain conditions; type `show c' for details.
319 | 
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License.  Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 | 
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary.  Here is a sample; alter the names:
328 | 
329 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 |   `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 | 
332 |   <signature of Ty Coon>, 1 April 1989
333 |   Ty Coon, President of Vice
334 | 
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs.  If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library.  If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 | 


--------------------------------------------------------------------------------