annotate MySQL/Plugins/MySQLStorageArea.cpp @ 135:e26690365c25

MySQL: Added an advisory lock to avoid race conditions during database setup
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 08 May 2019 21:09:18 +0200
parents 714c5d2bee76
children 52b3859ee0b7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
67
714c5d2bee76 preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 17
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
17
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #include "MySQLStorageArea.h"
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "../../Framework/MySQL/MySQLDatabase.h"
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "../../Framework/MySQL/MySQLTransaction.h"
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include <Core/Logging.h>
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <boost/math/special_functions/round.hpp>
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 namespace OrthancDatabases
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 IDatabase* MySQLStorageArea::OpenInternal()
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 std::auto_ptr<MySQLDatabase> db(new MySQLDatabase(parameters_));
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 db->Open();
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 if (parameters_.HasLock())
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 db->AdvisoryLock(43 /* some arbitrary constant */);
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
135
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
45 /**
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
46 * Try and acquire a transient advisory lock to protect the setup
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
47 * of the database, because concurrent statements like "CREATE
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
48 * TABLE" are not protected by transactions.
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
49 * https://groups.google.com/d/msg/orthanc-users/yV3LSTh_TjI/h3PRApJFBAAJ
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
50 **/
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
51 MySQLDatabase::TransientAdvisoryLock lock(*db, 44 /* some arbitrary constant */);
e26690365c25 MySQL: Added an advisory lock to avoid race conditions during database setup
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 67
diff changeset
52
17
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 MySQLTransaction t(*db);
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 int64_t size;
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 if (db->LookupGlobalIntegerVariable(size, "max_allowed_packet"))
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 int mb = boost::math::iround(static_cast<double>(size) /
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 static_cast<double>(1024 * 1024));
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 LOG(WARNING) << "Your MySQL server cannot "
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 << "store DICOM files larger than " << mb << "MB";
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 LOG(WARNING) << " => Consider increasing \"max_allowed_packet\" "
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 << "in \"my.cnf\" if this limit is insufficient for your use";
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 else
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 LOG(WARNING) << "Unable to auto-detect the maximum size of DICOM "
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 << "files that can be stored in this MySQL server";
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 if (clearAll_)
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 db->Execute("DROP TABLE IF EXISTS StorageArea", false);
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 db->Execute("CREATE TABLE IF NOT EXISTS StorageArea("
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 "uuid VARCHAR(64) NOT NULL PRIMARY KEY,"
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 "content LONGBLOB NOT NULL,"
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 "type INTEGER NOT NULL)", false);
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 t.Commit();
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 return db.release();
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 MySQLStorageArea::MySQLStorageArea(const MySQLParameters& parameters) :
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 StorageBackend(new Factory(*this)),
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 parameters_(parameters),
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 clearAll_(false)
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 {
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
54ea251aed70 unit test
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }