Back to home page

OSCL-LXR
 
 

     

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef ISCSI_PARAMETERS_H
0003 #define ISCSI_PARAMETERS_H
0004 
0005 #include <linux/types.h>
0006 #include <scsi/iscsi_proto.h>
0007 
0008 struct iscsi_extra_response {
0009     char key[KEY_MAXLEN];
0010     char value[32];
0011     struct list_head er_list;
0012 } ____cacheline_aligned;
0013 
0014 struct iscsi_param {
0015     char *name;
0016     char *value;
0017     u8 set_param;
0018     u8 phase;
0019     u8 scope;
0020     u8 sender;
0021     u8 type;
0022     u8 use;
0023     u16 type_range;
0024     u32 state;
0025     struct list_head p_list;
0026 } ____cacheline_aligned;
0027 
0028 struct iscsit_conn;
0029 struct iscsi_conn_ops;
0030 struct iscsi_param_list;
0031 struct iscsi_sess_ops;
0032 
0033 extern int iscsi_login_rx_data(struct iscsit_conn *, char *, int);
0034 extern int iscsi_login_tx_data(struct iscsit_conn *, char *, char *, int);
0035 extern void iscsi_dump_conn_ops(struct iscsi_conn_ops *);
0036 extern void iscsi_dump_sess_ops(struct iscsi_sess_ops *);
0037 extern void iscsi_print_params(struct iscsi_param_list *);
0038 extern int iscsi_create_default_params(struct iscsi_param_list **);
0039 extern int iscsi_set_keys_to_negotiate(struct iscsi_param_list *, bool);
0040 extern int iscsi_set_keys_irrelevant_for_discovery(struct iscsi_param_list *);
0041 extern int iscsi_copy_param_list(struct iscsi_param_list **,
0042             struct iscsi_param_list *, int);
0043 extern int iscsi_change_param_value(char *, struct iscsi_param_list *, int);
0044 extern void iscsi_release_param_list(struct iscsi_param_list *);
0045 extern struct iscsi_param *iscsi_find_param_from_key(char *, struct iscsi_param_list *);
0046 extern int iscsi_extract_key_value(char *, char **, char **);
0047 extern int iscsi_update_param_value(struct iscsi_param *, char *);
0048 extern int iscsi_decode_text_input(u8, u8, char *, u32, struct iscsit_conn *);
0049 extern int iscsi_encode_text_output(u8, u8, char *, u32 *,
0050             struct iscsi_param_list *, bool);
0051 extern int iscsi_check_negotiated_keys(struct iscsi_param_list *);
0052 extern void iscsi_set_connection_parameters(struct iscsi_conn_ops *,
0053             struct iscsi_param_list *);
0054 extern void iscsi_set_session_parameters(struct iscsi_sess_ops *,
0055             struct iscsi_param_list *, int);
0056 
0057 #define YES             "Yes"
0058 #define NO              "No"
0059 #define ALL             "All"
0060 #define IRRELEVANT          "Irrelevant"
0061 #define NONE                "None"
0062 #define NOTUNDERSTOOD           "NotUnderstood"
0063 #define REJECT              "Reject"
0064 
0065 /*
0066  * The Parameter Names.
0067  */
0068 #define AUTHMETHOD          "AuthMethod"
0069 #define HEADERDIGEST            "HeaderDigest"
0070 #define DATADIGEST          "DataDigest"
0071 #define MAXCONNECTIONS          "MaxConnections"
0072 #define SENDTARGETS         "SendTargets"
0073 #define TARGETNAME          "TargetName"
0074 #define INITIATORNAME           "InitiatorName"
0075 #define TARGETALIAS         "TargetAlias"
0076 #define INITIATORALIAS          "InitiatorAlias"
0077 #define TARGETADDRESS           "TargetAddress"
0078 #define TARGETPORTALGROUPTAG        "TargetPortalGroupTag"
0079 #define INITIALR2T          "InitialR2T"
0080 #define IMMEDIATEDATA           "ImmediateData"
0081 #define MAXRECVDATASEGMENTLENGTH    "MaxRecvDataSegmentLength"
0082 #define MAXXMITDATASEGMENTLENGTH    "MaxXmitDataSegmentLength"
0083 #define MAXBURSTLENGTH          "MaxBurstLength"
0084 #define FIRSTBURSTLENGTH        "FirstBurstLength"
0085 #define DEFAULTTIME2WAIT        "DefaultTime2Wait"
0086 #define DEFAULTTIME2RETAIN      "DefaultTime2Retain"
0087 #define MAXOUTSTANDINGR2T       "MaxOutstandingR2T"
0088 #define DATAPDUINORDER          "DataPDUInOrder"
0089 #define DATASEQUENCEINORDER     "DataSequenceInOrder"
0090 #define ERRORRECOVERYLEVEL      "ErrorRecoveryLevel"
0091 #define SESSIONTYPE         "SessionType"
0092 #define IFMARKER            "IFMarker"
0093 #define OFMARKER            "OFMarker"
0094 #define IFMARKINT           "IFMarkInt"
0095 #define OFMARKINT           "OFMarkInt"
0096 
0097 /*
0098  * Parameter names of iSCSI Extentions for RDMA (iSER).  See RFC-5046
0099  */
0100 #define RDMAEXTENSIONS          "RDMAExtensions"
0101 #define INITIATORRECVDATASEGMENTLENGTH  "InitiatorRecvDataSegmentLength"
0102 #define TARGETRECVDATASEGMENTLENGTH "TargetRecvDataSegmentLength"
0103 
0104 /*
0105  * For AuthMethod.
0106  */
0107 #define KRB5                "KRB5"
0108 #define SPKM1               "SPKM1"
0109 #define SPKM2               "SPKM2"
0110 #define SRP             "SRP"
0111 #define CHAP                "CHAP"
0112 
0113 /*
0114  * Initial values for Parameter Negotiation.
0115  */
0116 #define INITIAL_AUTHMETHOD          CHAP
0117 #define INITIAL_HEADERDIGEST            "CRC32C,None"
0118 #define INITIAL_DATADIGEST          "CRC32C,None"
0119 #define INITIAL_MAXCONNECTIONS          "1"
0120 #define INITIAL_SENDTARGETS         ALL
0121 #define INITIAL_TARGETNAME          "LIO.Target"
0122 #define INITIAL_INITIATORNAME           "LIO.Initiator"
0123 #define INITIAL_TARGETALIAS         "LIO Target"
0124 #define INITIAL_INITIATORALIAS          "LIO Initiator"
0125 #define INITIAL_TARGETADDRESS           "0.0.0.0:0000,0"
0126 #define INITIAL_TARGETPORTALGROUPTAG        "1"
0127 #define INITIAL_INITIALR2T          YES
0128 #define INITIAL_IMMEDIATEDATA           YES
0129 #define INITIAL_MAXRECVDATASEGMENTLENGTH    "8192"
0130 /*
0131  * Match outgoing MXDSL default to incoming Open-iSCSI default
0132  */
0133 #define INITIAL_MAXXMITDATASEGMENTLENGTH    "262144"
0134 #define INITIAL_MAXBURSTLENGTH          "262144"
0135 #define INITIAL_FIRSTBURSTLENGTH        "65536"
0136 #define INITIAL_DEFAULTTIME2WAIT        "2"
0137 #define INITIAL_DEFAULTTIME2RETAIN      "20"
0138 #define INITIAL_MAXOUTSTANDINGR2T       "1"
0139 #define INITIAL_DATAPDUINORDER          YES
0140 #define INITIAL_DATASEQUENCEINORDER     YES
0141 #define INITIAL_ERRORRECOVERYLEVEL      "0"
0142 #define INITIAL_SESSIONTYPE         NORMAL
0143 #define INITIAL_IFMARKER            NO
0144 #define INITIAL_OFMARKER            NO
0145 #define INITIAL_IFMARKINT           REJECT
0146 #define INITIAL_OFMARKINT           REJECT
0147 
0148 /*
0149  * Initial values for iSER parameters following RFC-5046 Section 6
0150  */
0151 #define INITIAL_RDMAEXTENSIONS          NO
0152 #define INITIAL_INITIATORRECVDATASEGMENTLENGTH  "262144"
0153 #define INITIAL_TARGETRECVDATASEGMENTLENGTH "8192"
0154 
0155 /*
0156  * For [Header,Data]Digests.
0157  */
0158 #define CRC32C              "CRC32C"
0159 
0160 /*
0161  * For SessionType.
0162  */
0163 #define DISCOVERY           "Discovery"
0164 #define NORMAL              "Normal"
0165 
0166 /*
0167  * struct iscsi_param->use
0168  */
0169 #define USE_LEADING_ONLY        0x01
0170 #define USE_INITIAL_ONLY        0x02
0171 #define USE_ALL             0x04
0172 
0173 #define IS_USE_LEADING_ONLY(p)      ((p)->use & USE_LEADING_ONLY)
0174 #define IS_USE_INITIAL_ONLY(p)      ((p)->use & USE_INITIAL_ONLY)
0175 #define IS_USE_ALL(p)           ((p)->use & USE_ALL)
0176 
0177 #define SET_USE_INITIAL_ONLY(p)     ((p)->use |= USE_INITIAL_ONLY)
0178 
0179 /*
0180  * struct iscsi_param->sender
0181  */
0182 #define SENDER_INITIATOR        0x01
0183 #define SENDER_TARGET           0x02
0184 #define SENDER_BOTH         0x03
0185 /* Used in iscsi_check_key() */
0186 #define SENDER_RECEIVER         0x04
0187 
0188 #define IS_SENDER_INITIATOR(p)      ((p)->sender & SENDER_INITIATOR)
0189 #define IS_SENDER_TARGET(p)     ((p)->sender & SENDER_TARGET)
0190 #define IS_SENDER_BOTH(p)       ((p)->sender & SENDER_BOTH)
0191 
0192 /*
0193  * struct iscsi_param->scope
0194  */
0195 #define SCOPE_CONNECTION_ONLY       0x01
0196 #define SCOPE_SESSION_WIDE      0x02
0197 
0198 #define IS_SCOPE_CONNECTION_ONLY(p) ((p)->scope & SCOPE_CONNECTION_ONLY)
0199 #define IS_SCOPE_SESSION_WIDE(p)    ((p)->scope & SCOPE_SESSION_WIDE)
0200 
0201 /*
0202  * struct iscsi_param->phase
0203  */
0204 #define PHASE_SECURITY          0x01
0205 #define PHASE_OPERATIONAL       0x02
0206 #define PHASE_DECLARATIVE       0x04
0207 #define PHASE_FFP0          0x08
0208 
0209 #define IS_PHASE_SECURITY(p)        ((p)->phase & PHASE_SECURITY)
0210 #define IS_PHASE_OPERATIONAL(p)     ((p)->phase & PHASE_OPERATIONAL)
0211 #define IS_PHASE_DECLARATIVE(p)     ((p)->phase & PHASE_DECLARATIVE)
0212 #define IS_PHASE_FFP0(p)        ((p)->phase & PHASE_FFP0)
0213 
0214 /*
0215  * struct iscsi_param->type
0216  */
0217 #define TYPE_BOOL_AND           0x01
0218 #define TYPE_BOOL_OR            0x02
0219 #define TYPE_NUMBER         0x04
0220 #define TYPE_NUMBER_RANGE       0x08
0221 #define TYPE_STRING         0x10
0222 #define TYPE_VALUE_LIST         0x20
0223 
0224 #define IS_TYPE_BOOL_AND(p)     ((p)->type & TYPE_BOOL_AND)
0225 #define IS_TYPE_BOOL_OR(p)      ((p)->type & TYPE_BOOL_OR)
0226 #define IS_TYPE_NUMBER(p)       ((p)->type & TYPE_NUMBER)
0227 #define IS_TYPE_NUMBER_RANGE(p)     ((p)->type & TYPE_NUMBER_RANGE)
0228 #define IS_TYPE_STRING(p)       ((p)->type & TYPE_STRING)
0229 #define IS_TYPE_VALUE_LIST(p)       ((p)->type & TYPE_VALUE_LIST)
0230 
0231 /*
0232  * struct iscsi_param->type_range
0233  */
0234 #define TYPERANGE_BOOL_AND      0x0001
0235 #define TYPERANGE_BOOL_OR       0x0002
0236 #define TYPERANGE_0_TO_2        0x0004
0237 #define TYPERANGE_0_TO_3600     0x0008
0238 #define TYPERANGE_0_TO_32767        0x0010
0239 #define TYPERANGE_0_TO_65535        0x0020
0240 #define TYPERANGE_1_TO_65535        0x0040
0241 #define TYPERANGE_2_TO_3600     0x0080
0242 #define TYPERANGE_512_TO_16777215   0x0100
0243 #define TYPERANGE_AUTH          0x0200
0244 #define TYPERANGE_DIGEST        0x0400
0245 #define TYPERANGE_ISCSINAME     0x0800
0246 #define TYPERANGE_SESSIONTYPE       0x1000
0247 #define TYPERANGE_TARGETADDRESS     0x2000
0248 #define TYPERANGE_UTF8          0x4000
0249 
0250 #define IS_TYPERANGE_0_TO_2(p)      ((p)->type_range & TYPERANGE_0_TO_2)
0251 #define IS_TYPERANGE_0_TO_3600(p)   ((p)->type_range & TYPERANGE_0_TO_3600)
0252 #define IS_TYPERANGE_0_TO_32767(p)  ((p)->type_range & TYPERANGE_0_TO_32767)
0253 #define IS_TYPERANGE_0_TO_65535(p)  ((p)->type_range & TYPERANGE_0_TO_65535)
0254 #define IS_TYPERANGE_1_TO_65535(p)  ((p)->type_range & TYPERANGE_1_TO_65535)
0255 #define IS_TYPERANGE_2_TO_3600(p)   ((p)->type_range & TYPERANGE_2_TO_3600)
0256 #define IS_TYPERANGE_512_TO_16777215(p) ((p)->type_range & \
0257                         TYPERANGE_512_TO_16777215)
0258 #define IS_TYPERANGE_AUTH_PARAM(p)  ((p)->type_range & TYPERANGE_AUTH)
0259 #define IS_TYPERANGE_DIGEST_PARAM(p)    ((p)->type_range & TYPERANGE_DIGEST)
0260 #define IS_TYPERANGE_SESSIONTYPE(p) ((p)->type_range & \
0261                         TYPERANGE_SESSIONTYPE)
0262 
0263 /*
0264  * struct iscsi_param->state
0265  */
0266 #define PSTATE_ACCEPTOR         0x01
0267 #define PSTATE_NEGOTIATE        0x02
0268 #define PSTATE_PROPOSER         0x04
0269 #define PSTATE_IRRELEVANT       0x08
0270 #define PSTATE_REJECT           0x10
0271 #define PSTATE_REPLY_OPTIONAL       0x20
0272 #define PSTATE_RESPONSE_GOT     0x40
0273 #define PSTATE_RESPONSE_SENT        0x80
0274 
0275 #define IS_PSTATE_ACCEPTOR(p)       ((p)->state & PSTATE_ACCEPTOR)
0276 #define IS_PSTATE_NEGOTIATE(p)      ((p)->state & PSTATE_NEGOTIATE)
0277 #define IS_PSTATE_PROPOSER(p)       ((p)->state & PSTATE_PROPOSER)
0278 #define IS_PSTATE_IRRELEVANT(p)     ((p)->state & PSTATE_IRRELEVANT)
0279 #define IS_PSTATE_REJECT(p)     ((p)->state & PSTATE_REJECT)
0280 #define IS_PSTATE_REPLY_OPTIONAL(p) ((p)->state & PSTATE_REPLY_OPTIONAL)
0281 #define IS_PSTATE_RESPONSE_GOT(p)   ((p)->state & PSTATE_RESPONSE_GOT)
0282 #define IS_PSTATE_RESPONSE_SENT(p)  ((p)->state & PSTATE_RESPONSE_SENT)
0283 
0284 #define SET_PSTATE_ACCEPTOR(p)      ((p)->state |= PSTATE_ACCEPTOR)
0285 #define SET_PSTATE_NEGOTIATE(p)     ((p)->state |= PSTATE_NEGOTIATE)
0286 #define SET_PSTATE_PROPOSER(p)      ((p)->state |= PSTATE_PROPOSER)
0287 #define SET_PSTATE_IRRELEVANT(p)    ((p)->state |= PSTATE_IRRELEVANT)
0288 #define SET_PSTATE_REJECT(p)        ((p)->state |= PSTATE_REJECT)
0289 #define SET_PSTATE_REPLY_OPTIONAL(p)    ((p)->state |= PSTATE_REPLY_OPTIONAL)
0290 #define SET_PSTATE_RESPONSE_GOT(p)  ((p)->state |= PSTATE_RESPONSE_GOT)
0291 #define SET_PSTATE_RESPONSE_SENT(p) ((p)->state |= PSTATE_RESPONSE_SENT)
0292 
0293 #endif /* ISCSI_PARAMETERS_H */
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!