RdbmsCatalogue.hpp 47.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
 * The CERN Tape Archive (CTA) project
 * Copyright (C) 2015  CERN
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "catalogue/Catalogue.hpp"
22
#include "catalogue/RequesterAndGroupMountPolicies.hpp"
Steven Murray's avatar
Steven Murray committed
23
#include "catalogue/TimeBasedCache.hpp"
24
#include "common/threading/Mutex.hpp"
25
#include "rdbms/ConnPool.hpp"
26
#include "rdbms/Login.hpp"
27

28
#include <memory>
29

30
31
32
33
34
35
36
namespace cta {
namespace common {
namespace dataStructures {

/**
 * Forward declaration.
 */
37
class TapeFile;
38
39
40
41
42

} // namespace dataStructures
} // namespace catalogue
} // namespace cta

43
44
45
namespace cta {
namespace catalogue {

46
47
48
49
50
/**
 * Forward declaration.
 */
class ArchiveFileRow;

51
52
53
/**
 * Forward declaration.
 */
54
class RdbmsArchiveFileItorImpl;
55

56
/**
Steven Murray's avatar
Steven Murray committed
57
 * CTA catalogue implemented using a relational database backend.
58
 */
59
class RdbmsCatalogue: public Catalogue {
60
protected:
61

62
63
64
  /**
   * Protected constructor only to be called by sub-classes.
   *
65
   * @param log Object representing the API to the CTA logging system.
66
67
   * @param login The database login details to be used to create new
   * connections.
68
69
70
71
72
73
   * @param nbConns The maximum number of concurrent connections to the
   * underlying relational database for all operations accept listing archive
   * files which can be relatively long operations.
   * @param nbArchiveFileListingConns The maximum number of concurrent
   * connections to the underlying relational database for the sole purpose of
   * listing archive files.
74
75
76
   * @param maxTriesToConnext The maximum number of times a single method should
   * try to connect to the database in the event of LostDatabaseConnection
   * exceptions being thrown.
77
   */
78
79
  RdbmsCatalogue(
    log::Logger &log,
80
    const rdbms::Login &login,
81
    const uint64_t nbConns,
82
    const uint64_t nbArchiveFileListingConns,
83
    const uint32_t maxTriesToConnect);
84

85
86
public:

87
88
89
  /**
   * Destructor.
   */
90
  ~RdbmsCatalogue() override;
91

92
93
94
  /////////////////////////////////////////////////////////////////////
  // START OF METHODS DIRECTLY INVOLVED IN DATA TRANSFER AND SCHEDULING
  /////////////////////////////////////////////////////////////////////
95
96
97
98
99
100
101
102

  /**
   * Notifies the catalogue that the specified tape was labelled.
   *
   * @param vid The volume identifier of the tape.
   * @param drive The name of tape drive that was used to label the tape.
   * @param lbpIsOn Set to true if Logical Block Protection (LBP) was enabled.
   */
103
  void tapeLabelled(const std::string &vid, const std::string &drive, const bool lbpIsOn) override;
104

105
  /**
106
107
108
   * Checks the specified archival could take place and returns a new and
   * unique archive file identifier that can be used by a new archive file
   * within the catalogue.
109
110
111
112
113
114
115
116
117
118
   *
   * @param diskInstanceName The name of the disk instance to which the
   * storage class belongs.
   * @param storageClassName The name of the storage class of the file to be
   * archived.  The storage class name is only guaranteed to be unique within
   * its disk instance.  The storage class name will be used by the Catalogue
   * to determine the destination tape pool for each tape copy.
   * @param user The user for whom the file is to be archived.  This will be
   * used by the Catalogue to determine the mount policy to be used when
   * archiving the file.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
   * @return The new archive file identifier.
   */
  uint64_t checkAndGetNextArchiveFileId(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const common::dataStructures::UserIdentity &user) override;

  /**
   * Returns the information required to queue an archive request.
   *
   * @param diskInstanceName The name of the disk instance to which the
   * storage class belongs.
   * @param storageClassName The name of the storage class of the file to be
   * archived.  The storage class name is only guaranteed to be unique within
   * its disk instance.  The storage class name will be used by the Catalogue
   * to determine the destination tape pool for each tape copy.
   * @param user The user for whom the file is to be archived.  This will be
   * used by the Catalogue to determine the mount policy to be used when
   * archiving the file.
   * @return The information required to queue an archive request.
139
140
141
142
143
144
   */
  common::dataStructures::ArchiveFileQueueCriteria getArchiveFileQueueCriteria(
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const common::dataStructures::UserIdentity &user) override;

145
146
147
148
149
150
  /**
   * Returns the list of tapes that can be written to by a tape drive in the
   * specified logical library, in other words tapes that are labelled, not
   * disabled, not full and are in the specified logical library.
   *
   * @param logicalLibraryName The name of the logical library.
151
   * @return The list of tapes for writing.
152
   */
153
  std::list<TapeForWriting> getTapesForWriting(const std::string &logicalLibraryName) const override;
154
155

