1 /*
2    Copyright (c) 2003, 2021, Oracle and/or its affiliates.
3 
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License, version 2.0,
6    as published by the Free Software Foundation.
7 
8    This program is also distributed with certain software (including
9    but not limited to OpenSSL) that is licensed under separate terms,
10    as designated in a particular file or component or in included license
11    documentation.  The authors of MySQL hereby grant you an additional
12    permission to link the program and your derivative works with the
13    separately licensed software that they have included with MySQL.
14 
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License, version 2.0, for more details.
19 
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
23 */
24 
25 #ifndef ACC_LOCK_HPP
26 #define ACC_LOCK_HPP
27 
28 #include "SignalData.hpp"
29 
30 #define JAM_FILE_ID 153
31 
32 
33 /*
34  * Lock or unlock tuple.  If lock request is queued, the reply is later
35  * via ACCKEYCONF.
36  */
37 class AccLockReq {
38   friend class Dbacc;
39   friend class Dbtup;
40   friend class Dbtux;
41   friend bool printACC_LOCKREQ(FILE *, const Uint32*, Uint32, Uint16);
42 public:
43   enum RequestType {    // first byte
44     LockShared = 1,
45     LockExclusive = 2,
46     Unlock = 3,
47     Abort = 4,
48     AbortWithConf = 5
49   };
50   enum RequestFlag {    // second byte
51   };
52   enum ReturnCode {
53     Success = 0,
54     IsBlocked = 1,      // was put in lock queue
55     WouldBlock = 2,     // if we add non-blocking option
56     Refused = 3,
57     NoFreeOp = 4
58   };
59   STATIC_CONST( LockSignalLength = 13 );
60   STATIC_CONST( UndoSignalLength = 3 );
61 private:
62   Uint32 returnCode;
63   Uint32 requestInfo;
64   Uint32 accOpPtr;
65   // rest only if lock request
66   Uint32 userPtr;
67   Uint32 userRef;
68   Uint32 tableId;
69   Uint32 fragId;
70   Uint32 fragPtrI;
71   Uint32 hashValue;
72   Uint32 page_id;
73   Uint32 page_idx;
74   Uint32 transId1;
75   Uint32 transId2;
76 };
77 
78 
79 #undef JAM_FILE_ID
80 
81 #endif
82