  /**
156
157
158
159
160
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to archive files.
   *
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for archiving files last.
161
162
   *
   * @param vid The volume identifier of the tape.
163
   * @param drive The name of the drive where the tape was mounted.
164
   */
165
  void tapeMountedForArchive(const std::string &vid, const std::string &drive) override;
166

167
  /**
168
169
   * Prepares for a file retrieval by returning the information required to
   * queue the associated retrieve request(s).
170
   *
171
172
   * @param diskInstanceName The name of the instance from where the retrieval
   * request originated
173
174
175
176
177
   * @param archiveFileId The unique identifier of the archived file that is
   * to be retrieved.
   * @param user The user for whom the file is to be retrieved.  This will be
   * used by the Catalogue to determine the mount policy to be used when
   * retrieving the file.
178
   * @param lc The log context.
179
180
   *
   * @return The information required to queue the associated retrieve request(s).
181
   */
182
  common::dataStructures::RetrieveFileQueueCriteria prepareToRetrieveFile(
183
    const std::string &diskInstanceName,
184
    const uint64_t archiveFileId,
185
186
    const common::dataStructures::UserIdentity &user,
    log::LogContext &lc) override;
187
188
189
190
191

  /**
   * Notifies the CTA catalogue that the specified tape has been mounted in
   * order to retrieve files.
   *
192
193
194
   * The purpose of this method is to keep track of which drive mounted a given
   * tape for retrieving files last.
   *
195
196
197
   * @param vid The volume identifier of the tape.
   * @param drive The name of the drive where the tape was mounted.
   */
198
  void tapeMountedForRetrieve(const std::string &vid, const std::string &drive) override;
199

200
201
202
203
204
205
  /**
   * This method notifies the CTA catalogue that there is no more free space on
   * the specified tape.
   *
   * @param vid The volume identifier of the tape.
   */
206
  void noSpaceLeftOnTape(const std::string &vid) override;
207
208
209
210

  ///////////////////////////////////////////////////////////////////
  // END OF METHODS DIRECTLY INVOLVED IN DATA TRANSFER AND SCHEDULING
  ///////////////////////////////////////////////////////////////////
211

Steven Murray's avatar
Steven Murray committed
212
  void createAdminUser(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) override;
213
214
  void deleteAdminUser(const std::string &username) override;
  std::list<common::dataStructures::AdminUser> getAdminUsers() const override;
Steven Murray's avatar
Steven Murray committed
215
  void modifyAdminUserComment(const common::dataStructures::SecurityIdentity &admin, const std::string &username, const std::string &comment) override;
216

217
218
219
  /**
   * Creates the specified storage class.
   *
Steven Murray's avatar
Steven Murray committed
220
   * @param admin The administrator.
221
222
   * @param storageClass The storage class.
   */
223
  void createStorageClass(
Steven Murray's avatar
Steven Murray committed
224
    const common::dataStructures::SecurityIdentity &admin,
225
    const common::dataStructures::StorageClass &storageClass) override;
226
227
228
229
230
231
232
233
234

  /**
   * Deletes the specified storage class.
   *
   * @param diskInstanceName The name of the disk instance to which the
   * storage class belongs.
   * @param stoargeClassName The name of the storage class which is only
   * guaranteed to be unique within its disk isntance.
   */
235
  void deleteStorageClass(const std::string &diskInstanceName, const std::string &storageClassName) override;
236

237
  std::list<common::dataStructures::StorageClass> getStorageClasses() const override;
Steven Murray's avatar
Steven Murray committed
238
239
  void modifyStorageClassNbCopies(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const uint64_t nbCopies) override;
  void modifyStorageClassComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &name, const std::string &comment) override;
240

241
  void createTapePool(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &vo, const uint64_t nbPartialTapes, const bool encryptionValue, const std::string &comment) override;
242
  void deleteTapePool(const std::string &name) override;
243
  std::list<TapePool> getTapePools() const override;
244
  void modifyTapePoolVo(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &vo) override;
Steven Murray's avatar
Steven Murray committed
245
246
247
  void modifyTapePoolNbPartialTapes(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t nbPartialTapes) override;
  void modifyTapePoolComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
  void setTapePoolEncryption(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const bool encryptionValue) override;
248

249
  void createArchiveRoute(
Steven Murray's avatar
Steven Murray committed
250
    const common::dataStructures::SecurityIdentity &admin,
251
252
253
254
    const std::string &diskInstanceName,
    const std::string &storageClassName,
    const uint64_t copyNb,
    const std::string &tapePoolName,
255
    const std::string &comment) override;
256
257
258
259
260
261
262
263
264
265
266


  /**
   * Deletes the specified archive route.
   *
   * @param diskInstanceName The name of the disk instance to which the storage
   * class belongs.
   * @param storageClassName The name of the storage class which is only
   * guaranteed to be unique within its disk instance.
   * @param copyNb The copy number of the tape file.
   */
267
  void deleteArchiveRoute(
268
269
    const std::string &diskInstanceName,
    const std::string &storageClassName, 
270
    const uint64_t copyNb) override;
271

272
  std::list<common::dataStructures::ArchiveRoute> getArchiveRoutes() const override;
Steven Murray's avatar
Steven Murray committed
273
274
  void modifyArchiveRouteTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &tapePoolName) override;
  void modifyArchiveRouteComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &storageClassName, const uint64_t copyNb, const std::string &comment) override;
275

Steven Murray's avatar
Steven Murray committed
276
  void createLogicalLibrary(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
277
278
  void deleteLogicalLibrary(const std::string &name) override;
  std::list<common::dataStructures::LogicalLibrary> getLogicalLibraries() const override;
Steven Murray's avatar
Steven Murray committed
279
  void modifyLogicalLibraryComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
280

281
  /**
282
   * Creates a tape.
283
   */
284
  void createTape(
Steven Murray's avatar
Steven Murray committed
285
    const common::dataStructures::SecurityIdentity &admin,
286
287
288
289
290
291
    const std::string &vid,
    const std::string &logicalLibraryName,
    const std::string &tapePoolName,
    const uint64_t capacityInBytes,
    const bool disabled,
    const bool full,
292
    const std::string &comment) override;
293

294
  void deleteTape(const std::string &vid) override;
295
296
297
298
299
300
301

  /**
   * Returns the list of tapes that meet the specified search criteria.
   *
   * @param searchCriteria The search criteria.
   * @return The list of tapes.
   */
302
  std::list<common::dataStructures::Tape> getTapes(const TapeSearchCriteria &searchCriteria) const override;
303

304
305
306
307
308
309
310
311
312
  /**
   * Returns the tapes with the specified volume identifiers.
   *
   * This method will throw an exception if it cannot find ALL of the specified
   * tapes.
   *
   * @param vids The tape volume identifiers (VIDs).
   * @return Map from tape volume identifier to tape.
   */
313
  common::dataStructures::VidToTapeMap getTapesByVid(const std::set<std::string> &vids) const override;
314

Steven Murray's avatar
Steven Murray committed
315
316
317
318
319
320
321
  /**
   * Returns all the tapes within the CTA catalogue.
   *
   * @return Map from tape volume identifier to tape.
   */
  common::dataStructures::VidToTapeMap getAllTapes() const override;

322
323
324
325
326
327
328
329
330
331
  /**
   * Reclaims the specified tape.
   *
   * This method will throw an exception if the specified tape does not exist.
   *
   * This method will throw an exception if the specified tape is not FULL.
   *
   * This method will throw an exception if there is still at least one tape
   * file recorded in the cataligue as being on the specified tape.
   *
Steven Murray's avatar
Steven Murray committed
332
   * @param admin The administrator.
333
334
   * @param vid The volume identifier of the tape to be reclaimed.
   */
Steven Murray's avatar
Steven Murray committed
335
  void reclaimTape(const common::dataStructures::SecurityIdentity &admin, const std::string &vid) override;
336

Steven Murray's avatar
Steven Murray committed
337
338
339
340
  void modifyTapeLogicalLibraryName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &logicalLibraryName) override;
  void modifyTapeTapePoolName(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &tapePoolName) override;
  void modifyTapeCapacityInBytes(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const uint64_t capacityInBytes) override;
  void modifyTapeEncryptionKey(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &encryptionKey) override;
341
342
343
344
345
346
347

  /**
   * Sets the full status of the specified tape.
   *
   * Please note that this method is to be called by the CTA front-end in
   * response to a command from the CTA command-line interface (CLI).
   *
Steven Murray's avatar
Steven Murray committed
348
   * @param admin The administrator.
349
350
351
   * @param vid The volume identifier of the tape to be marked as full.
   * @param fullValue Set to true if the tape is full.
   */
Steven Murray's avatar
Steven Murray committed
352
  void setTapeFull(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool fullValue) override;
353

Steven Murray's avatar
Steven Murray committed
354
355
  void setTapeDisabled(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const bool disabledValue) override;
  void modifyTapeComment(const common::dataStructures::SecurityIdentity &admin, const std::string &vid, const std::string &comment) override;
356

Steven Murray's avatar
Steven Murray committed
357
358
359
360
  void modifyRequesterMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &mountPolicy) override;
  void modifyRequesteMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterName, const std::string &comment) override;
  void modifyRequesterGroupMountRulePolicy(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &mountPolicy) override;
  void modifyRequesterGroupMountRuleComment(const common::dataStructures::SecurityIdentity &admin, const std::string &instanceName, const std::string &requesterGroupName, const std::string &comment) override;
361

362
  void createMountPolicy(
Steven Murray's avatar
Steven Murray committed
363
    const common::dataStructures::SecurityIdentity &admin,
364
365
366
367
368
369
    const std::string &name,
    const uint64_t archivePriority,
    const uint64_t minArchiveRequestAge,
    const uint64_t retrievePriority,
    const uint64_t minRetrieveRequestAge,
    const uint64_t maxDrivesAllowed,
370
    const std::string &comment) override;
371

372
  /**
373
   * Returns the list of all existing mount policies.
374
   *
375
376
   * @return the list of all existing mount policies.
   */
377
  std::list<common::dataStructures::MountPolicy> getMountPolicies() const override;
378
379
380
381
382
383

  /**
   * Deletes the specified mount policy.
   *
   * @param name The name of the mount policy.
   */
384
  void deleteMountPolicy(const std::string &name) override;
385
386
387
388
389
390
391

  /**
   * Creates the rule that the specified mount policy will be used for the
   * specified requester.
   *
   * Please note that requester mount-rules overrule requester-group
   * mount-rules.
392
   *
Steven Murray's avatar
Steven Murray committed
393
   * @param admin The administrator.
394
   * @param mountPolicyName The name of the mount policy.
395
396
397
398
   * @param diskInstance The name of the disk instance to which the requester
   * belongs.
   * @param requesterName The name of the requester which is only guarantted to
   * be unique within its disk instance.
399
400
   * @param comment Comment.
   */
401
  void createRequesterMountRule(
Steven Murray's avatar
Steven Murray committed
402
    const common::dataStructures::SecurityIdentity &admin,
403
    const std::string &mountPolicyName,
404
    const std::string &diskInstance,
405
    const std::string &requesterName,
406
    const std::string &comment) override;
407
408

  /**
409
410
411
412
413
414
   * Returns the rules that specify which mount policy is be used for which
   * requester.
   *
   * @return the rules that specify which mount policy is be used for which
   * requester.
   */
415
  std::list<common::dataStructures::RequesterMountRule> getRequesterMountRules() const override;
416
417
418
419

  /**
   * Deletes the specified mount rule.
   *
420
421
422
423
   * @param diskInstanceName The name of the disk instance to which the
   * requester belongs.
   * @param requesterName The name of the requester which is only guaranteed to
   * be unique within its disk instance.
424
   */
425
  void deleteRequesterMountRule(const std::string &diskInstanceName, const std::string &requesterName) override;
426
427
428
429

  /**
   * Creates the rule that the specified mount policy will be used for the
   * specified requester group.
430
   *
431
432
   * Please note that requester mount-rules overrule requester-group
   * mount-rules.
433
   *
Steven Murray's avatar
Steven Murray committed
434
   * @param admin The administrator.
435
   * @param mountPolicyName The name of the mount policy.
436
437
438
439
   * @param diskInstanceName The name of the disk instance to which the
   * requester group belongs.
   * @param requesterGroupName The name of the requester group which is only
   * guarantted to be unique within its disk instance.
440
441
   * @param comment Comment.
   */
442
  void createRequesterGroupMountRule(
Steven Murray's avatar
Steven Murray committed
443
    const common::dataStructures::SecurityIdentity &admin,
444
    const std::string &mountPolicyName,
445
    const std::string &diskInstanceName,
446
    const std::string &requesterGroupName,
447
    const std::string &comment) override;
448
449
450
451
452
453
454

  /**
   * Returns the rules that specify which mount policy is be used for which
   * requester group.
   *
   * @return the rules that specify which mount policy is be used for which
   * requester group.
455
   */
456
  std::list<common::dataStructures::RequesterGroupMountRule> getRequesterGroupMountRules() const override;
457
458
459
460

  /**
   * Deletes the specified mount rule.
   *
461
462
463
464
   * @param diskInstanceName The name of the disk instance to which the
   * requester group belongs.
   * @param requesterGroupName The name of the requester group which is only
   * guaranteed to be unique within its disk instance.
465
   */
466
  void deleteRequesterGroupMountRule(
467
    const std::string &diskInstanceName,
468
469
    const std::string &requesterGroupName) override;

Steven Murray's avatar
Steven Murray committed
470
471
472
473
474
475
  void modifyMountPolicyArchivePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t archivePriority) override;
  void modifyMountPolicyArchiveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minArchiveRequestAge) override;
  void modifyMountPolicyRetrievePriority(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t retrievePriority) override;
  void modifyMountPolicyRetrieveMinRequestAge(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t minRetrieveRequestAge) override;
  void modifyMountPolicyMaxDrivesAllowed(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const uint64_t maxDrivesAllowed) override;
  void modifyMountPolicyComment(const common::dataStructures::SecurityIdentity &admin, const std::string &name, const std::string &comment) override;
476

477
  /**
478
479
   * Throws a UserError exception if the specified searchCriteria is not valid
   * due to a user error.
480
481
482
   *
   * @param searchCriteria The search criteria.
   */
483
  void checkTapeFileSearchCriteria(const TapeFileSearchCriteria &searchCriteria) const;
484

485
  /**
486
487
   * Returns the specified archive files.  Please note that the list of files
   * is ordered by archive file ID.
488
489
   *
   * @param searchCriteria The search criteria.
490
   * @return The archive files.
491
   */
492
  ArchiveFileItor getArchiveFiles(const TapeFileSearchCriteria &searchCriteria) const override;
493

494
  /**
495
   * Returns a summary of the tape files that meet the specified search
496
497
498
499
500
   * criteria.
   *
   * @param searchCriteria The search criteria.
   * @return The summary.
   */
501
  common::dataStructures::ArchiveFileSummary getTapeFileSummary(
502
    const TapeFileSearchCriteria &searchCriteria) const override;
503
504
505
506
507
508
509
510
511
512

  /**
   * Returns the archive file with the specified unique identifier.
   *
   * This method assumes that the archive file being requested exists and will
   * therefore throw an exception if it does not.
   *
   * @param id The unique identifier of the archive file.
   * @return The archive file.
   */
513
  common::dataStructures::ArchiveFile getArchiveFileById(const uint64_t id) override;
514

515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
  /**
   * Deletes the specified archive file and its associated tape copies from the
   * catalogue.
   *
   * Please note that the name of the disk instance is specified in order to
   * prevent a disk instance deleting an archive file that belongs to another
   * disk instance.
   *
   * Please note that this method is idempotent.  If the file to be deleted does
   * not exist in the CTA catalogue then this method returns without error.
   *
   * @param instanceName The name of the instance from where the deletion request
   * originated
   * @param archiveFileId The unique identifier of the archive file.
   * @param lc The log context.
   * @return The metadata of the deleted archive file including the metadata of
   * the associated and also deleted tape copies.
   */
  void deleteArchiveFile(const std::string &instanceName, const uint64_t archiveFileId,
    log::LogContext &lc) override;

536
  /**
537
   * Returns true if the specified user has administrator privileges.
538
   *
Steven Murray's avatar
Steven Murray committed
539
   * @param admin The administrator.
540
   * @return True if the specified user has administrator privileges.
541
   */
Steven Murray's avatar
Steven Murray committed
542
  bool isAdmin(const common::dataStructures::SecurityIdentity &admin) const override;
543

544
545
546
547
548
549
  /**
   * Checks that the most trivial query goes through. Returns true on success,
   * false on failure.
   * 
   * @return True if the query went through.
   */
550
  void ping() override;
551

552
protected:
553

554
555
556
557
558
  /**
   * Object representing the API to the CTA logging system.
   */
  log::Logger &m_log;

559
560
561
  /**
   * Mutex to be used to a take a global lock on the database.
   */
562
  threading::Mutex m_mutex;
563
564

  /**
565
566
567
   * The pool of connections to the underlying relational database to be used
   * for all operations accept listing archive files which can be relatively
   * long operations.
568
   */
569
  mutable rdbms::ConnPool m_connPool;
570

571
572
573
574
575
576
  /**
   * The pool of connections to the underlying relational database to be used
   * for the sole purpose of listing archive files.
   */
  mutable rdbms::ConnPool m_archiveFileListingConnPool;

577
578
579
580
581
582
  /**
   * The maximum number of times a single method should try to connect to the
   * database in the event of LostDatabaseConnection exceptions being thrown.
   */
  uint32_t m_maxTriesToConnect;

583
  /**
584
   * Returns true if the specified admin user exists.
585
   *
586
   * @param conn The database connection.
587
588
   * @param adminUsername The name of the admin user.
   * @return True if the admin user exists.
589
   */
590
  bool adminUserExists(rdbms::Conn &conn, const std::string adminUsername) const;
591
592
593
594

  /**
   * Returns true if the specified storage class exists.
   *
595
   * @param conn The database connection.
596
   * @param diskInstanceName The name of the disk instance to which the storage
597
   * class belongs.
598
   * @param storageClassName The name of the storage class.
599
600
   * @return True if the storage class exists.
   */
601
  bool storageClassExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &storageClassName)
602
    const;
603

604
605
606
607
608
609
610
611
  /**
   * Returns true if the specified tape pool exists.
   *
   * @param tapePoolName The name of the tape pool.
   * @return True if the tape pool exists.
   */
  bool tapePoolExists(const std::string &tapePoolName) const override;

612
613
614
  /**
   * Returns true if the specified tape pool exists.
   *
615
   * @param conn The database connection.
616
617
618
   * @param tapePoolName The name of the tape pool.
   * @return True if the tape pool exists.
   */
619
  bool tapePoolExists(rdbms::Conn &conn, const std::string &tapePoolName) const;
620

621
622
623
624
625
626
627
  /**
   * Returns true if the specified archive file identifier exists.
   *
   * @param conn The database connection.
   * @param archiveFileId The archive file identifier.
   * @return True if the archive file identifier exists.
   */
628
  bool archiveFileIdExists(rdbms::Conn &conn, const uint64_t archiveFileId) const;
629

630
631
632
633
634
635
636
  /**
   * Returns true if the specified disk file identifier exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file identifier belongs.
   * @param diskFileId The disk file identifier.
637
   * @return True if the disk file identifier exists.
638
   */
639
  bool diskFileIdExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileId) const;
640

641
642
643
644
645
  /**
   * Returns true if the specified disk file path exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
646
   * file path belongs.
647
648
649
   * @param diskFilePath The disk file path.
   * @return True if the disk file path exists.
   */
650
  bool diskFilePathExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFilePath)
651
652
    const;

653
654
655
656
657
658
659
660
661
  /**
   * Returns true if the specified disk file user exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file user belongs.
   * @param diskFileUSer The name of the disk file user.
   * @return True if the disk file user exists.
   */
662
  bool diskFileUserExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileUser)
663
664
    const;

665
666
667
668
669
670
  /**
   * Returns true if the specified disk file group exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the disk
   * file group belongs.
671
   * @param diskFileGroup The name of the disk file group.
672
673
   * @return True if the disk file group exists.
   */
674
  bool diskFileGroupExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &diskFileGroup)
675
676
    const;

677
678
679
680
681
682
683
684
685
686
687
  /**
   * Returns true if the specified archive route exists.
   *
   * @param conn The database connection.
   * @param diskInstanceName The name of the disk instance to which the storage
   * class belongs.
   * @param storageClassName The name of the storage class which is only
   * guaranteed to be unique within its disk instance.
   * @param copyNb The copy number of the tape file.
   * @return True if the archive route exists.
   */
688
  bool archiveRouteExists(rdbms::Conn &conn, const std::string &diskInstanceName, const std::string &storageClassName,
689
690
    const uint64_t copyNb) const;

691
692
693
694
695
696
697
698
  /**
   * Returns true if the specified tape exists.
   *
   * @param vid The volume identifier of the tape.
   * @return True if the tape exists.
   */
  bool tapeExists(const std::string &vid) const override;

699
700
701
  /**
   * Returns true if the specified tape exists.
   *
702
   * @param conn The database connection.
703
704
705
   * @param vid The volume identifier of the tape.
   * @return True if the tape exists.
   */
706
  bool tapeExists(rdbms::Conn &conn, const std::string &vid) const;
707

708
709
710
711
712
713
714
  /**
   * Returns the list of tapes that meet the specified search criteria.
   *
   * @param conn The database connection.
   * @param searchCriteria The search criteria.
   * @return The list of tapes.
   */
715
  std::list<common::dataStructures::Tape> getTapes(rdbms::Conn &conn, const TapeSearchCriteria &searchCriteria) const;
716

717
718
719
  /**
   * Returns true if the specified logical library exists.
   *
720
   * @param conn The database connection.
721
722
723
   * @param logicalLibraryName The name of the logical library.
   * @return True if the logical library exists.
   */
724
  bool logicalLibraryExists(rdbms::Conn &conn, const std::string &logicalLibraryName) const;
725
726
727
728

  /**
   * Returns true if the specified mount policy exists.
   *
729
   * @param conn The database connection.
730
731
732
   * @param mountPolicyName The name of the mount policy
   * @return True if the mount policy exists.
   */
733
  bool mountPolicyExists(rdbms::Conn &conn, const std::string &mountPolicyName) const;
734

735
  /**
736
   * Returns true if the specified requester mount-rule exists.
737
   *
738
739
740
741
742
   * @param diskInstanceName The name of the disk instance to which the
   * requester belongs.
   * @param requesterName The username of the requester which is only guaranteed
   * to be unique within its disk instance.
   * @return True if the requester mount-rule exists.
743
   */
744
  bool requesterMountRuleExists(rdbms::Conn &conn, const std::string &diskInstanceName,
745
    const std::string &requesterName) const;
746
747

  /**
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
    * A fully qualified user, in other words the name of the disk instance and
    * the name of the group.
    */
  struct User {
    /**
     * The name of the disk instance to which the user name belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the user which is only guaranteed to be unique within its
     * disk instance.
     */
    std::string username;

    /**
     * Constructor.
     *
     * @param d The name of the disk instance to which the group name belongs.
     * @param u The name of the group which is only guaranteed to be unique
     * within its disk instance.
     */
    User(const std::string &d, const std::string &u): diskInstanceName(d), username(u) {
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
    bool operator<(const User &rhs) const {
      return diskInstanceName < rhs.diskInstanceName || username < rhs.username;
    }
  }; // struct User

  /**
   * Returns a cached version of the specified requester mount-policy or nullopt
   * if one does not exist.
788
   *
789
790
   * @param user The fully qualified user, in other words the name of the disk
   * instance and the name of the group.
791
   * @return The mount policy or nullopt if one does not exists.
792
   */
793
  optional<common::dataStructures::MountPolicy> getCachedRequesterMountPolicy(const User &user) const;
794
795
796
797
798
799
800
801
802
803
804

  /**
   * Returns the specified requester mount-policy or nullopt if one does not
   * exist.
   *
   * @param conn The database connection.
   * @param user The fully qualified user, in other words the name of the disk
   * instance and the name of the group.
   * @return The mount policy or nullopt if one does not exists.
   */
  optional<common::dataStructures::MountPolicy> getRequesterMountPolicy(rdbms::Conn &conn, const User &user) const;
805
806

  /**
807
   * Returns true if the specified requester-group mount-rule exists.
808
   *
809
   * @param conn The database connection.
810
811
812
813
814
   * @param diskInstanceName The name of the disk instance to which the
   * requester group belongs.
   * @param requesterGroupName The name of the requester group which is only
   * guaranteed to be unique within its disk instance.
   * @return True if the requester-group mount-rule exists.
815
   */
816
  bool requesterGroupMountRuleExists(rdbms::Conn &conn, const std::string &diskInstanceName,
817
    const std::string &requesterGroupName) const;
818

819
  /**
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
    * A fully qualified user group, in other words the name of the disk instance
    * and the name of the group.
    */
  struct Group {
    /**
     * The name of the disk instance to which the group name belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the group which is only guaranteed to be unique within its
     * disk instance.
     */
    std::string groupName;

    /**
     * Constructor.
     *
     * @param d The name of the disk instance to which the group name belongs.
     * @param g The name of the group which is only guaranteed to be unique
     * within its disk instance.
     */
    Group(const std::string &d, const std::string &g): diskInstanceName(d), groupName(g) {
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
    bool operator<(const Group &rhs) const {
      return diskInstanceName < rhs.diskInstanceName || groupName < rhs.groupName;
    }
  }; // struct Group

  /**
   * Returns a cached version of the specified requester-group mount-policy or
   * nullptr if one does not exist.
   *
   * This method updates the cache when necessary.
862
   *
863
864
   * @param group The fully qualified group, in other words the name of the disk
   * instance and the name of the group.
865
   * @return The cached mount policy or nullopt if one does not exists.
866
   */
867
  optional<common::dataStructures::MountPolicy> getCachedRequesterGroupMountPolicy(const Group &group) const;
868
869
870
871
872
873
874
875

  /**
   * Returns the specified requester-group mount-policy or nullptr if one does
   * not exist.
   *
   * @param conn The database connection.
   * @param group The fully qualified group, in other words the name of the disk
   * instance and the name of the group.
876
   * @return The mount policy or nullopt if one does not exists.
877
   */
878
879
  optional<common::dataStructures::MountPolicy> getRequesterGroupMountPolicy(rdbms::Conn &conn, const Group &group)
    const;
880

881
882
883
884
885
  /**
   * Returns the specified tape log information from the specified database
   * result set.
   *
   * @param rset The result set.
886
   * @param driveColName The name of the database column that contains the name
887
888
889
890
   * of the tape drive.
   * @param timeColNAme The name of the database column that contains the time
   * stamp.
   */
891
  optional<common::dataStructures::TapeLog> getTapeLogFromRset(const rdbms::Rset &rset,
892
893
    const std::string &driveColName, const std::string &timeColName) const;

894
  /**
895
896
   * An RdbmsCatalogue specific method that inserts the specified row into the
   * ArchiveFile table.
897
   *
898
   * @param conn The database connection.
899
   * @param autocommitMode The autocommit mode of the SQL insert statement.
900
   * @param row The row to be inserted.
901
   */
902
  void insertArchiveFile(rdbms::Conn &conn, const rdbms::AutocommitMode autocommitMode,
903
    const ArchiveFileRow &row);
904

905
906
907
908
909
  /**
   * Creates the database schema.
   */
  void createDbSchema();

910
911
912
913
  /**
   * A fully qualified storage class, in other words the name of the disk
   * instance and the name of the storage class.
   */
914
  struct StorageClass {
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
    /**
     * The name of the disk instance to which the storage class belongs.
     */
    std::string diskInstanceName;

    /**
     * The name of the storage class which is only guaranteed to be unique
     * within its disk instance.
     */
    std::string storageClassName;

    /**
     * Constructor.
     *
     * @param dIN The name of the disk instance to which the storage class
     * belongs.
     * @param sN The name of the storage class which is only guaranteed to be
     * unique within its disk instance.
     */
934
    StorageClass(const std::string &d, const std::string &s): diskInstanceName(d), storageClassName(s) {
935
936
937
938
939
940
941
942
943
    }

    /**
     * Less than operator.
     *
     * @param rhs The argument on the right hand side of the operator.
     * @return True if this object is less than the argument on the right hand
     * side of the operator.
     */
944
    bool operator<(const StorageClass &rhs) const {
945
946
      return diskInstanceName < rhs.diskInstanceName || storageClassName < rhs.storageClassName;
    }
947
  }; // struct StorageClass
948

949
950
951
952
953
954
955
956
957
958
959
960
  /**
   * Returns a cached version of the expected number of archive routes for the
   * specified storage class as specified by the call to the
   * createStorageClass() method as opposed to the actual number entered so far
   * using the createArchiveRoute() method.
   *
   * This method updates the cache when necessary.
   *
   * @param storageClass The fully qualified storage class, in other words the
   * name of the disk instance and the name of the storage class.
   * @return The expected number of archive routes.
   */
961
  uint64_t getCachedExpectedNbArchiveRoutes(const StorageClass &storageClass) const;
962

963
964
965
966
967
968
  /**
   * Returns the expected number of archive routes for the specified storage
   * class as specified by the call to the createStorageClass() method as
   * opposed to the actual number entered so far using the createArchiveRoute()
   * method.
   *
969
   * @param conn The database connection.
970
971
   * @param storageClass The fully qualified storage class, in other words the
   * name of the disk instance and the name of the storage class.
972
973
   * @return The expected number of archive routes.
   */
974
  uint64_t getExpectedNbArchiveRoutes(rdbms::Conn &conn, const StorageClass &storageClass) const;
975

976
  /**
977
   * Inserts the specified tape file into the Tape table.
978
   *
979
   * @param conn The database connection.
980
   * @param autocommitMode The autocommit mode of the SQL insert statement.
981
982
983
984
   * @param tapeFile The tape file.
   * @param archiveFileId The identifier of the archive file of which the tape
   * file is a copy.
   */
985
  void insertTapeFile(
986
987
    rdbms::Conn &conn,
    const rdbms::AutocommitMode autocommitMode,
988
989
    const common::dataStructures::TapeFile &tapeFile,
    const uint64_t archiveFileId);
990

991
992
993
  /**
   * Sets the last FSeq of the specified tape to the specified value.
   *
994
   * @param conn The database connection.
995
996
997
   * @param vid The volume identifier of the tape.
   * @param lastFseq The new value of the last FSeq.
   */
998
  void setTapeLastFSeq(rdbms::Conn &conn, const std::string &vid, const uint64_t lastFSeq);
999
1000

  /**
For faster browsing, not all history is shown. View entire blame